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 true
130 \output_changes false
132 \postpone_fragile_content false
136 \docbook_table_output 0
137 \docbook_mathml_prefix 1
138 \author -712698321 "Jürgen Spitzmüller"
141 \author 244031559 "Yuriy"
142 \author 274215730 "scott"
143 \author 545138413 "Koji Yokota" yokota6@gmail.com
144 \author 564990737 "John Lyx"
145 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
146 \author 1075283030 "Thibaut"
147 \author 1119979965 "Joel A. Kulesza"
153 Additional \SpecialChar LyX
157 \begin_layout Subtitle
159 \change_deleted 630872221 1622909155
161 \change_inserted 630872221 1622909155
168 by the \SpecialChar LyX
173 \begin_layout Plain Layout
175 Principal maintainer of this file is
177 Richard Kimberly Heck
180 If you have comments or error corrections,
181 please send them to the \SpecialChar LyX
182 Documentation mailing list,
184 \begin_inset Flex Code
187 \begin_layout Plain Layout
188 <lyx-docs@lists.lyx.org>
201 \begin_layout Standard
202 \begin_inset CommandInset toc
203 LatexCommand tableofcontents
210 \begin_layout Standard
212 \change_inserted 5863208 1672865652
213 \begin_inset Note Note
216 \begin_layout Plain Layout
218 \change_inserted 5863208 1672865674
219 Note to all translators:
222 \begin_layout Plain Layout
224 \change_inserted 5863208 1672865817
225 This manual was restructured for LyX 2.4.
226 Attached are notes for translators to help them to find their way round the new structure of Additional.lyx.
227 This note itself will be deleted in the final 2.4 release.
228 \begin_inset Newline newline
234 \begin_layout Plain Layout
236 \change_inserted 5863208 1672865801
239 Additional.lyx 2.4 Changes
242 \begin_layout Itemize
244 \change_inserted 5863208 1672865801
249 \begin_layout Itemize
251 \change_inserted 5863208 1672865801
256 \begin_layout Itemize
258 \change_inserted 5863208 1672865801
265 \begin_layout Itemize
267 \change_inserted 5863208 1672865801
269 moved and minor edits
272 \begin_layout Itemize
274 \change_inserted 5863208 1672865801
279 \begin_layout Itemize
281 \change_inserted 5863208 1672865801
286 \begin_layout Itemize
288 \change_inserted 5863208 1672865801
293 \begin_layout Itemize
295 \change_inserted 5863208 1672865801
297 moved and significant edits
300 \begin_layout Itemize
302 \change_inserted 5863208 1672865801
307 \begin_layout Itemize
309 \change_inserted 5863208 1672865801
314 \begin_layout Itemize
316 \change_inserted 5863208 1672865801
318 moved and minor edits
321 \begin_layout Itemize
323 \change_inserted 5863208 1672865801
328 \begin_layout Itemize
330 \change_inserted 5863208 1672865801
335 \begin_layout Itemize
337 \change_inserted 5863208 1672865801
342 \begin_layout Itemize
344 \change_inserted 5863208 1672865801
349 \begin_layout Itemize
351 \change_inserted 5863208 1672865824
356 \begin_layout Itemize
358 \change_inserted 5863208 1672865831
363 \begin_layout Itemize
365 \change_inserted 5863208 1672865831
370 \begin_layout Itemize
372 \change_inserted 5863208 1672865831
377 \begin_layout Itemize
379 \change_inserted 5863208 1672865831
384 \begin_layout Itemize
386 \change_inserted 5863208 1672865831
391 \begin_layout Itemize
393 \change_inserted 5863208 1672865831
398 \begin_layout Itemize
400 \change_inserted 5863208 1672865831
402 moved with minor edits
405 \begin_layout Itemize
407 \change_inserted 5863208 1672865831
412 \begin_layout Itemize
414 \change_inserted 5863208 1672865831
419 \begin_layout Itemize
421 \change_inserted 5863208 1672865831
423 moved with minor edits
426 \begin_layout Itemize
428 \change_inserted 5863208 1672865831
433 \begin_layout Itemize
435 \change_inserted 5863208 1672865831
440 \begin_layout Itemize
442 \change_inserted 5863208 1672865831
447 \begin_layout Itemize
449 \change_inserted 5863208 1672865831
450 (Note that document classes which appeared in 2.3 but do not appear in 2.4 were either removed previously or have been removed during this revision because they are no longer available anywhere.)
454 \begin_layout Itemize
456 \change_inserted 5863208 1672865831
463 \begin_layout Itemize
465 \change_inserted 5863208 1672865831
466 All module descriptions new except:
469 \begin_layout Itemize
471 \change_inserted 5863208 1672865831
473 moved with minor edits
476 \begin_layout Itemize
478 \change_inserted 5863208 1672865831
479 Custom header/footer text:
480 moved with minor edits
483 \begin_layout Itemize
485 \change_inserted 5863208 1672865831
487 moved with minor edits
490 \begin_layout Itemize
492 \change_inserted 5863208 1672865831
493 Custom paragraph shapes:
494 moved with minor edits
497 \begin_layout Itemize
499 \change_inserted 5863208 1672865831
501 moved with minor edits
505 \begin_layout Itemize
507 \change_inserted 5863208 1672865831
514 \begin_layout Itemize
516 \change_inserted 5863208 1672865831
517 Content moved but unchanged
521 \begin_layout Itemize
523 \change_inserted 5863208 1672865831
530 \begin_layout Itemize
532 \change_inserted 5863208 1672865845
533 Content moved but unchanged
537 \begin_layout Itemize
539 \change_inserted 5863208 1672865845
542 new chapter and content
545 \begin_layout Itemize
547 \change_inserted 5863208 1672865845
548 All other chapters unchanged but renumbered except:
551 \begin_layout Itemize
553 \change_inserted 5863208 1672865845
554 section 11.3 Literate programming:
565 \begin_layout Chapter
569 \begin_layout Standard
570 This manual is essentially Part II of the
572 User's Guide\SpecialChar endofsentence
575 The reason for separating the two documents is simple:
580 is already quite lengthy,
581 and it contains information on all of the basic features one needs to know in order to prepare most documents.
584 Team has worked to make \SpecialChar LyX
585 extensible through various configuration files and external packages.
586 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
588 you can create a layout file (or module) for it without having to alter \SpecialChar LyX
590 We've already had contributions of several new features this way,
591 and some of them are documented here.
592 There are also some more `advanced' features,
593 such as how to control the presentation of bibliographies and how to work with multi-part documents,
594 that are not covered in the
598 and are discussed here.
601 \begin_layout Standard
602 This manual also documents some special features,
604 \change_deleted 244031559 1603802929
607 \change_inserted 244031559 1603802931
611 \change_deleted 244031559 1603802954
616 which require additional software to work properly.
617 There is also a chapter on \SpecialChar LyX
620 there's a chapter of \SpecialChar LaTeX
622 things you can use to spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
630 only WYSIWYM and will only ever interface to some,
636 \begin_layout Standard
637 If you haven't read the
642 you are definitely in the wrong manual.
647 is the first place to go,
648 since it describes the notation and format of all of the manuals.
649 You should also be thoroughly familiar with the
653 and all of the basic features of \SpecialChar LyX
654 before attempting to read this one.
657 \begin_layout Standard
658 Since many of the topics in this manual depend heavily on \SpecialChar LyX
659 's interaction with \SpecialChar LaTeX
661 this first chapter covers the inner workings of \SpecialChar LyX
662 and how to direct \SpecialChar LyX
663 to generate exactly the \SpecialChar LaTeX
665 It is obviously for more seasoned \SpecialChar LyX
669 \begin_layout Chapter
671 and \SpecialChar LaTeX
675 \begin_layout Section
677 Uses \SpecialChar LaTeX
681 \begin_layout Standard
682 This chapter is for both \SpecialChar TeX
683 -nicians and the \SpecialChar LaTeX
686 we'll explain how \SpecialChar LyX
687 and \SpecialChar LaTeX
688 work together to produce printable output.
689 This is the only place in any of the manuals where we assume you know something about \SpecialChar LaTeX
693 \begin_layout Standard
697 \begin_inset Quotes eld
700 WYSIWYM frontend to \SpecialChar LaTeX
702 \begin_inset Quotes erd
705 but that's no longer true.
706 There are frontends to \SpecialChar LaTeX
711 \begin_layout Plain Layout
712 Some familar ones are \SpecialChar TeX
718 There are also the \SpecialChar LaTeX
719 modes for vi and emacs,
725 These are basically text editors with the ability to run \SpecialChar LaTeX
726 and mark any errors in the file you're editing.
727 Although \SpecialChar LyX
737 run \SpecialChar LaTeX
739 and it also indicates errors in the file,
743 you don't need to know \SpecialChar LaTeX
744 to use \SpecialChar LyX
747 has added its own extensions to \SpecialChar LaTeX
749 Try the following sometime:
751 \change_deleted -712698321 1674917358
755 \begin_inset Flex Noun
758 \begin_layout Plain Layout
761 Export\SpecialChar menuseparator
768 \change_inserted -712698321 1674917358
769 Export\SpecialChar menuseparator
775 \change_deleted -712698321 1674917366
777 \begin_inset Flex Noun
780 \begin_layout Plain Layout
787 \change_inserted -712698321 1674917366
795 \change_deleted -712698321 1674917371
797 \begin_inset Flex Noun
800 \begin_layout Plain Layout
801 View\SpecialChar menuseparator
812 \change_inserted -712698321 1674917371
815 View\SpecialChar menuseparator
825 then look at the preamble of the resulting
826 \begin_inset Flex Code
829 \begin_layout Plain Layout
836 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
838 These macros are defined automatically,
839 according to the features you use in the document.
842 \begin_layout Standard
843 There are several commands that automatically invoke \SpecialChar LaTeX
848 \begin_layout Itemize
850 \change_deleted -712698321 1674917379
851 \begin_inset Flex Noun
854 \begin_layout Plain Layout
855 Document\SpecialChar menuseparator
862 \change_inserted -712698321 1674917379
865 Document\SpecialChar menuseparator
871 \begin_layout Itemize
873 \change_deleted -712698321 1674917381
874 \begin_inset Flex Noun
877 \begin_layout Plain Layout
878 Document\SpecialChar menuseparator
885 \change_inserted -712698321 1674917381
888 Document\SpecialChar menuseparator
894 \begin_layout Standard
895 They will only invoke \SpecialChar LaTeX
896 if the file has changed since the last time \SpecialChar LaTeX
901 \begin_layout Standard
902 When \SpecialChar LyX
903 runs \SpecialChar LaTeX
904 on the file you're editing,
905 it performs these steps:
908 \begin_layout Enumerate
909 Convert the document to \SpecialChar LaTeX
910 and save to a file with the extension
911 \begin_inset Flex Code
914 \begin_layout Plain Layout
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
933 \begin_layout Enumerate
934 Run \SpecialChar LaTeX
936 \begin_inset Flex Code
939 \begin_layout Plain Layout
945 file (maybe several times),
946 and run any other commands (such as
947 \begin_inset Flex Code
950 \begin_layout Plain Layout
957 \begin_inset Flex Code
960 \begin_layout Plain Layout
966 ) needed to compile the \SpecialChar LaTeX
970 \begin_layout Enumerate
971 If there are any errors,
975 \begin_layout Standard
976 If you have run \SpecialChar LaTeX
978 \change_deleted -712698321 1674917394
980 \begin_inset Flex Noun
983 \begin_layout Plain Layout
984 View\SpecialChar menuseparator
991 \change_inserted -712698321 1674917394
994 View\SpecialChar menuseparator
1001 then runs a DVI viewer to display the DVI-file.
1003 \change_deleted -712698321 1674917400
1005 \begin_inset Flex Noun
1008 \begin_layout Plain Layout
1009 View\SpecialChar menuseparator
1016 \change_inserted -712698321 1674917400
1019 View\SpecialChar menuseparator
1026 performs further steps:
1029 \begin_layout Enumerate
1031 \begin_inset Flex Code
1034 \begin_layout Plain Layout
1040 to convert the DVI file to PostScript.
1043 \begin_layout Enumerate
1044 Run a PostScript viewer,
1046 \begin_inset Flex Code
1049 \begin_layout Plain Layout
1056 to display the PostScript file.
1059 \begin_layout Standard
1061 does similar things when viewing,
1066 \begin_layout Section
1067 Translating \SpecialChar LaTeX
1068 files into \SpecialChar LyX
1072 \begin_layout Standard
1073 You can import a \SpecialChar LaTeX
1074 file into \SpecialChar LyX
1076 \change_deleted -712698321 1674917408
1078 \begin_inset Flex Noun
1081 \begin_layout Plain Layout
1082 File\SpecialChar menuseparator
1083 Import\SpecialChar menuseparator
1090 \change_inserted -712698321 1674917408
1093 File\SpecialChar menuseparator
1094 Import\SpecialChar menuseparator
1099 command in \SpecialChar LyX
1101 This will call a program named
1102 \begin_inset Flex Code
1105 \begin_layout Plain Layout
1111 which will create a file
1112 \begin_inset Flex Code
1115 \begin_layout Plain Layout
1122 \begin_inset Flex Code
1125 \begin_layout Plain Layout
1133 will then open that file.
1137 \begin_layout Plain Layout
1138 \begin_inset Flex Code
1141 \begin_layout Plain Layout
1147 can also be run from the command line,
1156 \begin_layout Standard
1157 \begin_inset Flex Code
1160 \begin_layout Plain Layout
1166 will translate most legal \SpecialChar LaTeX
1169 It will put things it doesn't understand into \SpecialChar TeX
1171 so after translating a file with
1172 \begin_inset Flex Code
1175 \begin_layout Plain Layout
1182 you can look for \SpecialChar TeX
1183 code and hand-edit it until it looks right.
1186 \begin_layout Standard
1187 If you don't know what \SpecialChar TeX
1189 read the next section.
1192 \begin_layout Section
1193 \begin_inset CommandInset label
1195 name "sec:Inserting-TeX-Code"
1199 Inserting \SpecialChar TeX
1200 Code into \SpecialChar LyX
1204 \begin_layout Standard
1205 Anything you can do in \SpecialChar LaTeX
1206 you can do in \SpecialChar LyX
1208 for a very simple reason:
1209 You can always insert \SpecialChar TeX
1210 code into any \SpecialChar LyX
1214 and will never be able to,
1215 display every possible \SpecialChar LaTeX
1217 If ever you need to insert \SpecialChar LaTeX
1218 commands into your \SpecialChar LyX
1221 \begin_inset Flex Code
1224 \begin_layout Plain Layout
1232 which you can insert into your document with
1233 \change_deleted -712698321 1674917417
1235 \begin_inset Flex Noun
1238 \begin_layout Plain Layout
1239 Insert\SpecialChar menuseparator
1250 \change_inserted -712698321 1674917417
1253 Insert\SpecialChar menuseparator
1258 or the keyboard shortcut
1267 \begin_layout Standard
1268 Here's an example of inserting \SpecialChar LaTeX
1269 commands in a \SpecialChar LyX
1271 The code looks like this:
1274 \begin_layout LyX-Code
1278 \begin_inset Newline newline
1283 begin{minipage}{5cm}
1284 \begin_inset Newline newline
1287 This is an example of a minipage environment.
1289 \begin_inset Newline newline
1292 can put nearly everything in it,
1294 \begin_inset Newline newline
1299 \begin_inset Newline newline
1305 \begin_inset Newline newline
1309 \begin_inset Newline newline
1314 begin{minipage}{5cm}
1315 \begin_inset Newline newline
1321 \begin_inset Newline newline
1326 begin{minipage}{5cm}
1327 \begin_inset Newline newline
1332 \begin_inset Newline newline
1338 \begin_inset Newline newline
1344 \begin_inset Newline newline
1350 \begin_inset Newline newline
1358 \begin_layout LyX-Code
1362 \begin_layout Standard
1364 \begin_inset Flex Code
1367 \begin_layout Plain Layout
1374 box containing this text is directly after this paragraph.
1375 Those of you reading the manual in \SpecialChar LyX
1376 will only see the \SpecialChar TeX
1378 Those reading a printed version of the manuals will see the actual results:
1379 \begin_inset VSpace bigskip
1385 \begin_layout Standard
1389 \begin_layout Plain Layout
1396 \begin_layout Plain Layout
1400 begin{minipage}{5cm}
1403 \begin_layout Plain Layout
1405 This is an example of a minipage environment.
1406 You can put nearly everything in it,
1407 even (non-floating) figures and tables.
1411 \begin_layout Plain Layout
1418 \begin_layout Plain Layout
1423 \begin_layout Plain Layout
1427 begin{minipage}{5cm}
1430 \begin_layout Plain Layout
1437 \begin_layout Plain Layout
1441 begin{minipage}{5cm}
1444 \begin_layout Plain Layout
1450 \begin_layout Plain Layout
1457 \begin_layout Plain Layout
1464 \begin_layout Plain Layout
1471 \begin_layout Plain Layout
1481 \begin_inset VSpace bigskip
1487 \begin_layout Standard
1488 In addition to using \SpecialChar TeX
1490 you can also create a separate file containing some complex \SpecialChar LaTeX
1491 structure and then use
1492 \change_deleted -712698321 1674917427
1494 \begin_inset Flex Noun
1497 \begin_layout Plain Layout
1498 Insert\SpecialChar menuseparator
1500 \begin_inset space ~
1509 \change_inserted -712698321 1674917427
1512 Insert\SpecialChar menuseparator
1514 \begin_inset space ~
1521 to include your file (you should select the type
1522 \begin_inset Flex Code
1525 \begin_layout Plain Layout
1532 We recommend that you only do this if you have a
1533 \begin_inset Flex Code
1536 \begin_layout Plain Layout
1548 you'll have a big job tracking down \SpecialChar LaTeX
1552 \begin_layout Standard
1553 There are a few last points to emphasize:
1556 \begin_layout Itemize
1562 check if your \SpecialChar LaTeX
1566 \begin_layout Itemize
1567 Beware of reinventing the wheel.
1570 \begin_layout Standard
1573 does have quite a few features tucked into it,
1574 and more are coming.
1575 Be sure to check the manuals to make sure that \SpecialChar LyX
1576 doesn't have such-and-such feature before you decide you have to do it by hand.
1578 there are numerous \SpecialChar LaTeX
1579 packages out there to do all sorts of things,
1580 from labels to envelopes to fancy multipage tables.
1582 \change_inserted 244031559 1603815732
1584 \begin_inset CommandInset href
1587 target "https://www.ctan.org/"
1593 \change_deleted 244031559 1603815732
1595 \begin_inset CommandInset href
1598 target "http://www.ctan.org/"
1608 \begin_layout Standard
1609 If you do need to do some wild and fancy things within your document,
1610 be sure to check out a good \SpecialChar LaTeX
1611 book for assistance.
1612 There are a number of them listed in the bibliography of the
1619 \begin_layout Section
1621 and the \SpecialChar LaTeX
1625 \begin_layout Subsection
1626 About the \SpecialChar LaTeX
1630 \begin_layout Standard
1631 If you already know \SpecialChar LaTeX
1633 there is no need to explain here what the preamble is good for.
1635 the following will give you some ideas—
1636 we recommend again that you consult a \SpecialChar LaTeX
1637 book for further information.
1639 you should read the points below,
1640 because they explain what you can do and what you don't need to do in the \SpecialChar LaTeX
1641 preamble of a \SpecialChar LyX
1645 \begin_layout Standard
1646 The \SpecialChar LaTeX
1647 preamble comes at the very beginning of a document,
1656 \begin_layout Itemize
1657 Declare the document class.
1659 \begin_inset Newline newline
1663 already does this for you.
1664 If you're a seasoned \SpecialChar LaTeX
1666 and you have a custom document class you want to use,
1669 Customization Manual
1671 for information on how to make \SpecialChar LyX
1675 \begin_layout Itemize
1676 Declare the usage of packages.
1678 \begin_inset Newline newline
1682 packages provide special commands,
1683 which are only available within a document when the package has been declared in the preamble.
1684 In addition to providing special commands,
1685 the inclusion of a package can change the document.
1688 \begin_inset Flex Code
1691 \begin_layout Plain Layout
1697 forces all paragraphs to be indented.
1698 There are other packages for labels,
1705 \begin_layout Itemize
1710 \begin_inset Newline newline
1713 There are several \SpecialChar LaTeX
1714 counters and variables that
1718 be set globally from within the preamble in order to have the desired effect.
1719 (There are variables that you can set and reset inside the document,
1720 too.) Margins are a good example of something that must be set in the preamble.
1721 Another example is the label format for lists.
1722 You can actually set these just about anywhere,
1723 but it's best to do it just once,
1724 inside the preamble.
1727 \begin_layout Itemize
1728 Declare user defined commands (with
1729 \begin_inset Flex Code
1732 \begin_layout Plain Layout
1741 \begin_inset Flex Code
1744 \begin_layout Plain Layout
1753 \begin_inset Newline newline
1756 These are abbreviations for \SpecialChar LaTeX
1757 commands which appear very often inside a document.
1758 Although the preamble is a good place to declare such commands,
1763 be declared anywhere (before they are used for the first time,
1765 This can be useful if there is a lot of raw \SpecialChar LaTeX
1766 code in your document,
1767 which normally should not be the case.
1770 \begin_layout Standard
1772 adds its own set of definitions to the preamble of the
1773 \begin_inset Flex Code
1776 \begin_layout Plain Layout
1783 This makes \SpecialChar LaTeX
1784 files generated by \SpecialChar LyX
1788 \begin_layout Subsection
1789 Changing the Preamble
1792 \begin_layout Standard
1793 The commands which \SpecialChar LyX
1794 adds to the preamble of a \SpecialChar LaTeX
1796 you can't change them without patching \SpecialChar LyX
1800 add your own stuff to the preamble by selecting
1801 \begin_inset Flex Noun
1804 \begin_layout Plain Layout
1807 \begin_inset space ~
1816 \change_deleted -712698321 1674917437
1818 \begin_inset Flex Noun
1821 \begin_layout Plain Layout
1822 Document\SpecialChar menuseparator
1829 \change_inserted -712698321 1674917437
1832 Document\SpecialChar menuseparator
1839 adds anything in the
1840 \begin_inset Flex Noun
1843 \begin_layout Plain Layout
1849 dialog to its own built-in preamble.
1850 Before adding your own declarations in the preamble,
1851 you should make sure that \SpecialChar LyX
1852 doesn't already support what you want to do.
1853 (Remember what we said about reinventing the wheel?) Also,
1856 make sure your preamble code is correct
1860 doesn't check it for you.
1861 If there is an error,
1862 you're likely to get an error like
1863 \begin_inset Quotes eld
1867 \begin_inset Flex Code
1870 \begin_layout Plain Layout
1879 \begin_inset Quotes erd
1883 If you see this error,
1884 check your preamble.
1887 \begin_layout Subsection
1891 \begin_layout Standard
1892 Here are some examples of what you can add to a preamble,
1896 \begin_layout Subsubsection
1901 \begin_layout Standard
1902 There are two variables under \SpecialChar LaTeX
1903 that control page position:
1905 \begin_inset Flex Code
1908 \begin_layout Plain Layout
1917 \begin_inset Flex Code
1920 \begin_layout Plain Layout
1929 Their names should be self-explanatory.
1930 These variables are useful if you think for a moment about computer labels.
1932 the size of a print medium and the area of the medium that you can actually print on aren't the same.
1934 \begin_inset Flex Code
1937 \begin_layout Plain Layout
1946 \begin_inset Flex Code
1949 \begin_layout Plain Layout
1960 \begin_layout Standard
1961 The default values for
1962 \begin_inset Flex Code
1965 \begin_layout Plain Layout
1974 \begin_inset Flex Code
1977 \begin_layout Plain Layout
1986 \begin_inset space \thinspace{}
1991 \begin_inset space \thinspace{}
1995 \begin_inset space \space{}
1998 the page isn't shifted.
2000 some DVI drivers always seem to shift the page.
2001 We have no idea why,
2002 or why the sysadmin hasn't fixed such behavior.
2003 If you're using \SpecialChar LyX
2004 on a system that you don't personally maintain,
2005 and your sysadmin is a doofus,
2007 \begin_inset Flex Code
2010 \begin_layout Plain Layout
2019 \begin_inset Flex Code
2022 \begin_layout Plain Layout
2031 Suppose your left and top margins are always 0.5
2032 \begin_inset space \thinspace{}
2036 You can add this to the preamble:
2039 \begin_layout LyX-Code
2047 \begin_layout LyX-Code
2055 \begin_layout Standard
2056 and your margins should now be correct.
2059 \begin_layout Subsubsection
2064 \begin_layout Standard
2066 suppose you wanted to print out a bunch of address labels.
2067 There's a rather nice package,
2068 available at your nearest CTAN archive,
2069 for printing sheets of labels:
2071 \begin_inset Flex Code
2074 \begin_layout Plain Layout
2082 your system may not have this package installed by default.
2083 We leave that up to you to check.
2084 You'll also want to read the documentation for it;
2085 we're not going to do that for you.
2086 Since this is an example,
2088 we'll give you an example of how you use this package.
2091 \begin_layout Standard
2093 make sure you're using the
2094 \begin_inset Flex Code
2097 \begin_layout Plain Layout
2105 you need to put the following in your preamble:
2108 \begin_layout LyX-Code
2114 \begin_layout LyX-Code
2120 \begin_layout LyX-Code
2126 \begin_layout LyX-Code
2132 \begin_layout LyX-Code
2138 \begin_layout LyX-Code
2144 \begin_layout LyX-Code
2150 \begin_layout Standard
2151 This sets things up for Avery label sheets,
2153 You're now ready to print labels,
2154 but you'll need to insert \SpecialChar LaTeX
2156 placing the commands
2157 \begin_inset Flex Code
2160 \begin_layout Plain Layout
2169 \begin_inset Flex Code
2172 \begin_layout Plain Layout
2180 around each label text.
2181 This and other special features of
2182 \begin_inset Flex Code
2185 \begin_layout Plain Layout
2191 are explained in its documentation.
2194 \begin_layout Standard
2196 someone may write a \SpecialChar LyX
2197 layout file to support this package directly.
2198 Maybe that someone is you.
2201 \begin_layout Subsubsection
2203 Paragraph Indentation
2206 \begin_layout Standard
2207 Americans are trained to indent the first line of
2212 As with all of their other weird quirks,
2213 most Americans will whine and moan until they can have their way and indent the first line of all paragraphs.
2224 \begin_layout Standard
2226 this behavior isn't standard typography.
2228 you typically only indent the first line of a paragraph
2232 it follows another one.
2233 The idea behind indenting the first line of a paragraph is to distinguish neighboring paragraphs from one another.
2234 If there is no previous paragraph—
2236 if it follows a figure or is the first paragraph in a section—
2237 then there is no need for indentation.
2241 \begin_layout Standard
2242 If you're a typical American (we're still joking!),
2244 you don't care about such esoteric things;
2245 you want your indentation!
2246 Add this to the preamble:
2249 \begin_layout LyX-Code
2252 usepackage{indentfirst}
2255 \begin_layout Standard
2256 If your \SpecialChar TeX
2257 distribution isn't braindead,
2258 you'll have this package,
2259 and all of your paragraphs will get the indentation the Founding Fathers intended they should have.
2262 \begin_layout Subsubsection
2267 \begin_layout Standard
2268 You can also check out the preamble of this document to get an idea of some of the advanced things you can do.
2271 \begin_layout Section
2273 and \SpecialChar LaTeX
2277 \begin_layout Standard
2278 When \SpecialChar LyX
2279 calls \SpecialChar LaTeX
2281 it tells \SpecialChar LaTeX
2282 to blithely ignore any errors and keep going.
2283 It then uses the logfile from the \SpecialChar LaTeX
2284 run to do a post-mortem.
2285 After analyzing the logfile,
2287 displays a dialog listing the errors.
2288 Clicking on any one of them will take you to the position in your \SpecialChar LyX
2289 file where the error occurred.
2293 \begin_layout Plain Layout
2296 Analyzing the logfile is a tough job,
2297 and \SpecialChar LyX
2298 doesn't always go to the right line.
2299 There are also cases where \SpecialChar LaTeX
2300 reports the error on one line,
2301 but the actual error is earlier.
2302 This is not unlike forgetting a closing brace in a program:
2303 You'll get an error,
2312 \begin_layout Standard
2313 Some folks also like to look at the log file directly:
2314 It is available from
2315 \change_deleted -712698321 1674917444
2317 \begin_inset Flex Noun
2320 \begin_layout Plain Layout
2321 Document\SpecialChar menuseparator
2323 \begin_inset space ~
2332 \change_inserted -712698321 1674917444
2335 Document\SpecialChar menuseparator
2337 \begin_inset space ~
2345 There are some fairly common error messages and warnings.
2346 We'll cover those here.
2347 You should look at a good \SpecialChar LaTeX
2348 book for a complete listing.
2351 \begin_layout Itemize
2352 \begin_inset Flex Code
2355 \begin_layout Plain Layout
2362 \begin_inset Newline newline
2365 Anything beginning with these words is a warning message for the purpose of
2366 \begin_inset Quotes eld
2370 \begin_inset Quotes erd
2373 the \SpecialChar LaTeX
2375 You'll get messages like this if you added or changed cross-references or bibliography entries,
2378 is trying to tell you that you need to make another run.
2379 You can by-and-large ignore these.
2382 \begin_layout Itemize
2383 \begin_inset Flex Code
2386 \begin_layout Plain Layout
2393 \begin_inset Newline newline
2396 Another warning message,
2397 this time about fonts which \SpecialChar LaTeX
2399 The rest of the message will often say something about a replacement font that \SpecialChar LaTeX
2401 You can safely ignore these,
2405 \begin_layout Itemize
2406 \begin_inset Flex Code
2409 \begin_layout Plain Layout
2418 \begin_inset Newline newline
2427 It seems to generate at least one of these messages for just about any document you write.
2428 They are warnings about lines that were too long and run past the right margin.
2429 This happens if \SpecialChar LaTeX
2430 does not find a reasonable way to break the lines (notoriously often with typewriter font,
2431 since this does not allow for automatic break points).
2433 this is unnoticeable in the final output.
2434 (It can be just a point or two.) Sometimes,
2436 the lines run rather visibly into the margin;
2437 something you will not want to have in your final print.
2439 \begin_inset Newline newline
2442 There are several global ways to try to minimize the overfull lines.
2445 Enable micro-typographic extensions
2449 Document\SpecialChar menuseparator
2450 Settings\SpecialChar menuseparator
2453 might already improve things a lot.
2456 code such as the following in
2458 Document\SpecialChar menuseparator
2459 Settings\SpecialChar menuseparator
2462 usually reduces the overfull lines drastically (we use this in the preamble of this document):
2466 \begin_layout LyX-Code
2470 \begin_inset Newline newline
2476 \begin_inset Newline newline
2481 emergencystretch 1.5em
2482 \begin_inset Newline newline
2490 \begin_layout Standard
2493 you eventually have to rewrite the text to get the line breaking right.
2497 \begin_layout Plain Layout
2498 For more information,
2500 \begin_inset Flex URL
2503 \begin_layout Plain Layout
2505 http://www.tex.ac.uk/FAQ-overfull.html
2518 \begin_layout Standard
2520 you should check the respective lines,
2521 at least for the final version of your document.
2522 Your eyes will tell you if there's a problem with something that's too wide.
2526 \begin_layout Plain Layout
2527 You can also enable the `draft' option in
2528 \change_deleted -712698321 1674917458
2530 \begin_inset Flex Noun
2533 \begin_layout Plain Layout
2534 Document\SpecialChar menuseparator
2541 \change_inserted -712698321 1674917458
2544 Document\SpecialChar menuseparator
2550 and then \SpecialChar LaTeX
2551 will draw a black box in the margin of lines that are overfull.
2560 \begin_layout Itemize
2561 \begin_inset Flex Code
2564 \begin_layout Plain Layout
2573 \begin_inset Newline newline
2576 Not quite as common as its cousin.
2577 This happens again if \SpecialChar LaTeX
2578 does not find a reasonable break point and consequently generates too loose lines.
2579 As with the overfull lines,
2580 you should check if this is a visible problem.
2583 \begin_layout Itemize
2584 \begin_inset Flex Code
2587 \begin_layout Plain Layout
2596 \begin_inset Flex Code
2599 \begin_layout Plain Layout
2608 \begin_inset Newline newline
2611 Warnings about troubles breaking the page.
2613 just look at the output.
2614 Your eyes will tell you where something has gone wrong.
2617 \begin_layout Itemize
2618 \begin_inset Flex Code
2621 \begin_layout Plain Layout
2624 \begin_inset Quotes els
2628 \begin_inset Quotes ers
2637 \begin_inset Newline newline
2641 \begin_inset Quotes eld
2645 \begin_inset Quotes erd
2648 isn't installed on this system.
2649 This usually appears because some package your document needs isn't installed.
2650 If you didn't touch the preamble or didn't use the
2651 \begin_inset Flex Code
2654 \begin_layout Plain Layout
2663 then one of the packages \SpecialChar LyX
2664 tried to load is missing.
2666 \change_deleted -712698321 1674917468
2668 \begin_inset Flex Noun
2671 \begin_layout Plain Layout
2672 Help\SpecialChar menuseparator
2680 \change_inserted -712698321 1674917478
2683 Help\SpecialChar menuseparator
2688 to get a list of packages that \SpecialChar LyX
2690 This file is updated whenever you reconfigure \SpecialChar LyX
2692 \change_deleted -712698321 1674917484
2694 \begin_inset Flex Noun
2697 \begin_layout Plain Layout
2698 Tools\SpecialChar menuseparator
2705 \change_inserted -712698321 1674917484
2708 Tools\SpecialChar menuseparator
2713 ) and tells you which packages have been detected and what they do.
2714 \begin_inset Newline newline
2718 \begin_inset Flex Code
2721 \begin_layout Plain Layout
2729 command and the package in question isn't installed,
2730 then you'll need to install it yourself.
2733 \begin_layout Itemize
2734 \begin_inset Flex Code
2737 \begin_layout Plain Layout
2745 \begin_inset Newline newline
2748 Error messages beginning with this are trying to tell you that you specified a bad or undefined option to a package.
2749 Check the package's documentation.
2752 \begin_layout Itemize
2753 \begin_inset Flex Code
2756 \begin_layout Plain Layout
2757 Undefined control sequence
2763 \begin_inset Newline newline
2766 If you've inserted \SpecialChar LaTeX
2767 code into your document,
2769 you'll get one of these.
2770 You may have forgotten to load a package.
2772 this error message usually means that you used an undefined command.
2776 \begin_layout Standard
2777 There are other error and warning messages.
2778 Some are self-explanatory.
2779 These are usually \SpecialChar LaTeX
2781 Others are downright cryptic.
2782 These are usually \SpecialChar TeX
2788 what they mean or how to decipher them.
2792 \begin_layout Standard
2793 There's a general sequence you should follow if you get error messages:
2796 \begin_layout Enumerate
2797 Look at the \SpecialChar LaTeX
2798 code you inserted for typos.
2801 \begin_layout Enumerate
2802 If there are no typos,
2803 check that you used the command(s) correctly.
2806 \begin_layout Enumerate
2807 If you get a bunch of error boxes piled up at the very top of the document—
2808 and especially if you see a
2809 \begin_inset Quotes eld
2813 \begin_inset Flex Code
2816 \begin_layout Plain Layout
2825 \begin_inset Quotes erd
2829 it means that there are errors in the preamble.
2830 Start debugging your preamble.
2833 \begin_layout Enumerate
2834 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2835 code to the document,
2836 the first suspect is your \SpecialChar LaTeX
2837 distribution itself.
2838 Check for missing packages and install them.
2841 \begin_layout Enumerate
2843 so there are no missing packages.
2844 Did you use any of the fine-tuning options in \SpecialChar LyX
2852 like trying to manually insert lots of
2853 \begin_inset Flex Code
2856 \begin_layout Plain Layout
2858 \change_deleted 177693 1654669036
2860 \change_inserted 177693 1654669038
2864 \begin_inset space ~
2868 \change_deleted 177693 1654669040
2870 \change_inserted 177693 1654669041
2880 \begin_inset Flex Code
2883 \begin_layout Plain Layout
2891 \begin_inset Flex Code
2894 \begin_layout Plain Layout
2901 Did you try to kludge something together with these instead of using the appropriate paragraph environment?
2904 \begin_layout Enumerate
2906 you didn't use any of the fine-tuning options,
2907 you played by the rules.
2908 Did you try to pull a fancy maneuver?
2909 Did you do something funky inside a table or an equation,
2910 like inserting a graphic into a table cell?
2913 \begin_layout Enumerate
2914 Do you have long sections of text where \SpecialChar LaTeX
2915 cannot find a place to break a line?
2918 is rather strict about how much extra inter-word spacing it will add in order to break a line.
2920 you should rework the paragraph to avoid the problem.
2923 \begin_layout Enumerate
2924 Did you go overboard with the nesting?
2926 (currently) doesn't check to make sure you're in the limits for nesting environments.
2927 If you nested a bunch of environments to the
2928 \begin_inset Formula $17^{\mathrm{th}}$
2933 (The limit in \SpecialChar LaTeX
2937 \begin_layout Enumerate
2939 you didn't get any error messages,
2940 but your output looks awful.
2941 If you have a table or figure that's too wide or long for the page,
2946 \begin_layout Enumerate
2947 rescale the figure so it fits.
2950 \begin_layout Enumerate
2951 trim down the table so it fits.
2955 \begin_layout Enumerate
2956 If something else is wrong with the output,
2957 and you didn't try to pull anything fancy or kludge the fine-tuning options,
2958 we're not sure what's wrong.
2961 \begin_layout Standard
2962 If all this doesn't help—
2968 you might have found a bug in \SpecialChar LyX
2973 \begin_layout Chapter
2975 \change_inserted 564990737 1672345271
2979 \begin_layout Standard
2981 \change_inserted 564990737 1672345272
2988 originally offered four standard document classes,
2992 but individuals and organizations,
2993 most notably the American Mathematical Society in the early days,
2994 have made many contributions to extending the range of document classes.
2995 In this chapter we summarize the main externally maintained classes,
2996 some of which are marked “Unavailable:” in the pull-down
2999 \begin_inset space ~
3013 ocument\SpecialChar menuseparator
3018 ettings\SpecialChar menuseparator
3020 \begin_inset space ~
3025 dialog and which you will need to install as described in the
3027 Installing New Document Classes
3033 manual if you want to use them.
3037 \begin_layout Section
3039 \change_inserted 564990737 1670439533
3040 \begin_inset CommandInset label
3042 name "sec:Collections"
3049 \begin_layout Subsection
3051 \change_inserted 564990737 1672345298
3052 \begin_inset CommandInset label
3054 name "subsec:AMS-LaTeX-(American-Mathematical"
3058 AMS-\SpecialChar LaTeX
3059 (American Mathematical Society)
3062 \begin_layout Standard
3064 \change_inserted 564990737 1672345298
3065 The \SpecialChar LyX
3066 supported document classes
3074 are maintained by the Society;
3075 use of their features is described in the Math manual and on their website
3076 \begin_inset Flex URL
3079 \begin_layout Plain Layout
3081 \change_inserted 564990737 1672345298
3083 http://www.ams.org/publications/authors/tex/amslatex
3091 The following summary was originally provided by
3098 \change_inserted -712698321 1673082716
3100 \change_inserted 564990737 1672345298
3103 and the \SpecialChar LyX
3107 \change_deleted 564990737 1672345297
3110 AMS \SpecialChar LaTeX
3114 \begin_layout Standard
3116 \change_deleted 564990737 1672345297
3124 Richard Kimberly Heck
3129 \begin_layout Standard
3130 \begin_inset VSpace bigskip
3136 \begin_layout Standard
3138 The AMS \SpecialChar LaTeX
3139 layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
3140 The layouts are not tailored to a specific journal,
3142 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
3144 That documentation is available on the Web at
3145 \begin_inset Flex URL
3148 \begin_layout Plain Layout
3156 \begin_inset Flex URL
3159 \begin_layout Plain Layout
3161 ftp://ftp.ams.org/pub/tex/amslatex/
3167 These layouts are appropriate,
3169 for any mathematical writing.
3173 \begin_layout Standard
3175 \change_deleted -712698321 1673083001
3177 \change_inserted -712698321 1673083002
3180 basic AMS \SpecialChar LaTeX
3185 \begin_layout Itemize
3187 The standard AMS article format
3188 \change_inserted 564990737 1672345333
3192 File\SpecialChar menuseparator
3193 Open Example\SpecialChar menuseparator
3194 Articles\SpecialChar menuseparator
3195 American Mathematical Society (AMS)
3202 \begin_layout Itemize
3204 the standard AMS book (really,
3206 \change_inserted 564990737 1672345366
3210 File\SpecialChar menuseparator
3211 Open Example\SpecialChar menuseparator
3212 Books\SpecialChar menuseparator
3213 American Mathematical Society (AMS)
3218 \change_inserted 564990737 1672345369
3222 \begin_layout Itemize
3224 \change_inserted 564990737 1672345383
3226 the standard AMS proceedings format.
3229 \begin_layout Standard
3231 \change_inserted 564990737 1672345383
3233 only supports the first two natively;
3236 Installing New Document Classes
3242 manual if you want to use
3249 \begin_layout Standard
3250 The layouts themselves contain only the minimum necessary to use the AMS classes.
3253 contain any of the `theorem' environments used for setting theorems,
3256 These are contained,
3259 \change_deleted 564990737 1672345416
3261 \begin_inset Flex Code
3264 \begin_layout Plain Layout
3271 \change_inserted 564990737 1672345416
3279 which is loaded by default when you select one of the AMS classes.
3280 (It can also be used with other classes and can be removed,
3281 if you would rather use something else.) Less commonly used environments are in the
3282 \change_deleted 564990737 1672345436
3284 \begin_inset Flex Code
3287 \begin_layout Plain Layout
3288 Theorems (AMS-Extended)
3294 \change_inserted 564990737 1672345436
3297 AMS Theorems (Extended)
3302 which must be loaded manually.
3305 \begin_layout Standard
3307 theorems and the like are numbered consecutively throughout the document,
3308 but this may be modified by loading the module
3309 \change_deleted 564990737 1672345461
3311 \begin_inset Flex Code
3314 \begin_layout Plain Layout
3315 Theorems (Order by Section)
3321 \change_inserted 564990737 1672345461
3324 Standard Theorems (Numbered by Section)
3330 \begin_inset Flex Code
3333 \begin_layout Plain Layout
3341 \change_deleted 564990737 1672345479
3343 \begin_inset Flex Code
3346 \begin_layout Plain Layout
3347 Theorems (Order by Chapter)
3353 \change_inserted 564990737 1672345480
3356 Standard Theorems (Numbered by Chapter)
3361 These will number the results as
3362 \begin_inset Formula $n.m$
3366 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).
3367 Many environments are also available unnumbered.
3368 These are indicated by an asterisk at the end.
3369 If you happen to want
3375 \change_deleted 564990737 1672345498
3377 \begin_inset Flex Code
3380 \begin_layout Plain Layout
3387 \change_inserted 564990737 1672345498
3390 Standard Theorems (Unnumbered)
3394 provides that option.
3397 \begin_layout Standard
3398 Note that these modules do not
3402 to be used with the AMS classes.
3403 It is perfectly possible to use the
3404 \change_deleted 564990737 1672345520
3406 \begin_inset Flex Code
3409 \begin_layout Plain Layout
3416 \change_inserted 564990737 1672345520
3424 and the others mentioned,
3427 \begin_inset Flex Code
3430 \begin_layout Plain Layout
3432 \change_deleted -712698321 1673083855
3434 \change_inserted -712698321 1673083855
3435 Article (Standard Class)
3444 \begin_inset Flex Code
3447 \begin_layout Plain Layout
3449 \change_deleted -712698321 1673083858
3451 \change_inserted -712698321 1673083862
3452 Report (Standard Class)
3461 \begin_inset Flex Code
3464 \begin_layout Plain Layout
3466 \change_deleted -712698321 1673083819
3468 \change_inserted -712698321 1673083822
3480 \begin_layout Subsubsection
3481 What these layouts provide
3484 \begin_layout Standard
3485 There is a long list of included environments provided by these layouts.
3486 In AMS-\SpecialChar LaTeX
3490 an opportunity to define an unlimited variety of `theorem' environments.
3492 the AMS recommends the environments that are available in \SpecialChar LyX
3497 \begin_layout Standard
3498 The following environments—
3499 as well as the standard environments,
3501 \begin_inset Flex Noun
3504 \begin_layout Plain Layout
3512 \begin_inset Flex Noun
3515 \begin_layout Plain Layout
3523 \begin_inset Flex Noun
3526 \begin_layout Plain Layout
3534 \begin_inset Flex Noun
3537 \begin_layout Plain Layout
3545 \begin_inset Flex Noun
3548 \begin_layout Plain Layout
3556 \begin_inset Flex Code
3559 \begin_layout Plain Layout
3566 \begin_inset Flex Code
3569 \begin_layout Plain Layout
3578 \begin_layout Description
3579 Address This should be the author's permanent address.
3582 \begin_layout Description
3584 \begin_inset space ~
3587 Address This should be the author's temporary address at the time of submission,
3588 if different from the Address.
3591 \begin_layout Description
3592 Email Author's e-mail address
3595 \begin_layout Description
3596 URL Author's Web address,
3600 \begin_layout Description
3601 Keywords Key words or phrases used to identify specific topics discussed in the paper.
3604 \begin_layout Description
3605 Subjectclass These refer to the AMS Subject Classifications,
3606 published and described in
3608 Mathematical Reviews
3611 These are also available online at the AMS cites listed above.
3614 \begin_layout Description
3618 \begin_layout Description
3622 \begin_layout Description
3626 \begin_layout Standard
3627 The following environments are provided by both the
3628 \change_deleted 564990737 1672345566
3630 \begin_inset Flex Code
3633 \begin_layout Plain Layout
3640 \change_inserted 564990737 1672345566
3648 \change_deleted 564990737 1672345580
3650 \begin_inset Flex Code
3653 \begin_layout Plain Layout
3660 \change_inserted 564990737 1672345580
3668 in the latter case in both
3669 \change_deleted -712698321 1673084072
3673 \change_deleted -712698321 1673084073
3677 \change_deleted -712698321 1673084075
3681 \change_deleted -712698321 1673084077
3685 These same environments are provided only in the starred versions by the
3686 \change_deleted 564990737 1672345596
3688 \begin_inset Flex Code
3691 \begin_layout Plain Layout
3698 \change_inserted 564990737 1672345596
3702 \change_inserted -712698321 1673084060
3710 \begin_layout Theorem
3711 This is typically used for the statements of major results.
3715 \begin_layout Corollary*
3716 This is used for statements which follow fairly directly from previous statements.
3718 these can be major results.
3723 These are smaller results needed to prove other statements.
3726 \begin_layout Proposition
3727 These are less major results which (hopefully) add to the general theory being discussed.
3730 \begin_layout Conjecture
3731 These are statements provided without justification,
3732 which the author does not know how to prove,
3733 but which seem to be true (to the author,
3737 \begin_layout Definition*
3738 Guess what this is for.
3739 The font is different for this environment than for the previous ones.
3743 \begin_layout Example*
3744 Used for examples illustrating proven results.
3747 \begin_layout Problem
3748 It's not really known what this is for.
3749 You should figure it out.
3752 \begin_layout Exercise*
3753 Write a description for this one.
3756 \begin_layout Remark
3757 This environment is also a type of theorem,
3758 usually a lesser sort of observation.
3761 \begin_layout Claim*
3762 Often used in the course of giving a proof of a larger result.
3767 these are used to break up long arguments,
3768 using specific instances of some condition.
3773 The numbering scheme for cases is on its own,
3774 not together with other numbered statements.
3779 At the end of this environment,
3780 a QED symbol (usually a square,
3781 but it can vary with different styles) is placed.
3782 If you want to have other environments within this one—
3785 and have the QED symbol appear only after them,
3786 then the other environments need to be nested within the proof environment.
3789 Nesting Environments
3795 for information on nesting.
3800 \change_inserted 564990737 1672345651
3801 Used in a way similar to Proposition,
3802 though perhaps lower on the scale.
3805 \begin_layout Standard
3806 And these environments are provided by
3807 \change_deleted 564990737 1672345684
3809 \begin_inset Flex Code
3812 \begin_layout Plain Layout
3813 Theorems (AMS-Extended)
3819 \change_inserted 564990737 1672345689
3822 AMS Theorems (Extended
3829 \begin_layout Criterion*
3830 A required condition.
3833 \begin_layout Algorithm*
3834 A general procedure to be used.
3837 \begin_layout Axiom*
3838 This is a property or statement taken as true within the system being discussed.
3841 \begin_layout Condition*
3842 Sometimes used to state a condition assumed within the present context of discussion.
3846 Similar to a Remark.
3849 \begin_layout Notation*
3850 Used for the explanation of,
3855 \begin_layout Summary
3856 Do we really need to tell you?
3860 \begin_layout Standard
3862 \change_deleted -712698321 1675595089
3868 \begin_layout Conclusion*
3869 Sometimes used at the end of a long train of argument.
3870 \change_deleted 564990737 1672345729
3876 \change_deleted 564990737 1672345638
3877 Used in a way similar to Proposition,
3878 though perhaps lower on the scale.
3879 \change_inserted 564990737 1672345720
3883 \begin_layout Assumption*
3885 \change_inserted 564990737 1672345721
3889 \begin_layout Question*
3891 \change_inserted 564990737 1672345721
3895 \begin_layout Standard
3897 \change_inserted 564990737 1672345721
3898 There are ten more Maths modules available including several offering options ordered on
3900 (Numbered by Type \SpecialChar ldots
3908 \begin_layout Standard
3910 the AMS classes automatically provide the AMS \SpecialChar LaTeX
3911 and AMS fonts packages.
3912 They need to be available on your system in order to use these environments.
3915 \begin_layout Subsection
3917 \change_inserted 564990737 1671383236
3918 \begin_inset CommandInset label
3920 name "subsec:Extra-font-sizes"
3927 \begin_layout Standard
3929 \change_inserted 564990737 1671383236
3930 The “Extra font sizes” collection provides the document classes
3933 \begin_inset space \thinspace{}
3936 (with extra font sizes)
3942 \begin_inset space \thinspace{}
3945 (with extra font sizes)
3951 \begin_inset space \thinspace{}
3954 (with extra font sizes)
3959 \begin_inset space \thinspace{}
3962 (with extra font sizes)
3982 document classes respectively but offer the additional
3988 \begin_inset space ~
4001 ocument\SpecialChar menuseparator
4006 ettings\SpecialChar menuseparator
4012 \begin_layout Subsection
4014 \change_inserted 564990737 1671383236
4018 \begin_layout Standard
4020 \change_inserted 564990737 1671383236
4021 The document classes
4024 \begin_inset space \thinspace{}
4032 \begin_inset space \thinspace{}
4047 document classes to facilitate the use of Hebrew in \SpecialChar LyX
4051 \begin_layout Subsection
4053 \change_inserted 564990737 1671383236
4054 \begin_inset CommandInset label
4056 name "subsec:Japanese"
4061 \change_inserted -712698321 1675848645
4063 \change_inserted 564990737 1671383236
4067 \begin_layout Standard
4069 \change_inserted -712698321 1676025662
4071 included a collection of several bundles that aim to facilitate typesetting Japanese documents.
4072 The bundles have been developed at different times,
4073 they thus support different typesetting engines and features.
4074 This collection is the oldest one.
4075 It adjusts the \SpecialChar LaTeX
4076 standard classes to requirements of Japanese typesetting,
4077 for horizontal and vertical writing.
4078 The collection includes
4081 \change_deleted 545138413 1676132735
4083 \change_inserted 545138413 1676132735
4085 \begin_inset space \thinspace{}
4089 \change_inserted -712698321 1676533466
4096 \begin_inset space \thinspace{}
4106 \begin_inset space \thinspace{}
4115 \begin_inset space \thinspace{}
4125 \begin_inset space \thinspace{}
4128 (Japanese Standard Class)
4134 \begin_inset space \thinspace{}
4142 \begin_inset Quotes eld
4146 \begin_inset Quotes erd
4149 engines tailored for Japanese,
4151 and up\SpecialChar LaTeX
4155 \begin_layout Standard
4157 \change_inserted -712698321 1676026113
4158 For the use with the more modern Lua\SpecialChar LaTeX
4160 the collection also includes dedicated classes
4163 \change_deleted 545138413 1676132664
4165 \change_inserted 545138413 1676132730
4167 \begin_inset space \thinspace{}
4171 \change_inserted -712698321 1676533517
4172 (Standard Class for LuaTeX),
4174 \begin_inset space \thinspace{}
4177 (Standard Class for LuaTeX,
4180 \begin_inset space \thinspace{}
4183 (Standard Class for LuaTeX)
4189 \begin_inset space \thinspace{}
4192 (Standard Class for LuaTeX,
4197 \change_deleted 545138413 1676132664
4199 \change_inserted -712698321 1676533501
4203 \begin_inset space \thinspace{}
4206 (Japanese Standard Class for LuaTeX)
4210 \change_deleted -712698321 1676533511
4214 \begin_inset space \thinspace{}
4217 (Standard Class for LuaTeX,
4220 \begin_inset space \thinspace{}
4223 (Standard Class for LuaTeX,
4228 \change_inserted 545138413 1676132454
4232 \begin_inset space \thinspace{}
4235 (Japanese Standard Class for LuaTeX,
4237 \change_deleted -712698321 1676533483
4239 \change_inserted -712698321 1676533501
4241 \change_inserted 545138413 1676132454
4246 \change_inserted -712698321 1676533501
4254 \change_deleted 545138413 1676132664
4255 These classes support both horizontal and vertical writing.
4256 \change_inserted -712698321 1676534105
4260 \begin_layout Standard
4262 \change_inserted -712698321 1676534227
4263 Templates for the Lua\SpecialChar LaTeX
4264 classes can be found in
4266 File\SpecialChar menuseparator
4269 in the respective category (
4288 \begin_layout Subsection
4290 \change_inserted -712698321 1675848929
4291 \begin_inset CommandInset label
4293 name "subsec:Japanese-JS"
4297 Japanese (JS Bundle)
4302 \begin_layout Standard
4304 \change_inserted -712698321 1675849034
4305 This collection includes improved versions of the classes included in
4307 Japanese (Standard Classes)
4310 \begin_inset space ~
4314 \begin_inset CommandInset ref
4316 reference "subsec:Japanese"
4322 \change_deleted -712698321 1675849038
4323 The document classes
4324 \change_inserted -712698321 1673089024
4328 \change_deleted -712698321 1673089025
4330 \change_inserted -712698321 1673089025
4332 \change_inserted 564990737 1671383236
4334 \begin_inset space \thinspace{}
4338 \change_deleted -712698321 1673089027
4340 \change_inserted 564990737 1671383236
4342 \change_deleted -712698321 1675848222
4344 \change_inserted -712698321 1675848223
4346 \change_inserted 564990737 1671383236
4348 \change_deleted -712698321 1675849103
4353 \change_inserted 564990737 1671383236
4357 \change_deleted -712698321 1675849055
4359 \begin_inset space \thinspace{}
4362 (Japanese Standard Class Vertical Writing)
4368 \begin_inset space \thinspace{}
4371 (Japanese Standard Class)
4375 \change_inserted -712698321 1675849107
4379 \change_deleted -712698321 1673089053
4381 \change_inserted -712698321 1673089064
4383 \change_inserted 564990737 1671383236
4385 \begin_inset space \thinspace{}
4389 \change_deleted -712698321 1673089067
4391 \change_inserted 564990737 1671383236
4393 \change_deleted -712698321 1675849059
4395 \change_inserted -712698321 1675849059
4397 \change_inserted 564990737 1671383236
4399 \change_deleted -712698321 1675849095
4406 \begin_inset space \thinspace{}
4409 (Japanese Standard Class Vertical Writing)
4415 \begin_inset space \thinspace{}
4418 (Japanese Standard Class)
4424 \begin_inset space \thinspace{}
4427 (Japanese Vertical Writing)
4432 \begin_inset space \thinspace{}
4435 (Japanese Standard Class)
4437 provide document classes for the Japanese language
4438 \change_inserted 564990737 1671383236
4441 \change_inserted -712698321 1676026196
4442 A report class can be obtained by using
4445 \begin_inset space \thinspace{}
4456 Document\SpecialChar menuseparator
4457 Settings\SpecialChar menuseparator
4458 Document Class\SpecialChar menuseparator
4459 Class Options\SpecialChar menuseparator
4463 All these classes work with
4464 \begin_inset Quotes eld
4468 \begin_inset Quotes erd
4471 engines tailored for Japanese,
4473 and up\SpecialChar LaTeX
4477 \begin_layout Standard
4479 \change_inserted -712698321 1676026178
4480 For the use with the more modern Lua\SpecialChar LaTeX
4482 the collection also includes dedicated classes
4484 Japanese Article (JS Bundle for LuaTeX),
4486 \begin_inset space \thinspace{}
4489 (JS Bundle for LuaTeX)
4495 \begin_inset space \thinspace{}
4508 \change_deleted 545138413 1676132499
4509 These classes support both horizontal and vertical writing.
4510 \change_inserted -712698321 1676534250
4514 \begin_layout Standard
4516 \change_inserted -712698321 1676534251
4517 Templates for the Lua\SpecialChar LaTeX
4518 classes can be found in
4520 File\SpecialChar menuseparator
4523 in the respective category (
4542 \begin_layout Subsection
4544 \change_inserted -712698321 1675848572
4545 \begin_inset CommandInset label
4547 name "subsec:Japanese-BX"
4551 Japanese (BX Bundle)
4554 \begin_layout Standard
4556 \change_inserted -712698321 1676026685
4557 This bundle contains the document classes
4560 \begin_inset space \thinspace{}
4569 \begin_inset space \thinspace{}
4578 \begin_inset space \thinspace{}
4583 which provide alternative document classes for Japanese documents.
4587 Japanese Slides (BX Bundle)
4589 for presentation slides,
4591 As opposed to the classes of the
4601 \begin_inset CommandInset ref
4603 reference "subsec:Japanese"
4608 \begin_inset CommandInset ref
4610 reference "subsec:Japanese-JS"
4615 which support only p\SpecialChar LaTeX
4616 and up\SpecialChar LaTeX
4617 out of the box (and Lua\SpecialChar LaTeX
4618 only through the extra classes added by the
4624 the classes of this bundle also support pdf\SpecialChar LaTeX
4626 Xe\SpecialChar LaTeX
4627 and Lua\SpecialChar LaTeX
4629 with the aid of suitable packages that provide capability of Japanese typesetting.
4632 \begin_layout Subsection
4634 \change_inserted -712698321 1675850366
4635 \begin_inset CommandInset label
4637 name "subsec:Japanese-JLReq"
4641 Japanese (JLReq Class)
4644 \begin_layout Standard
4646 \change_inserted -712698321 1675850768
4647 This bundle draws on the
4651 class which faithfully traces the standard of
4653 Requirements for Japanese Text Layout
4655 set by the World Wide Web Consortium (W3C,
4657 \begin_inset Flex URL
4660 \begin_layout Plain Layout
4662 \change_inserted -712698321 1675850769
4664 https://www.w3.org/TR/jlreq/?lang=en
4672 It can be used with Lua\SpecialChar LaTeX
4673 as well as p\SpecialChar LaTeX
4674 and up\SpecialChar LaTeX
4678 \begin_layout Standard
4680 \change_inserted -712698321 1675850585
4681 LyX provides layouts for
4684 \begin_inset space \thinspace{}
4693 \begin_inset space \thinspace{}
4702 \begin_inset space \thinspace{}
4707 which are all derived from the
4712 class via specific class options.
4715 \begin_layout Standard
4717 \change_inserted -712698321 1675850701
4718 An example article document is available at
4720 File\SpecialChar menuseparator
4721 Open Example\SpecialChar menuseparator
4722 Articles\SpecialChar menuseparator
4723 Japanese Article (JLReq Class)
4726 English documentation is available at
4727 \begin_inset Flex URL
4730 \begin_layout Plain Layout
4732 \change_inserted -712698321 1675850350
4734 http://mirrors.ctan.org/macros/jptex/latex/jlreq/jlreq.pdf
4742 \change_inserted 564990737 1671383236
4746 \begin_layout Subsection
4748 \change_inserted 564990737 1672429136
4749 \begin_inset CommandInset label
4751 name "subsec:KOMA-Script"
4758 \begin_layout Standard
4760 \change_inserted 564990737 1672429136
4770 and the \SpecialChar LyX
4772 \change_deleted 564990737 1672429136
4776 \begin_layout Standard
4778 \change_deleted 564990737 1672429136
4786 \begin_layout Subsubsection
4788 \change_inserted 564990737 1672429161
4792 \begin_layout Standard
4794 \change_inserted 564990737 1672429162
4795 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
4796 it was formally launched with the addition of a letter class in 1994.
4798 a second letter class has been added.
4799 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.
4805 \begin_layout Standard
4806 The \SpecialChar LyX
4808 \change_deleted -712698321 1673089779
4811 article (koma-script)
4812 \change_inserted -712698321 1673089784
4819 \change_deleted -712698321 1673089790
4822 report (koma-script)
4823 \change_inserted -712698321 1673089794
4830 \change_deleted -712698321 1673089790
4838 \change_inserted -712698321 1673089771
4845 \change_inserted -712698321 1673089799
4849 \change_deleted -712698321 1673089802
4851 \change_inserted -712698321 1673089802
4855 \change_deleted -712698321 1673089811
4864 correspond to the \SpecialChar LaTeX
4886 \begin_inset space ~
4889 of the Koma-Script family.
4890 They are replacements for the standard document classes
4910 and fit better to European typography conventions in a number of points.
4913 \begin_layout Itemize
4915 \change_deleted 564990737 1672429262
4916 Standard character size is
4917 \change_inserted 564990737 1672429263
4918 The base character sizes when you select a KOMA-Script class are
4921 \change_deleted -712698321 1673089877
4924 article (koma-script)
4925 \change_inserted -712698321 1673089877
4932 \change_deleted -712698321 1673089886
4935 report (koma-script)
4936 \change_inserted -712698321 1673089886
4943 \change_deleted -712698321 1673089893
4947 \change_inserted -712698321 1673089893
4949 \change_deleted 564990737 1672429267
4956 \change_deleted -712698321 1673089903
4959 letter (koma-script)
4960 \change_inserted -712698321 1673089903
4968 \begin_layout Itemize
4970 labels of the description environment,
4971 and a number of elements of the
4972 \change_deleted -712698321 1673089925
4975 letter (koma-script)
4976 \change_inserted -712698321 1673089925
4981 document class are set in a bold sans serif font.
4985 \begin_layout Plain Layout
4986 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
4987 especially in the appearance of headings.
4989 the ec bold sans serif fonts look a bit thin.
4990 Here the \SpecialChar LaTeX
4999 helps to produce the
5000 \begin_inset Quotes eld
5004 \begin_inset Quotes erd
5007 appearance when using the ec fonts.
5012 The numbering of chapter headings is made in the same way as the numbering of section headings,
5013 that is without the extra line
5014 \begin_inset Quotes eld
5017 Chapter\SpecialChar ldots
5019 \begin_inset Quotes erd
5024 the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
5025 to be entered in the field
5028 \begin_inset space ~
5035 Layout\SpecialChar menuseparator
5042 \begin_layout Itemize
5044 \change_deleted 564990737 1672429310
5045 The main means in the Koma-Script document classes to design the type area are the options
5053 (in \SpecialChar LyX
5054 to be entered in the extra class options field in the dialog
5056 Document\SpecialChar menuseparator
5060 They make a clearer modification of page margins possible as do the options of the dialog
5062 Document\SpecialChar menuseparator
5067 \change_inserted 564990737 1672429310
5068 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.
5069 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.
5070 You can change the sizes of the margins by changing the factor by which the page is divided into strips;
5071 the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
5076 \begin_layout Standard
5078 \change_inserted 564990737 1672429310
5079 Whatever the factor,
5080 two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
5081 leaving a text area occupying around half the page.
5082 Since most two-sided documents have a binding,
5083 this can make the inner margins appear too narrow;
5084 so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
5088 \begin_layout Standard
5090 \change_inserted 564990737 1672429310
5091 The main means in the Koma-Script document classes to design the type area are the options
5101 Document\SpecialChar menuseparator
5102 Settings\SpecialChar menuseparator
5103 Document Class\SpecialChar menuseparator
5104 Class Options\SpecialChar menuseparator
5111 \begin_layout Standard
5113 \change_inserted 564990737 1672429310
5115 the binding correction is 7.5mm which is added in the form
5122 \begin_inset space ~
5125 options\SpecialChar menuseparator
5133 To change the factor to 11,
5139 to the comma separated list of entries in the
5150 \begin_inset space ~
5156 If you want the default value of this factor for a page size other than A4,
5164 \begin_layout Standard
5166 \change_inserted 564990737 1672429310
5167 To use the circle method of calculating the page layout,
5178 \begin_layout Itemize
5179 The \SpecialChar LaTeX
5180 document classes of the Koma-Script family define a number of additional commands.
5181 Those part of it which makes sense in \SpecialChar LyX
5182 is implemented in corresponding paragraph types.
5185 \begin_layout Standard
5186 Detailed descriptions of the \SpecialChar LaTeX
5187 document classes of the Koma-Script family can be found in the Koma-Script documentation
5198 \begin_layout Subsubsection
5200 \change_inserted 564990737 1672429358
5203 \begin_inset CommandInset label
5205 name "subsec:article-(KOMA-Script),-report"
5210 \change_deleted -712698321 1673090826
5213 article (KOMA-Script)
5214 \change_inserted -712698321 1673090826
5218 \change_inserted 564990737 1672429358
5223 \change_deleted -712698321 1673090830
5224 report (KOMA-Script)
5225 \change_inserted -712698321 1673090840
5229 \change_inserted 564990737 1672429358
5234 \change_deleted -712698321 1673090835
5236 \change_inserted -712698321 1673090844
5240 \change_deleted 564990737 1672429367
5243 article (koma-script),
5244 report (koma-script),
5245 and book (koma-script)
5250 \begin_layout Standard
5251 The document classes
5252 \change_deleted -712698321 1673090858
5255 article (koma-script)
5256 \change_inserted -712698321 1673090858
5263 \change_deleted -712698321 1673090862
5266 report (koma-script)
5267 \change_inserted -712698321 1673090869
5274 \change_deleted -712698321 1673090866
5282 \change_inserted -712698321 1673090874
5287 are implemented in the layout files
5303 They contain all the paragraph types of the corresponding standard document classes
5320 with the exception of the \SpecialChar LyX
5326 which is replaced by the new
5330 -type having the same functionality.
5335 -Type there is a number of new paragraph types added.
5342 letter (koma-script)
5347 \begin_layout Itemize
5370 additionally inserting an entry in the table of contents.
5379 are not contained in
5381 article (koma-script)
5386 \begin_layout Itemize
5407 additionally clearing running heads.
5414 article (koma-script)
5420 \begin_layout Plain Layout
5433 report (koma-script)
5436 but since this is identical to
5441 is has not been implemented in \SpecialChar LyX
5450 \begin_layout Itemize
5456 generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
5459 \begin_layout Itemize
5468 are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
5469 you might want to place table captions always above the table).
5470 You can also use the class option
5488 You need at least Koma-Script version 2.8q to use this.
5491 \begin_layout Itemize
5497 can be used to set a bonmot,
5499 \begin_inset space \thinspace{}
5503 \begin_inset space \space{}
5506 at the beginning of a chapter.
5507 If you use the optional argument (
5509 Insert\SpecialChar menuseparator
5511 \begin_inset space ~
5517 you can insert the dictum's author there.
5518 Dictum and author are separated by a line.
5519 You need at least Koma-Script version 2.8q to use this.
5526 article (koma-script)
5531 \begin_layout Standard
5532 The following types,
5533 together with the standard types
5548 form the title area of the document.
5549 They must be entered ahead of the first
5550 \begin_inset Quotes eld
5554 \begin_inset Quotes erd
5561 \begin_layout Plain Layout
5562 The corresponding \SpecialChar LaTeX
5563 commands must appear before the
5574 When such a type is used more than once,
5575 the latter usage overwrites the former one,
5577 for every type only the latest usage is valid.
5578 The order of the different types however has,
5594 no effect on the appearance of the produced document.
5597 \begin_layout Itemize
5603 produces a centered paragraph above the ordinary title (
5617 ) for the subject of the document.
5620 \begin_layout Itemize
5626 produces a centered paragraph below the ordinary title (
5640 ) for the publishers' name.
5643 \begin_layout Itemize
5651 report (koma-script)
5657 produces a centered paragraph on its own page behind the title page,
5660 article (koma-script)
5662 produces a centered paragraph below the ordinary title (
5684 \begin_layout Itemize
5690 produces a left aligned paragraph above the ordinary title (
5709 ) for a document`s head.
5712 \begin_layout Itemize
5718 produces in a double-sided print in
5720 report (koma-script)
5726 a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
5728 article (koma-script)
5733 \begin_layout Itemize
5739 produces in a double-sided print in
5741 report (koma-script)
5747 a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
5749 article (koma-script)
5754 \begin_layout Itemize
5761 \begin_inset Quotes eld
5765 \begin_inset Quotes erd
5768 page ahead of the actual document containing a paragraph without special formatting.
5771 \begin_layout Standard
5773 \change_inserted 564990737 1672429680
5774 KOMA-Script offers a wide range of
5781 \begin_inset space ~
5791 ocument\SpecialChar menuseparator
5796 ettings\SpecialChar menuseparator
5798 \begin_inset space ~
5803 dialog which you can apply to the whole document,
5807 \begin_layout Description
5809 \change_inserted 564990737 1672429680
5816 which produces a PDF with a small black box at the end any line in which a formatting error occurs;
5817 the default setting is
5822 \begin_layout Description
5824 \change_inserted 564990737 1672429680
5831 which may take the values
5845 the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
5848 \begin_layout Description
5850 \change_inserted 564990737 1672429680
5857 which may take the values
5871 the first leaves it up to KOMA-Script to add periods after chapter,
5874 the second forces the addition of periods and third suppresses them
5877 \begin_layout Standard
5879 \change_inserted 564990737 1672429680
5880 and the math options:
5883 \begin_layout Description
5885 \change_inserted 564990737 1672429680
5892 which causes equations to be numbered on the left rather than on the right,
5896 \begin_layout Description
5898 \change_inserted 564990737 1672429680
5905 which causes equations to be left justified rather than centered.
5908 \begin_layout Standard
5910 \change_inserted 564990737 1672429680
5911 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
5912 commands and packages;
5914 if you want your captions in bold add
5917 \begin_layout Standard
5919 \change_inserted 564990737 1672429680
5924 setkomafont{captionlabel}{
5929 \begin_layout Standard
5931 \change_inserted 564990737 1672429680
5937 ocument\SpecialChar menuseparator
5944 \SpecialChar menuseparator
5949 \begin_inset space ~
5954 ) and the problem is solved.
5957 \begin_layout Standard
5959 \change_inserted 564990737 1672429680
5960 If you are writing a book,
5961 it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
5962 If you use the Chapter* environment,
5963 your Foreword and Preface will not appear in the Table of Contents;
5964 to make them to appear in the Table of contents,
5965 you need to use Chapter environments and add the \SpecialChar TeX
5969 \begin_layout Standard
5971 \change_inserted 564990737 1672429680
5979 \begin_layout Standard
5981 \change_inserted 564990737 1672429680
5982 at the very start of the book (not in the \SpecialChar LaTeX
5986 \begin_layout Standard
5988 \change_inserted 564990737 1672429680
5996 \begin_layout Standard
5998 \change_inserted 564990737 1672429680
5999 before the first chapter of the body of the text.
6001 \change_inserted -712698321 1673092640
6010 \begin_layout Standard
6012 \change_inserted 564990737 1672429680
6013 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
6018 \begin_layout Plain Layout
6020 \change_inserted 564990737 1672429680
6021 Appendices are normally “numbered” with letters.
6026 If you use the Chapter* environment,
6027 they will not appear in the Table of Contents;
6028 so add the \SpecialChar TeX
6032 \begin_layout Standard
6034 \change_inserted 564990737 1672429680
6042 \begin_layout Standard
6044 \change_inserted 564990737 1672429682
6045 before the first of these headings and use the Chapter environment.
6046 These commands will have no effect on the numbering in \SpecialChar LyX
6048 only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
6051 \begin_layout Standard
6052 The layout files for the document classes
6054 article (koma-script)
6059 report (koma-script)
6071 This is thought of as a place to define your own types.
6076 in your personal layout directory and edit the file!
6077 \change_deleted 564990737 1672430255
6081 \begin_layout Standard
6083 \change_deleted 564990737 1672430255
6084 letter (koma-script)
6087 \begin_layout Description
6089 \change_deleted 564990737 1672429749
6091 This section discusses the obsolete
6093 KOMA-Script-Letter (v.
6094 \begin_inset space ~
6100 which is not even included anymore in recent KOMA releases.
6101 Please refer to the next section for the current KOMA-Script-Letter class (v.
6102 \begin_inset space ~
6108 \begin_layout Standard
6111 \change_deleted 564990737 1672429749
6114 letter (koma-script)
6116 is implemented in the layout file
6121 It contains all the paragraph types of the corresponding standard document class
6127 with the exception of the \SpecialChar LyX
6142 which is replaced by the new
6149 in contrast to the standard document class,
6172 there are a number of new letter specific types.
6175 \begin_layout Standard
6177 \change_deleted 564990737 1672429749
6178 The appearance of the letter produced by this document class can be controlled by a number of \SpecialChar LaTeX
6180 which you can put in the \SpecialChar LaTeX
6185 \begin_layout Plain Layout
6187 the standard appearance of the letter`s heading,
6188 consisting of name and address,
6189 is quite self-willed.
6191 \begin_inset Quotes eld
6195 \begin_inset Quotes erd
6198 heading is produced by the following \SpecialChar LaTeX
6199 commands in the preamble:
6202 \begin_layout LyX-Code
6212 \begin_layout LyX-Code
6228 \begin_layout LyX-Code
6238 \begin_layout LyX-Code
6258 A detailed German description of such \SpecialChar LaTeX
6259 commands can be found in the Koma-Script documentation
6265 the letter's author can produce his personal letter layout.
6268 \begin_layout Standard
6270 \change_deleted 564990737 1672429749
6279 define the beginning of the letter and must be used in every letter.
6280 To emphasize them in the \SpecialChar LyX
6282 they are marked with the letter
6292 \begin_inset space ~
6296 It is possible to write any number of letters in one file.
6301 type produces a new letter using the same addressee and a
6305 type produces a new addressee.
6325 are ordinary paragraph types and can also be used several times in one and the same letter.
6328 \begin_layout Itemize
6330 \change_deleted 564990737 1672429749
6336 produces a paragraph for the addressee and implicitly defines the beginning of the letter.
6339 \begin_layout Itemize
6341 \change_deleted 564990737 1672429749
6347 produces a paragraph for the form of address and implicitly produces a new letter.
6350 \begin_layout Itemize
6352 \change_deleted 564990737 1672429749
6358 produces a paragraph for a close.
6361 \begin_layout Itemize
6363 \change_deleted 564990737 1672429749
6369 produces a paragraph for a postscript.
6372 \begin_layout Itemize
6374 \change_deleted 564990737 1672429749
6380 produces a paragraph for a distribution list.
6383 \begin_layout Itemize
6385 \change_deleted 564990737 1672429749
6391 produces a paragraph for enclosures.
6394 \begin_layout Standard
6396 \change_deleted 564990737 1672429749
6446 are input types provided with a label to enter information,
6447 which will be processed by the document class.
6451 \begin_layout Plain Layout
6452 It could be seen as a matter of inconsequence,
6461 described above are not such input types as well.
6462 Because of the special meaning of those types,
6464 I have implemented them as ordinary paragraph types with a one letter mark in the left margin.
6466 it would affect my feeling of symmetry,
6475 type had such a serious different appearance.
6480 The types must be used ahead of the corresponding
6487 \begin_layout Standard
6489 \change_deleted 564990737 1672429749
6490 An implementation of these types in a WYSIWYG fashion does not seem to make sense,
6491 because the real appearance of the produced letter does not only depend on the usage of the particular type,
6492 but also on other factors.
6494 a signature entered in the
6498 type will in the standard behavior appear in the produced letter only,
6499 when in the same letter also a
6504 The entered value of the
6508 type will in the standard behavior not appear in the produced letter at all.
6509 The possibility to design the letter`s heading freely is already indicated in a footnote above.
6512 \begin_layout Standard
6514 \change_deleted 564990737 1672429749
6515 The input types can also be used as empty paragraphs.
6517 \begin_inset space \thinspace{}
6521 \begin_inset space \space{}
6533 type is not used at all,
6534 in the standard behavior the value of the
6538 type is used as signature,
6544 no signature value is defined.
6547 \begin_layout Standard
6549 \change_deleted 564990737 1672429749
6550 By using the input types it is possible to write a letter template,
6551 containing filled input types with your personal dates (name,
6553 etc.) and empty input types for other dates you want to enter.
6556 \begin_layout Itemize
6558 \change_deleted 564990737 1672429749
6565 in the standard behavior appears as a centered paragraph in small caps in the letter`s heading.
6568 \begin_layout Itemize
6570 \change_deleted 564990737 1672429749
6577 in the standard behavior appears below the
6591 type appears instead.
6594 \begin_layout Itemize
6596 \change_deleted 564990737 1672429749
6603 in the standard behavior appears in a centered paragraph in the letter`s heading below the sender's name.
6606 \begin_layout Itemize
6608 \change_deleted 564990737 1672429749
6614 sender's telephone number,
6615 in the standard behavior only sets the \SpecialChar LaTeX
6625 \begin_layout Itemize
6627 \change_deleted 564990737 1672429749
6633 place of the letter`s making.
6636 \begin_layout Itemize
6638 \change_deleted 564990737 1672429749
6644 date of the letter`s making.
6654 in the standard behavior,
6655 produce the place and the date in a right-aligned line below the addressee's field.
6661 neither place nor date appear,
6662 independent of the value of the
6672 the date of the letter `s production is used.
6675 \begin_layout Itemize
6677 \change_deleted 564990737 1672429749
6683 sender`s back address,
6684 in the standard behavior appears above the addressee's field in a small sans serif font.
6687 \begin_layout Itemize
6689 \change_deleted 564990737 1672429749
6695 special mail information,
6696 in the standard behavior appears underlined above the addressee's field below the back address.
6699 \begin_layout Itemize
6701 \change_deleted 564990737 1672429749
6707 additional information,
6708 in the standard behavior appears on right side below the addressee`s field.
6711 \begin_layout Itemize
6713 \change_deleted 564990737 1672429749
6720 in the standard behavior appears in a big,
6722 sans serif font above the subject.
6725 \begin_layout Itemize
6727 \change_deleted 564990737 1672429749
6733 the letter's subject,
6734 in the standard behavior appears in a bold font above the
6741 \begin_layout Standard
6743 \change_deleted 564990737 1672429749
6768 produce a business letter like line above the
6772 line containing the fields
6773 \begin_inset Quotes eld
6777 \begin_inset Quotes erd
6782 \begin_inset Quotes eld
6786 \begin_inset Quotes erd
6791 \begin_inset Quotes eld
6795 \begin_inset Quotes erd
6800 \begin_inset Quotes eld
6804 \begin_inset Quotes erd
6809 \begin_inset Quotes eld
6813 \begin_inset Quotes erd
6818 \begin_inset Quotes eld
6822 \begin_inset Quotes erd
6833 \begin_inset Quotes eld
6836 business letter types
6837 \begin_inset Quotes erd
6845 type however does not appear,
6846 but only the \SpecialChar LaTeX
6854 The ordinary output of place and date in a right-aligned line below the addressee`s field is suppressed.
6855 The types are implemented as input types provided with a label and must be used ahead of the corresponding
6862 \begin_layout Itemize
6864 \change_deleted 564990737 1672429749
6873 \begin_layout Itemize
6875 \change_deleted 564990737 1672429749
6884 \begin_layout Itemize
6886 \change_deleted 564990737 1672429749
6895 \begin_layout Itemize
6897 \change_deleted 564990737 1672429749
6906 \begin_layout Itemize
6908 \change_deleted 564990737 1672429749
6919 \begin_layout Subsubsection
6921 \change_deleted 564990737 1672429773
6922 The new letter class:
6923 letter (koma-script v.2)
6924 \change_inserted 564990737 1672429774
6926 \begin_inset CommandInset label
6928 name "subsec:The-new-letter"
6932 The new letter class:
6934 \change_inserted -712698321 1673092709
6936 \change_deleted -712698321 1673092710
6938 \change_inserted -712698321 1673092710
6940 \change_inserted 564990737 1672429774
6942 \change_deleted -712698321 1673092713
6944 \change_inserted -712698321 1673092714
6946 \change_inserted 564990737 1672429774
6949 \change_inserted -712698321 1673092715
6951 \change_inserted 564990737 1672429774
6957 \begin_layout Standard
6963 \begin_layout Standard
6964 \begin_inset VSpace medskip
6970 \begin_layout Standard
6972 Koma-Script version 2.8 has introduced a new letter class
6976 which supersedes the now unsupported
6982 on the \SpecialChar LaTeX
6984 a completely new interface and is not compatible with the old class.
6988 though it is recommended you use the new class.
6991 \begin_layout Standard
6992 This class covers the same functionality as
6994 letter (koma-script),
7002 (receiver's address,
7022 will start a new letter (i.
7023 \begin_inset space \thinspace{}
7027 \begin_inset space \space{}
7030 you can write several letters per document).
7031 New elements are sender's
7050 and the possibility to use a
7056 Insert\SpecialChar menuseparator
7062 \begin_layout Standard
7063 The biggest improvement is,
7065 that the letter's layout is configurable to meet almost any needs.
7066 This can be done via the preamble or with a special style file (Letter Class Option,
7072 that will be read in as a class option.
7076 \begin_layout Plain Layout
7077 The KOMA package comes with some default
7088 file that follows german typesetting rules,
7093 that provides the default layout of the old
7098 The latter can be loaded with the class option
7105 Layout\SpecialChar menuseparator
7106 Document\SpecialChar menuseparator
7115 \change_deleted 564990737 1671617922
7123 \change_deleted 564990737 1671617938
7124 that is included in \SpecialChar LyX
7126 \change_inserted 564990737 1671617997
7132 ile\SpecialChar menuseparator
7134 \begin_inset space ~
7142 \begin_inset space ~
7145 Template\SpecialChar menuseparator
7146 Letters\SpecialChar menuseparator
7147 KOMA-Script Letter (V.2)
7152 A detailed description is to be found in the Koma-Script documentation (
7159 \begin_layout Subsubsection
7163 \begin_layout Standard
7164 Visualizing the Koma-Script document classes in \SpecialChar LyX
7166 the \SpecialChar LyX
7167 internals cause some problems.
7170 \begin_layout Itemize
7171 The chapter number of a
7175 type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
7176 The cause for that is the \SpecialChar LyX
7177 internal behavior for the labeltype
7184 \begin_layout Itemize
7185 The headings of the types
7194 \begin_inset Quotes eld
7198 \begin_inset Quotes erd
7203 but not in the \SpecialChar LyX
7206 Document\SpecialChar menuseparator
7208 \begin_inset space ~
7212 \begin_inset space ~
7220 \begin_layout Itemize
7225 document class appear in a skip separation mode,
7227 This is the standard behavior,
7228 no special \SpecialChar LaTeX
7229 commands are needed for that.
7232 Document\SpecialChar menuseparator
7235 dialog the corresponding radio button indicates
7244 value always has the effect that extra \SpecialChar LaTeX
7245 commands are inserted in the document to produce the gap,
7246 which is not what is wanted in this case.
7249 \begin_layout Subsection
7251 \change_inserted 564990737 1672743555
7252 \begin_inset CommandInset label
7254 name "subsec:Polish-M.W.collection"
7259 \begin_inset space \thinspace{}
7263 \begin_inset space \space{}
7267 \change_deleted 564990737 1670924933
7269 book (mwbk) and report (mwrep)
7270 \begin_inset Argument status
7273 \begin_layout Plain Layout
7288 \begin_layout Standard
7294 \begin_layout Standard
7295 The \SpecialChar LyX
7297 \change_deleted -712698321 1673094342
7301 \change_inserted -712698321 1673094343
7302 Polish Article (MW Bundle)
7308 \change_deleted -712698321 1673094349
7312 \change_inserted -712698321 1673094356
7313 Polish Report (MW Bundle)
7318 \change_deleted -712698321 1673094352
7326 \change_inserted -712698321 1673094359
7327 Polish Book (MW Bundle)
7331 correspond to the \SpecialChar LaTeX
7347 They are replacements for the standard document classes
7362 and fit better to Polish typography conventions in a number of points.
7366 \begin_layout Standard
7370 \begin_layout Itemize
7371 Unnumbered titles (with star,
7373 \begin_inset space \thinspace{}
7377 \begin_inset space \space{}
7384 ) are added into table of contents,
7387 \begin_layout Itemize
7388 Additional page styles:
7392 \begin_layout Description
7393 uheadings header with separated lines,
7396 \begin_layout Description
7397 myheadings custom header,
7398 contents headers via commands:
7414 \begin_layout Description
7415 myuheadings custom header with separated lines,
7418 \begin_layout Description
7419 outer page number is placed on outer side of page
7423 \begin_layout Itemize
7428 \begin_layout Description
7429 rmheadings serif titles —
7433 \begin_layout Description
7434 sfheadings sansserif titles,
7437 \begin_layout Description
7438 authortitle on title page first placed is author next title —
7442 \begin_layout Description
7443 titleauthor on title page first placed is title next author,
7446 \begin_layout Description
7447 withmarginpar reserve place on page for margins.
7451 \begin_layout Subsection
7453 \change_inserted 564990737 1672652245
7457 \begin_layout Standard
7459 \change_inserted 564990737 1672652245
7460 The document classes
7461 \change_deleted -712698321 1673094404
7465 \begin_inset space \thinspace{}
7469 \change_inserted -712698321 1673094404
7471 \change_inserted 564990737 1672652245
7475 \change_deleted -712698321 1673094408
7479 \begin_inset space \thinspace{}
7483 \change_inserted -712698321 1673094411
7485 \change_inserted 564990737 1672652245
7497 Detailed information about these document classes can be found in
7499 File\SpecialChar menuseparator
7500 Open Example\SpecialChar menuseparator
7501 Books\SpecialChar menuseparator
7506 File\SpecialChar menuseparator
7507 Open Example\SpecialChar menuseparator
7508 Handouts\SpecialChar menuseparator
7514 \begin_layout Section
7516 \change_inserted 564990737 1670439534
7520 \begin_layout Standard
7522 \change_inserted 564990737 1670794710
7523 See also the document classes in the Collections (section
7524 \begin_inset space ~
7528 \begin_inset CommandInset ref
7530 reference "sec:Collections"
7538 \begin_layout Subsection
7540 \change_deleted -712698321 1673095198
7542 \change_inserted -712698321 1673095198
7543 Astronomy & Astrophysics
7544 \change_inserted 564990737 1670794716
7548 \begin_layout Standard
7550 \change_inserted 564990737 1670794716
7556 updated by the \SpecialChar LyX
7560 \begin_layout Subsubsection
7562 \change_inserted 564990737 1670794716
7566 \begin_layout Standard
7568 \change_inserted 564990737 1670794716
7569 This section describes how \SpecialChar LyX
7570 can be used to write articles for submission to the scientific journal
7573 \change_deleted -712698321 1673095254
7575 \change_inserted -712698321 1673095254
7577 \change_inserted 564990737 1670794716
7581 \begin_inset CommandInset href
7584 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
7589 ) using Version 9.1 of the document class
7594 information about it is available at
7595 \begin_inset Flex URL
7598 \begin_layout Plain Layout
7600 \change_inserted 564990737 1670794716
7602 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
7612 \begin_layout Standard
7614 \change_inserted 564990737 1670794716
7615 A manual comes together with the package and should be consulted before installing this document class as described in the
7617 Installing New Document Classe
7627 \begin_layout Standard
7629 \change_inserted 564990737 1670794716
7630 \begin_inset Note Greyedout
7633 \begin_layout Plain Layout
7635 \change_inserted 564990737 1670794716
7636 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
7638 That change also involved some slight changes to the style files,
7639 namely the removal of the thesaurus command.
7640 If you have an older version installed,
7642 For information about compatibility with the old (version 4) layout,
7643 please refer to the comments in
7646 Dir/layouts/aapaper.layout
7656 \begin_layout Subsubsection
7658 \change_inserted 564990737 1670794716
7662 \begin_layout Standard
7664 \change_inserted 564990737 1671617129
7665 It is recommended you start from the template in the menu
7670 ile\SpecialChar menuseparator
7672 \begin_inset space ~
7680 \begin_inset space ~
7683 Template\SpecialChar menuseparator
7684 Articles\SpecialChar menuseparator
7685 Astronomy & Astrophysics
7688 If you are not using the template,
7689 note the following settings:
7692 \begin_layout Itemize
7694 \change_inserted 564990737 1670794716
7696 \change_deleted -712698321 1673095619
7700 \change_inserted -712698321 1673095619
7701 Astronomy & Astrophysics
7702 \change_inserted 564990737 1670794716
7710 ocument\SpecialChar menuseparator
7715 ettings\SpecialChar menuseparator
7717 \begin_inset space ~
7723 that one was obvious).
7726 \begin_layout Itemize
7728 \change_inserted 564990737 1670794716
7732 \begin_inset space ~
7744 \begin_inset space ~
7755 The whole layout is done by the macros,
7756 you shouldn't change anything.
7759 \begin_layout Subsubsection
7761 \change_inserted 564990737 1670794716
7765 \begin_layout Standard
7767 \change_inserted 564990737 1670794716
7768 First thing to enter is the header information.
7770 \change_deleted -712698321 1673167006
7772 \change_inserted -712698321 1673167007
7774 \change_inserted 564990737 1670794716
7776 of which one is optional.
7780 \begin_layout Itemize
7782 \change_inserted 564990737 1670794716
7791 \begin_layout Itemize
7793 \change_inserted 564990737 1670794716
7802 \begin_layout Itemize
7804 \change_inserted 564990737 1670794716
7813 \begin_layout Itemize
7815 \change_deleted -712698321 1673167065
7819 \change_inserted -712698321 1673167065
7821 \change_inserted 564990737 1670794716
7826 \change_inserted -712698321 1673167087
7830 \begin_layout Itemize
7832 \change_inserted -712698321 1673168577
7838 Determines to whom correspondence and reprints are to be sent.
7841 \begin_layout Itemize
7843 \change_inserted -712698321 1673168590
7848 [optional] Snail mail address for contacts.
7849 \change_inserted 564990737 1670794716
7853 \begin_layout Itemize
7855 \change_inserted 564990737 1670794716
7869 \begin_layout Standard
7871 \change_inserted -712698321 1673168612
7872 There is no need to issue the
7879 this is done automatically by \SpecialChar LyX
7880 when the header is finished.
7882 \change_inserted 564990737 1670794716
7883 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
7884 just to get the best optics and meets the layout of the real document.
7887 \begin_layout Standard
7889 \change_inserted 564990737 1670794716
7890 If you want to place footnotes in the header block,
7892 \begin_inset space \thinspace{}
7896 \begin_inset space \space{}
7899 to state your present address,
7900 just use the standard footnote via the menu
7905 nsert\SpecialChar menuseparator
7914 will automagically use the term
7921 \change_inserted -712698321 1673168649
7925 \begin_layout Standard
7927 \change_inserted -712698321 1673168649
7930 Edit\SpecialChar menuseparator
7934 you'll find two insets which are relevant for the titling:
7937 \begin_layout Itemize
7939 \change_inserted -712698321 1673168649
7946 to mark corresponding author\SpecialChar breakableslash
7948 The institutes are numbered sequentially as they appear in the
7953 so you have to put a marker to each author.
7956 \begin_layout Itemize
7958 \change_inserted -712698321 1673168649
7963 to supply an email address for fast contact.
7964 \change_inserted 564990737 1670794716
7968 \begin_layout Standard
7970 \change_inserted 564990737 1670794716
7971 In addition to these topics,
7972 the macros use three additional \SpecialChar LaTeX
7973 commands that have no counterpart in \SpecialChar LyX
7977 \begin_layout Itemize
7979 \change_inserted 564990737 1670794716
7986 to separate different names for more than one author and institute,
7990 \begin_layout Itemize
7992 \change_deleted -712698321 1673168671
7999 to mark corresponding author/institute pairs.
8000 The institutes are numbered sequentially as they appear in the
8005 so you have to put a marker to each author.
8008 \begin_layout Itemize
8010 \change_deleted -712698321 1673168671
8017 to supply an email address for fast contact.
8018 \change_inserted 564990737 1670794716
8022 \begin_layout Standard
8024 \change_deleted -712698321 1673168684
8027 \change_inserted -712698321 1673168684
8029 \change_inserted 564990737 1671642374
8030 he appropriate command has to be entered as \SpecialChar TeX
8031 code in \SpecialChar LyX
8033 See the examples in the template and in
8035 File\SpecialChar menuseparator
8036 Open Example\SpecialChar menuseparator
8037 Articles\SpecialChar menuseparator
8038 Astronomy & Astrophysics
8045 \begin_layout Subsubsection
8047 \change_inserted 564990737 1670794716
8051 \begin_layout Standard
8053 \change_inserted -712698321 1673168754
8054 The abstract should immediately follow the header block.
8055 With version 5 the abstract environment was changed to a command,
8056 and there is now a restriction to only one paragraph.
8058 it should contain an entry with the keywords.
8059 This is done via the paragraph style
8064 Refer to the example paper.
8065 \change_deleted -712698321 1673168754
8066 The abstract should immediately follow the header block and must contain five tokens:
8076 \begin_layout Enumerate
8078 \change_deleted -712698321 1673168754
8083 (optional) {} leave it empty if necessary
8086 \begin_layout Enumerate
8088 \change_deleted -712698321 1673168754
8096 \begin_layout Enumerate
8098 \change_deleted -712698321 1673168754
8106 \begin_layout Enumerate
8108 \change_deleted -712698321 1673168754
8116 \begin_layout Enumerate
8118 \change_deleted -712698321 1673168754
8123 (optional) {} leave it empty if necessary
8126 \begin_layout Standard
8128 \change_deleted -712698321 1673168754
8130 This structure not shown in
8135 \change_inserted 564990737 1670794716
8139 \begin_layout Subsubsection
8141 \change_inserted 564990737 1670794716
8142 Supported environments
8145 \begin_layout Standard
8147 \change_inserted 564990737 1670794716
8148 The A&A paper layout supports the following environments for structuring your text:
8151 \begin_layout Standard
8153 \change_inserted -712698321 1673169058
8156 \begin_inset Flex Multiple Columns
8159 \begin_layout Itemize
8161 \change_inserted -712698321 1673169058
8167 \begin_layout Itemize
8169 \change_inserted -712698321 1673169058
8175 \begin_layout Itemize
8177 \change_inserted -712698321 1673169058
8183 \begin_layout Itemize
8185 \change_inserted -712698321 1673169058
8191 \begin_layout Itemize
8193 \change_inserted -712698321 1673169058
8199 \begin_layout Itemize
8201 \change_inserted -712698321 1673169058
8207 \begin_layout Itemize
8209 \change_inserted -712698321 1673169058
8215 \begin_layout Itemize
8217 \change_inserted -712698321 1673169058
8223 \begin_layout Itemize
8225 \change_inserted -712698321 1673169058
8231 \begin_layout Itemize
8233 \change_inserted -712698321 1673169058
8239 \begin_layout Itemize
8241 \change_inserted -712698321 1673169058
8247 \begin_layout Itemize
8249 \change_inserted -712698321 1673169078
8258 \change_deleted -712698321 1673169058
8262 \begin_layout Itemize
8264 \change_deleted -712698321 1673169058
8270 \begin_layout Itemize
8272 \change_deleted -712698321 1673169058
8278 \begin_layout Itemize
8280 \change_deleted -712698321 1673169058
8286 \begin_layout Itemize
8288 \change_deleted -712698321 1673169058
8294 \begin_layout Itemize
8296 \change_deleted -712698321 1673169058
8302 \begin_layout Itemize
8304 \change_deleted -712698321 1673169058
8310 \begin_layout Itemize
8312 \change_deleted -712698321 1673169058
8318 \begin_layout Itemize
8320 \change_deleted -712698321 1673169058
8326 \begin_layout Itemize
8328 \change_deleted -712698321 1673169058
8334 \begin_layout Itemize
8336 \change_deleted -712698321 1673169058
8342 \begin_layout Itemize
8344 \change_deleted -712698321 1673169058
8349 \change_inserted 564990737 1670794716
8353 \begin_layout Subsubsection
8355 \change_inserted 564990737 1670794716
8356 Commands not supported by \SpecialChar LyX
8360 \begin_layout Standard
8362 \change_inserted 564990737 1670794716
8363 Some commands are not yet supported by the
8364 \change_deleted -712698321 1673169117
8368 \change_inserted -712698321 1673169117
8369 Astronomy & Astrophysics
8370 \change_inserted 564990737 1670794716
8373 layout for \SpecialChar LyX
8375 Some have already been mentioned.
8376 For the sake of completeness,
8377 they are listed all together here:
8380 \begin_layout Itemize
8382 \change_inserted 564990737 1670794716
8390 \begin_layout Itemize
8392 \change_inserted -712698321 1673168793
8400 \begin_layout Itemize
8402 \change_inserted -712698321 1673168793
8410 \begin_layout Itemize
8412 \change_inserted -712698321 1673168793
8418 \change_deleted -712698321 1673168793
8424 \begin_layout Itemize
8426 \change_deleted -712698321 1673168793
8434 \begin_layout Itemize
8436 \change_deleted -712698321 1673168793
8444 \begin_layout Itemize
8446 \change_deleted -712698321 1673168793
8452 \change_inserted 564990737 1670794716
8456 \begin_layout Standard
8458 \change_inserted 564990737 1670794716
8459 If you want to use any of these commands,
8460 you have to enter them yourself.
8461 Do not forget to use
8467 nsert\SpecialChar menuseparator
8470 \begin_inset space ~
8478 \begin_layout Subsubsection
8480 \change_inserted 564990737 1670794716
8481 Figure and Table Floats
8484 \begin_layout Standard
8486 \change_inserted 564990737 1670794716
8488 provides support for the necessary float environments
8499 therefore we won't tell much about it here.
8503 \begin_inset space ~
8509 Just remember that tables should be left-aligned.
8511 select the table and change the alignment in
8516 dit\SpecialChar menuseparator
8522 \begin_inset space ~
8526 \change_inserted -712698321 1673169201
8532 arg "layout-paragraph"
8536 \change_inserted 564990737 1670794716
8542 \begin_layout Standard
8544 \change_inserted 564990737 1670794716
8545 There is only one special thing:
8546 the figures with a caption beside the figure.
8547 To create such a figure,
8548 you have to do the following:
8551 \begin_layout Enumerate
8553 \change_inserted 564990737 1670794716
8554 Create a wide figure float:
8560 nsert\SpecialChar menuseparator
8565 t\SpecialChar menuseparator
8570 from within the float,
8576 dit\SpecialChar menuseparator
8582 \begin_inset space ~
8593 \begin_inset space ~
8605 \begin_layout Enumerate
8607 \change_inserted 564990737 1670794716
8608 Enter your caption text.
8611 \begin_layout Enumerate
8613 \change_inserted 564990737 1670794716
8618 to move the cursor above the caption.
8621 \begin_layout Enumerate
8623 \change_inserted 564990737 1670794716
8627 \begin_layout Enumerate
8629 \change_inserted 564990737 1670794716
8630 Position the cursor after the figure and insert a horizontal fill by using the menu:
8636 nsert\SpecialChar menuseparator
8641 rmatting\SpecialChar menuseparator
8647 \begin_inset space ~
8656 dialog and select the
8668 \change_deleted -712698321 1673169720
8670 \change_inserted -712698321 1673169724
8672 \change_inserted 564990737 1670794716
8676 \begin_layout Enumerate
8678 \change_inserted 564990737 1670794716
8679 Switch to \SpecialChar LaTeX
8684 \begin_inset space ~
8692 \begin_layout Enumerate
8694 \change_inserted 564990737 1670794716
8703 Do not close the brace!
8706 \begin_layout Enumerate
8708 \change_inserted 564990737 1670794716
8709 Position the cursor behind the caption text,
8710 switch to \SpecialChar LaTeX
8711 mode and insert the closing brace:
8715 \begin_inset space ~
8727 \begin_layout Standard
8729 \change_inserted 564990737 1671642458
8731 refer to the figures in the file in
8733 File\SpecialChar menuseparator
8734 Open Example\SpecialChar menuseparator
8735 Articles\SpecialChar menuseparator
8736 Astronomy & Astrophysics
8741 \begin_layout Subsubsection
8743 \change_inserted 564990737 1670794716
8747 \begin_layout Standard
8749 \change_inserted 564990737 1670794716
8751 the paper has to be formatted in a special double-spacing layout.
8753 you have to add the option
8764 \begin_inset space ~
8774 ocument\SpecialChar menuseparator
8779 ettings\SpecialChar menuseparator
8781 \begin_inset space ~
8790 \begin_layout Subsubsection
8792 \change_inserted 564990737 1670794716
8796 \begin_layout Standard
8798 \change_inserted 564990737 1671642520
8801 File\SpecialChar menuseparator
8802 Open Example\SpecialChar menuseparator
8803 Articles\SpecialChar menuseparator
8804 Astronomy & Astrophysics
8806 was written with \SpecialChar LyX
8808 It is the example paper from the original macro package,
8814 \begin_inset CommandInset href
8817 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
8823 but translated to \SpecialChar LyX
8824 using the older unstructured abstract type.
8825 Use it for inspiration,
8826 and compare the \SpecialChar LaTeX
8831 with the \SpecialChar LyX
8835 \begin_layout Subsection
8840 \begin_layout Standard
8846 \begin_layout Subsubsection
8850 \begin_layout Standard
8852 is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
8853 the Astrophysical Journal (including the Letters and Supplement),
8854 the Astronomical Journal,
8855 and the Publications of the Astronomical Society of the Pacific.
8857 has proven to be an excellent tool for generating these documents,
8858 especially given its equation,
8860 and figure handling capabilities.
8862 requires version 5.0 (or higher) of these macros;
8864 which is the version described here,
8866 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8867 2.09 and are fundamentally incompatible with \SpecialChar LyX
8869 The AAS\SpecialChar TeX
8870 package may be downloaded from the AAS\SpecialChar TeX
8874 \begin_layout Standard
8875 \begin_inset VSpace medskip
8881 \begin_layout Standard
8883 \begin_inset Flex URL
8886 \begin_layout Plain Layout
8888 https://aas.org/aastex/aastex-downloads
8896 \begin_layout Standard
8897 \begin_inset VSpace medskip
8903 \begin_layout Standard
8904 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
8907 will not reduce the need to figure out all the AAS\SpecialChar TeX
8909 it will only reduce the drudgery of typing everything in.
8910 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8911 document conforms completely to the requirements of the journal to which you are submitting your paper.
8914 \begin_layout Subsubsection
8915 Starting a New Paper
8918 \begin_layout Standard
8919 I strongly suggest that you start with the AAS\SpecialChar TeX
8923 File\SpecialChar menuseparator
8929 \change_inserted 564990737 1671617265
8930 \SpecialChar menuseparator
8931 Articles\SpecialChar menuseparator
8932 American Astronomical Society
8933 \change_deleted 564990737 1671617310
8937 enter the new file name,
8945 This will show the most common fields found in a manuscript.
8946 Simply overwrite the existing text (including the brackets,
8951 ) with the correct information.
8952 Many of the AAS\SpecialChar TeX
8953 commands and environments can be implemented directly in \SpecialChar LyX
8956 For commands such as these,
8957 the \SpecialChar LaTeX
8958 code must be entered directly and marked as such.
8959 Such commands are referred to as \SpecialChar TeX
8962 I tried to minimize the amount of \SpecialChar TeX
8963 code needed in an AAS\SpecialChar TeX
8967 \begin_layout Subsubsection
8968 Finishing Your Paper
8971 \begin_layout Standard
8972 When the paper is finished to your satisfaction and previews/prints correctly,
8974 \begin_inset Quotes eld
8978 \begin_inset Quotes erd
8981 actions which need to be done before you submit it to the journals.
8985 \begin_layout Enumerate
8986 Export your paper as a \SpecialChar LaTeX
8989 File\SpecialChar menuseparator
8990 Export\SpecialChar menuseparator
8998 \begin_layout Enumerate
9003 file with your favorite text editor
9007 \begin_layout Enumerate
9008 remove the comment lines before the
9017 \begin_layout Enumerate
9022 usepackage...{fontenc}
9024 line if it appears (usually just after
9040 \begin_layout Enumerate
9041 remove everything between (and including) the
9054 except for any commands you specifically put into the \SpecialChar LaTeX
9055 preamble (which should appear immediately after the
9056 \begin_inset Quotes eld
9059 User specified \SpecialChar LaTeX
9061 \begin_inset Quotes erd
9072 \begin_layout Enumerate
9073 Run the resulting file through \SpecialChar LaTeX
9074 to make sure it still processes correctly.
9077 \begin_layout Enumerate
9078 Reread the journal requirements to make sure your filenames and formats are correct.
9081 \begin_layout Enumerate
9085 \begin_layout Subsubsection
9086 Comments On Specific Commands
9089 \begin_layout Standard
9090 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9092 the AAS\SpecialChar TeX
9097 ) gives a good description of each.
9098 Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
9099 So let's begin \SpecialChar ldots
9103 \begin_layout Paragraph
9104 Things that work as expected
9107 \begin_layout Standard
9108 Because they work as you might expect,
9109 I simply list them and the section they are found in:
9226 begin{thebibliography}
9236 all the cite commands and their variations (2.13.2),
9237 the generic graphicx figure commands (2.14.1),
9266 amongst other places),
9297 \begin_layout Standard
9298 The following style options also work correctly:
9324 Simply put them in the
9330 Layout\SpecialChar menuseparator
9336 \begin_layout Paragraph
9338 but require more comment
9341 \begin_layout Standard
9342 The following items work,
9343 but require a little more discussion:
9346 \begin_layout Itemize
9347 These items are reserved for use by the journal editors,
9348 but you can put them into the \SpecialChar LaTeX
9349 preamble if you feel compelled to do so:
9387 \begin_layout Itemize
9388 These items may be placed in the \SpecialChar LaTeX
9390 and are included as blanks in the template file:
9414 \begin_layout Itemize
9421 (2.3) – can only be used
9422 \begin_inset Quotes eld
9426 \begin_inset Quotes erd
9430 not in the middle of a paragraph.
9431 Use \SpecialChar TeX
9432 code if you need to embed it.
9435 \begin_layout Itemize
9442 (2.3) – will have extra {} after it.
9443 This should not cause an error.
9446 \begin_layout Itemize
9453 (2.6) – can only be used
9454 \begin_inset Quotes eld
9458 \begin_inset Quotes erd
9462 not in the middle of a paragraph.
9463 Use \SpecialChar TeX
9464 code if you need to embed it.
9467 \begin_layout Itemize
9474 (2.8) – can't insert a cross-reference tag,
9475 you must type the tag name by hand
9478 \begin_layout Itemize
9492 \begin_layout Itemize
9499 (2.9) – will have extra {} after it.
9500 This should not cause an error.
9503 \begin_layout Itemize
9510 (2.11) – will have extra {} after it.
9511 This should not cause an error.
9514 \begin_layout Itemize
9521 (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
9523 Insert\SpecialChar menuseparator
9528 \begin_inset Quotes eld
9532 \begin_inset Quotes erd
9535 inserts an optional argument of the type needed by
9542 Hopefully it will be renamed someday.
9545 \begin_layout Itemize
9558 for the catalog ID optional parameter
9561 \begin_layout Itemize
9574 for the catalog ID optional parameter
9577 \begin_layout Paragraph
9578 Things not implemented,
9579 use \SpecialChar TeX
9583 \begin_layout Standard
9595 setcounter{equation}
9598 Journal name abbreviations (2.13.4),
9641 insert it as the first element in the lefthand cell after where you want it.
9642 Don't use any of \SpecialChar LyX
9643 's rules in the table),
9718 \begin_layout Paragraph
9719 Things that cannot be implemented
9722 \begin_layout Standard
9724 at least in any meaningful sort of way,
9725 so I suggest ignoring them.
9726 They are the references environment (2.13.3),
9727 and the deluxetable environment (2.15).
9729 really need to use deluxetable,
9730 I suggest editing it in a separate file with a text editor,
9733 Insert\SpecialChar menuseparator
9735 \begin_inset space ~
9740 to include it in your \SpecialChar LyX
9743 \change_deleted 564990737 1671642564
9749 \change_inserted 564990737 1671642618
9752 File\SpecialChar menuseparator
9753 Open Example\SpecialChar menuseparator
9754 Articles\SpecialChar menuseparator
9755 American Astronomical Society
9760 \change_inserted 564990737 1671642621
9766 \begin_layout Subsubsection
9770 and Other Ruminations
9773 \begin_layout Paragraph
9774 Getting \SpecialChar LyX
9775 and AAS\SpecialChar TeX
9779 \begin_layout Standard
9780 It can be a bit tricky to get \SpecialChar LyX
9781 to recognize a new layout and document class.
9782 When all else fails,
9786 \begin_layout Enumerate
9787 Make certain that \SpecialChar LaTeX
9788 can find AAS\SpecialChar TeX
9790 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9791 distribution into a directory completely unrelated to \SpecialChar LaTeX
9792 or AAS\SpecialChar TeX
9793 and run \SpecialChar LaTeX
9801 \begin_layout Enumerate
9806 appears in \SpecialChar LyX
9814 \begin_layout Enumerate
9817 Tools\SpecialChar menuseparator
9822 then restart \SpecialChar LyX
9826 \begin_layout Enumerate
9827 Open a regular new file,
9828 not from a template.
9830 \change_deleted -712698321 1673170671
9833 \change_inserted -712698321 1673170671
9836 American Astronomical Society (AASTeX V.
9837 \begin_inset space \thinspace{}
9844 appear in the class list in
9846 Document\SpecialChar menuseparator
9852 \begin_layout Standard
9853 If you get a warning from an existing AAS\SpecialChar TeX
9854 document about not being able to find the AAS\SpecialChar TeX
9855 layout or a message about
9856 \begin_inset Quotes eld
9859 You should not mix title layouts with normal ones
9860 \begin_inset Quotes erd
9864 things haven't been installed correctly.
9867 \begin_layout Paragraph
9869 error processing a table
9872 \begin_layout Standard
9876 attempts to center the table caption/title.
9877 This seems to produce a bad interaction in AAS\SpecialChar TeX
9878 so you should click somewhere in the caption/title,
9881 Edit\SpecialChar menuseparator
9883 \begin_inset space ~
9898 This took care of it for me.
9901 \begin_layout Paragraph
9905 \begin_layout Standard
9908 \change_inserted -712698321 1673170733
9912 \begin_layout Enumerate
9914 \change_deleted -712698321 1673170736
9917 I have noticed some funny spacing in the reference entries in the text.
9918 When you enter the bibliography item data,
9923 space between the last author and the parenthesis setting off the year;
9927 \begin_inset space \thinspace{}
9931 \begin_inset space \space{}
9947 \change_deleted -712698321 1673170741
9949 \change_inserted -712698321 1673170741
9953 \begin_layout Enumerate
9954 Entering the references at all is not obvious.
9955 The easiest thing is to start typing your first reference at the end of the document,
9956 then mark it as type
9961 That will put a small gray box in front of what you just typed.
9962 Click on the box to fill in the rest of the information.
9964 go to the end of an existing reference and press return.
9965 That will create a new line with its own box,
9969 \begin_layout Paragraph
9973 \begin_layout Standard
9974 Even though AAS\SpecialChar TeX
9975 provides its own figure commands (
9983 I much prefer \SpecialChar LaTeX
9984 's standard figure commands (with the default graphicx).
9993 \begin_inset space ~
9996 commands as \SpecialChar TeX
9997 code into a Figure Float box if you desire,
9998 but I never have much luck getting the layout right.
9999 With the standard graphics,
10005 usepackage{graphicx}
10007 command into the \SpecialChar LaTeX
10008 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10010 interspersing the figures in the text.
10011 I believe ApJ accepts figures exactly this way now;
10012 AJ might still use the
10013 \begin_inset Quotes eld
10016 stack everything at the end
10017 \begin_inset Quotes erd
10023 \begin_layout Paragraph
10024 Things I could have done,
10028 \begin_layout Standard
10030 \begin_inset Quotes eld
10034 \begin_inset Quotes erd
10037 things I could have implemented,
10040 I saw no point in double-spacing the text in the \SpecialChar LyX
10042 even though it is double-spaced in the paper manuscript.
10044 I chose not to make separate layouts for the preprint and preprint2 styles.
10045 Since I assume you will spend most of your time in the plain manuscript mode anyway,
10046 I decided not to chew up more disk space with this.
10050 \begin_layout Subsubsection
10054 \begin_layout Standard
10055 Your mileage may vary.
10056 I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
10058 the last 2% was the \SpecialChar LaTeX
10059 post-processing and a few cleanups.
10060 I have had no trouble with the submission process,
10061 and I'm sure the journals were never aware that there might be a difference.
10063 go forth and publish!
10066 \begin_layout Subsection
10068 \change_inserted 564990737 1671442131
10072 \begin_layout Standard
10074 \change_inserted 564990737 1671642768
10076 \change_deleted -712698321 1673171415
10080 \begin_inset space \thinspace{}
10084 \change_inserted 564990737 1671642768
10086 \change_deleted -712698321 1673171417
10088 \change_inserted 564990737 1671642768
10092 \change_deleted -712698321 1673171421
10098 \change_inserted -712698321 1673171424
10100 \change_inserted 564990737 1671642768
10101 document class together with the
10102 \change_deleted -712698321 1673171428
10104 \change_inserted -712698321 1673171429
10106 \change_inserted 564990737 1671642768
10110 \change_deleted -712698321 1673171431
10112 \change_inserted 564990737 1671642768
10115 to facilitate the description of chess games.
10118 File\SpecialChar menuseparator
10119 Open Example\SpecialChar menuseparator
10120 Articles\SpecialChar menuseparator
10123 where you will find
10134 \begin_layout Subsection
10136 \change_inserted 564990737 1671042028
10140 \begin_layout Standard
10142 \change_inserted 564990737 1671617396
10144 \change_deleted -712698321 1673171640
10148 \begin_inset space \thinspace{}
10152 \change_inserted 564990737 1671617396
10154 \change_deleted -712698321 1673171643
10156 \change_inserted 564990737 1671617396
10160 \change_inserted -712698321 1673171717
10162 \change_inserted 564990737 1671617396
10166 \change_deleted -712698321 1673171720
10168 \change_inserted 564990737 1671617396
10172 \change_deleted -712698321 1673171728
10174 \change_inserted -712698321 1673171728
10177 \change_inserted 564990737 1671617396
10179 \change_inserted -712698321 1673171744
10180 for journals in the Elsevier publishing house
10181 \change_inserted 564990737 1671617396
10183 This provides the following additional environments:
10187 \begin_inset space ~
10196 \begin_inset space ~
10205 \begin_inset space ~
10226 \change_inserted -712698321 1673172045
10230 \begin_layout Standard
10232 \change_inserted 564990737 1671617396
10233 A template is available in the menu
10238 ile\SpecialChar menuseparator
10240 \begin_inset space ~
10248 \begin_inset space ~
10251 Template\SpecialChar menuseparator
10252 Articles\SpecialChar menuseparator
10256 It has been customized with further environments and contains all the information you may need.
10258 the documentation is also available from
10259 \begin_inset CommandInset href
10262 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
10270 \begin_layout Subsection
10272 \change_inserted 564990737 1671042046
10276 \begin_layout Standard
10278 \change_inserted 564990737 1671042046
10280 \change_deleted -712698321 1673172423
10284 \begin_inset space \thinspace{}
10288 \change_inserted -712698321 1673172423
10289 Paper (Standard Class)
10290 \change_deleted -712698321 1673172423
10292 \change_inserted 564990737 1671042046
10295 provides an alternative to the
10296 \change_deleted -712698321 1673172092
10300 \change_inserted -712698321 1673172435
10303 Article (Standard Class)
10304 \change_inserted 564990737 1671042046
10308 It provides similar functionality,
10309 but you might prefer this layout with sans serif sections,
10314 \begin_layout Subsection
10315 Rev\SpecialChar TeX
10319 \begin_layout Standard
10325 \begin_layout Standard
10326 \begin_inset VSpace bigskip
10332 \begin_layout Standard
10337 \change_deleted -712698321 1673172482
10339 \begin_inset space ~
10343 \change_inserted -712698321 1673172487
10345 \begin_inset space \thinspace{}
10352 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
10354 \begin_inset Formula $\beta$
10361 \begin_layout Standard
10366 \change_deleted -712698321 1673172511
10368 \change_inserted -712698321 1673172517
10374 which works with Rev\SpecialChar TeX
10377 v3.1 is basically obsolete,
10378 as it works with \SpecialChar LaTeX
10380 That means that it doesn't interact very well with \SpecialChar LyX
10382 which requires \SpecialChar LaTeX2e
10384 although it has been kludged to work.
10385 Since Rev\SpecialChar TeX
10386 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
10390 \change_deleted -712698321 1673172538
10393 Rev\SpecialChar TeX
10395 \begin_inset space ~
10399 \change_inserted -712698321 1673172538
10401 \begin_inset space ~
10405 \begin_inset space \thinspace{}
10412 textclass should also be pretty easy to use.
10415 \begin_layout Standard
10416 These documents are supposed to be used in
10420 to the Rev\SpecialChar TeX
10422 so we don't describe any of the special Rev\SpecialChar TeX
10424 and assume you'll know what to put in the preamble if necessary.
10427 \begin_layout Subsubsection
10431 \begin_layout Standard
10432 All you need to do is install Rev\SpecialChar TeX
10434 as described in the package's README file.
10435 The package can be found at The Rev\SpecialChar TeX
10437 \begin_inset Flex URL
10440 \begin_layout Plain Layout
10442 http://publish.aps.org/revtex4/
10448 Install it somewhere that \SpecialChar LaTeX
10450 Test it by trying to \SpecialChar LaTeX
10451 a short Rev\SpecialChar TeX
10452 4 document in some random directory (i.
10453 \begin_inset space \thinspace{}
10457 \begin_inset space \space{}
10460 not the directory where you installed the class file.) Then,
10461 if you reconfigure \SpecialChar LyX
10463 it will find the class file and let you use the Rev\SpecialChar TeX
10467 \begin_layout Standard
10468 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
10477 \begin_inset space ~
10484 \change_deleted -712698321 1673172641
10485 the templates directory
10486 \change_inserted -712698321 1673172687
10489 File\SpecialChar menuseparator
10490 New From Templates\SpecialChar menuseparator
10498 \begin_layout Subsubsection
10502 \begin_layout Standard
10503 Optional arguments to
10511 \begin_inset Quotes eld
10515 \begin_inset Quotes erd
10519 \begin_inset Quotes eld
10523 \begin_inset Quotes erd
10530 \begin_inset space ~
10538 \begin_inset space ~
10545 Remember that in Rev\SpecialChar TeX
10547 at least one optional argument is required!
10551 \begin_layout Standard
10552 Other preamble matter,
10560 \begin_inset space ~
10567 \begin_inset space ~
10576 \begin_layout Subsubsection
10580 \begin_layout Standard
10581 The layouts basically correspond to the commands in Rev\SpecialChar TeX
10584 the Email layout corresponds to
10591 Note that (at least as of Rev\SpecialChar TeX
10601 layouts are exactly equivalent,
10602 so you shouldn't need to use both.
10606 \begin_layout Plain Layout
10607 In case you're curious,
10608 both were included so that
10612 would be able to translate both
10632 \begin_layout Subsubsection
10636 \begin_layout Standard
10637 There are a couple of important unique aspects of Rev\SpecialChar TeX
10638 4 which might cause bugs that will be even more confusing in \SpecialChar LyX
10642 \begin_layout Standard
10643 In Rev\SpecialChar TeX
10662 The \SpecialChar LyX
10663 equivalent is that there is a separate Thanks layout.
10668 write footnotes in the
10673 or weird things may happen.
10674 See the Rev\SpecialChar TeX
10675 4 documentation for more details.
10678 \begin_layout Standard
10683 \begin_inset space ~
10692 \begin_inset space ~
10702 layouts must be placed
10710 layout and the corresponding
10728 the \SpecialChar LaTeX
10732 \begin_layout Subsection
10734 \change_inserted 564990737 1671042072
10738 \begin_layout Standard
10740 \change_inserted 564990737 1671042072
10745 classes were replaced
10746 \change_deleted -712698321 1673176131
10748 \change_inserted 564990737 1671042072
10749 with a completely new
10750 \change_deleted -712698321 1673175919
10756 This package provides a \SpecialChar LaTeX
10757 class and templates for books to be published at Springer Gabler Research,
10758 Springer Vieweg Research,
10759 Springer Spektrum Research,
10760 Springer VS Research,
10761 or Springer VS Forschung.
10762 The documentation is available in German from
10763 \begin_inset CommandInset href
10766 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
10773 \change_inserted -712698321 1673176125
10780 Please find information at
10781 \begin_inset Flex URL
10784 \begin_layout Plain Layout
10786 \change_inserted -712698321 1673176047
10788 https://www.springernature.com/gp/authors/campaigns/latex-author-support
10796 Native \SpecialChar LyX
10797 support is not available yet.
10798 \change_inserted 564990737 1671042072
10802 \begin_layout Section
10804 \change_inserted 564990737 1670439560
10808 \begin_layout Standard
10810 \change_inserted 564990737 1670439581
10811 See also the document classes in the Collections (section
10812 \begin_inset space ~
10816 \begin_inset CommandInset ref
10818 reference "sec:Collections"
10826 \begin_layout Subsection
10830 \begin_layout Standard
10836 \begin_layout Subsubsection
10840 \begin_layout Standard
10841 Memoir is a very powerful and constantly evolving class.
10842 It has been designed with regard to fictional and non-fictional literature.
10843 Its aim is to let the user have maximum control over the typesetting of his document.
10844 Memoir is based on the standard book class,
10845 but it can also emulate the article class (see below).
10848 \begin_layout Standard
10850 the developer of Memoir,
10851 is known as the author of lots of useful packages in the \SpecialChar LaTeX
10853 Most of them have been merged with Memoir.
10855 it is much easier to layout the table of contents,
10857 chapter designs and such.
10861 does not support all of these goodies natively.
10862 Some of them might be added to forthcoming releases
10866 \begin_layout Plain Layout
10867 You are invited to send suggestions to
10868 \begin_inset Flex URL
10871 \begin_layout Plain Layout
10873 lyx-devel@lists.lyx.org
10884 lots will probably never be supported,
10885 due to the limitations of \SpecialChar LyX
10887 Of course you can still use all features with the help of some native \SpecialChar LaTeX
10888 commands (\SpecialChar TeX
10893 \begin_layout Plain Layout
10898 \begin_layout Plain Layout
10908 \begin_inset space ~
10912 \begin_inset CommandInset ref
10914 reference "sec:Inserting-TeX-Code"
10926 we can only list those features that are natively supported by \SpecialChar LyX
10928 For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
10932 \begin_layout Plain Layout
10937 \begin_layout Plain Layout
10947 \begin_inset Flex URL
10950 \begin_layout Plain Layout
10952 CTAN:/macros/latex/memoir/memman.pdf
10963 which is not only a user guide for the class,
10964 but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
10967 \begin_layout Subsubsection
10968 Basic features and restrictions
10971 \begin_layout Standard
10972 Memoir supports basically all features of the standard book classes.
10979 \begin_layout Description
10981 \begin_inset space ~
10985 Memoir has a broader range of font sizes:
10994 \begin_layout Description
10996 \begin_inset space ~
11000 The fancy page style is not supported,
11001 due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
11002 which confuses \SpecialChar LaTeX
11005 Memoir comes with a number of its own page styles (see
11007 Document\SpecialChar menuseparator
11008 Settings\SpecialChar menuseparator
11010 \begin_inset space ~
11016 If you want to use these for the chapter pages,
11017 you have to use the command
11023 in the main text or in preamble (e.
11024 \begin_inset space \thinspace{}
11028 \begin_inset space \space{}
11035 chapterstyle{companion}
11040 \begin_layout Description
11042 Sectionings (chapter,
11044 subsection etc.) come with an optional argument in the standard classes.
11046 you can specify an alternative version of the title for the table of contents and the headers (for instance,
11047 if the title is too long).
11048 In \SpecialChar LyX
11050 you can do this via
11052 Insert\SpecialChar menuseparator
11054 \begin_inset space ~
11059 at the beginning of a chapter/section.
11060 Memoir features a second optional argument and thus separates the table of contents from the header.
11061 You can define three variants of a title with this:
11062 one for the main text,
11063 one for the table of contents,
11064 and one for the headers.
11066 makes these available in form of specific
11077 \begin_layout Description
11079 In the standard classes (and in many other classes),
11080 the table of contents,
11081 the list of figures and the list of table start a new page automatically.
11082 Memoir does not follow this route.
11083 You have to insert a page break yourself,
11084 if you want to have one.
11087 \begin_layout Description
11089 For some unknown reason,
11090 Memoir uses pagination on the title page (in the standard classes,
11092 \begin_inset Quotes eld
11096 \begin_inset Quotes erd
11100 If you want an empty title page,
11105 aliaspagestyle{title}{empty}
11110 \begin_layout Description
11112 With the class option
11118 Document\SpecialChar menuseparator
11119 Settings\SpecialChar menuseparator
11120 Class Settings\SpecialChar menuseparator
11122 \begin_inset space ~
11128 you can emulate article style.
11130 counters (footnotes,
11132 tables etc.) will not be reset on new chapters,
11133 chapters don't start a new page (but are—
11135 \begin_inset Quotes eld
11139 \begin_inset Quotes erd
11146 use their own page,
11150 \begin_layout Description
11153 Memoir does not allow the use of the deprecated font commands,
11154 which have been used in the old \SpecialChar LaTeX
11156 \begin_inset space \thinspace{}
11160 \begin_inset space \space{}
11177 It produces an error and stops \SpecialChar LaTeX
11178 whenever such a command appears.
11183 reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
11185 Since a lot of packages and particularly Bib\SpecialChar TeX
11186 style files are still using those commands,
11187 we have decided to use this option by default.
11190 \begin_layout Subsubsection
11194 \begin_layout Standard
11195 We will only describe the features supported by \SpecialChar LyX
11196 (which is not much currently).
11197 Please consult the Memoir manual
11201 \begin_layout Plain Layout
11206 \begin_layout Plain Layout
11216 \begin_inset Flex URL
11219 \begin_layout Plain Layout
11221 CTAN:/macros/latex/memoir/memman.pdf
11234 \begin_layout Description
11236 You may wonder why an abstract is an extra feature.
11238 it is in book class.
11239 Usually books don't have abstracts.
11243 You can use it wherever and how often you like.
11246 \begin_layout Description
11248 You may know this older typesetting style:
11249 The contents of a chapter are summarized below the title and also in the table of contents (e.
11250 \begin_inset space \thinspace{}
11254 \begin_inset space \space{}
11259 Our hero arrives in Troia;
11260 he loses some friends;
11264 Chapterprecis does exactly this.
11265 It is therefore only sensible below a chapter.
11268 \begin_layout Description
11270 An epigraph is a smart slogan or motto at the beginning of a chapter.
11271 The epigraph environment provides an elegant way of typesetting such a motto.
11272 The motto itself (text) and its (optional) author (source) are divided by a short line.
11273 The author (source) can be inserted via
11275 Insert\SpecialChar menuseparator
11282 \begin_layout Description
11284 Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
11286 can only support a few of them.
11288 which is a centered title for poems,
11289 which will also be added to the table of contents (verse is the standard environment for poems.
11290 Memoir has some enhanced versions of verse,
11291 but you need to use \SpecialChar TeX
11293 because they have to be nested inside regular verse environments,
11294 which is not possible with \SpecialChar LyX
11298 \begin_layout Description
11301 but it adds no entry to the table of contents.
11304 \begin_layout Subsection
11306 \change_inserted 564990737 1671442175
11310 \begin_layout Standard
11312 \change_inserted 564990737 1671442175
11316 \change_inserted -712698321 1673182264
11318 \change_inserted 564990737 1671442175
11320 \change_deleted -712698321 1673182266
11324 \change_inserted 564990737 1671442175
11328 \change_deleted -712698321 1673182282
11332 \begin_inset space \thinspace{}
11336 \change_inserted 564990737 1671442175
11338 \change_inserted -712698321 1673182287
11340 \change_deleted -712698321 1673182290
11342 \change_inserted 564990737 1671442175
11345 document class but adds two environments:
11348 \begin_layout Description
11350 \change_inserted 564990737 1671442175
11351 Recipe a numbered section environment at the
11355 level which generates a bold centered heading above a double horizontal rule
11358 \begin_layout Description
11360 \change_inserted 564990737 1671442175
11371 are what are being described and the environment ends with a horizontal rule.
11374 \begin_layout Standard
11376 \change_inserted 564990737 1671642866
11379 File\SpecialChar menuseparator
11380 Open Example\SpecialChar menuseparator
11381 Books\SpecialChar menuseparator
11384 illustrates its use.
11387 \begin_layout Standard
11389 \change_deleted -712698321 1673186391
11391 \change_inserted -712698321 1673186393
11393 \change_inserted 564990737 1671442175
11394 is designed for typesetting one or two recipes per page
11395 \change_deleted -712698321 1673199172
11397 with dimensions of 5.5
11398 \begin_inset Quotes qrd
11402 \begin_inset Quotes qrd
11406 \change_inserted 564990737 1671442175
11408 The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient
11409 \change_inserted -712698321 1673186486
11411 \change_deleted -712698321 1673186487
11414 \change_inserted 564990737 1671442175
11416 \change_deleted -712698321 1673199346
11417 and the pages can be joined together or printed 2 per page to normal letterpaper easily.
11418 The size was chosen to work in half-page 3-ring binder cover sheets,
11419 because un-laminated paper just doesn't last in the kitchen.
11422 \begin_layout Standard
11424 \change_deleted -712698321 1673199346
11425 The half-letter pages can be printed two per page using your printer driver,
11426 or bound together using
11428 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
11438 is the compiled version of your recipes.
11439 \change_inserted -712698321 1673175424
11443 \begin_layout Section
11445 \change_inserted 564990737 1671442207
11447 \change_deleted -712698321 1673186818
11449 \change_inserted -712698321 1673186818
11451 \change_inserted 564990737 1671442207
11455 \begin_layout Subsection
11457 \change_inserted 564990737 1671442208
11459 \change_inserted -712698321 1673187876
11461 \change_inserted 564990737 1671442208
11465 \begin_layout Standard
11467 \change_inserted 564990737 1671642942
11469 \change_deleted -712698321 1673187623
11473 \begin_inset space \space{}
11477 \begin_inset space \thinspace{}
11481 \change_inserted 564990737 1671642942
11483 \change_inserted -712698321 1673187655
11485 \change_deleted -712698321 1673187624
11487 \change_inserted 564990737 1671642942
11495 an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
11498 File\SpecialChar menuseparator
11499 Open Example\SpecialChar menuseparator
11500 Curricula Vitae\SpecialChar menuseparator
11502 \change_deleted -712698321 1673187728
11504 \change_inserted 564990737 1671642942
11507 offers guidance on its use.
11508 Its documentation is available from
11509 \begin_inset CommandInset href
11512 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
11520 \begin_layout Subsection
11522 \change_inserted 564990737 1671442208
11524 \change_deleted -712698321 1673187829
11526 \change_inserted -712698321 1673187829
11528 \change_inserted 564990737 1671442208
11532 \begin_layout Standard
11534 \change_inserted 564990737 1671642984
11536 \change_deleted -712698321 1673187820
11540 \begin_inset space \space{}
11544 \begin_inset space \thinspace{}
11548 \change_inserted 564990737 1671642984
11550 \change_inserted -712698321 1673187823
11552 \change_deleted -712698321 1673187824
11554 \change_inserted 564990737 1671642984
11562 an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
11565 File\SpecialChar menuseparator
11566 Open Example\SpecialChar menuseparator
11567 Curricula Vitae\SpecialChar menuseparator
11570 offers guidance on its use.
11571 Its documentation is available from
11572 \begin_inset CommandInset href
11575 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
11583 \begin_layout Subsection
11585 \change_inserted 564990737 1671442208
11587 \change_inserted -712698321 1673187869
11589 \change_inserted 564990737 1671442208
11593 \begin_layout Standard
11595 \change_inserted 564990737 1671643003
11597 \change_deleted -712698321 1673187880
11601 \begin_inset space \space{}
11605 \begin_inset space \thinspace{}
11609 \change_inserted -712698321 1673187880
11611 \change_inserted 564990737 1671643003
11613 \change_inserted -712698321 1673187884
11615 \change_deleted -712698321 1673187884
11617 \change_inserted 564990737 1671643003
11625 This allows the creation of customizable CVs.
11628 File\SpecialChar menuseparator
11629 Open Example\SpecialChar menuseparator
11630 Curricula Vitae\SpecialChar menuseparator
11633 offers guidance on its use.
11634 Its documentation is available from
11635 \begin_inset CommandInset href
11638 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
11646 \begin_layout Subsection
11648 \change_inserted 564990737 1671442208
11650 \change_inserted -712698321 1673187900
11652 \change_inserted 564990737 1671442208
11656 \begin_layout Standard
11658 \change_inserted 564990737 1671643024
11660 \change_deleted -712698321 1673187895
11664 \begin_inset space \space{}
11668 \begin_inset space \thinspace{}
11672 \change_inserted -712698321 1673187895
11674 \change_inserted 564990737 1671643024
11676 \change_inserted -712698321 1673187897
11678 \change_deleted -712698321 1673187898
11680 \change_inserted 564990737 1671643024
11688 originally developed for use with \SpecialChar LyX
11692 File\SpecialChar menuseparator
11693 Open Example\SpecialChar menuseparator
11694 Curricula Vitae\SpecialChar menuseparator
11697 offers guidance on its use.
11698 Its documentation is available from
11699 \begin_inset CommandInset href
11702 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
11710 \begin_layout Section
11712 \change_inserted 564990737 1672652454
11716 \begin_layout Standard
11718 \change_inserted 564990737 1672652455
11720 \change_deleted -712698321 1673245882
11724 \begin_inset space \space{}
11728 \change_inserted -712698321 1673245882
11731 KOMA-Script Letter (V.
11733 \change_inserted 564990737 1672652455
11737 \begin_inset space ~
11741 \begin_inset CommandInset ref
11743 reference "subsec:The-new-letter"
11749 \change_deleted -712698321 1673245908
11753 \begin_inset space \space{}
11756 (with extra font sizes)
11757 \change_inserted -712698321 1673245908
11760 Letter (Standard Class with Extra Font Sizes)
11761 \change_inserted 564990737 1672652455
11765 \begin_inset space ~
11769 \begin_inset CommandInset ref
11771 reference "subsec:Extra-font-sizes"
11776 ) document classes .
11779 \begin_layout Subsection
11781 \change_inserted 564990737 1671041970
11783 \change_deleted -712698321 1673246109
11785 \change_inserted -712698321 1673246110
11787 \change_inserted 564990737 1671041970
11791 \begin_layout Standard
11793 \change_inserted 564990737 1671617528
11797 \change_deleted -712698321 1673246116
11799 \change_inserted -712698321 1673246116
11801 \change_inserted 564990737 1671617528
11805 \change_inserted -712698321 1673246192
11807 \change_inserted 564990737 1671617528
11813 \change_deleted -712698321 1673246242
11815 \change_inserted -712698321 1673246242
11818 \change_inserted 564990737 1671617528
11819 class for writing letters according to the
11820 \change_inserted -712698321 1673246140
11821 standards of the German Standards Institute (
11822 \change_deleted -712698321 1673246141
11824 \change_inserted 564990737 1671617528
11827 Deutsches Institut für Normung
11828 \change_inserted -712698321 1673246324
11831 \change_deleted -712698321 1673246131
11835 \change_inserted 564990737 1671617528
11837 The file in the menu
11842 ile\SpecialChar menuseparator
11844 \begin_inset space ~
11852 \begin_inset space ~
11855 Template\SpecialChar menuseparator
11856 Letters\SpecialChar menuseparator
11859 offers guidance on its use.
11860 The documentation is available from
11861 \begin_inset CommandInset href
11864 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
11872 \begin_layout Subsection
11874 \change_deleted -712698321 1673246778
11876 \change_inserted -712698321 1673246778
11878 \begin_inset space \space{}
11886 \begin_layout Standard
11888 \change_inserted 564990737 1672652499
11892 \begin_inset space \space{}
11898 \change_inserted -712698321 1673246198
11900 \change_inserted 564990737 1672652499
11906 \change_deleted -712698321 1673246247
11908 \change_inserted -712698321 1673246247
11911 \change_inserted 564990737 1672652499
11912 class for writing letters according to French conventions.
11913 The file in the menu
11918 ile\SpecialChar menuseparator
11920 \begin_inset space ~
11928 \begin_inset space ~
11931 Template\SpecialChar menuseparator
11932 Letters\SpecialChar menuseparator
11934 \begin_inset space \space{}
11939 offers guidance on its use.
11940 \change_inserted -712698321 1673246876
11944 \begin_layout Subsection
11946 \change_inserted -712698321 1673246876
11948 \begin_inset space \space{}
11954 \begin_layout Standard
11956 \change_inserted -712698321 1673246917
11960 \begin_inset space \space{}
11965 provides support for
11970 another \SpecialChar LaTeX
11971 class for writing letters,
11972 but also faxes and envelopes,
11974 The file in the menu
11979 ile\SpecialChar menuseparator
11981 \begin_inset space ~
11989 \begin_inset space ~
11992 Template\SpecialChar menuseparator
11993 Letters\SpecialChar menuseparator
11995 \begin_inset space \space{}
12000 offers guidance on its use.
12001 The documentation is available from
12002 \begin_inset CommandInset href
12005 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
12011 \change_inserted 564990737 1672652499
12015 \begin_layout Subsection
12017 \change_inserted 564990737 1672652499
12019 \change_inserted -712698321 1673246804
12021 \begin_inset space \thinspace{}
12025 \change_inserted 564990737 1672652499
12029 \begin_layout Standard
12031 \change_inserted 564990737 1672652499
12035 \begin_inset space \thinspace{}
12041 \change_inserted -712698321 1673246202
12043 \change_inserted 564990737 1672652499
12045 \change_deleted -712698321 1673246498
12047 \change_inserted 564990737 1672652499
12053 \change_deleted -712698321 1673246249
12055 \change_inserted -712698321 1673246249
12058 \change_inserted 564990737 1672652499
12059 class for writing letters in German.
12060 The file in the menu
12065 ile\SpecialChar menuseparator
12067 \begin_inset space ~
12075 \begin_inset space ~
12078 Template\SpecialChar menuseparator
12079 Letters\SpecialChar menuseparator
12081 \begin_inset space \thinspace{}
12086 offers guidance on its use.
12087 The documentation is available from
12088 \begin_inset CommandInset href
12091 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
12099 \begin_layout Subsection
12101 \change_deleted -712698321 1673246462
12105 \begin_layout Standard
12107 \change_deleted -712698321 1673246462
12116 document class for English letters and to create mailing labels.
12117 The file in the menu
12122 ile\SpecialChar menuseparator
12124 \begin_inset space ~
12132 \begin_inset space ~
12135 Template\SpecialChar menuseparator
12136 Letters\SpecialChar menuseparator
12137 Letter (Standard Class)
12139 offers guidance on its use.
12140 \change_inserted 564990737 1671617591
12144 \begin_layout Subsection
12146 \change_deleted -712698321 1673246872
12150 \begin_layout Standard
12152 \change_deleted -712698321 1673246872
12156 \begin_inset space \space{}
12165 document class for writing letters,
12166 faxes and envelopes in French.
12167 The file in the menu
12172 ile\SpecialChar menuseparator
12174 \begin_inset space ~
12182 \begin_inset space ~
12185 Template\SpecialChar menuseparator
12186 Letters\SpecialChar menuseparator
12188 \begin_inset space \space{}
12193 offers guidance on its use.
12194 The documentation is available from
12195 \begin_inset CommandInset href
12198 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
12204 \change_inserted 564990737 1672652527
12208 \begin_layout Section
12210 \change_inserted 564990737 1670439660
12214 \begin_layout Subsection
12216 \change_inserted 564990737 1671458922
12220 \begin_layout Standard
12222 \change_inserted 564990737 1671617655
12224 \change_deleted -712698321 1673255475
12228 \begin_inset space \thinspace{}
12232 \change_inserted -712698321 1673255475
12234 \change_inserted 564990737 1671617655
12236 \change_deleted -712698321 1673255477
12238 \change_inserted 564990737 1671617655
12246 \change_deleted -712698321 1673255496
12248 \change_inserted -712698321 1673255496
12251 \change_inserted 564990737 1671617655
12252 class for creating presentations.
12253 The file in the menu
12258 ile\SpecialChar menuseparator
12260 \begin_inset space ~
12268 \begin_inset space ~
12271 Template\SpecialChar menuseparator
12272 Presentations\SpecialChar menuseparator
12276 \change_inserted -712698321 1673257500
12279 Help\SpecialChar menuseparator
12280 Specific Manuals\SpecialChar menuseparator
12281 Beamer Presentations
12284 \change_inserted 564990737 1671617655
12285 offers guidance on its use.
12286 The documentation is available from
12287 \begin_inset CommandInset href
12290 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
12298 \begin_layout Subsection
12300 \change_deleted -712698321 1673255766
12305 Foil\SpecialChar TeX
12307 \change_deleted -712698321 1673255767
12313 \begin_inset CommandInset label
12322 \begin_layout Standard
12324 \change_inserted 564990737 1672743383
12330 updated by the \SpecialChar LyX
12334 \begin_layout Subsubsection
12336 \change_inserted 564990737 1672743383
12340 \begin_layout Standard
12342 \change_inserted 564990737 1672743396
12344 \change_deleted -712698321 1673255761
12348 \begin_inset space \thinspace{}
12352 \change_inserted 564990737 1672743396
12353 Foil\SpecialChar TeX
12355 \change_deleted -712698321 1673255763
12357 \change_inserted 564990737 1672743396
12364 document class to make slides for overhead projectors.
12365 There are two document classes that can do this:
12367 \change_deleted -712698321 1673256124
12371 \begin_inset space \thinspace{}
12375 \change_inserted -712698321 1673256124
12377 \change_inserted 564990737 1672743396
12379 \change_deleted -712698321 1673256130
12381 \change_inserted 564990737 1672743396
12384 document class (section
12385 \begin_inset space ~
12389 \begin_inset CommandInset ref
12391 reference "sec:slitex"
12401 Foil\SpecialChar TeX
12405 As of 2023 the former has continued to be maintained whereas
12407 Foil\SpecialChar TeX
12410 has not been maintained since 2008.
12411 This section documents the latter.
12412 If your machine doesn’t have the
12413 \change_deleted -712698321 1673256264
12417 \begin_inset space \thinspace{}
12421 \change_inserted 564990737 1672743396
12422 Foil\SpecialChar TeX
12424 \change_deleted -712698321 1673256265
12426 \change_inserted 564990737 1672743396
12429 document class installed,
12430 you’ll probably have to use the
12431 \change_deleted -712698321 1673256271
12435 \begin_inset space \thinspace{}
12439 \change_inserted -712698321 1673256271
12441 \change_inserted 564990737 1672743396
12443 \change_deleted -712698321 1673256273
12445 \change_inserted 564990737 1672743396
12449 If you want to install the
12454 it is available from
12455 \begin_inset CommandInset href
12458 target "https://www.ctan.org/pkg/foiltex"
12464 You should also read the
12466 Installing New Document Classes
12473 \change_deleted 564990737 1672743436
12479 \begin_layout Standard
12481 \change_deleted 564990737 1672743383
12485 \begin_layout Standard
12487 \change_deleted 564990737 1672743383
12488 This section describes how to use \SpecialChar LyX
12489 to make slides for overhead projectors.
12490 There are two document classes that can do this:
12491 the default slides class and the
12493 Foil\SpecialChar TeX
12497 This section documents the latter.
12500 \begin_layout Standard
12502 \change_deleted 564990737 1672743383
12503 I'm going to say this again,
12505 so that there's no misunderstanding:
12508 \begin_layout Standard
12510 \change_deleted 564990737 1672743383
12511 \begin_inset VSpace bigskip
12517 \begin_layout Standard
12520 \change_deleted 564990737 1672743383
12523 This section documents the class
12524 \begin_inset Quotes eld
12532 \begin_inset Quotes erd
12540 \begin_layout Standard
12542 \change_deleted 564990737 1672743383
12543 \begin_inset VSpace bigskip
12549 \begin_layout Standard
12551 \change_deleted 564990737 1672743383
12552 If you're looking for the documentation for
12553 \begin_inset Quotes eld
12561 \begin_inset Quotes erd
12566 \begin_inset space ~
12570 \begin_inset CommandInset ref
12572 reference "sec:slitex"
12578 If your machine doesn't have the
12587 you'll probably have to use the default
12592 which isn't quite as good as
12597 \begin_layout Standard
12599 \change_deleted 564990737 1672743383
12604 class is designed for use with version
12605 \begin_inset space ~
12613 class file which is now an integral part of \SpecialChar LaTeX2e
12619 \begin_layout Subsubsection
12623 \begin_layout Standard
12625 to use this document class,
12637 \begin_inset space ~
12643 There are some settings in the
12646 \begin_inset space ~
12651 dialog that you should know about that are specific to this class:
12654 \begin_layout Itemize
12655 Don't change the options
12666 \begin_inset space ~
12672 They're ignored by the
12679 \begin_layout Itemize
12680 The default font size is 20
12681 \begin_inset space \thinspace{}
12684 pt with the other options being 17
12685 \begin_inset space \thinspace{}
12690 \begin_inset space \thinspace{}
12694 \begin_inset space \thinspace{}
12700 \begin_layout Itemize
12701 The default font is
12709 but all math equations are still typeset in the usual roman font.
12712 \begin_layout Itemize
12715 Foil\SpecialChar TeX
12718 supports A4 and Letter paper sizes as well as a special size for working with 35
12719 \begin_inset space \thinspace{}
12723 It doesn't support A5,
12725 legal or executive paper sizes.
12728 \begin_layout Itemize
12729 Don't bother changing the
12733 settings because they are ignored anyway.
12734 All floats appear where they are defined in the text.
12737 \begin_layout Itemize
12742 setting behaves a bit differently for this class.
12745 Foil\SpecialChar TeX
12748 provides extensive footer and header capabilities including a user-defined logo.
12750 \begin_inset space ~
12754 \begin_inset CommandInset ref
12756 reference "sec:foilfoot"
12762 The title page is treated differently to all other pages in the document and is
12770 has the logo centered at the bottom of the page (if one is defined).
12771 The possible page style choices and what they do are as follows:
12775 \begin_layout Labeling
12776 \labelwidthstring MMMMMMM
12783 The final output contains no page numbers,
12784 or other headers or footers (except footnotes of course).
12788 \begin_layout Labeling
12789 \labelwidthstring MMMMMMM
12796 The final output contains page numbers centered at the bottom of the page.
12797 No other headings or footers (other than footnotes).
12800 \begin_layout Labeling
12801 \labelwidthstring MMMMMMM
12806 Page numbers in lower right corner.
12807 Additional headers and footers are also shown.
12808 This is also the default.
12811 \begin_layout Labeling
12812 \labelwidthstring MMMMMMM
12817 Gives you access to the
12821 package although its use with
12823 Foil\SpecialChar TeX
12826 is discouraged by the writer of the
12828 Foil\SpecialChar TeX
12831 package because of some potential page layout clashes.
12835 \begin_layout Paragraph
12839 \begin_layout Standard
12840 The following options may be used in the extra class options in the
12842 Document\SpecialChar menuseparator
12848 \begin_layout Labeling
12849 \labelwidthstring MMMMMMx
12854 This sets up the page layout for 7.33
12855 \begin_inset space \thinspace{}
12859 \begin_inset space \thinspace{}
12863 which is about the same aspect ratio as a 35
12864 \begin_inset space \thinspace{}
12868 making it a bit easier to work with this medium.
12871 \begin_layout Labeling
12872 \labelwidthstring MMMMMMx
12877 Places a rule across the page below the header on every page except the title page.
12880 \begin_layout Labeling
12881 \labelwidthstring MMMMMMx
12886 Places a rule across the page above the footer on every page except the title page.
12889 \begin_layout Labeling
12890 \labelwidthstring MMMMMMx
12895 This is automatically set each time you create a new
12902 Foil\SpecialChar TeX
12905 to use the dvips driver to rotate those pages that are set as landscape foils.
12908 \begin_layout Labeling
12909 \labelwidthstring MMMMMMx
12914 Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
12915 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.
12916 Note that this option effectively reverses the roles of the
12924 environments (don't worry these are described in the next section).
12927 \begin_layout Labeling
12928 \labelwidthstring MMMMMMx
12933 Equation numbers on the left.
12936 \begin_layout Labeling
12937 \labelwidthstring MMMMMMx
12942 Flush-left equations.
12945 \begin_layout Subsubsection
12946 Supported Environments
12949 \begin_layout Standard
12950 Most of the environments commonly supported in other classes are also supported by the
12951 \change_deleted -712698321 1673256683
12955 \change_inserted -712698321 1673256683
12956 Foil\SpecialChar TeX
12962 There are several additional environments provided by
12964 Foil\SpecialChar TeX
12967 as well as a couple added by \SpecialChar LyX
12969 The following environments are shared with other classes:
12972 \begin_layout Standard
12973 \begin_inset Flex Multiple Columns
12976 \begin_layout Itemize
12982 \begin_layout Itemize
12988 \begin_layout Itemize
12994 \begin_layout Itemize
13000 \begin_layout Itemize
13006 \begin_layout Itemize
13013 \begin_layout Itemize
13019 \begin_layout Itemize
13025 \begin_layout Itemize
13031 \begin_layout Itemize
13035 \change_inserted -712698321 1673256734
13039 \begin_layout Itemize
13045 \begin_layout Itemize
13051 \begin_layout Itemize
13057 \begin_layout Itemize
13063 \begin_layout Itemize
13069 \begin_layout Itemize
13080 \begin_layout Standard
13082 all the major environments apart from the sectioning environments.
13083 Since foils are essentially self-contained sections,
13084 with a title and body,
13087 Foil\SpecialChar TeX
13090 provides specific commands for starting new foils and these are:
13093 \begin_layout Itemize
13099 \begin_layout Itemize
13105 \begin_layout Standard
13107 also provides slightly modified versions of these two environments called:
13110 \begin_layout Itemize
13116 \begin_layout Itemize
13119 ShortRotatefoilhead
13122 \begin_layout Standard
13123 and the differences will be explained in the next section.
13126 \begin_layout Standard
13127 Since foils are often used in presenting ideas or new theorems and such
13129 Foil\SpecialChar TeX
13132 also provides a comprehensive box of goodies for presenting them:
13135 \begin_layout Standard
13136 \begin_inset Flex Multiple Columns
13139 \begin_layout Itemize
13145 \begin_layout Itemize
13151 \begin_layout Itemize
13157 \begin_layout Itemize
13163 \begin_layout Itemize
13169 \begin_layout Itemize
13175 \begin_layout Itemize
13181 \begin_layout Itemize
13187 \begin_layout Itemize
13193 \begin_layout Itemize
13199 \begin_layout Itemize
13210 \begin_layout Standard
13211 The starred versions are unnumbered while the unstarred versions are numbered.
13212 There are also two list environments added by \SpecialChar LyX
13216 \begin_layout Itemize
13222 \begin_layout Itemize
13228 \begin_layout Standard
13231 Foil\SpecialChar TeX
13234 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.
13235 If you want to change these settings in your document the best place to do so is at the very top of a foil,
13237 \begin_inset space \thinspace{}
13243 \begin_inset space \space{}
13248 straight after the foilhead.
13251 \begin_layout Standard
13253 the following command styles are provided [
13260 \begin_layout Standard
13261 \begin_inset Flex Multiple Columns
13264 \begin_layout Itemize
13268 \begin_inset space ~
13274 \begin_layout Itemize
13280 \begin_layout Itemize
13284 \begin_inset space ~
13290 \begin_layout Itemize
13294 \begin_inset space ~
13300 \begin_layout Itemize
13304 \begin_inset space ~
13311 \begin_layout Plain Layout
13312 \begin_inset space ~
13324 \begin_layout Standard
13325 There are also a few commands provided by
13327 Foil\SpecialChar TeX
13330 that aren't directly supported by \SpecialChar LyX
13331 but I'll tell you what they do and how to use them in section
13332 \begin_inset space ~
13336 \begin_inset CommandInset ref
13338 reference "sec:unsuppfoils"
13346 \begin_layout Subsubsection
13347 Building a Set of Foils
13350 \begin_layout Standard
13351 This section will give a simple introduction to using the different environments to build a set of foils.
13352 If you want to see an example set of foils,
13354 \change_deleted 564990737 1671643085
13359 file you find in \SpecialChar LyX
13365 \change_inserted 564990737 1671643099
13368 File\SpecialChar menuseparator
13369 Open Example\SpecialChar menuseparator
13370 Presentations\SpecialChar menuseparator
13378 \begin_layout Paragraph
13379 Give It a Title Page
13382 \begin_layout Standard
13383 Unlike other classes that provide
13403 \change_deleted -712698321 1673256940
13407 \change_inserted -712698321 1673256940
13415 creates the title on a page of its own.
13416 If you leave out the
13420 environment \SpecialChar LaTeX
13421 will substitute the current date (every time you regenerate the output).
13424 \begin_layout Paragraph
13428 \begin_layout Standard
13429 As I mentioned earlier,
13430 there are four ways of starting a new foil.
13431 For portrait foils you should use
13440 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.
13443 \begin_layout Standard
13444 Landscape foils are generated using the
13450 ShortRotatefoilhead
13453 Again the only difference is the spacing between foilhead and body.
13454 Both of the short versions have 0.5
13455 \begin_inset space ~
13458 inches less separation between the foilhead and the body.
13462 \begin_layout Standard
13463 One problem with the support for landscape foils is the requirement that you have to use the
13467 driver to generate the PostScript output otherwise the foils won't be rotated.
13468 It is possible to get landscape foils even if you haven't got the
13472 driver provided you can feed your foils sideways through your printer ;-)
13475 \begin_layout Paragraph
13481 \begin_layout Standard
13482 You can't have two of the same type of these environments directly following each other.
13483 If you use a normal paragraph break,
13485 you will just be extending the previous environment as if you had merged the two environments together.
13487 you need to insert a so-called separator.
13488 Please refer to the section entitled
13499 \begin_layout Paragraph
13503 \begin_layout Standard
13504 You get all the commonly supported list styles found in other classes as well as two new ones.
13505 I'll only describe the new ones here.
13506 If you want to find out more about the other list environments check out the
13511 If you intend to use itemized lists you might also want to read about the
13514 \begin_inset space ~
13518 \begin_inset space ~
13523 dialog described above in section
13524 \begin_inset space ~
13528 \change_inserted 564990737 1671355684
13530 \begin_inset CommandInset ref
13532 reference "chap:bullets"
13538 \change_deleted 564990737 1671355684
13540 \begin_inset CommandInset ref
13542 reference "sec:bullet"
13552 \begin_layout Standard
13553 The two new list styles,
13563 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.
13564 These lists are in fact dedicated variants of the
13569 They do however require that you have the
13573 packages installed.
13576 \begin_layout Paragraph
13580 \begin_layout Standard
13583 Foil\SpecialChar TeX
13586 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.
13587 In fact if you change the float placement settings they are simply ignored.
13590 \begin_layout Paragraph
13591 Page Headers and Footers
13592 \begin_inset CommandInset label
13594 name "sec:foilfoot"
13601 \begin_layout Standard
13605 \begin_inset space ~
13614 are two commands used to control the left-footer text string.
13615 The first is meant to allow you to include a graphic logo on your foils and defaults to
13616 \begin_inset Quotes eld
13621 Foil\SpecialChar TeX
13625 \begin_inset Quotes erd
13629 While the second is meant to provide a classification for the audience,
13633 \begin_inset space \thinspace{}
13639 \begin_inset space \space{}
13643 It is empty by default.
13646 \begin_layout Standard
13647 The remaining page corners can be filled by
13650 \begin_inset space ~
13655 (which defaults to page numbers),
13659 \begin_inset space ~
13667 \begin_inset space ~
13675 \begin_layout Subsubsection
13678 Foil\SpecialChar TeX
13682 \begin_inset CommandInset label
13684 name "sec:unsuppfoils"
13691 \begin_layout Standard
13692 All the commands mentioned below need to be set in a
13702 within another environment.
13705 \begin_layout Paragraph
13709 \begin_layout Standard
13710 All lengths are adjusted using the
13733 should be replaced by the name given to the length you want to change and
13737 is the length value.
13738 All lengths should be specified in units of length such as inches (
13751 ) or relative to some document or font-based length such as
13761 \begin_layout Standard
13762 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
13775 \begin_inset space \space{}
13778 in closer to their bodies put the following in the preamble:
13785 foilheadskip}{-0.5in}
13788 \begin_layout Standard
13789 The spacings around floats can be adjusted by setting these lengths:
13792 \begin_layout Labeling
13793 \labelwidthstring MMMMMMMMMMM
13800 Separation between the text and the top of the float
13803 \begin_layout Labeling
13804 \labelwidthstring MMMMMMMMMMM
13811 Separation between the float and the caption
13814 \begin_layout Labeling
13815 \labelwidthstring MMMMMMMMMMM
13822 Separation between the caption and the following text
13825 \begin_layout Labeling
13826 \labelwidthstring MMMMMMMMMMM
13833 You can make the captions narrower than the surrounding text by adjusting this length.
13834 Best done relative to
13843 \begin_layout Standard
13844 There are also several title page related lengths that you may find useful if you have a long title or several authors:
13847 \begin_layout Labeling
13848 \labelwidthstring MMMMMMMMMMM
13855 Separation from headers to
13860 \begin_layout Labeling
13861 \labelwidthstring MMMMMMMMMMM
13879 \begin_layout Labeling
13880 \labelwidthstring MMMMMMMMMMM
13894 \begin_layout Labeling
13895 \labelwidthstring MMMMMMMMMMM
13911 \begin_layout Labeling
13912 \labelwidthstring MMMMMMMMMMM
13928 \begin_layout Standard
13929 The last length related command affects all the list environments.
13940 a list environment then all the vertical spacing between the list items is removed.
13941 Note that this is a command not a length so it doesn't require
13947 like the stuff mentioned above.
13950 \begin_layout Paragraph
13951 Headers and Footers
13954 \begin_layout Standard
13967 commands control whether the logo in the
13971 definition appear on a given page.
13978 in the preamble then none of the foils will have the logo on them.
13979 If you don't want the logo on a particular page place the
13985 directly after the foilhead of that page and the
13991 directly after the next foilhead.
13994 \begin_layout Standard
13995 If you decide to use the
13999 page style setting in the
14002 \begin_inset space ~
14007 dialog you should probably add
14017 to your preamble so headers and footers on landscape pages are correctly placed when rotated.
14018 This is due to some clashes between the page layouts provided by the
14023 \change_deleted -712698321 1673257120
14027 \change_inserted -712698321 1673257120
14038 \begin_layout Subsection
14040 \change_inserted 564990737 1671459032
14044 \begin_layout Standard
14046 \change_inserted 564990737 1671643165
14048 \change_deleted -712698321 1673257152
14052 \begin_inset space \thinspace{}
14056 \change_inserted -712698321 1673257152
14058 \change_inserted 564990737 1671643165
14060 \change_deleted -712698321 1673257154
14062 \change_inserted 564990737 1671643165
14070 \change_deleted -712698321 1673257280
14072 \change_inserted -712698321 1673257280
14075 \change_inserted 564990737 1671643165
14076 class for creating presentations.
14079 File\SpecialChar menuseparator
14080 Open Example\SpecialChar menuseparator
14081 Presentations\SpecialChar menuseparator
14084 offers guidance on its use.
14085 The documentation is available from
14086 \begin_inset CommandInset href
14089 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
14097 \begin_layout Subsection
14099 \change_inserted 564990737 1671459032
14100 \begin_inset CommandInset label
14102 name "subsec:Seminar"
14111 \begin_layout Standard
14113 \change_inserted 564990737 1671643194
14115 \change_deleted -712698321 1673257295
14119 \begin_inset space \thinspace{}
14123 \change_inserted -712698321 1673257295
14125 \change_inserted 564990737 1671643194
14127 \change_deleted -712698321 1673257296
14129 \change_inserted 564990737 1671643194
14136 document class for creating presentations.
14139 File\SpecialChar menuseparator
14140 Open Example\SpecialChar menuseparator
14141 Presentations\SpecialChar menuseparator
14144 offers guidance on its use.
14145 The documentation is available from
14146 \begin_inset CommandInset href
14149 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
14157 \begin_layout Subsection
14160 Sli\SpecialChar TeX
14164 \begin_inset CommandInset label
14173 \begin_layout Standard
14175 \change_inserted 564990737 1672743492
14181 updated by the \SpecialChar LyX
14185 \begin_layout Subsubsection
14187 \change_inserted 564990737 1672743492
14191 \begin_layout Standard
14193 \change_inserted 564990737 1672743492
14194 This section describes how to use \SpecialChar LyX
14195 to make slides for overhead projectors.
14196 There are two document classes that can do this:
14198 \change_deleted -712698321 1673257697
14202 \begin_inset space \thinspace{}
14206 \change_inserted -712698321 1673257697
14210 \change_inserted 564990737 1672743492
14212 \change_deleted -712698321 1673257698
14216 \change_inserted 564990737 1672743492
14219 document class and the
14220 \change_deleted -712698321 1673257705
14224 \begin_inset space \thinspace{}
14228 \change_inserted 564990737 1672743492
14229 Foil\SpecialChar TeX
14231 \change_deleted -712698321 1673257707
14233 \change_inserted 564990737 1672743492
14237 This section documents the former.
14238 If you’re looking for the documentation for
14239 \change_deleted -712698321 1673257759
14243 \begin_inset space \thinspace{}
14247 \change_inserted 564990737 1672743492
14248 Foil\SpecialChar TeX
14250 \change_deleted -712698321 1673257760
14252 \change_inserted 564990737 1672743492
14257 \begin_inset space ~
14261 \change_inserted -712698321 1673257749
14263 \begin_inset CommandInset ref
14265 reference "sec:foiltex"
14274 \change_deleted -712698321 1673257749
14276 \begin_inset CommandInset ref
14278 reference "sec:Foiltex"
14284 \change_inserted 564990737 1672743492
14287 \change_deleted -712698321 1673257899
14289 \change_inserted -712698321 1673257899
14293 \change_inserted 564990737 1672743492
14296 has continued to be maintained whereas
14298 Foil\SpecialChar TeX
14301 has not been maintained since 2008.
14303 \change_deleted 564990737 1672743492
14311 \begin_layout Standard
14313 \change_deleted 564990737 1672743492
14317 \begin_layout Standard
14319 \change_deleted 564990737 1672743492
14320 This section describes how to use \SpecialChar LyX
14321 to make slides for overhead projectors.
14322 There are two document classes that can do this:
14323 the default slides class and the
14325 Foil\SpecialChar TeX
14329 This section documents the former.
14332 \begin_layout Standard
14334 \change_deleted 564990737 1672743492
14335 I'm going to say this again,
14337 so that there's no misunderstanding:
14340 \begin_layout Standard
14342 \change_deleted 564990737 1672743492
14343 \begin_inset VSpace bigskip
14349 \begin_layout Standard
14352 \change_deleted 564990737 1672743492
14355 This section documents the class
14356 \begin_inset Quotes eld
14364 \begin_inset Quotes erd
14372 \begin_layout Standard
14374 \change_deleted 564990737 1672743492
14375 \begin_inset VSpace bigskip
14381 \begin_layout Standard
14383 \change_deleted 564990737 1672743492
14384 If you're looking for the documentation for
14385 \begin_inset Quotes eld
14390 slides (Foil\SpecialChar TeX
14394 \begin_inset Quotes erd
14399 \begin_inset space ~
14403 \begin_inset CommandInset ref
14405 reference "sec:foiltex"
14416 \begin_inset Quotes eld
14421 slides (Foil\SpecialChar TeX
14425 \begin_inset Quotes erd
14428 ] is actually somewhat better than the default
14436 \begin_layout Plain Layout
14438 or so I've been told repeatedly by its advocates.
14439 Having never used it,
14440 I have no idea if this claim is true or not.
14445 which this section documents.
14448 \begin_layout Standard
14450 \change_deleted 564990737 1672743492
14451 This class is the \SpecialChar LaTeX2e
14452 improvement of the old
14454 Sli\SpecialChar TeX
14458 Every \SpecialChar LaTeX2e
14459 distribution includes this class [which I'll just refer to as
14460 \begin_inset Quotes eld
14468 \begin_inset Quotes erd
14472 so you're bound to have it.
14473 As I noted earlier,
14474 there are other classes,
14480 which also produce slides for overhead projectors and do a better job at it.
14482 there are some things which
14486 can do which the others can't,
14487 such as generate overlays.
14488 Read on to learn more!
14493 \begin_layout Subsubsection
14495 \begin_inset CommandInset label
14497 name "sec:slidesetup"
14504 \begin_layout Standard
14506 to use this document class,
14508 \begin_inset Quotes eld
14512 \change_deleted -712698321 1673257922
14516 \change_inserted -712698321 1673257922
14520 \change_deleted -712698321 1673257925
14526 \begin_inset Quotes erd
14529 from the class list in the
14531 Document\SpecialChar menuseparator
14535 There are some other special things you should know about this class:
14538 \begin_layout Itemize
14539 Don't bother changing the options
14544 They're not supported by the
14545 \change_deleted -712698321 1673257960
14549 \change_inserted -712698321 1673257960
14558 \begin_layout Itemize
14562 \begin_inset space ~
14567 behaves a bit differently for this class.
14568 The possible choices and what they do are as follows:
14572 \begin_layout Description
14577 The final output contains page numbers in the lower right corner.
14580 \begin_layout Description
14590 but also prints out any time markers you've put in.
14591 This is the default.
14594 \begin_layout Description
14599 The final output contains no page numbers,
14601 or alignment markers.
14605 \begin_layout Itemize
14607 \change_deleted -712698321 1673257971
14611 \change_inserted -712698321 1673257971
14616 class has an extra option:
14624 \begin_inset Quotes eld
14632 \begin_inset Quotes erd
14635 in the extra class options.
14639 \begin_layout Standard
14640 Using this options allows you to add time markers to
14646 \begin_inset space ~
14650 \begin_inset CommandInset ref
14652 reference "sec:slideNote"
14661 \begin_layout Standard
14662 You can also use the template file
14663 \change_deleted 564990737 1671617694
14665 \begin_inset Quotes eld
14673 \begin_inset Quotes erd
14678 to automatically set up a document to use the
14683 \change_deleted 564990737 1671617699
14688 File\SpecialChar menuseparator
14690 \begin_inset space ~
14694 \begin_inset space ~
14698 \change_inserted 564990737 1671617723
14699 \SpecialChar menuseparator
14700 Presentations\SpecialChar menuseparator
14705 to open your new document
14706 \change_deleted 564990737 1671617728
14710 The template file also contains some examples of the special paragraph environments used by this class.
14711 I'll describe those next.
14714 \begin_layout Subsubsection
14715 Paragraph Environments
14718 \begin_layout Paragraph
14719 Supported Environments
14722 \begin_layout Standard
14723 The first thing you'll notice when you start up a new
14724 \change_deleted -712698321 1673258063
14728 \change_inserted -712698321 1673258063
14733 document is the font size and type:
14734 it's the equivalent of the size
14735 \begin_inset Quotes eld
14743 \begin_inset Quotes erd
14749 \begin_inset space ~
14755 This is also what's used in the output.
14757 \begin_inset Quotes eld
14761 \begin_inset Quotes erd
14764 to remind you that this is a slide.
14765 Your final slides will use a larger font;
14767 you'll have less space.
14769 the larger default screen font isn't WYSIWYG,
14773 \begin_layout Standard
14774 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
14775 Most of the paragraph environments you're used to seeing are missing.
14776 There are also five new ones.
14778 \change_deleted -712698321 1673258093
14782 \change_inserted -712698321 1673258093
14787 class itself only supports certain paragraph environments:
14790 \begin_layout Standard
14792 \change_inserted -712698321 1673258082
14795 \begin_inset Flex Multiple Columns
14798 \begin_layout Itemize
14800 \change_inserted -712698321 1673258082
14806 \begin_layout Itemize
14808 \change_inserted -712698321 1673258082
14814 \begin_layout Itemize
14816 \change_inserted -712698321 1673258082
14822 \begin_layout Itemize
14824 \change_inserted -712698321 1673258082
14830 \begin_layout Itemize
14832 \change_inserted -712698321 1673258082
14838 \begin_layout Itemize
14840 \change_inserted -712698321 1673258082
14846 \begin_layout Itemize
14848 \change_inserted -712698321 1673258082
14854 \begin_layout Itemize
14856 \change_inserted -712698321 1673258082
14862 \begin_layout Itemize
14864 \change_inserted -712698321 1673258082
14870 \begin_layout Itemize
14872 \change_inserted -712698321 1673258082
14884 \change_deleted -712698321 1673258082
14888 \begin_layout Itemize
14890 \change_deleted -712698321 1673258082
14896 \begin_layout Itemize
14898 \change_deleted -712698321 1673258082
14904 \begin_layout Itemize
14906 \change_deleted -712698321 1673258082
14912 \begin_layout Itemize
14914 \change_deleted -712698321 1673258082
14920 \begin_layout Itemize
14922 \change_deleted -712698321 1673258082
14928 \begin_layout Itemize
14930 \change_deleted -712698321 1673258082
14936 \begin_layout Itemize
14938 \change_deleted -712698321 1673258082
14944 \begin_layout Itemize
14946 \change_deleted -712698321 1673258082
14952 \begin_layout Itemize
14954 \change_deleted -712698321 1673258082
14963 \begin_layout Standard
14964 All of the other standard environments,
14965 including the section-heading environments,
14967 \change_deleted -712698321 1673258102
14971 \change_inserted -712698321 1673258102
14979 \begin_layout Standard
14981 you'll notice the following new environments:
14984 \begin_layout Standard
14986 \change_inserted -712698321 1673258111
14989 \begin_inset Flex Multiple Columns
14992 \begin_layout Itemize
14994 \change_inserted -712698321 1673258111
15000 \begin_layout Itemize
15002 \change_inserted -712698321 1673258111
15008 \begin_layout Itemize
15010 \change_inserted -712698321 1673258111
15016 \begin_layout Itemize
15018 \change_inserted -712698321 1673258111
15024 \begin_layout Itemize
15026 \change_inserted -712698321 1673258119
15033 \begin_layout Plain Layout
15035 \change_inserted -712698321 1673258133
15036 \begin_inset space ~
15048 \change_deleted -712698321 1673258111
15052 \begin_layout Itemize
15054 \change_deleted -712698321 1673258111
15060 \begin_layout Itemize
15062 \change_deleted -712698321 1673258111
15068 \begin_layout Itemize
15070 \change_deleted -712698321 1673258111
15076 \begin_layout Itemize
15078 \change_deleted -712698321 1673258111
15086 \begin_layout Standard
15087 These five are kind of quirky,
15089 \begin_inset Quotes eld
15093 \begin_inset Quotes erd
15096 in \SpecialChar LyX
15100 doesn't permit you to nest any other paragraph environment into an empty environment.
15102 that's fine and dandy,
15103 but it means that you wouldn't be able to start a slide with anything except plain text.
15105 I've performed a little
15106 \begin_inset Quotes eld
15111 \begin_inset Quotes erd
15117 \begin_layout Paragraph
15118 Quirks of the New Environments
15119 \begin_inset CommandInset label
15121 name "sec:slideQuirk"
15128 \begin_layout Standard
15129 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
15131 As I just mentioned,
15133 forbids environments that begin with another environment.
15134 To get around this,
15139 environment isn't a paragraph environment as described in the
15147 \begin_layout Standard
15148 You should consider
15163 \begin_inset Quotes eld
15166 pseudo-environments.
15167 \begin_inset Quotes erd
15170 They look like a section heading or a
15171 \begin_inset Quotes eld
15179 \begin_inset Quotes erd
15182 but really begin a [and,
15184 end the previous] paragraph environment.
15195 \begin_inset Quotes eld
15199 \begin_inset Quotes erd
15202 These two perform some action.
15205 \begin_layout Standard
15206 A common feature of all five environments,
15231 is a rather long-ish label.
15232 The text following this label —
15233 ordinarily the contents of the paragraph environment —
15234 is utterly irrelevant for
15259 completely ignores it.
15261 you can leave these five environments completely empty.
15265 \begin_layout Standard
15270 to put any text after the rather long-ish label,
15272 This could be a short description of the contents of the
15279 enter your descriptive comment and hit
15283 as you normally would.
15286 \begin_layout Standard
15288 \change_deleted -712698321 1673258321
15291 you don't want to enter any descriptive text,
15292 you'll hit another \SpecialChar LyX
15298 and will not let you start a new paragraph environment until you put something in the old one.
15303 \begin_layout Itemize
15305 \change_deleted -712698321 1673258321
15306 Start entering the text that will
15337 \begin_layout Itemize
15339 \change_deleted -712698321 1673258321
15340 Now move to the beginning of that paragraph.
15344 \begin_layout Itemize
15346 \change_deleted -712698321 1673258321
15356 \begin_layout Itemize
15358 \change_deleted -712698321 1673258321
15361 empty paragraph to a
15388 \begin_layout Standard
15390 \change_deleted -712698321 1673258321
15391 Some future version of \SpecialChar LyX
15394 resolve this quirkiness\SpecialChar ldots
15400 \begin_layout Subsubsection
15401 Making a Presentation with
15415 \begin_layout Paragraph
15423 \begin_layout Standard
15424 If you're expecting this section to teach you how to actually make a presentation,
15425 you'll be sorely disappointed.
15427 I'll describe all of the ways the
15428 \change_deleted -712698321 1673258368
15432 \change_inserted -712698321 1673258368
15437 class can assist you in preparing the materials for a presentation.
15438 Filling in the contents,
15446 the \SpecialChar LyX
15450 \begin_layout Standard
15455 environment [in the manner described in section
15456 \begin_inset space ~
15460 \begin_inset CommandInset ref
15462 reference "sec:slideQuirk"
15467 ] tells \SpecialChar LyX
15468 to begin a new slide [duh].
15469 The label for this environment/
15470 \change_inserted -712698321 1673258390
15472 \begin_inset Quotes eld
15476 \change_deleted -712698321 1673258391
15478 \begin_inset Quotes erd
15484 \begin_inset Quotes erd
15488 \begin_inset Quotes eld
15492 \begin_inset Quotes erd
15496 followed by the label,
15498 \begin_inset Quotes eld
15502 \begin_inset Quotes erd
15506 Any text or paragraph environments that follow this one go on the new slide.
15510 \begin_layout Standard
15511 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
15512 (this can be specified in the
15519 once you finish entering the contents of one slide.
15520 If you've entered more text than can physically fit on a slide,
15521 the extra overflows onto a new slide.
15522 I don't recommend doing this,
15524 since the overflow slide won't have any page number on it.
15526 it may interfere with any
15530 you've made to accompany the oversized
15537 \begin_layout Standard
15546 environments work the same way as the
15551 They both create an
15552 \begin_inset Quotes eld
15556 \begin_inset Quotes erd
15559 followed by a label [
15560 \begin_inset Quotes eld
15564 \begin_inset Quotes erd
15568 \begin_inset Quotes eld
15572 \begin_inset Quotes erd
15577 The color is a stunning magenta instead of blue,
15579 \begin_inset Quotes eld
15583 \begin_inset Quotes erd
15586 will look different,
15587 in style and in length.
15588 The label fonts of all three also differ from one another.
15591 \begin_layout Standard
15597 if the contents of a
15605 exceed the physical size of a slide or sheet of paper,
15606 the extra will overflow onto a new sheet.
15608 you should avoid this.
15609 It defeats the whole purpose of
15620 \begin_layout Paragraph
15630 \begin_layout Standard
15635 is a slide that sits atop another slide.
15636 Perhaps you wish to discuss a figure on the main
15640 before displaying the text associated with it.
15641 One way to accomplish this is tape a flap of dark paper over the part of the
15645 you want to display later.
15648 if you wish to overlap one graph with another,
15650 You would then have to fumble while speaking to align the two separate,
15655 s to align the two graphs.
15660 environment in both cases makes life much easier.
15663 \begin_layout Standard
15668 receives the page number of its
15669 \begin_inset Quotes eld
15673 \begin_inset Quotes erd
15682 \begin_inset Quotes eld
15690 \begin_inset Quotes erd
15697 \begin_layout Plain Layout
15704 \begin_inset Quotes eld
15712 \begin_inset Quotes erd
15717 \begin_inset Quotes eld
15725 \begin_inset Quotes erd
15730 \begin_inset Quotes eld
15738 \begin_inset Quotes erd
15743 \begin_inset space ~
15746 appended to the page number of the parent
15757 you want the contents of both the
15765 to each fit on a single physical slide!
15766 You should probably consider an
15771 \begin_inset Quotes eld
15775 \begin_inset Quotes erd
15784 the \SpecialChar LyX
15789 class provides a visual cue for this:
15790 the label at the start of an
15794 is shorter than that at the start of a
15800 when you generate printable output,
15801 you'll find alignment markers in all four corners of both the
15805 page and its parent
15810 These will assist you in lining up the two physical slides.
15813 \begin_layout Standard
15814 The major problem in overlaying two slides is aligning the contents of the two transparencies.
15815 How much space should you leave for that graph on the second slide?
15817 what if you want a graph and a sentence on second slide,
15818 but there is text on the main transparency that goes in between them?
15819 You could try and insert vertical space of the right size.
15820 The better way is to use
15831 \begin_layout Standard
15832 As their names imply,
15841 are two command-like paragraph environments that make all subsequent text invisible and visible,
15844 \begin_inset space ~
15848 \begin_inset CommandInset ref
15850 reference "sec:slideQuirk"
15855 that you don't place anything
15859 these two environments,
15866 it inserts a centered,
15867 sky-blue label into the page reading
15868 \begin_inset Quotes eld
15871 <Invisible Text Follows>
15872 \begin_inset Quotes erd
15876 For paragraphs following this label,
15886 it doesn't matter which] where they would be contain instead blank space.
15890 \begin_layout Standard
15896 the corresponding centered label is
15897 \begin_inset Quotes eld
15900 <Visible Text Follows>
15901 \begin_inset Quotes erd
15905 Paragraphs following this label behave normally.
15906 Note that the beginning of a new
15920 automatically shuts off an
15925 It's therefore not necessary to use
15936 \begin_layout Standard
15938 it should be obvious how to create overlay transparencies using the proper combination of
15957 \begin_layout Enumerate
15963 including everything that will appear on it,
15964 whether on the main slide or on the
15971 \begin_layout Enumerate
15972 Before each figure or paragraph that will appear only on the
15987 environment after the
15994 \begin_layout Enumerate
15999 immediately following the
16006 \begin_layout Enumerate
16007 Copy the contents of this
16018 \begin_layout Enumerate
16035 \begin_layout Standard
16037 You've just made an
16044 \begin_layout Standard
16045 There's one problem with the way I've designed the \SpecialChar LyX
16051 you can't make text in the middle of a paragraph invisible,
16052 nor make text in the middle of an invisible paragraph visible again.
16053 To accomplish this feat,
16054 you'll need to use some inlined \SpecialChar LaTeX
16059 \begin_layout Plain Layout
16060 The commands of interest are:
16064 \begin_layout Itemize
16069 invisible \SpecialChar ldots
16073 \begin_layout Itemize
16078 visible \SpecialChar ldots
16082 \begin_layout Plain Layout
16084 and need to be marked as \SpecialChar TeX
16087 \begin_inset Quotes eld
16091 \begin_inset Quotes erd
16094 you wish to change goes in between the brackets [and after the
16107 If you don't know how to mark text as \SpecialChar TeX
16109 see the appropriate section of the
16121 \begin_layout Paragraph
16131 \begin_inset CommandInset label
16133 name "sec:slideNote"
16140 \begin_layout Standard
16150 is associated with a
16151 \begin_inset Quotes eld
16155 \begin_inset Quotes erd
16165 the \SpecialChar LyX
16170 class provides visual cues.
16175 is shorter than that of a
16179 [yet longer than that of an
16184 like the label of an
16188 is shockingly magenta.
16194 has the page number of its
16195 \begin_inset Quotes eld
16199 \begin_inset Quotes erd
16208 \begin_inset Quotes eld
16216 \begin_inset Quotes erd
16221 \begin_inset Quotes eld
16229 \begin_inset Quotes erd
16234 \begin_inset Quotes eld
16242 \begin_inset Quotes erd
16247 You can have multiple
16251 s associated with a single
16266 you'll probably want to break up long
16270 s so that they fit on a single sheet of paper.
16273 \begin_layout Standard
16279 it contains anything additional you might want to say about a
16284 It could also be used as a sheet of reminders for a particular
16289 In the case of the latter,
16290 you might want to make use of time markers.
16292 the \SpecialChar LyX
16298 \begin_inset Quotes eld
16302 \begin_inset Quotes erd
16305 support for time markers,
16308 Sli\SpecialChar TeX
16313 you'll have to resort to using the \SpecialChar LaTeX
16317 \begin_layout Standard
16318 To use time markers,
16319 you'll need to specify the extra class option
16320 \begin_inset Quotes eld
16328 \begin_inset Quotes erd
16332 \begin_inset space ~
16336 \begin_inset CommandInset ref
16338 reference "sec:slidesetup"
16344 This option turns on timing marks,
16345 which will appear in the lower-left-hand corner of every
16350 To set what appears in the time marker,
16351 you use the \SpecialChar LaTeX
16353 \begin_inset Quotes eld
16363 \begin_inset Quotes erd
16367 \begin_inset Quotes eld
16377 \begin_inset Quotes erd
16381 The arguments of both commands are time measured in seconds.
16383 \begin_inset Quotes eld
16393 \begin_inset Quotes erd
16396 sets the time marker to a given time.
16398 \begin_inset Quotes eld
16408 \begin_inset Quotes erd
16411 increments the time marker by the specified amount.
16412 Using time markers and
16417 you can remind yourself how much time to spend on a particular
16424 \begin_layout Standard
16425 There's one last feature to describe.
16427 you'd like to print out all of your
16435 s on transparencies while printing all of your
16453 with which it is associated.
16454 What's a person to do?
16457 \begin_layout Standard
16459 there are two \SpecialChar LaTeX
16460 commands that allow you to select what to print out.
16461 Both must be placed into the preamble of your document.
16463 \begin_inset Quotes eld
16475 \begin_inset Quotes erd
16478 will cause the output to contain only the
16489 \begin_inset Quotes eld
16501 \begin_inset Quotes erd
16504 prevents the output of anything but
16509 I'd advise placing both commands in the preamble and initially comment both out.
16510 You can then preview your entire presentation as you write.
16511 When you're done writing,
16512 you can then uncomment one of the two to select what you want to print.
16513 I like to uncomment
16514 \begin_inset Quotes eld
16526 \begin_inset Quotes erd
16530 print to a file with
16531 \begin_inset Quotes eld
16539 \begin_inset Quotes erd
16543 comment it back out,
16545 \begin_inset Quotes eld
16557 \begin_inset Quotes erd
16561 \begin_inset Quotes eld
16569 \begin_inset Quotes erd
16573 I can then send either file to a printer,
16574 loading transparencies or plain paper as appropriate.
16577 \begin_layout Standard
16578 You can also provide other arguments to the
16579 \begin_inset Quotes eld
16589 \begin_inset Quotes erd
16593 \begin_inset Quotes eld
16603 \begin_inset Quotes erd
16607 See a good \SpecialChar LaTeX
16611 \begin_layout Subsubsection
16616 Class Template File
16619 \begin_layout Standard
16620 I have also provided a template file
16621 \change_deleted 564990737 1671617750
16624 \begin_inset Quotes eld
16632 \begin_inset Quotes erd
16644 begin your new presentation with
16646 File\SpecialChar menuseparator
16648 \begin_inset space ~
16652 \begin_inset space ~
16656 \change_inserted 564990737 1671616988
16657 \SpecialChar menuseparator
16658 Presentations\SpecialChar menuseparator
16664 Your new \SpecialChar LyX
16665 presentation file will contain an example
16686 additionally contain an example of the use of
16696 the preamble will contain:
16699 \begin_layout LyX-Code
16700 % Uncomment to print out only slides and overlays
16703 \begin_layout LyX-Code
16707 \begin_layout LyX-Code
16713 \begin_inset Newline newline
16719 \begin_layout LyX-Code
16720 % Uncomment to print out only notes
16723 \begin_layout LyX-Code
16727 \begin_layout LyX-Code
16735 \begin_layout Standard
16737 I created this class to support the \SpecialChar LaTeX2e
16739 \begin_inset Quotes eld
16744 Sli\SpecialChar TeX
16748 \begin_inset Quotes erd
16752 one of the built-in \SpecialChar LaTeX2e
16754 Neither I nor the rest of the \SpecialChar LyX
16755 Team endorse or oppose the use of this built-in slide class.
16756 It's here if you want it or need it.
16757 There exist other \SpecialChar LaTeX2e
16758 classes for creating presentations,
16760 \change_deleted -712698321 1673258708
16768 \change_deleted -712698321 1673258709
16770 \change_inserted -712698321 1673258699
16772 \change_deleted -712698321 1673258700
16776 \begin_inset space ~
16780 \begin_inset CommandInset ref
16782 reference "sec:foiltex"
16788 \change_deleted -712698321 1673258703
16790 \change_inserted -712698321 1673258705
16794 \change_deleted -712698321 1673258714
16796 \begin_inset Quotes eld
16804 \begin_inset Quotes erd
16807 package [present on some \SpecialChar TeX
16809 The latter is not yet supported under \SpecialChar LyX
16814 \begin_layout Plain Layout
16815 Perhaps you can take on the task\SpecialChar ldots
16822 \change_inserted -712698321 1673258738
16828 \begin_inset space ~
16832 \begin_inset CommandInset ref
16834 reference "subsec:Seminar"
16846 \change_deleted -712698321 1673258749
16847 I know nothing about these other classes.
16850 Try them out to see what sort of alternative they provide.
16853 \begin_layout Section
16855 \change_inserted 564990737 1670439661
16859 \begin_layout Subsection
16861 \change_inserted 564990737 1670439661
16865 \begin_layout Standard
16867 \change_inserted -712698321 1673689969
16868 Report classes are sort of a hybrid between book and article classes:
16871 \change_deleted -712698321 1673689899
16880 document class for preparing reports.
16887 \change_inserted 564990737 1670439661
16889 \change_deleted -712698321 1673689904
16891 \change_inserted 564990737 1670439661
16893 chapters and sections but does not provide
16894 \change_deleted -712698321 1673690062
16895 the paragraph styles needed for a book
16896 \change_inserted -712698321 1673690073
16900 \change_inserted 564990737 1670439661
16903 \change_deleted -712698321 1673690088
16909 \change_inserted -712698321 1673690083
16911 \change_inserted 564990737 1670439661
16913 \change_inserted -712698321 1673690085
16915 \change_inserted 564990737 1670439661
16918 \change_deleted -712698321 1673690094
16920 \change_inserted -712698321 1673690094
16922 \change_inserted 564990737 1670439661
16924 \change_deleted -712698321 1673690097
16926 \change_inserted 564990737 1670439661
16928 \change_deleted -712698321 1673690101
16930 \change_inserted 564990737 1670439661
16931 abstract paragraph style
16932 \change_inserted -712698321 1673690514
16933 s and are one-sided by default.
16935 \change_deleted -712698321 1673690134
16939 \change_inserted -712698321 1673690520
16942 \change_inserted 564990737 1670439661
16943 not start a new chapter on the right hand page
16944 \change_inserted -712698321 1673690150
16945 (even in two-side mode)
16946 \change_inserted 564990737 1670439661
16950 \begin_layout Standard
16952 \change_deleted -712698321 1673690173
16954 \change_inserted -712698321 1673690287
16955 All externally maintained
16956 \change_inserted 564990737 1672743528
16962 \change_inserted -712698321 1673690678
16963 that are officially supported by \SpecialChar LyX
16965 \change_inserted 564990737 1672743528
16966 are described in the Collections (section
16967 \begin_inset space ~
16971 \begin_inset CommandInset ref
16973 reference "sec:Collections"
16979 \change_inserted -712698321 1673690301
16981 \change_deleted -712698321 1673690300
16983 \change_inserted 564990737 1672743528
16987 \begin_layout Itemize
16989 \change_inserted 564990737 1672743530
16991 \change_deleted -712698321 1673690794
16995 \begin_inset space \thinspace{}
16998 (Japanese in vertical writing)
16999 \change_inserted -712698321 1675851188
17000 Japanese Report (Standard Class,
17002 \change_inserted 564990737 1672743530
17006 \change_deleted -712698321 1673690762
17010 \begin_inset space \thinspace{}
17014 \change_inserted -712698321 1673690762
17015 Japanese Report (Standard Class)
17016 \change_inserted 564990737 1672743530
17021 \begin_inset space ~
17025 \begin_inset CommandInset ref
17027 reference "subsec:Japanese"
17035 \begin_layout Itemize
17037 \change_inserted 564990737 1672743530
17039 \change_deleted -712698321 1673690718
17043 \begin_inset space \thinspace{}
17047 \change_inserted -712698321 1673690718
17049 \change_inserted 564990737 1672743530
17054 \begin_inset space ~
17058 \begin_inset CommandInset ref
17060 reference "subsec:KOMA-Script"
17068 \begin_layout Itemize
17070 \change_inserted 564990737 1672743530
17072 \change_deleted -712698321 1673690815
17076 \begin_inset space \thinspace{}
17079 (with extra font sizes)
17080 \change_inserted -712698321 1673690815
17081 Report (Standard Class with Extra Font Sizes)
17082 \change_inserted 564990737 1672743530
17087 \begin_inset space ~
17091 \begin_inset CommandInset ref
17093 reference "subsec:Extra-font-sizes"
17101 \begin_layout Itemize
17103 \change_inserted 564990737 1672743569
17105 \change_deleted -712698321 1673690833
17109 \begin_inset space \thinspace{}
17112 (Polish version by M.
17113 \begin_inset space \thinspace{}
17117 \change_inserted -712698321 1673690833
17118 Polish Report (MW Bundle)
17119 \change_inserted 564990737 1672743569
17124 \begin_inset space ~
17128 \begin_inset CommandInset ref
17130 reference "subsec:Polish-M.W.collection"
17141 \begin_layout Section
17143 \change_inserted 564990737 1670439674
17145 \change_deleted -712698321 1673691106
17147 \change_inserted -712698321 1673691108
17151 \begin_layout Standard
17153 \change_inserted -712698321 1673691276
17159 we assemble document classes that help to write drama or movie scripts.
17160 The category is also open for other scripts,
17161 such as lecture scripts,
17162 for which no classes are officially supported yet by \SpecialChar LyX
17164 \change_inserted 564990737 1670439674
17168 \begin_layout Subsection
17172 \begin_layout Standard
17178 \begin_layout Subsubsection
17182 \begin_layout Standard
17187 is for writing plays.
17188 The format is more decorative than
17191 \change_inserted -712698321 1673691568
17195 \begin_inset space ~
17199 \begin_inset CommandInset ref
17201 reference "subsec:Hollywood"
17208 and much less standardized.
17209 This format should be suitable for workshops.
17212 \begin_layout Subsubsection
17216 \begin_layout Standard
17220 \change_inserted -712698321 1673691609
17224 \begin_inset space ~
17228 \begin_inset CommandInset ref
17230 reference "subsec:Special-problems-Hollywood"
17239 \begin_layout Subsubsection
17243 \begin_layout Standard
17248 names as labels then cross-reference the label to insert the name.
17249 The cross-reference dialog will show the current cast of characters.
17252 \begin_layout Subsubsection
17253 Paper size and Margins
17256 \begin_layout Standard
17264 \begin_layout Subsubsection
17268 \begin_layout Standard
17269 The following environments are available.
17274 to get the bind keys shown at the right.
17277 \begin_layout Itemize
17281 \begin_inset Newline newline
17286 You should not have to use this,
17287 but it is here for anything that does not fit otherwise.
17290 \begin_layout Itemize
17294 \begin_inset space \hfill{}
17298 \begin_inset Newline newline
17303 Used to describe stage setting and the action.
17304 First use of speaker names in all CAPs.
17307 \begin_layout Itemize
17311 \begin_inset space \hfill{}
17315 \begin_inset Newline newline
17320 Automatically numbered.
17321 On screen it will be arabic,
17322 but will print as Roman.
17325 \begin_layout Itemize
17329 \begin_inset space \hfill{}
17333 \begin_inset Newline newline
17343 It is just centered text.
17346 \begin_layout Itemize
17350 \begin_inset space \hfill{}
17354 \begin_inset Newline newline
17359 Not automatically numbered.
17360 You supply the number.
17361 This is because I couldn't figure out how.
17364 \begin_layout Itemize
17368 \begin_inset space \hfill{}
17372 \begin_inset Newline newline
17377 A special case of Narrative to describe the setting and action as the curtain rises.
17380 \begin_layout Itemize
17384 \begin_inset space \hfill{}
17388 \begin_inset Newline newline
17393 The speaker's (actor's) title,
17394 centered in all CAPS.
17397 \begin_layout Itemize
17401 \begin_inset space \hfill{}
17405 \begin_inset Newline newline
17410 Instructions to the speaker.
17411 The parentheses are automatically inserted.
17412 The ( will appear on screen,
17413 but both will be in the printed play.
17414 This environment is only used within
17421 \begin_layout Itemize
17425 \begin_inset space \hfill{}
17429 \begin_inset Newline newline
17434 What the Speaker says.
17437 \begin_layout Itemize
17441 \begin_inset space \hfill{}
17445 \begin_inset Newline newline
17450 The curtain comes down.
17453 \begin_layout Itemize
17457 \begin_inset space \hfill{}
17463 \begin_layout Itemize
17467 \begin_inset space \hfill{}
17473 \begin_layout Itemize
17477 \begin_inset space \hfill{}
17483 \begin_layout Standard
17487 \begin_layout Subsection
17489 \change_inserted -712698321 1673691551
17490 \begin_inset CommandInset label
17492 name "subsec:Hollywood"
17498 Hollywood (Hollywood spec scripts)
17501 \begin_layout Standard
17507 \begin_layout Subsubsection
17511 \begin_layout Standard
17512 Getting the format of a Hollywood script right is a
17513 \begin_inset Quotes eld
17517 \begin_inset Quotes erd
17520 It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
17521 Each page of a script should be one minute of film.
17522 Nothing goes in a script that you cannot see or hear on screen.
17523 The courier 12 pt font should be used throughout.
17527 \begin_layout Subsubsection
17529 \change_inserted -712698321 1673691597
17530 \begin_inset CommandInset label
17532 name "subsec:Special-problems-Hollywood"
17541 \begin_layout Standard
17542 Speakers' lines should
17543 \change_deleted -712698321 1673691805
17547 \change_inserted -712698321 1673691805
17552 break in mid-sentence.
17553 If a speaker's lines continue over a page break,
17558 title followed by (Cont'd).
17561 \begin_layout Subsubsection
17565 \begin_layout Standard
17570 names as labels then cross-reference the label to insert the name.
17571 The cross-reference dialog will show the current cast of characters.
17572 You can use this to insert the speaker name in narratives also.
17575 \begin_layout Subsubsection
17576 Paper size and Margins
17579 \begin_layout Standard
17587 \begin_layout Subsubsection
17591 \begin_layout Standard
17592 The following environments are available.
17597 to get the bind keys shown at the right.
17600 \begin_layout Itemize
17604 \begin_inset Newline newline
17609 Used where nothing else works.
17613 \begin_layout Itemize
17619 \begin_inset space \hfill{}
17627 \begin_inset Newline newline
17630 Usually followed by something like
17631 \begin_inset Quotes eld
17634 on Sally waking up.
17635 \begin_inset Quotes erd
17641 \begin_layout Itemize
17645 \begin_inset space \hfill{}
17649 \begin_inset Newline newline
17654 Introduces a new INTERIOR camera set-up.
17655 Always followed by DAY or NIGHT,
17656 or something similar to define the lighting required.
17657 Everthing on this line in CAPS.
17660 \begin_layout Itemize
17664 \begin_inset space \hfill{}
17668 \begin_inset Newline newline
17673 Introduces a new EXTERIOR camera set-up.
17674 Everthing on this line in CAPS.
17677 \begin_layout Itemize
17681 \begin_inset space \hfill{}
17685 \begin_inset Newline newline
17690 The character speaking.
17693 \begin_layout Itemize
17697 \begin_inset space \hfill{}
17701 \begin_inset Newline newline
17706 Instructions to the speaker.
17707 The () are automatically inserted.
17710 \begin_layout Itemize
17714 \begin_inset space \hfill{}
17718 \begin_inset Newline newline
17730 \begin_layout Itemize
17734 \begin_inset space \hfill{}
17738 \begin_inset Newline newline
17743 Camera movement instruction.
17745 \begin_inset space \thinspace{}
17749 \begin_inset space \space{}
17755 \begin_layout Itemize
17759 \begin_inset space \hfill{}
17765 \begin_layout Itemize
17769 \begin_inset space \hfill{}
17775 \begin_layout Itemize
17779 \begin_inset space \hfill{}
17785 \begin_layout Itemize
17789 \begin_inset space \hfill{}
17795 \begin_layout Subsubsection
17799 \begin_layout Itemize
17804 \begin_layout Itemize
17809 \begin_layout Itemize
17811 \begin_inset space \thinspace{}
17819 \begin_layout Itemize
17825 \begin_layout Itemize
17830 \begin_layout Itemize
17835 \begin_layout Chapter
17837 \change_inserted 564990737 1671185876
17841 \begin_layout Section
17843 \change_inserted 564990737 1671716212
17844 Academic Field Specifics
17847 \begin_layout Subsection
17849 \change_inserted 564990737 1671716212
17851 Hazard and Precautionary Statements
17854 \begin_layout Standard
17856 \change_inserted 564990737 1671716212
17857 This module provides two insets
17858 \change_inserted -712698321 1673779038
17859 and a paragraph style
17860 \change_inserted 564990737 1671716212
17861 to typeset numbers and phrases of chemical hazard and precautionary statements.
17862 For a description see
17864 File\SpecialChar menuseparator
17865 Open Example\SpecialChar menuseparator
17866 Modules\SpecialChar menuseparator
17867 Hazard and Precautionary Statements
17871 Help\SpecialChar menuseparator
17872 Specific Manuals\SpecialChar menuseparator
17873 Hazard and Precautionary Statements
17878 \begin_layout Subsection
17880 \change_inserted 564990737 1671716212
17884 Risk and Safety Statements
17887 \begin_layout Standard
17889 \change_inserted 564990737 1671716212
17890 This module provides two insets,
17900 accessible via the menu
17905 nsert\SpecialChar menuseparator
17907 \begin_inset space ~
17912 and an environment to typeset numbers and phrases of chemical risk and safety statements.
17915 \begin_layout Subsection
17917 \change_inserted 564990737 1671716212
17921 \begin_layout Standard
17923 \change_inserted 564990737 1671716212
17925 \change_deleted -712698321 1673779847
17931 \change_inserted -712698321 1673779869
17933 \change_inserted 564990737 1671716212
17934 environments useful for linguistics (numbered examples,
17938 \change_inserted -712698321 1673779891
17940 \change_inserted 564990737 1671716212
17942 You can obtain information about this module in
17947 elp\SpecialChar menuseparator
17953 \begin_inset space ~
17956 Manuals\SpecialChar menuseparator
17965 File\SpecialChar menuseparator
17966 Open Example\SpecialChar menuseparator
17967 Modules\SpecialChar menuseparator
17973 \begin_layout Section
17975 \change_inserted 564990737 1671788778
17979 \begin_layout Subsection
17981 \change_inserted 564990737 1671788778
17985 \begin_layout Standard
17987 \change_inserted 564990737 1671788778
17988 This module supports the Braille
17989 \change_deleted -712698321 1673779995
17991 \change_inserted -712698321 1673779996
17993 \change_inserted 564990737 1671788778
17995 It requires the \SpecialChar LaTeX
18001 This and its documentation can be obtained from
18002 \begin_inset CommandInset href
18005 target "https://www.ctan.org/pkg/braille"
18012 \change_deleted -712698321 1673780105
18013 You do not have to reconfigure your system after installing it.
18015 \change_inserted 564990737 1671788778
18021 elp\SpecialChar menuseparator
18027 \begin_inset space ~
18030 Manuals\SpecialChar menuseparator
18039 File\SpecialChar menuseparator
18040 Open Example\SpecialChar menuseparator
18041 Modules\SpecialChar menuseparator
18047 \begin_layout Section
18049 \change_inserted 564990737 1671788778
18050 Annotation & Revision
18053 \begin_layout Subsection
18055 \change_inserted 564990737 1671788778
18059 \begin_layout Standard
18061 \change_inserted 564990737 1671788778
18062 This module provides “FiXme” (marginal) annotations for document revision purposes.
18063 A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
18064 The annotations are customizable via the LaTeX preamble.
18066 \change_inserted -712698321 1673780478
18070 \change_deleted -712698321 1673780479
18072 \change_inserted 564990737 1671788778
18075 documentation which can be obtained from
18076 \begin_inset CommandInset href
18079 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
18088 \begin_layout Paragraph
18090 \change_inserted 564990737 1671788778
18094 \begin_layout Standard
18096 \change_inserted 564990737 1671788778
18098 the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
18100 Document\SpecialChar menuseparator
18101 Settings\SpecialChar menuseparator
18102 Document Class\SpecialChar menuseparator
18103 Class Options\SpecialChar menuseparator
18107 To display them always,
18116 Document\SpecialChar menuseparator
18117 Settings\SpecialChar menuseparator
18125 \begin_layout Subsection
18127 \change_inserted 564990737 1671788778
18131 \begin_layout Standard
18133 \change_inserted 564990737 1671788778
18134 This module provides various kinds of annotations for PDF output.
18137 Help\SpecialChar menuseparator
18138 Specific Manuals\SpecialChar menuseparator
18143 File\SpecialChar menuseparator
18144 Open Example\SpecialChar menuseparator
18145 Modules\SpecialChar menuseparator
18151 \begin_layout Subsection
18153 \change_inserted 564990737 1671788778
18159 \begin_layout Standard
18161 \change_inserted 564990737 1671788778
18162 This module provides fields and buttons for PDF forms.
18164 \begin_inset CommandInset href
18166 name "hyperref documentation"
18167 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
18175 Help\SpecialChar menuseparator
18176 Specific Manuals\SpecialChar menuseparator
18181 File\SpecialChar menuseparator
18182 Open Example\SpecialChar menuseparator
18183 Modules\SpecialChar menuseparator
18189 \begin_layout Subsection
18191 \change_inserted 564990737 1671788778
18197 \begin_layout Standard
18199 \change_inserted 564990737 1671788778
18200 This module defines an inset to typeset reading aids (ruby,
18201 furigana) to Chinese characters.
18203 \change_deleted -712698321 1673781076
18205 \change_inserted 564990737 1671788778
18211 \change_deleted -712698321 1673781078
18213 \change_inserted 564990737 1671788778
18215 \change_deleted -712698321 1673781079
18217 \change_inserted 564990737 1671788778
18221 \change_deleted -712698321 1673781080
18225 \change_inserted 564990737 1671788778
18227 \change_deleted -712698321 1673781082
18229 \change_inserted 564990737 1671788778
18233 \change_deleted -712698321 1673781083
18237 \change_inserted 564990737 1671788778
18238 package (depending on the TeX engine) or a fallback definition.
18242 \begin_layout Subsection
18244 \change_inserted 564990737 1671788778
18250 \begin_layout Standard
18252 \change_inserted 564990737 1671788778
18253 This module provides custom insets to insert TODO items in your document.
18254 In order to generate a “List of TODOs,” the module provides a paragraph style.
18256 \change_deleted -712698321 1673781223
18258 \change_inserted 564990737 1671788778
18262 \change_deleted -712698321 1673781224
18266 \change_inserted 564990737 1671788778
18269 Document\SpecialChar menuseparator
18270 Settings\SpecialChar menuseparator
18271 Document Class\SpecialChar menuseparator
18272 Class Options\SpecialChar menuseparator
18275 ) suppresses the output of TODO notes.
18277 \begin_inset CommandInset href
18279 name "todonotes documentation"
18280 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
18288 \begin_layout Section
18290 \change_inserted 564990737 1671829045
18294 \begin_layout Subsection
18296 \change_inserted 564990737 1671829045
18298 \change_deleted -712698321 1673781454
18300 \change_inserted -712698321 1673781454
18302 \change_inserted 564990737 1671829045
18306 \begin_layout Standard
18308 \change_inserted 564990737 1671829045
18309 This module adds support for using natbib together with apacite (the bibliography style need not be
18324 or any bibliography that works with both the natbib and apacite packages.)
18327 \begin_layout Section
18329 \change_inserted 564990737 1671829045
18333 \begin_layout Subsection
18335 \change_inserted 564990737 1671829045
18336 Fancy Colored Boxes
18339 \begin_layout Standard
18341 \change_inserted 564990737 1671829045
18342 This module adds ten custom insets that support colored boxes via the
18349 Help\SpecialChar menuseparator
18350 Specific Manuals\SpecialChar menuseparator
18356 File\SpecialChar menuseparator
18357 Open Example\SpecialChar menuseparator
18358 Modules\SpecialChar menuseparator
18362 \change_inserted -712698321 1673854244
18364 \change_inserted 564990737 1671829045
18366 \begin_inset CommandInset href
18368 name "tcolorbox documentation"
18369 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
18378 \begin_layout Subsection
18380 \change_inserted 564990737 1671829045
18384 \begin_layout Standard
18386 \change_inserted 564990737 1671829045
18387 This provides the custom insets
18405 to scale and rotate its content.
18408 \begin_layout Standard
18410 \change_inserted 564990737 1671829045
18415 is a simple way of reversing text without any other enhancement:
18418 \begin_layout Standard
18420 \change_inserted 564990737 1671829045
18421 \begin_inset Flex Reflectbox
18424 \begin_layout Plain Layout
18426 \change_inserted 564990737 1671829045
18427 Great Western Railway
18437 \begin_layout Standard
18439 \change_inserted 564990737 1671829045
18440 (You will need to use Ctrl-R to see any of these examples.)
18443 \begin_layout Standard
18445 \change_inserted 564990737 1671829045
18450 allows you to specify the dimensions of the text or image;
18451 permissible units are em,
18473 it scales by the width factor:
18476 \begin_layout Standard
18478 \change_inserted 564990737 1671829045
18479 \begin_inset Flex Resizebox
18482 \begin_layout Plain Layout
18484 \change_inserted 564990737 1671829045
18485 \begin_inset Argument 1
18488 \begin_layout Plain Layout
18490 \change_inserted 564990737 1671829045
18499 \begin_inset Argument 2
18502 \begin_layout Plain Layout
18504 \change_inserted 564990737 1671829045
18512 Great Western Railway
18522 \begin_layout Standard
18524 \change_inserted 564990737 1671829045
18529 allows you to rotate
18530 \change_deleted -712698321 1673856297
18532 \change_inserted -712698321 1673856302
18534 \change_inserted 564990737 1671829045
18535 around the reference point of the box.
18536 If you wish to rotate the box around a different origin,
18537 place the cursor inside the box and select Insert\SpecialChar menuseparator
18567 or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
18571 \begin_layout Standard
18573 \change_inserted 564990737 1671829045
18574 \begin_inset Flex Rotatebox
18577 \begin_layout Plain Layout
18579 \change_inserted 564990737 1671829045
18580 \begin_inset Argument 1
18583 \begin_layout Plain Layout
18585 \change_inserted 274215730 1672888693
18587 \change_inserted 564990737 1671829045
18596 \begin_inset Argument 2
18599 \begin_layout Plain Layout
18601 \change_inserted 564990737 1671829045
18609 Great Western Railway
18619 \begin_layout Standard
18621 \change_inserted 564990737 1671829045
18622 You can combine boxes as in:
18625 \begin_layout Standard
18627 \change_inserted 564990737 1671829045
18628 \begin_inset Flex Rotatebox
18631 \begin_layout Plain Layout
18633 \change_inserted 564990737 1671829045
18634 \begin_inset Argument 1
18637 \begin_layout Plain Layout
18639 \change_inserted 274215730 1672888702
18641 \change_inserted 564990737 1671829045
18650 \begin_inset Argument 2
18653 \begin_layout Plain Layout
18655 \change_inserted 564990737 1671829045
18664 \begin_inset Flex Resizebox
18667 \begin_layout Plain Layout
18669 \change_inserted 564990737 1671829045
18670 \begin_inset Argument 1
18673 \begin_layout Plain Layout
18675 \change_inserted 564990737 1671829045
18684 \begin_inset Argument 2
18687 \begin_layout Plain Layout
18689 \change_inserted 564990737 1671829045
18698 \begin_inset Flex Reflectbox
18701 \begin_layout Plain Layout
18703 \change_inserted 564990737 1671829045
18704 Great Western Railway
18728 \begin_layout Standard
18730 \change_inserted 564990737 1671829045
18736 \change_deleted -712698321 1673856306
18738 \change_inserted -712698321 1673856308
18740 \change_inserted 564990737 1671829045
18742 select Insert\SpecialChar menuseparator
18743 V-Factor to add a vertical factor.
18744 If the vertical factor is omitted,
18745 the horizontal is used.
18746 Adding different horizontal and vertical values creates distortion as in
18749 \begin_layout Standard
18751 \change_inserted 564990737 1671829045
18754 \begin_inset Flex Scalebox
18757 \begin_layout Plain Layout
18759 \change_inserted 564990737 1671829045
18760 \begin_inset Argument 1
18763 \begin_layout Plain Layout
18765 \change_inserted 564990737 1671829045
18774 \begin_inset Argument 2
18777 \begin_layout Plain Layout
18779 \change_inserted 564990737 1671829045
18789 Great Western Railway
18799 \begin_layout Standard
18801 \change_inserted 564990737 1671829045
18802 A negative horizontal value reverses the text
18803 \change_inserted -712698321 1673856686
18804 on the horizontal axis,
18806 \change_deleted -712698321 1673856688
18808 \change_inserted 564990737 1671829045
18809 a negative vertical value
18810 \change_deleted -712698321 1673856694
18812 \change_inserted -712698321 1673856702
18813 on the vertical axis,
18815 \change_inserted 564990737 1671829045
18817 \change_deleted -712698321 1673856704
18819 \change_inserted 564990737 1671829045
18823 \begin_layout Standard
18825 \change_inserted 564990737 1671829045
18826 \begin_inset Flex Scalebox
18829 \begin_layout Plain Layout
18831 \change_inserted 564990737 1671829045
18832 \begin_inset Argument 1
18835 \begin_layout Plain Layout
18837 \change_inserted 564990737 1671829045
18846 \begin_inset Argument 2
18849 \begin_layout Plain Layout
18851 \change_inserted 564990737 1671829045
18859 Great Western Railway
18867 \begin_inset Flex Scalebox
18870 \begin_layout Plain Layout
18872 \change_inserted 564990737 1671829045
18873 \begin_inset Argument 1
18876 \begin_layout Plain Layout
18878 \change_inserted 564990737 1671829045
18887 \begin_inset Argument 2
18890 \begin_layout Plain Layout
18892 \change_inserted 564990737 1671829045
18900 Great Western Railway
18910 \begin_layout Subsection
18912 \change_inserted 564990737 1671884699
18916 \begin_layout Standard
18918 \change_inserted 564990737 1671884699
18919 This module defines Boxes with section header.
18920 It is mainly intended for the SciPoster Document class.
18924 \begin_layout Subsection
18926 \change_inserted 564990737 1671884699
18927 Variable-width Minipages
18930 \begin_layout Standard
18932 \change_inserted 564990737 1671884699
18936 \begin_inset space \thinspace{}
18943 Insert\SpecialChar menuseparator
18955 package provides a variable-width minipage,
18956 whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
18957 The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
18959 Insert\SpecialChar menuseparator
18961 \begin_inset space \thinspace{}
18972 Insert\SpecialChar menuseparator
18974 \begin_inset space \thinspace{}
18988 File\SpecialChar menuseparator
18989 Open Example\SpecialChar menuseparator
18990 Variable-width Minipages
18996 \begin_layout Section
18998 \change_inserted 564990737 1671884699
19002 \begin_layout Subsection
19004 \change_inserted 564990737 1671884699
19005 Fix Computer Modern Fonts
19008 \begin_layout Standard
19010 \change_inserted 564990737 1671884699
19011 This module uses the
19015 package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
19017 \begin_inset CommandInset href
19019 name "fix-cm documentation"
19020 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
19029 \begin_layout Subsection
19031 \change_inserted 564990737 1671884699
19033 Kernel Fixes (Obsolete)
19036 \begin_layout Standard
19038 \change_inserted 564990737 1671884699
19039 This module loads the \SpecialChar LaTeX
19044 which contains some bug fixes for \SpecialChar LaTeX
19046 If you use this module your typeset document may look different when you process it,
19047 depending on the respective version of
19055 \begin_layout Paragraph
19057 \change_inserted 564990737 1671884699
19061 \begin_layout Standard
19063 \change_inserted 564990737 1671884699
19064 recent \SpecialChar LaTeX
19065 kernels (as of 2015/01/01) include the functionality of
19074 module is obsolete with newer \SpecialChar LaTeX
19077 \change_deleted -712698321 1673857809
19079 \change_inserted 564990737 1671884699
19083 \begin_layout Subsection
19085 \change_inserted 564990737 1671884699
19086 Minimalistic Insets
19089 \begin_layout Standard
19091 \change_inserted 564990737 1671884699
19092 This module redefines several insets (Index,
19094 URL) as being Minimalistic.
19097 \begin_layout Subsection
19099 \change_inserted 564990737 1671884699
19100 Title and Preamble Hacks
19103 \begin_layout Standard
19105 \change_inserted 564990737 1671884699
19106 This module provides two new paragraph styles:
19110 \begin_layout Enumerate
19112 \change_inserted 564990737 1671884699
19117 which puts whatever is entered into it into the preamble.
19120 to include preamble code in the body of a LyX document.
19124 \begin_layout Enumerate
19126 \change_inserted 564990737 1671884699
19131 which that will put its contents into the body of the LaTeX document,
19139 This is useful for making branches and notes in title-related material.
19141 if you put these in a
19146 this signals to LyX to output
19153 which may then come too early.)
19156 \begin_layout Section
19158 \change_inserted 564990737 1672081439
19162 \begin_layout Subsection
19164 \change_inserted 564990737 1672081439
19168 \begin_layout Standard
19170 \change_inserted 564990737 1672081439
19171 This module uses the
19175 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
19176 Use the Algorithm paragraph style to enter and indent the algorithm.
19178 \begin_inset CommandInset href
19180 name "algorithm2e documentation"
19181 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
19189 \begin_layout Subsection
19191 \change_inserted 564990737 1672081439
19192 Bilingual Captions AKA Multilingual Captions
19195 \begin_layout Standard
19197 \change_inserted 564990737 1672081439
19198 This module provides the paragraph style
19201 \begin_inset space ~
19206 with which to typeset
19207 \change_deleted -712698321 1673859156
19209 \change_inserted -712698321 1673859156
19211 \change_inserted 564990737 1672081439
19213 Within this paragraph style
19215 Insert\SpecialChar menuseparator
19218 allows you to enter the desired
19219 \change_inserted -712698321 1673859387
19221 \change_inserted 564990737 1672081439
19222 language using one of the babel names.
19225 File\SpecialChar menuseparator
19226 Open Example\SpecialChar menuseparator
19228 \change_inserted -712698321 1673859558
19229 Modules\SpecialChar menuseparator
19231 \change_inserted 564990737 1672081439
19232 Multilingual Captions
19236 Help\SpecialChar menuseparator
19237 Specific Manuals\SpecialChar menuseparator
19238 Multilingual Captions
19240 further information on its use.
19243 \begin_layout Subsection
19245 \change_inserted 564990737 1672081439
19246 Number Figures by Section
19249 \begin_layout Standard
19251 \change_inserted 564990737 1672081439
19252 This module resets the figure number at section start and prepends the section number to the figure number,
19253 as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
19256 \begin_layout Subsection
19258 \change_inserted 564990737 1672081439
19259 Number Tables by Section
19262 \begin_layout Standard
19264 \change_inserted 564990737 1672081439
19265 This module resets the table number at section start and prepends the section number to the table number,
19266 as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
19269 \begin_layout Section
19271 \change_inserted 564990737 1672081439
19275 \begin_layout Subsection
19277 \change_inserted 564990737 1672081439
19281 \begin_layout Standard
19283 \change_inserted 564990737 1672081439
19284 This module adds an endnote inset,
19285 in addition to footnotes.
19291 which has some limitations but works with older
19292 \change_deleted -712698321 1673861636
19294 \change_inserted -712698321 1673861636
19297 \change_inserted 564990737 1672081439
19298 distributions as well.
19301 Insert\SpecialChar menuseparator
19302 Custom Inset\SpecialChar menuseparator
19305 to insert an endnote and
19307 Insert\SpecialChar menuseparator
19308 List/Contents/References\SpecialChar menuseparator
19311 to insert the endnotes list where you want the endnotes to appear.
19314 Help\SpecialChar menuseparator
19316 \change_deleted -712698321 1673861792
19317 \SpecialChar menuseparator
19319 \change_inserted 564990737 1672081439
19321 \change_deleted -712698321 1673861963
19322 \SpecialChar menuseparator
19323 Notes\SpecialChar menuseparator
19325 \change_inserted -712698321 1673861963
19332 \change_inserted 564990737 1672081439
19338 \begin_layout Subsection
19340 \change_inserted 564990737 1672081439
19341 Endnotes (Extended)
19344 \begin_layout Standard
19346 \change_inserted 564990737 1672081439
19347 This module adds an endnote inset,
19348 in addition to footnotes.
19353 package which is more powerful and customizable than the
19358 but requires a fairly modern
19359 \change_deleted -712698321 1673861643
19361 \change_inserted -712698321 1673861643
19364 \change_inserted 564990737 1672081439
19366 \change_deleted -712698321 1673861645
19368 \change_inserted -712698321 1673861645
19371 \change_inserted 564990737 1672081439
19375 Insert\SpecialChar menuseparator
19376 Custom Inset\SpecialChar menuseparator
19379 to insert an endnote and
19381 Insert\SpecialChar menuseparator
19382 List/Contents/References\SpecialChar menuseparator
19385 to insert the endnotes list where you want the endnotes to appear.
19388 Help\SpecialChar menuseparator
19390 \change_deleted -712698321 1673861798
19391 \SpecialChar menuseparator
19393 \change_inserted 564990737 1672081439
19395 \change_inserted -712698321 1673861924
19404 \change_deleted -712698321 1673861927
19407 \SpecialChar menuseparator
19408 Notes\SpecialChar menuseparator
19410 \change_inserted 564990737 1672081439
19416 \begin_layout Subsection
19418 \change_inserted 564990737 1672081439
19419 Footnotes as Endnotes (Basic)
19422 \begin_layout Standard
19424 \change_inserted 564990737 1672081439
19425 This module sets all footnotes as endnotes.
19431 which has some limitations but works with older
19432 \change_deleted -712698321 1673861650
19434 \change_inserted -712698321 1673861650
19437 \change_inserted 564990737 1672081439
19438 distributions as well.
19441 Insert\SpecialChar menuseparator
19442 List/Contents/References\SpecialChar menuseparator
19445 to insert the endnotes list where you want the endnotes to appear.
19448 Help\SpecialChar menuseparator
19450 \change_deleted -712698321 1673861805
19451 \SpecialChar menuseparator
19453 \change_inserted 564990737 1672081439
19455 \change_deleted -712698321 1673861947
19456 \SpecialChar menuseparator
19457 Notes\SpecialChar menuseparator
19459 \change_inserted -712698321 1673861947
19466 \change_inserted 564990737 1672081439
19472 \begin_layout Subsection
19474 \change_inserted 564990737 1672081439
19475 Footnotes as Endnotes (Extended)
19478 \begin_layout Standard
19480 \change_inserted 564990737 1672081439
19481 This module sets all footnotes as endnotes.
19486 package which is more powerful and customizable than then
19491 but requires a fairly modern
19492 \change_deleted -712698321 1673861654
19494 \change_inserted -712698321 1673861654
19497 \change_inserted 564990737 1672081439
19499 \change_deleted -712698321 1673861656
19501 \change_inserted -712698321 1673861656
19504 \change_inserted 564990737 1672081439
19508 Insert\SpecialChar menuseparator
19509 List/Contents/References\SpecialChar menuseparator
19512 to insert the endnotes list where you want the endnotes to appear.
19515 Help\SpecialChar menuseparator
19517 \change_deleted -712698321 1673861808
19518 \SpecialChar menuseparator
19520 \change_inserted 564990737 1672081439
19522 \change_deleted -712698321 1673861955
19523 \SpecialChar menuseparator
19524 Notes\SpecialChar menuseparator
19526 \change_inserted -712698321 1673861989
19535 \change_deleted -712698321 1673861956
19537 \change_inserted 564990737 1672081439
19541 \begin_layout Section
19543 \change_inserted 564990737 1672081439
19548 \begin_layout Subsection
19550 \change_inserted 564990737 1672081439
19554 \begin_layout Standard
19556 \change_inserted 564990737 1672081439
19557 This module provides support for the
19561 package to print chess games.
19564 File\SpecialChar menuseparator
19565 Open Example\SpecialChar menuseparator
19566 Articles\SpecialChar menuseparator
19569 where you will find
19578 \begin_inset CommandInset href
19580 name "chessboard documentation"
19581 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
19589 \begin_layout Subsection
19591 \change_inserted 564990737 1672081439
19592 Lilypond Music Notation
19595 \begin_layout Standard
19597 \change_inserted 564990737 1672081439
19598 This module provides an inset via
19603 nsert\SpecialChar menuseparator
19604 Custom Inset\SpecialChar menuseparator
19607 in which to enter code for the LilyPond music editor.
19608 It will then be processed in the output.
19611 Help\SpecialChar menuseparator
19612 Specific Manuals\SpecialChar menuseparator
19617 File\SpecialChar menuseparator
19618 Open Example\SpecialChar menuseparator
19619 Modules\SpecialChar menuseparator
19623 It cannot be used if the modules
19626 \begin_inset space \thinspace{}
19638 \begin_layout Section
19640 \change_inserted 564990737 1672138150
19644 \begin_layout Subsection
19646 \change_inserted 564990737 1672138150
19648 \begin_inset CommandInset label
19650 name "subsec:Customizable-Lists"
19657 \begin_layout Standard
19659 \change_inserted 564990737 1672138150
19660 This module uses the
19664 package to enable the customization of various list environments.
19667 \begin_layout Subsubsection
19669 \change_inserted 564990737 1672138150
19670 Custom Enumerate Lists
19673 \begin_layout Standard
19676 \change_inserted 564990737 1672138150
19677 The default numbering of numbered lists can be changed by adding an optional argument (menu
19682 nsert\SpecialChar menuseparator
19689 ) to the first item of each level in the list.
19690 There you add the command
19693 \begin_layout Standard
19695 \change_inserted 564990737 1672138150
19703 \begin_layout Standard
19705 \change_inserted 564990737 1672138150
19706 in \SpecialChar TeX
19716 \begin_layout Standard
19718 \change_inserted 564990737 1672138150
19723 is the first level counter of the enumeration.
19724 To change the numbering for the list sublevels,
19729 ” in the command by the small Roman numeral of the level (
19751 \begin_layout Standard
19753 \change_inserted 564990737 1672138150
19760 outputs the counter as a small Roman numeral.
19761 For capital Roman numerals replace
19773 in the command above.
19774 For Arabic numerals use
19782 \begin_inset Quotes eld
19786 \begin_inset Quotes erd
19789 items with capital or small Latin letters use
19805 \begin_layout Standard
19808 \change_inserted 564990737 1672138150
19809 \begin_inset Note Greyedout
19812 \begin_layout Plain Layout
19814 \change_inserted 564990737 1672138150
19820 You can only number 26
19821 \begin_inset space ~
19824 items with Latin letters,
19825 because this numbering is limited to single letters.
19833 \begin_layout Standard
19835 \change_inserted 564990737 1672138150
19836 Here is a list with custom numbering:
19839 \begin_layout Enumerate
19841 \change_inserted 564990737 1672138150
19842 \begin_inset Argument 1
19845 \begin_layout Plain Layout
19847 \change_inserted 564990737 1672138150
19851 \begin_layout Plain Layout
19853 \change_inserted 564990737 1672138150
19874 \begin_inset Separator latexpar
19881 \begin_layout Enumerate
19883 \change_inserted 564990737 1672138150
19884 \begin_inset Argument 1
19887 \begin_layout Plain Layout
19889 \change_inserted 564990737 1672138150
19893 \begin_layout Plain Layout
19895 \change_inserted 564990737 1672138150
19916 \begin_layout Enumerate
19918 \change_inserted 564990737 1672138150
19920 \begin_inset Separator latexpar
19927 \begin_layout Enumerate
19929 \change_inserted 564990737 1672138150
19930 \begin_inset Argument 1
19933 \begin_layout Plain Layout
19935 \change_inserted 564990737 1672138150
19939 \begin_layout Plain Layout
19941 \change_inserted 564990737 1672138150
19944 \change_deleted 274215730 1672889016
19948 \change_inserted 274215730 1672889016
19952 \change_inserted 564990737 1672138150
19968 \begin_inset Separator latexpar
19975 \begin_layout Enumerate
19977 \change_inserted 564990737 1672138150
19978 \begin_inset Argument 1
19981 \begin_layout Plain Layout
19983 \change_inserted 564990737 1672138150
19987 \begin_layout Plain Layout
19989 \change_inserted 564990737 1672138150
20013 \begin_layout Standard
20015 \change_inserted 564990737 1672138150
20016 For this list these commands were used:
20019 \begin_layout Standard
20022 \change_inserted 564990737 1672138150
20032 \begin_inset Newline newline
20040 \begin_inset Newline newline
20044 \change_deleted 274215730 1672889037
20048 \change_inserted 274215730 1672889037
20052 \change_inserted 564990737 1672138150
20056 \begin_inset Newline newline
20066 \begin_layout Standard
20068 \change_inserted 564990737 1672138150
20075 makes the label emphasized and
20076 \change_deleted 274215730 1672889045
20082 \change_inserted 274215730 1672889046
20086 \change_inserted 564990737 1672138150
20092 \begin_layout Standard
20094 \change_inserted 564990737 1672138150
20095 \begin_inset Note Greyedout
20098 \begin_layout Plain Layout
20100 \change_inserted 564990737 1672138150
20106 When you change the label of a list level,
20107 it will be used for all following lists until you change the definition.
20115 \begin_layout Standard
20117 \change_inserted 564990737 1672138150
20121 \begin_layout Plain Layout
20123 \change_inserted 564990737 1672138150
20141 \begin_layout Subsubsection
20143 \change_inserted 564990737 1672138150
20144 Numbered Paragraphs in Reports
20147 \begin_layout Enumerate
20149 \change_inserted 564990737 1672138213
20150 Official reports often include numbered paragraphs;
20151 you can achieve this with a variation on the approach outlined in
20152 \change_deleted -712698321 1674916429
20154 \change_inserted 564990737 1672138213
20156 \change_deleted -712698321 1674916431
20158 \change_inserted -712698321 1674916432
20160 \change_inserted 564990737 1672138213
20162 \begin_inset space ~
20166 \change_inserted -712698321 1674916425
20168 \begin_inset CommandInset ref
20170 reference "sec:How-to-use"
20175 \change_deleted -712698321 1674916426
20177 \begin_inset CommandInset ref
20179 reference "fn:If-you-really"
20188 \change_inserted 564990737 1672138213
20194 in each command with
20201 \begin_layout Enumerate
20203 \change_inserted 564990737 1672138150
20204 These numbered paragraphs were generated by inserting the \SpecialChar TeX
20206 \begin_inset Separator latexpar
20213 \begin_layout Standard
20215 \change_inserted 564990737 1672138150
20229 \begin_layout Standard
20231 \change_inserted 564990737 1672138150
20232 before the start of the section;
20239 uses the \SpecialChar LaTeX
20240 section counter to generate the first part of the number.
20244 \begin_layout Enumerate
20246 \change_inserted 564990737 1672138150
20247 I have ignored the subsection heading in this example because,
20248 with paragraphs numbered in this way,
20249 subsections are less likely to be used.
20252 \begin_layout Subsubsection
20254 \change_inserted 564990737 1672138150
20255 Resumed Enumeration
20258 \begin_layout Standard
20260 \change_inserted 564990737 1672138150
20264 \begin_layout Plain Layout
20266 \change_inserted 564990737 1672138150
20282 \begin_layout Standard
20284 \change_inserted 564990737 1672138150
20285 Enumerations can be resumed after intermediate paragraphs:
20288 \begin_layout Enumerate
20290 \change_inserted 564990737 1672138150
20291 \begin_inset Argument 1
20294 \begin_layout Plain Layout
20296 \change_inserted 564990737 1672138150
20300 \begin_layout Plain Layout
20302 \change_inserted 564990737 1672138150
20319 \begin_inset Note Note
20322 \begin_layout Plain Layout
20324 \change_inserted 564990737 1672138150
20325 goes back to default numbering
20333 \begin_layout Enumerate
20335 \change_inserted 564990737 1672138150
20339 \begin_layout Standard
20341 \change_inserted 564990737 1672138150
20345 \begin_layout Enumerate-Resume
20347 \change_inserted 564990737 1672138150
20351 \begin_layout Standard
20353 \change_inserted 564990737 1672138150
20354 To resume an enumeration,
20361 \change_deleted -712698321 1673882803
20362 Its numbering appears in blue within \SpecialChar LyX
20363 to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
20366 \change_inserted 564990737 1672138150
20370 \begin_layout Standard
20372 \change_inserted 564990737 1672138150
20373 \begin_inset Note Greyedout
20376 \begin_layout Plain Layout
20378 \change_inserted 564990737 1672138150
20384 If there is no previous enumeration to resume,
20385 you will get a \SpecialChar LaTeX
20394 \begin_layout Standard
20396 \change_inserted 564990737 1672138150
20397 Perhaps you might want to resume the list with a different number from the next one.
20398 Or you want to start a new enumeration with a defined number.
20399 This is possible by adding an optional argument to the first list item of a normal enumeration.
20404 \begin_layout Standard
20406 \change_inserted 564990737 1672138150
20412 \begin_layout Standard
20414 \change_inserted 564990737 1672138150
20419 is the number with which you want to resume the list.
20423 \begin_layout Enumerate
20425 \change_inserted 564990737 1672138150
20429 \begin_layout Enumerate
20431 \change_inserted 564990737 1672138150
20435 \begin_layout Standard
20437 \change_inserted 564990737 1672138150
20438 Enumeration starting at a given value:
20441 \begin_layout Enumerate
20443 \change_inserted 564990737 1672138150
20444 \begin_inset Argument 1
20447 \begin_layout Plain Layout
20449 \change_inserted 564990737 1672138150
20453 \begin_layout Plain Layout
20455 \change_inserted 564990737 1672138150
20469 This enumeration starts at 4
20472 \begin_layout Subsubsection
20474 \change_inserted 564990737 1672138150
20476 \begin_inset Index idx
20481 \begin_layout Plain Layout
20483 \change_inserted 564990737 1672138150
20495 \begin_layout Standard
20497 \change_inserted 564990737 1672138150
20498 In some cases you might want less or more vertical space between the items of a list.
20499 For example if the default space is too much in your opinion in this case:
20502 \begin_layout Itemize
20504 \change_inserted 564990737 1672138150
20508 \begin_layout Itemize
20510 \change_inserted 564990737 1672138150
20511 with standard spacing
20514 \begin_layout Standard
20516 \change_inserted 564990737 1672138150
20517 You can decrease the space by adding an optional argument to the first item of the list.
20518 Add there the command
20522 to get no additional list space like in this example:
20525 \begin_layout Itemize
20527 \change_inserted 564990737 1672138150
20528 \begin_inset Argument 1
20531 \begin_layout Plain Layout
20533 \change_inserted 564990737 1672138150
20537 \begin_layout Plain Layout
20539 \change_inserted 564990737 1672138150
20556 \begin_layout Itemize
20558 \change_inserted 564990737 1672138150
20562 \begin_layout Itemize
20564 \change_inserted 564990737 1672138150
20568 \begin_layout Standard
20570 \change_inserted 564990737 1672138150
20571 To add space you can use several other commands provided by the
20576 \begin_inset Index idx
20581 \begin_layout Plain Layout
20583 \change_inserted 564990737 1672138150
20594 For more information see the
20595 \begin_inset CommandInset href
20597 name "enumitem documentation"
20598 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
20606 \begin_layout Standard
20608 \change_inserted 564990737 1672138150
20609 There are also many commands available to change the horizontal spacing and indentation.
20610 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
20611 \begin_inset space \thinspace{}
20614 cm so that the number is in the page margin:
20617 \begin_layout Enumerate
20619 \change_inserted 564990737 1672138150
20620 \begin_inset Argument 1
20623 \begin_layout Plain Layout
20625 \change_inserted 564990737 1672138150
20629 \begin_layout Plain Layout
20631 \change_inserted 564990737 1672138150
20651 \begin_layout Enumerate
20653 \change_inserted 564990737 1672138150
20654 with negative indentation
20657 \begin_layout Subsubsection
20659 \change_inserted 564990737 1672138150
20660 Further Customization
20661 \begin_inset Index idx
20666 \begin_layout Plain Layout
20668 \change_inserted 564990737 1672138150
20680 \begin_layout Standard
20682 \change_inserted 564990737 1672138150
20683 You can also change the style of description lists.
20687 \begin_layout Standard
20689 \change_inserted 564990737 1672138150
20695 \begin_layout Standard
20697 \change_inserted 564990737 1672138150
20698 changes the description label font,
20702 \begin_layout Standard
20704 \change_inserted 564990737 1672138150
20713 \begin_layout Standard
20715 \change_inserted 564990737 1672138150
20716 sets the list style.
20719 \begin_layout Standard
20721 \change_inserted 564990737 1672138150
20722 An example where the command
20725 \begin_layout Standard
20727 \change_inserted 564990737 1672138150
20736 \begin_layout Standard
20738 \change_inserted 564990737 1672138150
20742 \begin_layout Description
20744 \change_inserted 564990737 1672138150
20746 \begin_inset space ~
20751 \begin_inset Argument 1
20754 \begin_layout Plain Layout
20756 \change_inserted 564990737 1672138150
20760 \begin_layout Plain Layout
20762 \change_inserted 564990737 1672138150
20781 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
20782 therefore ionizing them.
20785 \begin_layout Description
20787 \change_inserted 564990737 1672138150
20789 \begin_inset space ~
20793 In computer science,
20794 reference counting is a technique of storing the number of references,
20796 or handles to a resource such as an object,
20798 disk space or other resource.
20801 \begin_layout Standard
20803 \change_inserted 564990737 1672138150
20804 There are many more commands and features provided by the
20809 \begin_inset Index idx
20814 \begin_layout Plain Layout
20816 \change_inserted 564990737 1672138150
20827 For more information see the
20828 \begin_inset CommandInset href
20830 name "enumitem documentation"
20831 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
20839 \begin_layout Subsection
20841 \change_inserted 564990737 1672138150
20847 \begin_layout Standard
20849 \change_inserted 564990737 1672138150
20850 This module uses the package
20854 to provide nine new list environments.
20855 Itemized and enumerated lists can be typeset within paragraphs,
20856 as paragraphs and in a compact version.
20857 Most environments have optional arguments to format the labels.
20859 the \SpecialChar LaTeX
20860 list environments itemize and enumerate are extended to use a similar optional argument.
20861 For further details see
20863 File\SpecialChar menuseparator
20864 Open Example\SpecialChar menuseparator
20865 Modules\SpecialChar menuseparator
20866 Paragraph Lists (paralist)
20871 Help\SpecialChar menuseparator
20872 Specific Manuals\SpecialChar menuseparator
20876 \begin_inset CommandInset href
20878 name "paralist documentation"
20879 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
20887 \begin_layout Section
20889 \change_inserted 564990737 1672161542
20890 Literate Programming
20891 \change_deleted -712698321 1673885680
20893 \change_inserted 564990737 1672161542
20897 \begin_layout Subsection
20899 \change_inserted 564990737 1672161542
20903 \begin_layout Standard
20905 \change_inserted 564990737 1672161542
20906 This module allows the use of Noweb as a literate programming tool.
20907 The files and the documentation for Noweb can be obtained from
20908 \begin_inset CommandInset href
20911 target "https://www.ctan.org/pkg/noweb"
20917 Literate programming is described in section
20918 \begin_inset space ~
20922 \begin_inset CommandInset ref
20924 reference "sec:Literate-Programming"
20929 and there are three example files:
20932 File\SpecialChar menuseparator
20933 Open Example\SpecialChar menuseparator
20934 Modules\SpecialChar menuseparator
20940 File\SpecialChar menuseparator
20941 Open Example\SpecialChar menuseparator
20942 Modules\SpecialChar menuseparator
20947 File\SpecialChar menuseparator
20948 Open Example\SpecialChar menuseparator
20949 Modules\SpecialChar menuseparator
20950 Noweb2\SpecialChar LyX
20956 \begin_layout Subsection
20958 \change_inserted 564990737 1672161542
20962 \begin_layout Standard
20964 \change_inserted 564990737 1672161542
20965 This module uses the
20975 \begin_inset Flex Code
20978 \begin_layout Plain Layout
20980 \change_inserted 564990737 1672161542
20988 package in R for dynamic report generation has to be installed for this module to work:
20990 \begin_inset Flex Code
20993 \begin_layout Plain Layout
20995 \change_inserted 564990737 1672161542
20996 install.packages(“knitr”)
21007 \begin_layout Paragraph
21009 \change_inserted 564990737 1672161542
21013 \begin_layout Itemize
21015 \change_inserted 564990737 1672161542
21016 it depends on R >= 2.14.1.
21018 \begin_inset Flex URL
21021 \begin_layout Plain Layout
21023 \change_inserted 564990737 1672161542
21025 http://yihui.name/knitr
21034 \change_deleted -712698321 1673886383
21036 \change_inserted 564990737 1672161542
21040 \begin_layout Itemize
21042 \change_inserted 564990737 1672161542
21047 also has to be installed.
21049 \change_inserted -712698321 1673886396
21053 \begin_layout Itemize
21055 \change_inserted 564990737 1672161542
21056 It cannot be used if the modules
21059 \begin_inset space ~
21070 \change_deleted -712698321 1673886383
21072 \change_inserted -712698321 1673886376
21076 \begin_layout Standard
21078 \change_inserted 564990737 1672161542
21081 Help\SpecialChar menuseparator
21082 Specific Manuals\SpecialChar menuseparator
21088 File\SpecialChar menuseparator
21089 Open Example\SpecialChar menuseparator
21090 Modules\SpecialChar menuseparator
21094 \begin_inset space ~
21098 \begin_inset CommandInset ref
21100 reference "sec:Literate-Programming"
21105 for information about literate programming.
21108 \begin_layout Subsection
21110 \change_inserted 564990737 1672161542
21114 \begin_layout Standard
21116 \change_inserted 564990737 1672161542
21117 This module allows the use of the statistical language S/R as a literate programming tool.
21128 \begin_inset CommandInset href
21131 target "https://www.ctan.org/pkg/includernw"
21137 \begin_inset CommandInset href
21140 target "https://www.ctan.org/pkg/fancyvrb"
21145 are available from CTAN.
21146 It cannot be used if the module
21149 \begin_inset space ~
21157 Help\SpecialChar menuseparator
21158 Specific Manuals\SpecialChar menuseparator
21164 File\SpecialChar menuseparator
21165 Open Example\SpecialChar menuseparator
21166 Modules\SpecialChar menuseparator
21170 \begin_inset space ~
21174 \begin_inset CommandInset ref
21176 reference "sec:Literate-Programming"
21181 for information about literate programming.
21184 \begin_layout Section
21186 \change_inserted 564990737 1672224959
21190 \begin_layout Subsection
21192 \change_inserted 564990737 1672224959
21196 \begin_layout Standard
21198 \change_inserted 564990737 1672224959
21199 This modules defines theorem environments and the proof environment using the extended AMS machinery.
21200 Both numbered and unnumbered types are provided.
21202 the theorems are numbered consecutively throughout the document.
21203 This can be changed by loading one of the
21205 AMS Theorems (Numbered by \SpecialChar ldots
21209 It cannot be used if the modules
21215 Standard Theorems (Unnumbered)
21220 \begin_layout Subsection
21222 \change_inserted 564990737 1672224959
21223 AMS Theorems (Extended)
21226 \begin_layout Standard
21228 \change_inserted 564990737 1672224959
21229 This module defines some additional theorem environments for use with the
21233 package (which must be loaded).
21270 \change_deleted -712698321 1675594790
21277 \change_inserted 564990737 1672224959
21301 in both numbered and unnumbered forms.
21304 \begin_layout Subsection
21306 \change_inserted 564990737 1672224959
21307 AMS Theorems (Extended,
21308 Numbered by Type within Chapters)
21311 \begin_layout Standard
21313 \change_inserted 564990737 1672224959
21314 This module defines some additional theorem environments for use with the
21316 AMS Theorems (Numbered by Type within Chapters)
21319 \change_deleted -712698321 1674898102
21321 \change_inserted -712698321 1674898103
21323 \change_inserted 564990737 1672224959
21324 (which must be loaded).
21361 \change_deleted -712698321 1675594800
21368 \change_inserted 564990737 1672224959
21382 in both numbered and unnumbered forms.
21384 \change_inserted -712698321 1674898226
21388 \begin_layout Standard
21390 \change_inserted 564990737 1672224959
21393 AMS Theorems (Extended)
21396 the different theorem types provided here each have a separate counter,
21397 restarted with each new chapter (e.g.,
21399 \change_deleted -712698321 1674898319
21403 \change_inserted -712698321 1674898319
21405 \change_inserted 564990737 1672224959
21410 \change_deleted -712698321 1674898320
21414 \change_inserted -712698321 1674898321
21416 \change_inserted 564990737 1672224959
21421 \change_deleted -712698321 1674898322
21425 \change_inserted -712698321 1674898322
21427 \change_inserted 564990737 1672224959
21432 \change_deleted -712698321 1674898325
21436 \change_inserted -712698321 1674898325
21438 \change_inserted 564990737 1672224959
21443 \change_deleted -712698321 1674898327
21447 \change_inserted -712698321 1674898327
21449 \change_inserted 564990737 1672224959
21454 \change_deleted -712698321 1674898329
21458 \change_inserted -712698321 1674898329
21460 \change_inserted 564990737 1672224959
21467 \change_deleted -712698321 1674898339
21469 \change_inserted -712698321 1674898339
21471 \change_inserted 564990737 1672224959
21473 \change_inserted -712698321 1674898336
21478 \change_inserted 564990737 1672224959
21482 \change_deleted -712698321 1674898342
21484 \change_inserted -712698321 1674898342
21488 \change_inserted 564990737 1672224959
21493 \change_deleted -712698321 1674898344
21495 \change_inserted -712698321 1674898344
21499 \change_inserted 564990737 1672224959
21504 \change_deleted -712698321 1674898346
21506 \change_inserted -712698321 1674898347
21510 \change_inserted 564990737 1672224959
21515 \change_deleted -712698321 1674898348
21517 \change_inserted -712698321 1674898348
21521 \change_inserted 564990737 1672224959
21523 \change_inserted -712698321 1674898350
21528 \change_deleted -712698321 1674898352
21530 \change_inserted -712698321 1674898353
21533 \change_inserted 564990737 1672224959
21537 \begin_layout Subsection
21539 \change_inserted 564990737 1672224959
21540 AMS Theorems (Extended,
21544 \begin_layout Standard
21546 \change_inserted 564990737 1672224959
21547 This module defines some additional theorem environments for use with the
21549 AMS Theorems (Numbered by Type)
21551 package (which must be loaded).
21588 \change_deleted -712698321 1675594806
21595 \change_inserted 564990737 1672224959
21609 in both numbered and unnumbered forms.
21611 \change_inserted -712698321 1674898455
21615 \begin_layout Standard
21617 \change_inserted 564990737 1672224959
21620 AMS Theorems (Extended)
21623 the different theorem types provided here each have a separate counter (e.g.,
21625 \change_deleted -712698321 1674898821
21627 \change_inserted -712698321 1674898821
21631 \change_inserted 564990737 1672224959
21636 \change_deleted -712698321 1674898823
21638 \change_inserted -712698321 1674898823
21642 \change_inserted 564990737 1672224959
21647 \change_deleted -712698321 1674898825
21649 \change_inserted -712698321 1674898825
21653 \change_inserted 564990737 1672224959
21658 \change_deleted -712698321 1674898827
21660 \change_inserted -712698321 1674898827
21664 \change_inserted 564990737 1672224959
21669 \change_deleted -712698321 1674898830
21671 \change_inserted -712698321 1674898830
21675 \change_inserted 564990737 1672224959
21682 \change_deleted -712698321 1674898832
21684 \change_inserted -712698321 1674898832
21688 \change_inserted 564990737 1672224959
21693 \change_deleted -712698321 1674898834
21695 \change_inserted -712698321 1674898834
21699 \change_inserted 564990737 1672224959
21704 \change_deleted -712698321 1674898836
21706 \change_inserted -712698321 1674898836
21710 \change_inserted 564990737 1672224959
21715 \change_deleted -712698321 1674898838
21717 \change_inserted -712698321 1674898838
21721 \change_inserted 564990737 1672224959
21729 \begin_layout Subsection
21731 \change_inserted 564990737 1672224959
21732 AMS Theorems (Numbered by Type within Chapters)
21735 \begin_layout Standard
21737 \change_inserted 564990737 1672224959
21738 This module defines theorem environments and the proof environment using the extended AMS machinery.
21739 Both numbered and unnumbered types are provided.
21741 \change_inserted -712698321 1674901718
21745 \begin_layout Standard
21747 \change_inserted 564990737 1672224959
21753 the different theorem types provided here each have a separate counter (e.g.,
21755 \change_deleted -712698321 1674901843
21757 \change_inserted -712698321 1674901843
21761 \change_inserted 564990737 1672224959
21766 \change_deleted -712698321 1674901845
21768 \change_inserted -712698321 1674901845
21772 \change_inserted 564990737 1672224959
21777 \change_deleted -712698321 1674901847
21781 \change_inserted -712698321 1674901847
21783 \change_inserted 564990737 1672224959
21788 \change_inserted -712698321 1674901849
21792 \change_deleted -712698321 1674901849
21794 \change_inserted 564990737 1672224959
21799 \change_inserted -712698321 1674901852
21803 \change_deleted -712698321 1674901852
21805 \change_inserted 564990737 1672224959
21810 \change_inserted -712698321 1674901854
21814 \change_deleted -712698321 1674901854
21816 \change_inserted 564990737 1672224959
21823 \change_deleted -712698321 1674901859
21825 \change_inserted -712698321 1674901859
21829 \change_inserted 564990737 1672224959
21834 \change_deleted -712698321 1674901861
21836 \change_inserted -712698321 1674901861
21840 \change_inserted 564990737 1672224959
21845 \change_deleted -712698321 1674901863
21847 \change_inserted -712698321 1674901863
21851 \change_inserted 564990737 1672224959
21856 \change_deleted -712698321 1674901868
21858 \change_inserted -712698321 1674901868
21862 \change_inserted 564990737 1672224959
21868 The numbering restarts for each chapter:
21870 \change_deleted -712698321 1674901871
21872 \change_inserted -712698321 1674901871
21876 \change_inserted 564990737 1672224959
21881 \change_deleted -712698321 1674901873
21883 \change_inserted -712698321 1674901873
21887 \change_inserted 564990737 1672224959
21893 \change_inserted -712698321 1674901725
21897 \begin_layout Standard
21899 \change_inserted 564990737 1672224959
21900 It cannot be used if the modules
21912 Standard Theorems (Numbered by Type)
21916 Standard Theorems (Unnumbered)
21921 \begin_layout Subsection
21923 \change_inserted 564990737 1672224959
21924 AMS Theorems (Numbered by Type)
21927 \begin_layout Standard
21929 \change_inserted 564990737 1672224959
21930 This module defines theorem environments and the proof environment using the extended AMS machinery.
21931 Both numbered and unnumbered types are provided.
21937 the different theorem types provided here each have a separate counter (e.g.,
21939 \change_deleted -712698321 1674902051
21941 \change_inserted -712698321 1674902051
21945 \change_inserted 564990737 1672224959
21950 \change_deleted -712698321 1674902053
21952 \change_inserted -712698321 1674902053
21956 \change_inserted 564990737 1672224959
21961 \change_deleted -712698321 1674902055
21963 \change_inserted -712698321 1674902055
21967 \change_inserted 564990737 1672224959
21972 \change_inserted -712698321 1674902058
21976 \change_deleted -712698321 1674902058
21978 \change_inserted 564990737 1672224959
21983 \change_inserted -712698321 1674902061
21987 \change_deleted -712698321 1674902060
21989 \change_inserted 564990737 1672224959
21994 \change_deleted -712698321 1674902063
21996 \change_inserted -712698321 1674902063
22000 \change_inserted 564990737 1672224959
22007 \change_deleted -712698321 1674902066
22009 \change_inserted -712698321 1674902067
22013 \change_inserted 564990737 1672224959
22018 \change_deleted -712698321 1674902069
22020 \change_inserted -712698321 1674902069
22024 \change_inserted 564990737 1672224959
22029 \change_deleted -712698321 1674902071
22031 \change_inserted -712698321 1674902071
22035 \change_inserted 564990737 1672224959
22040 \change_deleted -712698321 1674902075
22042 \change_inserted -712698321 1674902075
22046 \change_inserted 564990737 1672224959
22052 The numbering’s scope is the whole document.
22053 For chapter- and section-wide numbering,
22054 use one of the ‘within Sections’/‘within Chapters’ modules,
22057 \change_inserted -712698321 1674902047
22061 \begin_layout Standard
22063 \change_inserted 564990737 1672224959
22064 It cannot be used if the modules
22076 Standard Theorems (Numbered by Type)
22080 Standard Theorems (Unnumbered)
22085 \begin_layout Subsection
22087 \change_inserted 564990737 1672224959
22088 Number Equations by Section
22091 \begin_layout Standard
22093 \change_inserted 564990737 1672224959
22094 This module resets the equation number at section start and prepends the section number to the equation number,
22096 \change_deleted -712698321 1674902160
22098 \change_inserted 564990737 1672224959
22104 \change_deleted -712698321 1674902162
22106 \change_inserted 564990737 1672224959
22110 \begin_layout Subsection
22112 \change_inserted 564990737 1672224959
22116 \begin_layout Standard
22118 \change_inserted 564990737 1672224959
22119 This module defines some theorem environments for use with non-AMS classes.
22121 the theorems are numbered consecutively throughout the document.
22122 This can be changed by loading one of the
22124 Standard Theorems (Numbered by \SpecialChar ldots
22129 \change_inserted -712698321 1674902414
22133 \begin_layout Standard
22135 \change_inserted 564990737 1672224959
22136 It cannot be used if the modules
22142 Standard Theorems (Unnumbered)
22148 \begin_layout Subsection
22150 \change_inserted 564990737 1672224959
22151 Standard Theorems (Nameable)
22154 \begin_layout Standard
22156 \change_inserted 564990737 1672224959
22157 This module facilitates the use of named theorems.
22158 The name of the theorem
22159 \change_deleted -712698321 1674902805
22161 \change_inserted -712698321 1674902825
22162 can be inserted via
22164 Insert\SpecialChar menuseparator
22166 \change_deleted -712698321 1674902827
22168 \change_inserted 564990737 1672224959
22169 Additional Theorem Text
22170 \change_deleted -712698321 1674902831
22174 \change_inserted 564990737 1672224959
22179 \begin_layout Subsection
22181 \change_inserted 564990737 1672224959
22182 Standard Theorems (Numbered by Chapter)
22185 \begin_layout Standard
22187 \change_inserted 564990737 1672224959
22188 This module numbers theorems and the like by chapter (i.e.,
22189 the counter is reset at each chapter start).
22190 Use this module only with document classes that provide a chapter environment.
22192 \change_inserted -712698321 1674903079
22196 \begin_layout Standard
22198 \change_inserted 564990737 1672224959
22209 \change_inserted -712698321 1674903082
22213 \begin_layout Standard
22215 \change_inserted 564990737 1672224959
22216 It cannot be used if the module
22218 Standard Theorems (Numbered by Section)
22223 \begin_layout Subsection
22225 \change_inserted 564990737 1672224959
22226 Standard Theorems (Numbered by Section)
22229 \begin_layout Standard
22231 \change_inserted 564990737 1672224959
22232 This module numbers theorems and the like by section (i.e.,
22233 the counter is reset at each section start).
22243 It cannot be used if the module
22245 Standard Theorems (Numbered by Chapter)
22250 \begin_layout Subsection
22252 \change_inserted 564990737 1672224959
22253 Standard Theorems (Numbered by Type within Chapters)
22256 \begin_layout Standard
22258 \change_inserted 564990737 1672224959
22259 This module defines some theorem environments for use with non-AMS classes.
22269 the different theorem types provided here each have a separate counter (e.g.,
22271 \change_deleted -712698321 1674903338
22273 \change_inserted -712698321 1674903338
22277 \change_inserted 564990737 1672224959
22282 \change_deleted -712698321 1674903340
22284 \change_inserted -712698321 1674903340
22288 \change_inserted 564990737 1672224959
22293 \change_deleted -712698321 1674903343
22295 \change_inserted -712698321 1674903343
22299 \change_inserted 564990737 1672224959
22304 \change_deleted -712698321 1674903346
22306 \change_inserted -712698321 1674903346
22310 \change_inserted 564990737 1672224959
22315 \change_deleted -712698321 1674903348
22317 \change_inserted -712698321 1674903348
22321 \change_inserted 564990737 1672224959
22326 \change_deleted -712698321 1674903351
22328 \change_inserted -712698321 1674903351
22332 \change_inserted 564990737 1672224959
22339 \change_deleted -712698321 1674903354
22341 \change_inserted -712698321 1674903354
22345 \change_inserted 564990737 1672224959
22350 \change_deleted -712698321 1674903356
22352 \change_inserted -712698321 1674903356
22356 \change_inserted 564990737 1672224959
22361 \change_deleted -712698321 1674903359
22363 \change_inserted -712698321 1674903359
22367 \change_inserted 564990737 1672224959
22372 \change_deleted -712698321 1674903361
22374 \change_inserted -712698321 1674903361
22378 \change_inserted 564990737 1672224959
22384 The numbering is reset at each chapter start.
22386 \change_inserted -712698321 1674902715
22390 \begin_layout Standard
22392 \change_inserted 564990737 1672224959
22395 AMS Theorems (Numbered by Type)
22399 Standard Theorems (Numbered by Type)
22403 \change_inserted -712698321 1674902717
22407 \begin_layout Standard
22409 \change_inserted 564990737 1672224959
22410 It cannot be used if any of the modules
22422 Standard Theorems (Unnumbered)
22427 Standard Theorems (Numbered by Sections)
22431 Standard Theorems (Numbered by Type within Sections)
22436 \begin_layout Subsection
22438 \change_inserted 564990737 1672224959
22439 Standard Theorems (Numbered by Type within Sections)
22442 \begin_layout Standard
22444 \change_inserted 564990737 1672224959
22445 This module defines some theorem environments for use with non-AMS classes.
22455 the different theorem types provided here each have a separate counter (e.g.,
22457 \change_deleted -712698321 1674902520
22459 \change_inserted -712698321 1674902520
22463 \change_inserted 564990737 1672224959
22468 \change_deleted -712698321 1674902522
22470 \change_inserted -712698321 1674902522
22474 \change_inserted 564990737 1672224959
22479 \change_deleted -712698321 1674902527
22481 \change_inserted -712698321 1674902527
22485 \change_inserted 564990737 1672224959
22490 \change_inserted -712698321 1674902529
22494 \change_deleted -712698321 1674902529
22496 \change_inserted 564990737 1672224959
22501 \change_deleted -712698321 1674902532
22503 \change_inserted -712698321 1674902532
22507 \change_inserted 564990737 1672224959
22512 \change_inserted -712698321 1674902535
22516 \change_deleted -712698321 1674902534
22518 \change_inserted 564990737 1672224959
22525 \change_deleted -712698321 1674902538
22527 \change_inserted -712698321 1674902538
22531 \change_inserted 564990737 1672224959
22536 \change_deleted -712698321 1674902540
22538 \change_inserted -712698321 1674902540
22542 \change_inserted 564990737 1672224959
22547 \change_deleted -712698321 1674902543
22549 \change_inserted -712698321 1674902543
22553 \change_inserted 564990737 1672224959
22558 \change_inserted -712698321 1674902545
22562 \change_deleted -712698321 1674902545
22564 \change_inserted 564990737 1672224959
22570 The numbering is reset at each section start.
22572 \change_inserted -712698321 1674902574
22576 \begin_layout Standard
22578 \change_inserted 564990737 1672224959
22581 AMS Theorems (Numbered by Type)
22585 Standard Theorems (Numbered by Type)
22589 \change_inserted -712698321 1674902609
22593 \begin_layout Standard
22595 \change_inserted 564990737 1672224959
22596 It cannot be used if any of the modules
22608 Standard Theorems (Unnumbered)
22613 Standard Theorems (Numbered by Chapters)
22617 Standard Theorems (Numbered by Type within Chapters)
22622 \begin_layout Subsection
22624 \change_inserted 564990737 1672224959
22625 Standard Theorems (Numbered by Type)
22628 \begin_layout Standard
22630 \change_inserted 564990737 1672224959
22631 This module defines some theorem environments for use with non-AMS classes.
22641 the different theorem types provided here each have a separate counter (e.g.,
22643 \change_deleted -712698321 1674903220
22645 \change_inserted -712698321 1674903220
22649 \change_inserted 564990737 1672224959
22654 \change_deleted -712698321 1674903221
22656 \change_inserted -712698321 1674903221
22660 \change_inserted 564990737 1672224959
22665 \change_deleted -712698321 1674903225
22667 \change_inserted -712698321 1674903226
22671 \change_inserted 564990737 1672224959
22676 \change_inserted -712698321 1674903228
22680 \change_deleted -712698321 1674903228
22682 \change_inserted 564990737 1672224959
22687 \change_deleted -712698321 1674903231
22689 \change_inserted -712698321 1674903232
22693 \change_inserted 564990737 1672224959
22698 \change_inserted -712698321 1674903261
22702 \change_deleted -712698321 1674903233
22704 \change_inserted 564990737 1672224959
22711 \change_deleted -712698321 1674903237
22713 \change_inserted -712698321 1674903237
22717 \change_inserted 564990737 1672224959
22722 \change_deleted -712698321 1674903240
22724 \change_inserted -712698321 1674903240
22728 \change_inserted 564990737 1672224959
22733 \change_deleted -712698321 1674903242
22735 \change_inserted -712698321 1674903242
22739 \change_inserted 564990737 1672224959
22744 \change_deleted -712698321 1674903246
22746 \change_inserted -712698321 1674903246
22750 \change_inserted 564990737 1672224959
22756 The numbering’s scope is the whole document.
22757 For chapter- and section-wide numbering,
22758 use one of the “within Chapters”/“within Sections” modules,
22761 \change_inserted -712698321 1674903280
22765 \begin_layout Standard
22767 \change_inserted 564990737 1672224959
22768 It cannot be used if any of the modules
22780 Standard Theorems (Unnumbered)
22784 AMS Theorems (Numbered by Type)
22789 \begin_layout Subsection
22791 \change_inserted 564990737 1672224959
22792 Standard Theorems (Unnumbered)
22795 \begin_layout Standard
22797 \change_inserted 564990737 1672224959
22798 This module defines only unnumbered theorem environments and the proof environment,
22799 using the extended AMS machinery.
22800 It cannot be used if either of the modules
22811 \begin_layout Subsection
22813 \change_inserted 564990737 1672224959
22817 \begin_layout Standard
22819 \change_inserted 564990737 1672224959
22820 This module provides a straightforward way to segregate subequations in LyX.
22823 Help\SpecialChar menuseparator
22824 Math\SpecialChar menuseparator
22831 \begin_layout Section
22833 \change_inserted 564990737 1672236008
22837 \begin_layout Subsection
22839 \change_inserted 564990737 1672236008
22840 Custom Header/Footer Text
22843 \begin_layout Standard
22845 \change_inserted 564990737 1672236008
22846 This module requires the
22849 \begin_inset space ~
22863 ocument\SpecialChar menuseparator
22868 ettings\SpecialChar menuseparator
22870 \begin_inset space ~
22875 dialog to be set to
22880 It adds six environments to document classes which support the
22887 \begin_layout Itemize
22889 \change_inserted 564990737 1672236008
22895 \begin_layout Itemize
22897 \change_inserted 564990737 1672236008
22903 \begin_layout Itemize
22905 \change_inserted 564990737 1672236008
22911 \begin_layout Itemize
22913 \change_inserted 564990737 1672236008
22919 \begin_layout Itemize
22921 \change_inserted 564990737 1672236008
22927 \begin_layout Itemize
22929 \change_inserted 564990737 1672236008
22935 \begin_layout Subsubsection
22937 \change_inserted 564990737 1672236008
22938 Fancy Headers and Footers
22941 \begin_layout Standard
22943 \change_inserted 564990737 1672236008
22944 The default page layout is rather plain;
22946 \change_deleted -712698321 1674910295
22948 \begin_inset Flex Code
22951 \begin_layout Plain Layout
22953 \change_inserted 564990737 1672236008
22962 \change_inserted 564990737 1672236008
22964 \change_inserted -712698321 1674910328
22967 Article (Standard Class)
22970 \change_inserted 564990737 1672236008
22972 all you get is a centered page number at the bottom of the page.
22974 \change_inserted -712698321 1674910381
22976 \change_inserted 564990737 1672236008
22978 \change_deleted -712698321 1674910376
22980 \change_inserted -712698321 1674910376
22984 \change_inserted 564990737 1672236008
22988 so it appears to be a bit fancier.
22990 \change_inserted -712698321 1674910455
22994 \begin_layout Standard
22996 \change_inserted 564990737 1672236008
23000 \begin_inset space ~
23014 ocument\SpecialChar menuseparator
23019 ettings\SpecialChar menuseparator
23023 \begin_inset Quotes eld
23027 \begin_inset Quotes erd
23031 you will find that the page header is divided into three fields,
23032 not surprisingly labeled
23033 \begin_inset Quotes eld
23037 \begin_inset Quotes erd
23042 \begin_inset Quotes eld
23046 \begin_inset Quotes erd
23051 \begin_inset Quotes eld
23055 \begin_inset Quotes erd
23059 The footer is also divided into these three fields.
23060 The \SpecialChar LaTeX
23061 commands to set these fields in the simplest manner are
23090 Suppose you wish to put your name in the upper left hand corner of each page.
23091 Simply insert the following command in the preamble:
23095 \begin_layout LyX-Code
23097 \change_inserted 564990737 1672236008
23104 \begin_layout Standard
23106 \change_inserted 564990737 1672236008
23107 You will now see your name in the upper left.
23108 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,
23110 \begin_inset space \thinspace{}
23116 \begin_layout LyX-Code
23118 \change_inserted 564990737 1672236008
23124 \begin_layout Standard
23126 \change_inserted 564990737 1672236008
23129 an easier way to make simple changes.
23135 ocument\SpecialChar menuseparator
23140 ettings\SpecialChar menuseparator
23141 Modules\SpecialChar menuseparator
23142 Page Layout\SpecialChar menuseparator
23143 Custom Header/Footer Text
23146 you will find you have six new environments corresponding to the six fields described above.
23149 \begin_layout Standard
23151 \change_inserted 564990737 1672236008
23152 Let's get really fancy:
23153 lets put the section number with the word
23154 \begin_inset Quotes eld
23158 \begin_inset Quotes erd
23162 \begin_inset space \thinspace{}
23166 \begin_inset space \space{}
23169 Section 3) in the upper left,
23170 the page number (e.
23171 \begin_inset space \thinspace{}
23175 \begin_inset space \space{}
23178 Page 4) in the upper right,
23179 your name in the lower left,
23180 and the date in the lower right.
23181 Use your newly enabled environments to add these entries:
23184 \begin_layout Standard
23186 \change_deleted -712698321 1674910975
23187 \begin_inset VSpace defskip
23191 \change_inserted 564990737 1672236008
23195 \begin_layout LyX-Code
23197 \change_inserted 564990737 1672236008
23201 \begin_inset space ~
23220 \begin_layout LyX-Code
23222 \change_inserted 564990737 1672236008
23228 \begin_layout LyX-Code
23230 \change_inserted 564990737 1672236008
23247 \begin_layout LyX-Code
23249 \change_inserted 564990737 1672236008
23261 \begin_layout LyX-Code
23263 \change_inserted 564990737 1672236008
23269 \begin_layout LyX-Code
23271 \change_inserted 564990737 1672236008
23285 \begin_layout Standard
23287 \change_deleted -712698321 1674910976
23288 \begin_inset VSpace defskip
23292 \change_inserted 564990737 1672236008
23296 \begin_layout Standard
23298 \change_inserted 564990737 1672236008
23299 Make sure you enter the commands
23318 as \SpecialChar TeX
23336 access \SpecialChar LaTeX
23337 ’s section and page counters,
23338 and so print out the current section and page numbers.
23345 simply prints out today’s date.
23348 \begin_layout Standard
23350 \change_inserted 564990737 1672236008
23351 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
23352 If you don't want one of the rules,
23353 set its thickness to 0.
23354 The header rule has a default thickness of 0.4pt,
23355 the footer rule is 0pt.
23356 For this you will need to use \SpecialChar TeX
23360 \begin_layout Standard
23362 \change_inserted 564990737 1672236008
23369 headrulewidth}{0.4pt}
23374 \begin_layout Standard
23376 \change_inserted 564990737 1672236008
23383 footrulewidth}{0.4pt}
23385 to set the thicknesses.
23388 \begin_layout Standard
23390 \change_inserted 564990737 1672236008
23391 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
23396 thispagestyle{empty}
23403 thispagestyle{plain}
23410 thispagestyle{fancy}
23413 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
23416 title pages are marked as plain by default,
23417 while following pages are marked fancy when using the global fancy setting.
23421 \begin_layout Standard
23423 \change_inserted 564990737 1672236008
23424 If you want a header or footer to be on the outer side of a two sided document,
23425 you need to use something like:
23428 \begin_layout LyX-Code
23430 \change_deleted -712698321 1674911361
23433 \begin_inset Flex Strong
23436 \begin_layout Plain Layout
23438 \change_inserted 564990737 1672236008
23452 \change_inserted -712698321 1674911361
23462 \begin_layout LyX-Code
23464 \change_deleted -712698321 1674911364
23467 \begin_inset Flex Strong
23470 \begin_layout Plain Layout
23472 \change_inserted 564990737 1672236008
23488 \change_inserted -712698321 1674911364
23500 \begin_layout Standard
23502 \change_inserted 564990737 1672236008
23503 The first command clears all existing footers avoiding any conflicts with your new command.
23506 \begin_layout Standard
23508 \change_inserted 564990737 1672236008
23509 You can enter any of these commands,
23510 the simpler ones in any of your new environments,
23511 the more complex ones as \SpecialChar TeX
23513 at any point in your document and they will take effect on the next page.
23516 \begin_layout Standard
23518 \change_inserted 564990737 1672236008
23519 As a final example,
23520 it is possible to include an image in the header or footer.
23521 Suppose you want to put a company logo in the upper left hand corner.
23522 You might try something like
23523 \change_inserted -712698321 1674911745
23526 Document\SpecialChar menuseparator
23527 Settings\SpecialChar menuseparator
23531 \change_inserted 564990737 1672236008
23535 \begin_layout LyX-Code
23537 \change_inserted 564990737 1672236008
23544 includegraphics{logo.
23545 \change_deleted -712698321 1674911807
23547 \change_inserted -712698321 1674911807
23549 \change_inserted 564990737 1672236008
23553 \begin_layout Standard
23556 \change_deleted -712698321 1674911836
23558 \change_inserted -712698321 1674911837
23560 \change_inserted 564990737 1672236008
23561 ou may need to preface this with
23565 usepackage{graphics}
23567 if you don't include graphics elsewhere in your document
23568 \change_deleted -712698321 1674911839
23570 \change_inserted 564990737 1672236008
23574 \begin_layout Standard
23576 \change_inserted 564990737 1672236008
23577 For more information on fancy headers,
23579 \begin_inset Flex Code
23582 \begin_layout Plain Layout
23584 \change_inserted 564990737 1672236008
23593 \begin_inset CommandInset href
23596 target "http://www.ctan.org/pkg/fancyhdr"
23605 \begin_layout Subsection
23607 \change_inserted 564990737 1672236008
23608 Landscape Document Parts
23611 \begin_layout Standard
23613 \change_inserted 564990737 1672236008
23614 This module outputs parts of the document in landscape mode using
23616 Insert\SpecialChar menuseparator
23617 Custom Insets\SpecialChar menuseparator
23622 Insert\SpecialChar menuseparator
23623 Custom Insets\SpecialChar menuseparator
23624 Landscape (Floating)
23629 \begin_layout Subsection
23631 \change_inserted 564990737 1672236008
23632 \begin_inset CommandInset label
23634 name "sec:Multiple-Columns"
23641 \begin_layout Standard
23643 \change_inserted 564990737 1672236008
23644 This module uses the
23649 \begin_inset Index idx
23654 \begin_layout Plain Layout
23656 \change_inserted 564990737 1672236008
23666 package and is independent of the option
23679 ocument\SpecialChar menuseparator
23684 ettings\SpecialChar menuseparator
23686 \begin_inset space ~
23692 If you want to have two columns for the whole document,
23693 you are recommended to use the
23702 For all other cases use this module.
23703 \change_deleted 564990737 1672236008
23704 Multiple Text Columns
23707 \begin_layout Standard
23709 \change_deleted 564990737 1672236008
23710 This feature is independent of the option
23712 Two-column document
23714 in the document settings under
23719 If you want to have 2
23720 \begin_inset space ~
23723 columns for the whole document,
23724 it is recommended to use the
23726 Two-column document
23729 For all other cases use this feature.
23732 \begin_layout Standard
23734 \change_deleted 564990737 1672236008
23735 To use multiple text columns in your document,
23736 you have to load the module
23742 Document\SpecialChar menuseparator
23743 Settings\SpecialChar menuseparator
23746 ) and must have the \SpecialChar LaTeX
23748 \begin_inset Flex Code
23751 \begin_layout Plain Layout
23762 \begin_layout Standard
23763 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
23764 Within the different columns you can use everything,
23765 with the limitation that for floats you need to
23766 \change_deleted 564990737 1672236179
23767 use the float option
23770 \change_inserted 564990737 1672236179
23779 \begin_inset space ~
23789 dit\SpecialChar menuseparator
23795 \begin_inset space ~
23805 \begin_layout Subsubsection
23809 \begin_layout Standard
23810 If you want to have
23811 \change_deleted -712698321 1674912320
23813 \change_inserted -712698321 1674912321
23815 \change_deleted -712698321 1674912322
23817 \begin_inset space ~
23821 \change_inserted -712698321 1674912322
23824 columns in your text,
23825 insert a multicolumn inset via the menu
23827 Insert\SpecialChar menuseparator
23829 \begin_inset space ~
23832 Insets\SpecialChar menuseparator
23834 \begin_inset space ~
23839 where the columns should start.
23840 Write all text that should be printed in 2
23841 \begin_inset space ~
23844 columns into this inset.
23847 \begin_layout Standard
23848 Here is an example:
23851 \begin_layout Standard
23853 \begin_inset Flex Multiple Columns
23856 \begin_layout Plain Layout
23861 The Adventure of the Empty House
23864 \begin_inset Newline newline
23869 Sir Arthur Conan Doyle
23872 \begin_layout Plain Layout
23875 It was in the spring of the year 1894 that all London was interested,
23876 and the fashionable world dismayed,
23877 by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
23878 The public has already learned those particulars of the crime which came out in the police investigation,
23879 but a good deal was suppressed upon that occasion,
23880 since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
23882 at the end of nearly ten years,
23883 am I allowed to supply those missing links which make up the whole of that remarkable chain.
23884 The crime was of interest in itself,
23885 but that interest was as nothing to me compared to the inconceivable sequel,
23886 which afforded me the greatest shock and surprise of any event in my adventurous life.
23888 after this long interval,
23889 I find myself thrilling as I think of it,
23890 and feeling once more that sudden flood of joy,
23892 and incredulity which utterly submerged my mind.
23893 Let me say to that public,
23894 which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
23895 that they are not to blame me if I have not shared my knowledge with them,
23896 for I should have considered it my first duty to do so,
23897 had I not been barred by a positive prohibition from his own lips,
23898 which was only withdrawn upon the third of last month.
23906 \begin_layout Standard
23907 To get 3 or more columns,
23908 set the cursor into the multicolumn inset and use the menu
23910 Insert\SpecialChar menuseparator
23912 \begin_inset space ~
23916 \begin_inset space ~
23922 The number of the desired columns is written into that inset (for 3
23923 \begin_inset space ~
23927 \begin_inset Quotes eld
23931 \begin_inset Quotes erd
23935 \begin_inset Newline newline
23938 Here is an example with 3
23939 \begin_inset space ~
23945 \begin_layout Standard
23946 \begin_inset Flex Multiple Columns
23949 \begin_layout Plain Layout
23952 \begin_inset Argument 1
23955 \begin_layout Plain Layout
23962 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
23963 and that after his disappearance I never failed to read with care the various problems which came before the public.
23964 And I even attempted,
23966 for my own private satisfaction,
23967 to employ his methods in their solution,
23968 though with indifferent success.
23971 which appealed to me like this tragedy of Ronald Adair.
23972 As I read the evidence at the inquest,
23973 which led up to a verdict of willful murder against some person or persons unknown,
23974 I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
23975 There were points about this strange business which would,
23977 have specially appealed to him,
23978 and the efforts of the police would have been supplemented,
23979 or more probably anticipated,
23980 by the trained observation and the alert mind of the first criminal agent in Europe.
23982 as I drove upon my round,
23983 I turned over the case in my mind and found no explanation which appeared to me to be adequate.
23984 At the risk of telling a twice-told tale,
23985 I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
23993 \begin_layout Standard
23994 You can have up to 10
23995 \begin_inset space ~
23998 columns if you want to,
23999 but that might not be very pleasant for the readers of your document.
24002 \begin_layout Standard
24004 \change_deleted 564990737 1672236245
24005 \begin_inset Newpage newpage
24013 \begin_layout Subsubsection
24014 Columns inside Columns
24017 \begin_layout Standard
24018 You can also have columns inside columns:
24021 \begin_layout Standard
24022 \begin_inset Flex Multiple Columns
24025 \begin_layout Plain Layout
24028 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24029 at that time governor of one of the Australian colonies.
24030 Adair's mother had returned from Australia to undergo the operation for cataract,
24033 and her daughter Hilda were living together at 427 Park Lane.
24036 \begin_layout Plain Layout
24037 \begin_inset Flex Multiple Columns
24040 \begin_layout Plain Layout
24043 The youth moved in the best society
24044 \begin_inset space ~
24048 so far as was known,
24049 no enemies and no particular vices.
24050 He had been engaged to Miss Edith Woodley,
24052 but the engagement had been broken off by mutual consent some months before,
24053 and there was no sign that it had left any very profound feeling behind it.
24054 For the rest {sic} the man's life moved in a narrow and conventional circle,
24055 for his habits were quiet and his nature unemotional.
24056 Yet it was upon this easy-going young aristocrat that death came,
24057 in most strange and unexpected form,
24058 between the hours of ten and eleven-twenty on the night of March 30,
24067 \begin_layout Plain Layout
24070 Ronald Adair was fond of cards
24071 \begin_inset space ~
24074 – playing continually,
24075 but never for such stakes as would hurt him.
24076 He was a member of the Baldwin,
24078 and the Bagatelle card clubs.
24080 after dinner on the day of his death,
24081 he had played a rubber of whist at the latter club.
24082 He had also played there in the afternoon.
24087 The evidence of those who had played with him
24088 \begin_inset space ~
24095 \begin_inset space ~
24098 – showed that the game was whist,
24099 and that there was a fairly equal fall of the cards.
24100 Adair might have lost five pounds,
24102 His fortune was a considerable one,
24103 and such a loss could not in any way affect him.
24104 He had played nearly every day at one club or other,
24105 but he was a cautious player,
24106 and usually rose a winner.
24107 It came out in evidence that,
24108 in partnership with Colonel Moran,
24109 he had actually won as much as four hundred and twenty pounds in a sitting,
24111 from Godfrey Milner and Lord Balmoral.
24112 So much for his recent history as it came out at the inquest.
24120 \begin_layout Subsubsection
24124 \begin_layout Standard
24125 The examples in this section show some more special features of multiple columns.
24128 \begin_layout Standard
24129 For more features of multiple columns,
24131 \begin_inset CommandInset href
24133 name "documentation"
24134 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24139 of the \SpecialChar LaTeX
24141 \begin_inset Flex Code
24144 \begin_layout Plain Layout
24153 \begin_layout Paragraph
24157 \begin_layout Standard
24158 To add a preface text for multiple columns,
24159 set the cursor into the multicolumn inset and use the menu
24161 Insert\SpecialChar menuseparator
24165 Write your preface text into that inset.
24166 \begin_inset Newline newline
24169 This is an example with some preface text:
24172 \begin_layout Standard
24173 \begin_inset VSpace bigskip
24179 \begin_layout Standard
24180 \begin_inset Flex Multiple Columns
24183 \begin_layout Plain Layout
24184 \begin_inset Argument 2
24187 \begin_layout Plain Layout
24188 And the story continues and continues and continues and continues\SpecialChar ldots
24196 On the evening of the crime,
24197 he returned from the club exactly at ten.
24198 His mother and sister were out spending the evening with a relation.
24199 The servant deposed that she heard him enter the front room on the second floor,
24200 generally used as his sitting-room.
24201 She had lit a fire there,
24202 and as it smoked she had opened the window.
24203 No sound was heard from the room until eleven-twenty,
24204 the hour of the return of Lady Maynooth and her daughter.
24205 Desiring to say good-night,
24206 she attempted to enter her son's room.
24207 The door was locked on the inside,
24208 and no answer could be got to their cries and knocking.
24210 and the door forced.
24211 The unfortunate young man was found lying near the table.
24212 His head had been horribly mutilated by an expanding revolver bullet,
24213 but no weapon of any sort was to be found in the room.
24221 \begin_layout Standard
24222 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
24224 For example the command
24227 \begin_layout LyX-Code
24230 subsection{subsection title}
24233 \begin_layout Standard
24234 creates a subsection.
24235 In this example the preface is a subsubsection:
24238 \begin_layout Standard
24239 \begin_inset Flex Multiple Columns
24242 \begin_layout Plain Layout
24243 \begin_inset Argument 2
24246 \begin_layout Plain Layout
24250 \begin_layout Plain Layout
24259 This is a subsubsection heading as a preface
24263 \begin_layout Plain Layout
24277 A minute examination of the circumstances served only to make the case more complex.
24278 In the first place,
24279 no reason could be given why the young man should have fastened the door upon the inside.
24280 There was the possibility that the murderer had done this,
24281 and had afterwards escaped by the window.
24282 The drop was at least twenty feet,
24284 and a bed of crocuses in full bloom lay beneath.
24285 Neither the flowers nor the earth showed any sign of having been disturbed,
24286 nor were there any marks upon the narrow strip of grass which separated the house from the road.
24289 it was the young man himself who had fastened the door.
24290 But how did he come by his death?
24291 No one could have climbed up to the window without leaving traces.
24292 Suppose a man had fired through the window,
24293 he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
24295 Park Lane is a frequented thoroughfare;
24296 there is a cab stand within a hundred yards of the house.
24297 No one had heard a shot.
24305 \begin_layout Standard
24306 If there is less vertical space than
24307 \change_deleted -712698321 1674913194
24309 \begin_inset space ~
24313 \change_inserted -712698321 1674913195
24316 text lines is left on the page at the beginning of the multiple columns,
24317 a page break will be inserted before the multiple columns.
24318 Depending on the number of lines of the preface text,
24319 you might want to change this space.
24320 This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
24322 Insert\SpecialChar menuseparator
24324 \begin_inset space ~
24328 \begin_inset space ~
24332 \begin_inset space ~
24338 Insert into that inset the amount of space like e.
24339 \begin_inset space \thinspace{}
24343 \begin_inset space \space{}
24347 \begin_inset Quotes eld
24351 \begin_inset Quotes erd
24355 \begin_inset Newline newline
24358 In this example the space is set to 7
24359 \begin_inset space ~
24362 text lines by using
24363 \begin_inset Flex Code
24366 \begin_layout Plain Layout
24375 \begin_inset Flex Code
24378 \begin_layout Plain Layout
24386 needs to be inserted as \SpecialChar TeX
24390 \begin_layout Standard
24391 \begin_inset Flex Multiple Columns
24394 \begin_layout Plain Layout
24395 \begin_inset Argument 3
24398 \begin_layout Plain Layout
24403 \begin_layout Plain Layout
24419 On the evening of the crime,
24420 he returned from the club exactly at ten.
24421 His mother and sister were out spending the evening with a relation.
24422 The servant deposed that she heard him enter the front room on the second floor,
24423 generally used as his sitting-room.
24424 She had lit a fire there,
24425 and as it smoked she had opened the window.
24426 No sound was heard from the room until eleven-twenty,
24427 the hour of the return of Lady Maynooth and her daughter.
24428 Desiring to say good-night,
24429 she attempted to enter her son's room.
24430 The door was locked on the inside,
24431 and no answer could be got to their cries and knocking.
24433 and the door forced.
24434 The unfortunate young man was found lying near the table.
24435 His head had been horribly mutilated by an expanding revolver bullet,
24436 but no weapon of any sort was to be found in the room.
24444 \begin_layout Paragraph
24448 \begin_layout Standard
24449 The amount of space before and after multiple columns can be changed by changing the length
24450 \begin_inset Flex Code
24453 \begin_layout Plain Layout
24462 For example the command
24465 \begin_layout LyX-Code
24473 \begin_layout Standard
24474 in \SpecialChar TeX
24475 Code changes its value to 3
24476 \begin_inset space \thinspace{}
24480 The change must be made before the multiple columns' start.
24481 The predefined value is 13
24482 \begin_inset space \thinspace{}
24488 \begin_layout Standard
24490 \begin_inset Flex Code
24493 \begin_layout Plain Layout
24502 \begin_inset space \thinspace{}
24508 \begin_layout Standard
24512 \begin_layout Plain Layout
24518 multicolsep}{2.5cm}
24526 \begin_layout Standard
24527 \begin_inset Flex Multiple Columns
24530 \begin_layout Plain Layout
24533 All day I turned these facts over in my mind,
24534 endeavouring to hit upon some theory which could reconcile them all,
24535 and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
24536 I confess that I made little progress.
24537 In the evening I strolled across the Park,
24538 and found myself about six o'clock at the Oxford Street end of Park Lane.
24539 A group of loafers upon the pavements,
24540 all staring up at a particular window,
24541 directed me to the house which I had come to see.
24543 thin man with coloured glasses,
24544 whom I strongly suspected of being a plain-clothes detective,
24545 was pointing out some theory of his own,
24546 while the others crowded round to listen to what he said.
24547 I got as near him as I could,
24548 but his observations seemed to me to be absurd,
24549 so I withdrew again in some disgust.
24550 As I did so I struck against an elderly,
24552 who had been behind me,
24553 and I knocked down several books which he was carrying.
24561 \begin_layout Standard
24562 \begin_inset Note Greyedout
24565 \begin_layout Plain Layout
24571 The values you set with
24572 \begin_inset Flex Code
24575 \begin_layout Plain Layout
24583 will be used for all following multiple columns until you change them again.
24591 \begin_layout Standard
24595 \begin_layout Plain Layout
24607 \begin_inset Note Note
24610 \begin_layout Plain Layout
24611 go back to the default
24619 \begin_layout Standard
24621 \change_deleted 564990737 1672236355
24622 \begin_inset Newpage newpage
24630 \begin_layout Paragraph
24634 \begin_layout Standard
24635 A column break can be forced by inserting the command
24636 \begin_inset Flex Code
24639 \begin_layout Plain Layout
24647 as \SpecialChar TeX
24648 Code to that position in the text where the column should be broken.
24649 Note that this leads in most cases to whitespace in the text.
24650 \begin_inset Newline newline
24653 Here is an example:
24656 \begin_layout Standard
24657 \begin_inset Flex Multiple Columns
24660 \begin_layout Plain Layout
24663 \begin_inset Quotes eld
24666 You're surprised to see me,
24668 \begin_inset Quotes erd
24676 \begin_layout Plain Layout
24679 I acknowledged that I was.
24682 \begin_layout Plain Layout
24685 \begin_inset Quotes eld
24691 and when I chanced to see you go into this house,
24692 as I came hobbling after you,
24693 I thought to myself,
24694 I'll just step in and see that kind gentleman,
24695 and tell him that if I was a bit gruff in my manner there was not any harm meant,
24696 and that I am much obliged to him for picking up my books.
24697 \begin_inset Quotes erd
24703 \begin_layout Plain Layout
24706 \begin_inset Quotes eld
24709 You make too much of a trifle,
24710 \begin_inset Quotes erd
24715 \begin_inset Quotes eld
24718 May I ask how you knew who I was?
24719 \begin_inset Quotes erd
24722 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
24726 \begin_layout Plain Layout
24738 \begin_layout Plain Layout
24741 \begin_inset Quotes eld
24746 if it isn't too great a liberty,
24747 I am a neighbour of yours,
24748 for you'll find my little bookshop at the corner of Church Street,
24749 and very happy to see you,
24751 Maybe you collect yourself,
24756 \begin_inset space ~
24772 \begin_inset space ~
24777 With five volumes you could just fill that gap on that second shelf.
24781 \begin_inset Quotes erd
24792 \begin_layout Paragraph
24796 \begin_layout Standard
24797 The width of the columns is automatically calculated,
24798 but you can modify the space between the columns.
24799 This is done by changing the length
24800 \begin_inset Flex Code
24803 \begin_layout Plain Layout
24812 Its predefined value is 10
24813 \begin_inset space \thinspace{}
24817 Here is an example where
24818 \begin_inset Flex Code
24821 \begin_layout Plain Layout
24830 \begin_inset space \thinspace{}
24836 \begin_layout Standard
24840 \begin_layout Plain Layout
24854 \begin_layout Standard
24855 \begin_inset Flex Multiple Columns
24858 \begin_layout Plain Layout
24861 My observations of No.
24862 \begin_inset space \space{}
24865 427 Park Lane did little to clear up the problem in which I was interested.
24866 The house was separated from the street by a low wall and railing,
24867 the whole not more than five feet high.
24868 It was perfectly easy,
24870 for anyone to get into the garden,
24871 but the window was entirely inaccessible,
24872 since there was no water pipe or anything which could help the most active man to climb it.
24873 More puzzled than ever,
24874 I retraced my steps to Kensington.
24875 I had not been in my study five minutes when the maid entered to say that a person desired to see me.
24876 To my astonishment it was none other than my strange old book collector,
24878 wizened face peering out from a frame of white hair,
24879 and his precious volumes,
24880 a dozen of them at least,
24881 wedged under his right arm.
24889 \begin_layout Standard
24893 \begin_layout Plain Layout
24905 \begin_inset Note Note
24908 \begin_layout Plain Layout
24909 go back to the default
24917 \begin_layout Paragraph
24921 \begin_layout Standard
24922 Between the columns a rule with a width of the length
24923 \begin_inset Flex Code
24926 \begin_layout Plain Layout
24935 If this rule width is set to 0
24936 \begin_inset space \thinspace{}
24939 pt (this is the default),
24940 the rule is suppressed.
24941 In the following example the rule is 2
24942 \begin_inset space \thinspace{}
24948 \begin_layout Standard
24952 \begin_layout Plain Layout
24958 columnseprule}{2pt}
24966 \begin_layout Standard
24967 \begin_inset Flex Multiple Columns
24970 \begin_layout Plain Layout
24973 \begin_inset Quotes eld
24976 You're surprised to see me,
24978 \begin_inset Quotes erd
24986 \begin_layout Plain Layout
24989 I acknowledged that I was.
24992 \begin_layout Plain Layout
24995 \begin_inset Quotes eld
25001 and when I chanced to see you go into this house,
25002 as I came hobbling after you,
25003 I thought to myself,
25004 I'll just step in and see that kind gentleman,
25005 and tell him that if I was a bit gruff in my manner there was not any harm meant,
25006 and that I am much obliged to him for picking up my books.
25007 \begin_inset Quotes erd
25013 \begin_layout Plain Layout
25016 \begin_inset Quotes eld
25019 You make too much of a trifle,
25020 \begin_inset Quotes erd
25025 \begin_inset Quotes eld
25028 May I ask how you knew who I was?
25029 \begin_inset Quotes erd
25035 \begin_layout Plain Layout
25038 \begin_inset Quotes eld
25043 if it isn't too great a liberty,
25044 I am a neighbour of yours,
25045 for you'll find my little bookshop at the corner of Church Street,
25046 and very happy to see you,
25048 Maybe you collect yourself,
25053 \begin_inset space ~
25069 \begin_inset space ~
25074 With five volumes you could just fill that gap on that second shelf.
25078 \begin_inset Quotes erd
25089 \begin_layout Standard
25090 \begin_inset VSpace defskip
25096 \begin_layout Standard
25097 The rule can be colored by redefining the command
25098 \begin_inset Flex Code
25101 \begin_layout Plain Layout
25110 This is done by inserting the command
25113 \begin_layout LyX-Code
25118 columnseprulecolor}{
25123 \begin_layout Standard
25124 as \SpecialChar TeX
25125 Code before the multicolumn inset.
25127 \begin_inset Flex Code
25130 \begin_layout Plain Layout
25136 in this command by a color of your choice.
25137 You can use all pre- and self-defined colors.
25146 \begin_inset space ~
25151 for more information about pre- and self-defined colors.
25152 To go back to the default color insert the command
25155 \begin_layout LyX-Code
25160 columnseprulecolor}{
25165 \begin_layout Standard
25166 Here is the example with a cyan rule and 1
25167 \begin_inset space \thinspace{}
25170 cm column separation:
25173 \begin_layout Standard
25177 \begin_layout Plain Layout
25186 \begin_layout Plain Layout
25192 columnseprulecolor}{
25202 \begin_layout Standard
25203 \begin_inset Flex Multiple Columns
25206 \begin_layout Plain Layout
25209 \begin_inset Quotes eld
25212 You're surprised to see me,
25214 \begin_inset Quotes erd
25222 \begin_layout Plain Layout
25225 I acknowledged that I was.
25228 \begin_layout Plain Layout
25231 \begin_inset Quotes eld
25237 and when I chanced to see you go into this house,
25238 as I came hobbling after you,
25239 I thought to myself,
25240 I'll just step in and see that kind gentleman,
25241 and tell him that if I was a bit gruff in my manner there was not any harm meant,
25242 and that I am much obliged to him for picking up my books.
25243 \begin_inset Quotes erd
25249 \begin_layout Plain Layout
25252 \begin_inset Quotes eld
25255 You make too much of a trifle,
25256 \begin_inset Quotes erd
25261 \begin_inset Quotes eld
25264 May I ask how you knew who I was?
25265 \begin_inset Quotes erd
25271 \begin_layout Plain Layout
25274 \begin_inset Quotes eld
25279 if it isn't too great a liberty,
25280 I am a neighbour of yours,
25281 for you'll find my little bookshop at the corner of Church Street,
25282 and very happy to see you,
25284 Maybe you collect yourself,
25289 \begin_inset space ~
25305 \begin_inset space ~
25310 With five volumes you could just fill that gap on that second shelf.
25314 \begin_inset Quotes erd
25325 \begin_layout Standard
25329 \begin_layout Plain Layout
25335 columnseprule}{0pt}
25338 \begin_layout Plain Layout
25344 columnseprulecolor}{
25352 \begin_inset Note Note
25355 \begin_layout Plain Layout
25356 go back to the default
25364 \begin_layout Section
25366 \change_inserted 564990737 1671270380
25370 \begin_layout Subsection
25372 \change_inserted 564990737 1671270398
25374 \change_deleted 564990737 1671270396
25380 \begin_layout Standard
25383 as well as any other text processor uses by default rectangular paragraphs.
25384 For special cases like for example posters,
25385 invitation cards or poems you can modify the paragraph shape to one of your choice.
25387 \change_deleted 564990737 1672311802
25388 This can be done by using the \SpecialChar LaTeX
25390 \begin_inset Flex Code
25393 \begin_layout Plain Layout
25399 which is loaded by using in the document settings the module
25401 Custom paragraph shapes
25404 \change_inserted 564990737 1672311802
25405 This module uses the
25409 package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
25415 \begin_layout Subsubsection
25419 \begin_layout Standard
25421 \change_deleted 5863208 1701101601
25425 \change_inserted 5863208 1701101603
25434 \change_inserted -712698321 1674913877
25437 provides the following shapes:
25440 \begin_layout Standard
25441 \begin_inset Tabular
25442 <lyxtabular version="3" rows="13" columns="3">
25443 <features booktabs="true" islongtable="true" longtabularalignment="center">
25444 <column alignment="left" valignment="middle" width="16col%">
25445 <column alignment="left" valignment="middle" width="40col%">
25446 <column alignment="left" valignment="middle" width="35col%">
25447 <row endhead="true">
25448 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25451 \begin_layout Plain Layout
25460 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25463 \begin_layout Plain Layout
25472 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25475 \begin_layout Plain Layout
25485 <row interlinespace="default">
25486 <cell alignment="left" valignment="top" usebox="none">
25489 \begin_layout Plain Layout
25497 <cell alignment="left" valignment="top" usebox="none">
25500 \begin_layout Plain Layout
25503 Circle with circular hole (in the size of a CD/DVD)
25508 <cell alignment="left" valignment="top" usebox="none">
25511 \begin_layout Plain Layout
25515 take care there is not too much text
25521 <row interlinespace="default">
25522 <cell alignment="left" valignment="top" usebox="none">
25525 \begin_layout Plain Layout
25533 <cell alignment="left" valignment="top" usebox="none">
25536 \begin_layout Plain Layout
25544 <cell alignment="left" valignment="top" usebox="none">
25547 \begin_layout Plain Layout
25551 calculation might fail
25557 <row interlinespace="default">
25558 <cell alignment="left" valignment="top" usebox="none">
25561 \begin_layout Plain Layout
25569 <cell alignment="left" valignment="top" usebox="none">
25572 \begin_layout Plain Layout
25575 Rhomboid (symbolizing a
25576 \begin_inset Quotes eld
25580 \begin_inset Quotes erd
25588 <cell alignment="left" valignment="top" usebox="none">
25591 \begin_layout Plain Layout
25600 <row interlinespace="default">
25601 <cell alignment="left" valignment="top" usebox="none">
25604 \begin_layout Plain Layout
25612 <cell alignment="left" valignment="top" usebox="none">
25615 \begin_layout Plain Layout
25623 <cell alignment="left" valignment="top" usebox="none">
25626 \begin_layout Plain Layout
25635 <row interlinespace="default">
25636 <cell alignment="left" valignment="top" usebox="none">
25639 \begin_layout Plain Layout
25647 <cell alignment="left" valignment="top" usebox="none">
25650 \begin_layout Plain Layout
25658 <cell alignment="left" valignment="top" usebox="none">
25661 \begin_layout Plain Layout
25670 <row interlinespace="default">
25671 <cell alignment="left" valignment="top" usebox="none">
25674 \begin_layout Plain Layout
25682 <cell alignment="left" valignment="top" usebox="none">
25685 \begin_layout Plain Layout
25688 Nut for bolt (hexagon with circular hole)
25693 <cell alignment="left" valignment="top" usebox="none">
25696 \begin_layout Plain Layout
25705 <row interlinespace="default">
25706 <cell alignment="left" valignment="top" usebox="none">
25709 \begin_layout Plain Layout
25717 <cell alignment="left" valignment="top" usebox="none">
25720 \begin_layout Plain Layout
25728 <cell alignment="left" valignment="top" usebox="none">
25731 \begin_layout Plain Layout
25740 <row interlinespace="default">
25741 <cell alignment="left" valignment="top" usebox="none">
25744 \begin_layout Plain Layout
25752 <cell alignment="left" valignment="top" usebox="none">
25755 \begin_layout Plain Layout
25763 <cell alignment="left" valignment="top" usebox="none">
25766 \begin_layout Plain Layout
25775 <row interlinespace="default">
25776 <cell alignment="left" valignment="top" usebox="none">
25779 \begin_layout Plain Layout
25787 <cell alignment="left" valignment="top" usebox="none">
25790 \begin_layout Plain Layout
25798 <cell alignment="left" valignment="top" usebox="none">
25801 \begin_layout Plain Layout
25810 <row interlinespace="default">
25811 <cell alignment="left" valignment="top" usebox="none">
25814 \begin_layout Plain Layout
25822 <cell alignment="left" valignment="top" usebox="none">
25825 \begin_layout Plain Layout
25828 Normal/reversed rain drop
25833 <cell alignment="left" valignment="top" usebox="none">
25836 \begin_layout Plain Layout
25840 calculation might fail
25846 <row interlinespace="default">
25847 <cell alignment="left" valignment="top" usebox="none">
25850 \begin_layout Plain Layout
25859 <cell alignment="left" valignment="top" usebox="none">
25862 \begin_layout Plain Layout
25865 The \SpecialChar TeX
25871 <cell alignment="left" valignment="top" usebox="none">
25874 \begin_layout Plain Layout
25883 <row interlinespace="default">
25884 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25887 \begin_layout Plain Layout
25891 \begin_inset Newline newline
25899 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25902 \begin_layout Plain Layout
25905 Triangles in different orientations
25910 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25913 \begin_layout Plain Layout
25929 \begin_layout Standard
25930 To use a shape for your paragraph,
25931 simply select it in \SpecialChar LyX
25932 's pull-down box for environments in the toolbar.
25935 \begin_layout Standard
25936 \begin_inset Newpage newpage
25942 \begin_layout Standard
25943 Here is an example paragraph in the shape of a nut:
25946 \begin_layout Standard
25947 \begin_inset VSpace bigskip
25956 Lorem ipsum dolor sit amet,
25957 consetetur sadipscing elitr,
25958 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25960 At vero eos et accusam et justo duo dolores et ea rebum.
25961 Stet clita kasd gubergren,
25962 no sea takimata sanctus est Lorem ipsum dolor sit amet.
25963 Lorem ipsum dolor sit amet,
25964 consetetur sadipscing elitr,
25965 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25969 \begin_layout Standard
25970 \begin_inset VSpace bigskip
25976 \begin_layout Standard
25977 \begin_inset Note Greyedout
25980 \begin_layout Plain Layout
25990 paragraphs cannot run over a page break.
25998 \begin_layout Standard
25999 \begin_inset VSpace bigskip
26005 \begin_layout Standard
26007 \begin_inset Flex Code
26010 \begin_layout Plain Layout
26016 takes care that the shape will always be preserved,
26017 no matter how much text is in the paragraph.
26018 Therefore the paragraph size changes with the amount of contained text.
26019 This can lead to paragraph sizes exceeding the page margins.
26020 To demonstrate the size scaling,
26021 here is the same example paragraph but with twice as much text:
26024 \begin_layout Standard
26025 \begin_inset Newpage newpage
26034 Lorem ipsum dolor sit amet,
26035 consetetur sadipscing elitr,
26036 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26038 At vero eos et accusam et justo duo dolores et ea rebum.
26039 Stet clita kasd gubergren,
26040 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26041 Lorem ipsum dolor sit amet,
26042 consetetur sadipscing elitr,
26043 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26045 Lorem ipsum dolor sit amet,
26046 consetetur sadipscing elitr,
26047 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26049 At vero eos et accusam et justo duo dolores et ea rebum.
26050 Stet clita kasd gubergren,
26051 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26052 Lorem ipsum dolor sit amet,
26053 consetetur sadipscing elitr,
26054 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26058 \begin_layout Standard
26059 \begin_inset VSpace bigskip
26065 \begin_layout Standard
26066 An exception is the shape
26071 It cannot be scaled because it must fit the size of a CD/DVD.
26072 Therefore the amount of text that fits into the shape is limited.
26073 \change_deleted -712698321 1674914001
26075 \begin_inset Newline newline
26079 \change_inserted -712698321 1674914001
26083 \begin_layout Standard
26093 meaning that the calculation of their size can fail,
26094 depending on the amount of text.
26095 You will then get the \SpecialChar LaTeX
26097 \begin_inset Quotes eld
26100 Arithmetic overflow
26101 \begin_inset Quotes erd
26105 In this case one can try to remove or add some text;
26106 if nothing works one has to use another shape.
26109 \begin_layout Standard
26111 \change_deleted -712698321 1674914021
26112 \begin_inset VSpace bigskip
26120 \begin_layout Standard
26121 For shapes with tips you will maybe see that \SpecialChar LaTeX
26122 's hyphenation routine fails for text in the tips.
26123 Therefore it is often necessary to add hyphenation points
26128 arg "specialchar-insert hyphenation"
26133 ) to the corresponding text parts.
26136 \begin_layout Standard
26138 \change_deleted -712698321 1674914022
26139 \begin_inset VSpace bigskip
26147 \begin_layout Standard
26148 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
26149 You can therefore not use the paragraph dialog to align such paragraphs.
26150 A solution is to put the paragraph into a minipage or parbox and align the box.
26151 The problem is hereby to find the right width for the box.
26152 Because if it is too wide and you center the box,
26153 the paragraph is not centered too because it sticks at the left side of the box.
26154 So you might have to play a bit with the width until it fits.
26155 Here are two heart-shaped paragraphs,
26156 the first one is not aligned,
26157 the second one is right-aligned:
26160 \begin_layout Standard
26161 \begin_inset Newpage newpage
26167 \begin_layout Heart
26171 Lo\SpecialChar softhyphen
26172 rem ipsum dolor sit amet,
26173 consetetur sadipscing elitr,
26174 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26176 At vero eos et accusam et justo duo dolores et ea rebum.
26177 Stet clita kasd gubergren,
26178 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26181 \begin_layout Standard
26182 \begin_inset VSpace bigskip
26188 \begin_layout Standard
26191 \begin_inset Box Frameless
26201 height_special "totalheight"
26206 backgroundcolor "none"
26209 \begin_layout Heart
26213 Lo\SpecialChar softhyphen
26214 rem ipsum dolor sit amet,
26215 consetetur sadipscing elitr,
26216 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26218 At vero eos et accusam et justo duo dolores et ea rebum.
26219 Stet clita kasd gubergren,
26220 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26228 \begin_layout Subsubsection
26232 \begin_layout Standard
26233 You can define any shape you want.
26234 Doing this manually is a lot of work because every coordinate must be specified.
26235 But there is a way to let the computer calculate the coordinates:
26238 \begin_layout Enumerate
26239 Install the program
26240 \begin_inset CommandInset href
26243 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26251 \begin_layout Enumerate
26258 TeX/LaTeX\SpecialChar menuseparator
26259 Settings\SpecialChar menuseparator
26262 and select the font size you are using in your document.
26263 For example this document uses the size 12
26264 \begin_inset space \thinspace{}
26270 \begin_layout Enumerate
26274 \begin_layout Enumerate
26277 TeX/LaTeX\SpecialChar menuseparator
26280 to export the shape to coordinates.
26281 In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
26285 \begin_layout Plain Layout
26286 For more information see
26287 \begin_inset CommandInset href
26289 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26302 \begin_layout Standard
26303 The coordinates are written into a \SpecialChar TeX
26305 To use it for your \SpecialChar LyX
26309 \begin_layout Enumerate
26310 Place the cursor before the first character of your paragraph (or into a new empty one).
26313 \begin_layout Enumerate
26314 Open in \SpecialChar LyX
26317 Insert\SpecialChar menuseparator
26318 File\SpecialChar menuseparator
26320 \begin_inset space ~
26326 select the file and use
26335 \begin_layout Standard
26336 \begin_inset VSpace defskip
26342 \begin_layout Standard
26343 \begin_inset Note Greyedout
26346 \begin_layout Plain Layout
26352 The changed shape only applies to the current paragraph;
26353 everything is reset to normal for the next paragraph.
26354 Therefore the shape definition file must be input into every paragraph with the desired shape.
26362 \begin_layout Standard
26363 \begin_inset VSpace bigskip
26369 \begin_layout Standard
26370 Here is an example:
26373 \begin_layout Standard
26374 \begin_inset VSpace bigskip
26380 \begin_layout Standard
26381 \begin_inset CommandInset include
26383 filename "SpecialParagraphShape.tex"
26390 Lorem ipsum dolor sit amet,
26391 consetetur sadipscing elitr,
26392 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26394 At vero eos et accusam et justo duo dolores et ea rebum.
26395 Stet clita kasd gubergren,
26396 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26397 Lorem ipsum dolor sit amet,
26398 consetetur sadipscing elitr,
26399 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26403 \begin_layout Standard
26404 \begin_inset VSpace bigskip
26410 \begin_layout Standard
26416 to draw complexer shapes in
26420 you can draw the shape in a program of your choice and import the resulting image to
26425 Then you only need to draw a line or spline along the outline of the image.
26428 \begin_layout Standard
26430 \change_deleted -712698321 1674914114
26431 \begin_inset VSpace bigskip
26439 \begin_layout Standard
26442 Custom paragraph shapes
26444 also provides the two commands
26452 which can be used to define custom shapes coordinate by coordinate.
26456 \begin_layout Plain Layout
26457 These commands are internally used for all shapes described here.
26462 For information how these styles are used and about further customization possibilities,
26464 \begin_inset CommandInset href
26466 name "documentation"
26467 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26473 \begin_inset Flex Code
26476 \begin_layout Plain Layout
26485 \begin_layout Subsection
26487 \change_inserted 564990737 1672311925
26491 \begin_layout Hanging
26493 \change_inserted 564990737 1672311925
26494 This module adds the
26500 one where all but the first line of the paragraph is indented.
26501 This may not appear in your \SpecialChar LyX
26502 document but will appear in the final output.
26505 \begin_layout Subsection
26507 \change_inserted 564990737 1672311925
26508 \begin_inset CommandInset label
26510 name "subsec:Initials"
26514 Initials (Drop Caps)
26517 \begin_layout Initial
26519 \change_inserted 564990737 1672311925
26520 \begin_inset Argument 2
26523 \begin_layout Plain Layout
26525 \change_inserted 564990737 1672311925
26534 \begin_inset Argument 3
26537 \begin_layout Plain Layout
26539 \change_inserted 564990737 1672311925
26547 module adds a drop capitals paragraph style
26551 for paragraph environments which you can use wherever you want to have drop capitals.
26552 You then have three more items in the
26559 \begin_layout Itemize
26561 \change_inserted 564990737 1672311925
26566 which creates an inset for the drop capital
26569 \begin_layout Itemize
26571 \change_inserted 564990737 1672311925
26576 which creates an inset for the rest of the word
26579 \begin_layout Itemize
26581 \change_inserted 564990737 1672311925
26586 which allow you configure the formatting of the drop capital.
26589 \begin_layout Standard
26591 \change_inserted 564990737 1672311925
26592 To customize the appearance of the style,
26595 Help\SpecialChar menuseparator
26596 Embedded Objects\SpecialChar menuseparator
26597 Objects Surrounded by Text\SpecialChar menuseparator
26603 \begin_layout Section
26605 \change_inserted 564990737 1672312011
26609 \begin_layout Subsection
26611 \change_inserted 564990737 1672312011
26612 Hyphenatable Text Markup
26613 \change_inserted -712698321 1674915075
26615 \change_inserted 564990737 1672312011
26619 \begin_layout Standard
26621 \change_inserted 564990737 1672312011
26623 \change_deleted -712698321 1674915086
26625 \change_inserted -712698321 1674915087
26627 \change_inserted 564990737 1672312011
26628 defines text styles to highlight,
26631 underline and capitalize/small-cap text by means of the
26637 \change_inserted -712698321 1674915141
26641 \begin_layout Standard
26643 \change_inserted 564990737 1672312011
26644 As opposed to the markup provided by the Text Properties dialog,
26645 words marked-up with
26651 \begin_inset CommandInset href
26653 name "soul documentation"
26654 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
26662 \begin_layout Subsection
26664 \change_inserted 564990737 1672312011
26668 \begin_layout Standard
26670 \change_inserted 564990737 1672312011
26671 This module defines some character styles for logical markup:
26675 \begin_inset Flex Noun
26678 \begin_layout Plain Layout
26680 \change_inserted 564990737 1672312011
26696 \begin_inset Flex Emph
26699 \begin_layout Plain Layout
26701 \change_inserted 564990737 1672312011
26715 \begin_inset Flex Strong
26718 \begin_layout Plain Layout
26720 \change_inserted 564990737 1672312011
26730 \begin_inset Flex Code
26733 \begin_layout Plain Layout
26735 \change_inserted 564990737 1672312011
26743 which are accessed via the
26748 dit\SpecialChar menuseparator
26750 \begin_inset space ~
26754 \begin_inset space ~
26766 \begin_layout Chapter
26768 \change_deleted 564990737 1671304317
26772 \change_inserted 564990737 1671304322
26774 \change_deleted 564990737 1671304331
26775 ies with Bib\SpecialChar TeX
26781 \begin_layout Standard
26782 The most basic information about how to use Bib\SpecialChar TeX
26787 with \SpecialChar LyX
26788 is contained in the section
26790 Bibliography databases
26797 The following subsections explain special bibliography features supported by \SpecialChar LyX
26801 \begin_layout Section
26802 Alternative Citation Styles
26805 \begin_layout Standard
26806 Standard Bib\SpecialChar TeX
26808 \begin_inset space \thinspace{}
26812 \begin_inset space \space{}
26816 \begin_inset Quotes eld
26820 \begin_inset Quotes erd
26823 ) to refer to a cited work.
26825 in many scientific disciplines,
26826 other citation styles are in use.
26827 The most common one is the author-year style (e.
26828 \begin_inset space \thinspace{}
26832 \begin_inset space \space{}
26836 \begin_inset Quotes eld
26840 \begin_inset Quotes erd
26845 supports three packages that provide this style,
26847 \begin_inset Flex Code
26850 \begin_layout Plain Layout
26858 \begin_inset Flex Code
26861 \begin_layout Plain Layout
26869 \begin_inset Flex Code
26872 \begin_layout Plain Layout
26879 Each of these packages has their pros and cons,
26880 which cannot be listed in detail.
26881 If you only want to have simple author-year (or author-numerical) style,
26882 or if you want to use one of the countless style files for
26883 \begin_inset Flex Code
26886 \begin_layout Plain Layout
26893 then the established
26894 \begin_inset Flex Code
26897 \begin_layout Plain Layout
26903 package is probably your choice.
26904 If you look for specific citation styles common in law studies,
26905 you might consider the
26906 \begin_inset Flex Code
26909 \begin_layout Plain Layout
26916 If you want to have full control over the formatting or look for advanced features such as ibidem,
26917 footnote citations,
26918 full title citations,
26919 advanced date formats (such as 400 BC) or full localization to other languages than English,
26920 you should definitely consider
26921 \begin_inset Flex Code
26924 \begin_layout Plain Layout
26931 which exceeds all other packages in terms of features,
26932 but is also quite heavy and more resource-hungry.
26935 \begin_layout Standard
26936 The handling of these packages in \SpecialChar LyX
26937 is basically the same.
26939 \change_deleted -712698321 1674917685
26941 \begin_inset Flex Noun
26944 \begin_layout Plain Layout
26945 Document\SpecialChar menuseparator
26952 \change_inserted -712698321 1674917685
26955 Document\SpecialChar menuseparator
26961 \change_deleted -712698321 1674917692
26963 \begin_inset Flex Noun
26966 \begin_layout Plain Layout
26973 \change_inserted -712698321 1674917692
26981 \change_deleted -712698321 1674917696
26983 \begin_inset Flex Noun
26986 \begin_layout Plain Layout
26993 \change_inserted -712698321 1674917696
27001 \change_deleted -712698321 1674917703
27003 \begin_inset Flex Noun
27006 \begin_layout Plain Layout
27013 \change_inserted -712698321 1674917703
27022 \change_deleted -712698321 1674917708
27024 \begin_inset Flex Noun
27027 \begin_layout Plain Layout
27034 \change_inserted -712698321 1674917708
27043 \change_deleted -712698321 1674917712
27045 \begin_inset Flex Noun
27048 \begin_layout Plain Layout
27049 Biblatex (Natbib mode)
27055 \change_inserted -712698321 1674917712
27058 Biblatex (Natbib mode)
27064 \change_deleted -712698321 1674917718
27066 \begin_inset Flex Noun
27069 \begin_layout Plain Layout
27076 \change_inserted -712698321 1674917718
27084 \change_deleted -712698321 1674917724
27086 \begin_inset Flex Noun
27089 \begin_layout Plain Layout
27096 \change_inserted -712698321 1674917724
27104 \begin_inset space ~
27107 6.5.3 in the User's Guide for more information on these choices).
27108 With all these packages,
27109 you will get some extra features in the citation dialog and you can select the style of the reference (
27110 \begin_inset Quotes eld
27114 \begin_inset Quotes erd
27119 \begin_inset Quotes eld
27123 \begin_inset Quotes erd
27128 \begin_inset Quotes eld
27133 \begin_inset Quotes erd
27138 \begin_inset Quotes eld
27142 \begin_inset Quotes erd
27146 Note that either package needs specifically designed style files.
27147 They all ship their own,
27148 but there are lots of additional style files,
27149 and there is even an interactive style file builder
27153 \begin_layout Plain Layout
27155 \begin_inset Flex URL
27158 \begin_layout Plain Layout
27160 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
27171 \begin_inset Flex Code
27174 \begin_layout Plain Layout
27183 \begin_layout Section
27184 Subdivided Bibliographies
27187 \begin_layout Standard
27188 Sometimes you might need to divide your bibliography into several sections.
27189 If you are for instance a historian,
27190 the possibility to separate sources and scientific works is most likely a
27191 \begin_inset Quotes eld
27195 \begin_inset Quotes erd
27200 Bib\SpecialChar TeX
27201 itself does not allow you to do this.
27202 But with the help of some \SpecialChar LaTeX
27204 Bib\SpecialChar TeX
27205 can be extended to fit your needs.
27208 \begin_layout Standard
27210 provides native support for one of these packages,
27219 \begin_layout Plain Layout
27221 \begin_inset Flex URL
27224 \begin_layout Plain Layout
27226 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
27236 The advantage of this package (compared to other packages such as
27240 ) is that you don't need to define new citation commands.
27242 you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
27244 If you want to divide your bibliography into the sections
27245 \begin_inset Quotes eld
27249 \begin_inset Quotes erd
27253 \begin_inset Quotes eld
27257 \begin_inset Quotes erd
27261 you first need to create two bibliographic databases,
27263 \begin_inset space \thinspace{}
27267 \begin_inset space \space{}
27271 \begin_inset Flex Code
27274 \begin_layout Plain Layout
27281 \begin_inset Flex Code
27284 \begin_layout Plain Layout
27294 \begin_layout Standard
27296 \change_deleted -712698321 1674917736
27298 \begin_inset Flex Noun
27301 \begin_layout Plain Layout
27302 Document\SpecialChar menuseparator
27309 \change_inserted -712698321 1674917736
27312 Document\SpecialChar menuseparator
27318 \change_deleted -712698321 1674917752
27320 \begin_inset Flex Noun
27323 \begin_layout Plain Layout
27330 \change_inserted -712698321 1674917752
27338 \change_deleted -712698321 1674917741
27342 \begin_inset Flex Noun
27345 \begin_layout Plain Layout
27348 Subdivided bibliography
27354 \change_inserted -712698321 1674917741
27355 Subdivided bibliography
27360 Now you can insert multiple Bib\SpecialChar TeX
27362 one for each section of your bibliography.
27363 Returning to our example:
27364 Insert the Bib\SpecialChar TeX
27366 \begin_inset Flex Code
27369 \begin_layout Plain Layout
27375 and a second one for the database
27376 \begin_inset Flex Code
27379 \begin_layout Plain Layout
27386 You are free to use the same or different styles for each section.
27388 you can choose if the bibliography section should contain
27389 \begin_inset Quotes eld
27392 all cited references
27393 \begin_inset Quotes erd
27396 of the specified database(s) (which is the default),
27398 \begin_inset Quotes eld
27401 all uncited references
27402 \begin_inset Quotes erd
27406 \begin_inset Quotes eld
27410 \begin_inset Quotes erd
27414 This might be useful if you would like to separate your bibliography into three sections:
27416 \begin_inset Quotes eld
27420 \begin_inset Quotes erd
27425 \begin_inset Quotes eld
27429 \begin_inset Quotes erd
27434 \begin_inset Quotes eld
27438 \begin_inset Quotes erd
27442 The titles for the sections can be added as ordinary sections or subsections.
27444 \begin_inset Flex Code
27447 \begin_layout Plain Layout
27453 removes the bibliography title,
27454 you have to manually re-add that,
27455 too (as a chapter* or section*,
27459 \begin_layout Standard
27465 the procedure is a bit different.
27476 \begin_inset Flex Noun
27479 \begin_layout Plain Layout
27480 Subdivided bibliography
27485 option is disabled if you use
27495 provides its own means to generate subdivided bibliographies.
27496 You can either add keywords to bibliography entries via the
27497 \begin_inset Flex Code
27500 \begin_layout Plain Layout
27506 entry option and then filter bibliography sections by keyword (by adding
27507 \begin_inset Flex Code
27510 \begin_layout Plain Layout
27517 \begin_inset Flex Noun
27520 \begin_layout Plain Layout
27526 field of the dialog that opens if you left-click on the
27527 \begin_inset Flex Noun
27530 \begin_layout Plain Layout
27531 Biblatex Generated Bibliography
27537 or you can filter by entry types (such as
27546 \begin_inset space \thinspace{}
27551 \begin_inset Flex Code
27554 \begin_layout Plain Layout
27561 \begin_inset Flex Code
27564 \begin_layout Plain Layout
27571 \begin_inset Flex Noun
27574 \begin_layout Plain Layout
27581 or you can create so-called
27582 \begin_inset Quotes eld
27585 Bibliography Categories
27586 \begin_inset Quotes erd
27589 to which you can assign individual entries.
27590 Please refer to the Biblatex manual,
27593 Subdivided Bibliographies
27599 \begin_layout Section
27600 Multiple Bibliographies
27601 \begin_inset CommandInset label
27603 name "subsec:Multiple-Bibliographies"
27610 \begin_layout Standard
27611 Multiple bibliographies,
27613 \begin_inset space \thinspace{}
27617 \begin_inset space \space{}
27620 a bibliography for each part,
27623 subsection or child (sub-document) of the document,
27624 are also supported by \SpecialChar LyX
27626 In order to enable it,
27628 \change_deleted -712698321 1674917759
27630 \begin_inset Flex Noun
27633 \begin_layout Plain Layout
27634 Document\SpecialChar menuseparator
27635 Settings\SpecialChar menuseparator
27642 \change_inserted -712698321 1674917759
27645 Document\SpecialChar menuseparator
27646 Settings\SpecialChar menuseparator
27651 and select the relevant unit (e.
27652 \begin_inset space \thinspace{}
27657 \begin_inset Quotes eld
27661 \begin_inset Quotes erd
27665 \begin_inset Flex Noun
27668 \begin_layout Plain Layout
27669 Multiple Bibliographies
27675 Then add a Bib(la)\SpecialChar TeX
27676 bibliography to each unit (e.
27677 \begin_inset space \thinspace{}
27681 section) of your document.
27683 a separate bibliography,
27684 containing only the references done in the current unit is generated.
27687 \begin_layout Standard
27688 If you use Bib\SpecialChar TeX
27691 \begin_inset Flex Code
27694 \begin_layout Plain Layout
27701 \begin_inset Flex Code
27704 \begin_layout Plain Layout
27710 package is used to create multiple bibliographies.
27711 The former package is used if you select
27712 \begin_inset Quotes eld
27716 \begin_inset Quotes erd
27724 \begin_inset Flex Noun
27727 \begin_layout Plain Layout
27728 Sectioned Bibliography
27734 In all other cases,
27736 \begin_inset Flex Code
27739 \begin_layout Plain Layout
27749 \begin_layout Plain Layout
27750 An alternative approach,
27751 if you are willing to use some
27752 \begin_inset Flex Noun
27755 \begin_layout Plain Layout
27763 \begin_inset space ~
27767 \begin_inset CommandInset ref
27769 reference "sec:Inserting-TeX-Code"
27776 \begin_inset Flex Code
27779 \begin_layout Plain Layout
27791 \begin_inset Flex Code
27794 \begin_layout Plain Layout
27802 encloses the specified units in
27803 \begin_inset Flex Code
27806 \begin_layout Plain Layout
27813 \begin_inset Flex Code
27816 \begin_layout Plain Layout
27825 \begin_inset Flex Code
27828 \begin_layout Plain Layout
27836 in order to create the units.
27837 Note that this approach has some limitations.
27839 every citation reference has to be inside some
27840 \begin_inset Flex Code
27843 \begin_layout Plain Layout
27850 So citations outside a defined unit (e.
27851 \begin_inset space \thinspace{}
27855 before the first section if you use
27856 \begin_inset Quotes eld
27860 \begin_inset Quotes erd
27864 \begin_inset Quotes eld
27868 \begin_inset Quotes erd
27872 You can also create your own units by entering
27873 \begin_inset Flex Code
27876 \begin_layout Plain Layout
27885 \begin_inset Flex Code
27888 \begin_layout Plain Layout
27896 as \SpecialChar TeX
27897 code (for instance to work around the mentioned limitation).
27901 \begin_inset Flex Code
27904 \begin_layout Plain Layout
27910 s cannot be nested.
27911 A second limitation is that
27912 \begin_inset Flex Code
27915 \begin_layout Plain Layout
27921 always processes all references of a bibliography database,
27922 even if they are not cited.
27923 This can result in odd labels (e.
27924 \begin_inset space \thinspace{}
27929 \begin_inset Quotes eld
27933 \begin_inset Quotes erd
27936 if two works of this author from 2014 are in the database,
27937 even if only one is cited).
27940 \begin_layout Standard
27947 \begin_inset Flex Code
27950 \begin_layout Plain Layout
27956 option is used instead.
27957 If you need specific units,
27958 you can start them with the \SpecialChar TeX
27960 \begin_inset Flex Code
27963 \begin_layout Plain Layout
27972 \begin_inset Flex Code
27975 \begin_layout Plain Layout
27985 If you also want to control the end of the unit,
27986 use the environment
27987 \begin_inset Flex Code
27990 \begin_layout Plain Layout
28000 \begin_inset Flex Code
28003 \begin_layout Plain Layout
28015 \begin_inset Flex Code
28018 \begin_layout Plain Layout
28024 s cannot be nested.
28025 In addition to the individual bibliography of the current unit,
28030 also provides an easy way to output all bibliographies,
28033 \begin_inset space \thinspace{}
28037 at the end of the document).
28039 \begin_inset Quotes eld
28042 all reference units
28043 \begin_inset Quotes erd
28046 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
28047 Please refer to the
28051 manual for more information on this topic.
28054 \begin_layout Chapter
28056 \change_deleted 564990737 1671355654
28060 \change_inserted 564990737 1671355667
28062 \change_deleted 564990737 1671355661
28064 \change_inserted 564990737 1671355684
28066 \begin_inset CommandInset label
28068 name "chap:bullets"
28073 \change_deleted 564990737 1671355684
28075 \begin_inset CommandInset label
28086 \begin_layout Standard
28092 \begin_layout Section
28096 \begin_layout Standard
28098 provides 216 bullet shapes that can be accessed from a simple dialog.
28099 Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
28100 These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
28104 \begin_layout Plain Layout
28106 actually you can but you'll have to do it by hand.
28114 \begin_layout Section
28118 \begin_layout Standard
28119 Open the dialog by selecting the
28120 \change_deleted -712698321 1674916009
28122 \begin_inset Flex Noun
28125 \begin_layout Plain Layout
28126 Document\SpecialChar menuseparator
28133 \change_inserted -712698321 1674916009
28136 Document\SpecialChar menuseparator
28141 menu item and then select the
28142 \begin_inset Flex Noun
28145 \begin_layout Plain Layout
28154 \begin_layout Standard
28155 The dialog provides you with a table of bullet shapes.
28156 A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
28157 The row of buttons across the top is used to select which bullet depth you are changing.
28158 \change_inserted -712698321 1674916033
28162 \begin_layout Standard
28164 \change_inserted -712698321 1674916177
28171 \change_deleted -712698321 1674916065
28173 \change_inserted -712698321 1674916067
28176 text entry under the table
28177 \change_inserted -712698321 1674916074
28179 \change_deleted -712698321 1674916096
28180 shows the currently selected
28181 \change_inserted -712698321 1674916101
28182 in which you can enter a
28184 bullet shape's \SpecialChar LaTeX
28186 \change_deleted -712698321 1674916109
28187 and this can be edited if desired
28190 If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
28194 \begin_layout Standard
28195 The six panels are divided up by the packages they require.
28196 The following table shows the mappings from button name to \SpecialChar LaTeX
28200 \begin_layout Standard
28202 \begin_inset Tabular
28203 <lyxtabular version="3" rows="7" columns="2">
28204 <features tabularvalignment="middle">
28205 <column alignment="center" valignment="top" width="0pt">
28206 <column alignment="center" valignment="top" width="0pt">
28208 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28211 \begin_layout Plain Layout
28226 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28229 \begin_layout Plain Layout
28246 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28249 \begin_layout Plain Layout
28264 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28267 \begin_layout Plain Layout
28276 base \SpecialChar LaTeX
28284 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28287 \begin_layout Plain Layout
28302 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28305 \begin_layout Plain Layout
28322 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28325 \begin_layout Plain Layout
28340 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28343 \begin_layout Plain Layout
28360 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28363 \begin_layout Plain Layout
28378 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28381 \begin_layout Plain Layout
28398 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28401 \begin_layout Plain Layout
28416 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28419 \begin_layout Plain Layout
28436 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28439 \begin_layout Plain Layout
28454 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28457 \begin_layout Plain Layout
28480 \begin_layout Standard
28482 doesn't stop you using bullets from packages you don't have.
28483 If you get errors from \SpecialChar LaTeX
28484 when you try to view or print the file,
28485 then it is likely you are missing a package.
28489 \begin_layout Plain Layout
28491 doesn't restrict your use since you may be editing locally and exporting elsewhere.
28499 \begin_layout Section
28501 \change_inserted -712698321 1674916414
28502 \begin_inset CommandInset label
28504 name "sec:How-to-use"
28513 \begin_layout Standard
28514 Select which bullet depth you want to change then select the bullet shape and size.
28515 Any changes will not be visible in \SpecialChar LyX
28517 but are visible when viewing the document.
28520 \begin_layout Standard
28521 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
28522 \change_deleted -712698321 1674916288
28527 \begin_layout Plain Layout
28529 \change_deleted -712698321 1674916287
28530 \begin_inset CommandInset label
28532 name "fn:If-you-really"
28542 want to have multiple sets of paragraphs with different sets of bullets in each,
28543 then you're going to have to get your hands dirty with \SpecialChar TeX
28545 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
28546 code for a wide range of bullet shapes.
28547 To make your own custom paragraphs you have the following options:
28550 \begin_layout Plain Layout
28554 \begin_layout Plain Layout
28570 \begin_layout Plain Layout
28574 \begin_layout Plain Layout
28596 \begin_layout Itemize
28597 Use the \SpecialChar LaTeX
28599 \begin_inset Flex Code
28602 \begin_layout Plain Layout
28610 to specify a new bullet shape for a given depth.
28611 You'll also need to save the current bullet shape so you can restore it again afterwards.
28612 In this itemized list the following \SpecialChar LaTeX
28613 code was used to change the bullet used for the first depth.
28617 \begin_layout LyX-Code
28627 \begin_layout LyX-Code
28644 \begin_layout Itemize
28645 Note that the itemize depth is specified in Roman numerals as part of the
28654 \begin_layout Itemize
28655 \begin_inset Argument item:1
28658 \begin_layout Plain Layout
28662 \begin_layout Plain Layout
28680 Specify each individual entry by starting each item with the bullet shape enclosed in a
28681 \begin_inset Quotes eld
28685 \begin_inset Quotes erd
28688 inset (available at
28690 Insert\SpecialChar menuseparator
28694 \begin_inset Flex Noun
28697 \begin_layout Plain Layout
28706 this item was started with
28707 \begin_inset Flex Code
28710 \begin_layout Plain Layout
28725 \begin_layout Plain Layout
28729 \begin_layout Plain Layout
28745 \begin_layout Plain Layout
28746 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
28747 The way used here was:
28750 \begin_layout LyX-Code
28763 \change_inserted -712698321 1674916331
28765 \begin_inset CommandInset label
28767 name "fn:If-you-really"
28774 \begin_layout Standard
28776 \change_inserted -712698321 1674916288
28781 want to have multiple sets of paragraphs with different sets of bullets in each,
28782 then you're going to have to get your hands dirty with \SpecialChar TeX
28784 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
28785 code for a wide range of bullet shapes.
28786 To make your own custom paragraphs you have the following options:
28789 \begin_layout Standard
28791 \change_inserted -712698321 1674916288
28795 \begin_layout Plain Layout
28797 \change_inserted -712698321 1674916288
28813 \begin_layout Standard
28815 \change_inserted -712698321 1674916288
28819 \begin_layout Plain Layout
28821 \change_inserted -712698321 1674916288
28843 \begin_layout Itemize
28845 \change_inserted -712698321 1674916288
28846 Use the \SpecialChar LaTeX
28848 \begin_inset Flex Code
28851 \begin_layout Plain Layout
28853 \change_inserted -712698321 1674916288
28863 to specify a new bullet shape for a given depth.
28864 You'll also need to save the current bullet shape so you can restore it again afterwards.
28865 In this itemized list the following \SpecialChar LaTeX
28866 code was used to change the bullet used for the first depth.
28870 \begin_layout LyX-Code
28872 \change_inserted -712698321 1674916288
28882 \begin_layout LyX-Code
28884 \change_inserted -712698321 1674916288
28901 \begin_layout Itemize
28903 \change_inserted -712698321 1674916288
28904 Note that the itemize depth is specified in Roman numerals as part of the
28913 \begin_layout Itemize
28915 \change_inserted -712698321 1674916288
28916 \begin_inset Argument item:1
28919 \begin_layout Plain Layout
28921 \change_inserted -712698321 1674916288
28925 \begin_layout Plain Layout
28927 \change_inserted -712698321 1674916288
28947 Specify each individual entry by starting each item with the bullet shape enclosed in a
28948 \begin_inset Quotes eld
28952 \begin_inset Quotes erd
28955 inset (available at
28957 Insert\SpecialChar menuseparator
28961 \begin_inset Flex Noun
28964 \begin_layout Plain Layout
28966 \change_inserted -712698321 1674916288
28977 this item was started with
28978 \begin_inset Flex Code
28981 \begin_layout Plain Layout
28983 \change_inserted -712698321 1674916288
29000 \begin_layout Standard
29002 \change_inserted -712698321 1674916288
29006 \begin_layout Plain Layout
29008 \change_inserted -712698321 1674916288
29024 \begin_layout Standard
29026 \change_inserted -712698321 1674916288
29027 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
29028 The way used here was:
29031 \begin_layout LyX-Code
29033 \change_inserted -712698321 1674916288
29045 \begin_layout Chapter
29049 \begin_layout Section
29050 Multipart Documents
29053 \begin_layout Subsection
29057 \begin_layout Standard
29058 When you are working on a large file with many sections,
29059 it is often convenient to break up the document into several files,
29060 or perhaps you have something where a table may change from time to time,
29061 but the preceding text does not.
29063 you should seriously consider using multipart documents.
29065 scientific papers often have five major sections:
29071 Each of these could be its own separate \SpecialChar LyX
29074 \begin_inset Quotes eld
29078 \begin_inset Quotes erd
29081 file which contains the title,
29086 plus the five included files.
29087 It is important to note that each of these files is a full \SpecialChar LyX
29088 file which can be formatted and printed on its own,
29089 as well as included in a master file.
29090 Each of these files must have the same document class,
29092 don't attempt to mix book classes with article classes.
29093 You may also include \SpecialChar LaTeX
29096 these files must not have their own preamble (i.
29097 \begin_inset space \thinspace{}
29101 \begin_inset space \space{}
29104 everything up to and including the
29105 \begin_inset Flex Code
29108 \begin_layout Plain Layout
29116 line as well as the
29117 \begin_inset Flex Code
29120 \begin_layout Plain Layout
29128 line must be deleted) or else errors will be generated when you try to make a DVI file.
29131 \begin_layout Standard
29133 allows you to include files quite easily with
29134 \change_deleted -712698321 1674917774
29136 \begin_inset Flex Noun
29139 \begin_layout Plain Layout
29140 Insert\SpecialChar menuseparator
29142 \begin_inset space ~
29151 \change_inserted -712698321 1674917774
29154 Insert\SpecialChar menuseparator
29156 \begin_inset space ~
29164 When you click on this selection a small box is inserted into the file at the current cursor location.
29165 Clicking on the box raises a dialog which allows you to select the file to be included,
29166 and the method of its inclusion.
29170 \begin_layout Standard
29171 The file selection box should by now be obvious.
29172 The three inclusion methods are
29173 \begin_inset Quotes eld
29177 \begin_inset Quotes erd
29182 \begin_inset Quotes eld
29186 \begin_inset Quotes erd
29191 \begin_inset Quotes eld
29195 \begin_inset Quotes erd
29200 \begin_inset Quotes eld
29204 \begin_inset Quotes erd
29208 \begin_inset Quotes eld
29212 \begin_inset Quotes erd
29215 are similar in many ways,
29216 but there are also some notable differences:
29219 \begin_layout Enumerate
29221 \begin_inset Quotes eld
29225 \begin_inset Quotes erd
29228 are typeset beginning on a new page,
29229 while files that are
29230 \begin_inset Quotes eld
29234 \begin_inset Quotes erd
29237 are typeset starting on the current page.
29240 \begin_layout Enumerate
29241 \begin_inset Quotes eld
29245 \begin_inset Quotes erd
29248 files cannot themselves
29249 \begin_inset Quotes eld
29253 \begin_inset Quotes erd
29257 \begin_inset Quotes eld
29261 \begin_inset Quotes erd
29266 \begin_inset Quotes eld
29270 \begin_inset Quotes erd
29275 infinite sub-inputting is possible.
29278 \begin_layout Enumerate
29279 \begin_inset Quotes eld
29283 \begin_inset Quotes erd
29286 allow for the output of only selected
29287 \begin_inset Quotes eld
29291 \begin_inset Quotes erd
29295 while maintaining the actual counters (pagination etc.) and references (please refer to the section
29298 \begin_inset space ~
29306 \begin_inset space ~
29311 manual for details).
29314 \begin_layout Standard
29317 \begin_inset Quotes eld
29321 \begin_inset Quotes erd
29324 is the preferred method for chapters that are outsourced to child documents,
29326 \begin_inset Quotes eld
29330 \begin_inset Quotes erd
29333 is more suitable for arbitrary file inheritance.
29336 \begin_layout Standard
29338 \begin_inset Quotes eld
29342 \begin_inset Quotes erd
29345 included file allows you to include a file typeset exactly as it appears in the file,
29347 \begin_inset space \thinspace{}
29351 \begin_inset space \space{}
29355 \begin_inset Flex Code
29358 \begin_layout Plain Layout
29365 with the characters set in a fixed-width typewriter font.
29367 spaces in this file are invisible,
29368 though two consecutive spaces are conserved,
29369 unlike \SpecialChar LyX
29370 's normal treatment of spaces.
29373 \begin_inset Flex Noun
29376 \begin_layout Plain Layout
29378 \begin_inset space ~
29382 \begin_inset space ~
29386 \begin_inset space ~
29394 checkbox typesets a mark to unambiguously define the presence of a space.
29398 \begin_layout Standard
29400 the master file is converted into a full \SpecialChar LaTeX
29401 file before typesetting,
29402 while the included files are converted to \SpecialChar LaTeX
29403 files that do not have all the preamble information.
29406 \begin_layout Subsection
29407 Cross-References Between Files
29410 \begin_layout Standard
29411 \begin_inset Box Shadowbox
29421 height_special "totalheight"
29426 backgroundcolor "none"
29429 \begin_layout Plain Layout
29430 This section is somewhat out of date.
29431 Need to describe default master documents and how children are opened when the master is.
29440 \begin_layout Standard
29441 It is possible to set up cross-references between the different files.
29443 open all the files in question:
29444 let's call them A and B in a two file example,
29445 where B is included in A.
29446 Let's say you insert a label in A,
29447 then want to reference it in B.
29448 Open the cross-reference dialog whilst in document B,
29449 and you can select the
29450 \begin_inset Quotes eld
29454 \begin_inset Quotes erd
29460 \begin_layout Subsection
29461 Bibliography Lists in all Subdocuments
29464 \begin_layout Standard
29465 If you work with child documents,
29466 you might want to have only one main bibliography at the end,
29467 but still be able to have a selected bibliography for the child if you output it on its own.
29468 Here is how to achieve this.
29471 \begin_layout Standard
29472 For the main document,
29473 you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
29474 If the bibliography inset is in the master file,
29475 the references will be inherited by all children,
29476 so they are available in the citation dialog within each child.
29479 \begin_layout Standard
29480 For child-specific bibliographies,
29481 insert bibliography insets within the child documents,
29482 at the place where the bibliography should appear when the child is compiled separately.
29484 the trick is to insert them into a branch (
29486 Insert\SpecialChar menuseparator
29487 Branch\SpecialChar menuseparator
29488 Insert New Branch...
29492 \begin_inset space \thinspace{}
29497 \begin_inset Quotes eld
29501 \begin_inset Quotes erd
29505 Within the children,
29506 activate the branch (
29508 Document\SpecialChar menuseparator
29509 Settings...\SpecialChar menuseparator
29514 deactivate the branch (
29516 Document\SpecialChar menuseparator
29517 Settings...\SpecialChar menuseparator
29521 Now the child's bibliography will be ignored by the master,
29522 but considered by the child.
29525 \begin_layout Standard
29526 If you need multiple bibliographies (e.
29527 \begin_inset space \thinspace{}
29531 one per child in the
29536 please refer to sec.
29537 \begin_inset space ~
29541 \begin_inset CommandInset ref
29543 reference "subsec:Multiple-Bibliographies"
29551 \begin_layout Section
29556 \begin_layout Standard
29557 Users sometimes need to be able to
29558 \begin_inset Quotes eld
29562 \begin_inset Quotes erd
29566 file together with all the images (and other files) on which it depends,
29567 either for sending to a publisher or for sharing with a co-author.
29569 includes a Python script (
29570 \begin_inset Flex Code
29573 \begin_layout Plain Layout
29579 ) that automates this process.
29581 you must have either the
29582 \begin_inset Flex Code
29585 \begin_layout Plain Layout
29592 \begin_inset Flex Code
29595 \begin_layout Plain Layout
29601 python modules installed on your system.
29603 the script prefers the
29604 \begin_inset Flex Code
29607 \begin_layout Plain Layout
29614 \begin_inset Flex Code
29617 \begin_layout Plain Layout
29623 format on Unix-like systems and the
29624 \begin_inset Flex Code
29627 \begin_layout Plain Layout
29636 \begin_layout Standard
29638 's configuration process will set the script up to export a `\SpecialChar LyX
29640 and this format will then be available under
29641 \change_deleted -712698321 1674917789
29643 \begin_inset Flex Code
29646 \begin_layout Plain Layout
29647 File\SpecialChar menuseparator
29654 \change_inserted -712698321 1674917789
29657 File\SpecialChar menuseparator
29665 \begin_layout Standard
29666 Independently of the platform,
29667 the generation of a particular archive format can be forced by adding either the
29668 \begin_inset Flex Code
29671 \begin_layout Plain Layout
29678 \begin_inset Flex Code
29681 \begin_layout Plain Layout
29688 \begin_inset Flex Code
29691 \begin_layout Plain Layout
29698 \begin_inset Flex Code
29701 \begin_layout Plain Layout
29707 format) switch to the
29708 \begin_inset Flex Code
29711 \begin_layout Plain Layout
29714 \change_deleted -712698321 1674918890
29715 \SpecialChar menuseparator
29717 \change_inserted -712698321 1674918890
29727 \change_deleted -712698321 1674917814
29729 \begin_inset Flex Code
29732 \begin_layout Plain Layout
29733 Tools\SpecialChar menuseparator
29734 Preferences\SpecialChar menuseparator
29735 File Handling\SpecialChar menuseparator
29742 \change_inserted -712698321 1674917814
29745 Tools\SpecialChar menuseparator
29746 Preferences\SpecialChar menuseparator
29747 File Handling\SpecialChar menuseparator
29753 (Make sure you add the switch after the script name,
29757 \begin_layout Section
29759 \change_deleted -712698321 1674910251
29760 Fancy Headers and Footers
29763 \begin_layout Standard
29765 \change_deleted -712698321 1674910251
29766 The default page layout is rather plain;
29768 \begin_inset Flex Code
29771 \begin_layout Plain Layout
29778 all you get is a centered page number at the bottom of the page.
29779 This document uses KOMA-script's book class,
29780 so it appears to be a bit fancier.
29781 But to really put on a show,
29782 you need to set the document page style to
29783 \begin_inset Quotes eld
29787 \begin_inset Quotes erd
29791 as mentioned in the
29796 This section describes the \SpecialChar LaTeX
29797 code you need to insert in your \SpecialChar LaTeX
29798 preamble in order to get the desired effects.
29801 \begin_layout Standard
29803 \change_deleted -712698321 1674910251
29804 For more information on fancy headers,
29806 \begin_inset Flex Code
29809 \begin_layout Plain Layout
29815 package documentation.
29817 \begin_inset Flex URL
29820 \begin_layout Plain Layout
29822 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
29830 \begin_layout Standard
29832 \change_deleted -712698321 1674910251
29833 The page header is divided into three fields,
29834 not surprisingly labeled
29835 \begin_inset Quotes eld
29839 \begin_inset Quotes erd
29844 \begin_inset Quotes eld
29848 \begin_inset Quotes erd
29853 \begin_inset Quotes eld
29857 \begin_inset Quotes erd
29861 The footer is also divided into these three fields.
29862 The \SpecialChar LaTeX
29863 commands to set these fields in the simplest manner are
29864 \begin_inset Flex Code
29867 \begin_layout Plain Layout
29877 \begin_inset Flex Code
29880 \begin_layout Plain Layout
29890 \begin_inset Flex Code
29893 \begin_layout Plain Layout
29903 \begin_inset Flex Code
29906 \begin_layout Plain Layout
29916 Suppose you wish to put your name in the upper left hand corner of each page.
29917 Simply insert the following command in the preamble:
29921 \begin_layout Standard
29923 \change_deleted -712698321 1674910251
29932 \begin_layout Standard
29934 \change_deleted -712698321 1674910251
29935 You will now see your name in the upper left.
29936 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,
29938 \begin_inset space \thinspace{}
29944 \begin_layout Standard
29946 \change_deleted -712698321 1674910251
29954 \begin_layout Standard
29956 \change_deleted -712698321 1674910251
29957 Let's get really fancy:
29958 lets put the section number with the word
29959 \begin_inset Quotes eld
29963 \begin_inset Quotes erd
29967 \begin_inset space \thinspace{}
29971 \begin_inset space \space{}
29974 Section 3) in the upper left,
29975 the page number (e.
29976 \begin_inset space \thinspace{}
29980 \begin_inset space \space{}
29983 Page 4) in the upper right,
29984 your name in the lower left,
29985 and the date in the lower right.
29986 The following commands should now appear in the preamble:
29989 \begin_layout Standard
29991 \change_deleted -712698321 1674910251
30001 \begin_layout Standard
30003 \change_deleted -712698321 1674910251
30011 \begin_layout Standard
30013 \change_deleted -712698321 1674910251
30023 \begin_layout Standard
30025 \change_deleted -712698321 1674910251
30034 \begin_layout Standard
30036 \change_deleted -712698321 1674910251
30044 \begin_layout Standard
30046 \change_deleted -712698321 1674910251
30056 \begin_layout Standard
30058 \change_deleted -712698321 1674910251
30060 \begin_inset Flex Code
30063 \begin_layout Plain Layout
30072 \begin_inset Flex Code
30075 \begin_layout Plain Layout
30083 access \SpecialChar LaTeX
30084 's section and page counters,
30085 and so print out the current section and page number.
30087 \begin_inset Flex Code
30090 \begin_layout Plain Layout
30098 simply prints out today's date.
30101 \begin_layout Standard
30103 \change_deleted -712698321 1674910251
30104 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
30105 If you don't want one of the rules,
30106 set its thickness to 0.
30107 The header rule has a default thickness of 0.4pt,
30108 the footer rule is 0pt.
30114 \begin_inset Flex Code
30117 \begin_layout Plain Layout
30122 headrulewidth}{0.4pt}
30128 \begin_inset Flex Code
30131 \begin_layout Plain Layout
30136 footrulewidth}{0.4pt}
30141 to set the thicknesses.
30144 \begin_layout Standard
30146 \change_deleted -712698321 1674910251
30147 You can switch the header/footer settings on and off for individual pages using commands like
30148 \begin_inset Flex Code
30151 \begin_layout Plain Layout
30154 thispagestyle{empty}
30161 \begin_inset Flex Code
30164 \begin_layout Plain Layout
30167 thispagestyle{plain}
30174 \begin_inset Flex Code
30177 \begin_layout Plain Layout
30180 thispagestyle{fancy}
30186 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
30189 title pages are marked as plain by default,
30190 while following pages are marked fancy when using the global fancy setting.
30193 \begin_layout Standard
30195 \change_deleted -712698321 1674910251
30196 As a final example,
30197 it is possible to include an image in the header or footer.
30198 Suppose you want to put a company logo in the upper lefthand corner.
30199 You might try something like
30202 \begin_layout Standard
30204 \change_deleted -712698321 1674910251
30213 includegraphics{logo.eps}}}
30216 \begin_layout Standard
30219 \change_deleted -712698321 1674910251
30220 (you may need to preface this with
30221 \begin_inset Flex Code
30224 \begin_layout Plain Layout
30227 usepackage{graphics}
30232 if you don't include graphics elsewhere in your document).
30237 \begin_layout Chapter
30239 and the World Wide Web
30242 \begin_layout Standard
30244 has long supported the export of documents to various web-friendly formats,
30246 Before version 2.0,
30248 HTML export was always accomplished by the use of external converters.
30252 \begin_layout Plain Layout
30253 For details on the use of external converters with \SpecialChar LyX
30259 section of the Customization manual.
30264 These fall into two large groups:
30265 there are converters that use \SpecialChar LaTeX
30266 as an intermediate format,
30268 \begin_inset Flex Code
30271 \begin_layout Plain Layout
30279 \begin_inset Flex Code
30282 \begin_layout Plain Layout
30290 \begin_inset Flex Code
30293 \begin_layout Plain Layout
30300 relying upon \SpecialChar LyX
30301 to produce the \SpecialChar LaTeX
30303 and there is a converter that works directly on \SpecialChar LyX
30306 \begin_inset Flex Code
30309 \begin_layout Plain Layout
30317 All of these have different advantages and disadvantages.
30321 \begin_layout Standard
30322 The \SpecialChar LaTeX
30323 -based converters have the advantage that,
30325 they know everything about the exported document that \SpecialChar LaTeX
30327 Such converters do not care,
30329 if a certain block of code was produced by \SpecialChar LyX
30330 or was Evil Red Text.
30331 These converters know about
30332 \begin_inset Flex Code
30335 \begin_layout Plain Layout
30344 and can often make use of the
30345 \begin_inset Flex Code
30348 \begin_layout Plain Layout
30354 files generated by Bib\SpecialChar TeX
30358 is a very hard language to parse—
30359 it is sometimes said that only \SpecialChar TeX
30360 itself understands \SpecialChar TeX
30362 and \SpecialChar LaTeX
30363 -based converters will often choke on what seem to be quite simple constructs;
30364 complex ones can throw them completely,
30365 and as of this writing,
30371 manual will not export with
30372 \begin_inset Flex Code
30375 \begin_layout Plain Layout
30382 though the others will.
30383 The other issue concerns how math is handled.
30384 These converters typically convert the formulae into little pictures that are then linked from the HTML document.
30385 Since these are actually generated by \SpecialChar LaTeX
30388 But they do not scale well,
30389 and just getting them to look as if they are actually meant to be in your document—
30390 so that the font sizes seem to be roughly the same—
30391 can be a challenge.
30394 \begin_layout Standard
30396 \begin_inset Flex Code
30399 \begin_layout Plain Layout
30407 \begin_inset CommandInset href
30409 name "http://pinchito.es/elyxer/"
30410 target "http://pinchito.es/elyxer/"
30415 ) solves some of these problems.
30417 the formulae it produces scale perfectly,
30418 since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
30419 But even moderately complex formula are rendered less well than with
30420 \begin_inset Flex Code
30423 \begin_layout Plain Layout
30430 this reflects the limitations of HTML.
30434 \begin_layout Plain Layout
30437 \begin_inset Flex Code
30440 \begin_layout Plain Layout
30447 can also use jsMath and MathJax for equations,
30448 but this setting is only available globally and requires one to have access to a server that runs the backend.
30453 More importantly (as of version 1.1.1,
30456 \begin_inset Flex Code
30459 \begin_layout Plain Layout
30466 has limited support for math macros and no support for user-defined paragraph or character styles.
30467 These limitations make
30468 \begin_inset Flex Code
30471 \begin_layout Plain Layout
30478 unsuitable for many of the documents \SpecialChar LyX
30482 these problems could be solved,
30483 but the \SpecialChar LyX
30484 developers have decided to follow a different path and have made \SpecialChar LyX
30485 itself capable of writing XHTML,
30486 just as it is capable of writing \SpecialChar LaTeX
30492 \begin_layout Standard
30493 As of this writing,
30494 XHTML output remains under development and should probably be regarded as
30495 \begin_inset Quotes eld
30499 \begin_inset Quotes erd
30506 \begin_layout Plain Layout
30508 \begin_inset Flex Code
30511 \begin_layout Plain Layout
30512 development/HTML/HTML.notes
30518 which can be found in the \SpecialChar LyX
30520 \begin_inset CommandInset href
30522 name "accessed online"
30523 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
30529 usually contains up-to-date information about the state of XHTML output.
30530 See also the list of XHTML bugs on
30531 \begin_inset CommandInset href
30533 name "the bug tracker"
30534 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"
30545 the developers have chosen this approach because it has several potential advantages over the other two.
30548 \begin_layout Standard
30549 These advantages are primarily due to the fact that the XHTML output routines,
30550 since they are part of \SpecialChar LyX
30552 know everything \SpecialChar LyX
30553 knows about the document being exported.
30557 \begin_layout Plain Layout
30558 Another advantage is that,
30559 since these routines are internal to \SpecialChar LyX
30561 they are immune to changes in \SpecialChar LyX
30563 or to changes in the semantics of existing insets.
30568 So they know about the table of contents (as displayed in the outline),
30569 about the counters associated with different paragraph styles,
30570 and about user-defined styles.
30571 The XHTML output routines know what \SpecialChar LyX
30572 knows about internationalization,
30574 so they will output
30575 \begin_inset Quotes eld
30579 \begin_inset Quotes erd
30583 \begin_inset Quotes eld
30591 \begin_inset Quotes erd
30595 depending upon the language in effect at the time.
30599 \begin_layout Standard
30601 the output routines know what \SpecialChar LyX
30602 knows about document layout,
30604 about how the document is to be rendered on screen.
30605 We use this information when we output the document as XHTML.
30612 generates CSS style information corresponding to the layout information it uses to render the document on screen:
30613 if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
30615 then (by default) they will be sans-serif and bold when viewed in a web browser,
30617 And this is true not just for pre-defined styles,
30620 including user-defined styles.
30622 the XHTML output routines make no distinction between user-defined paragraph and
30623 \change_deleted 244031559 1603876931
30625 \change_inserted 244031559 1603876940
30628 styles and \SpecialChar LyX
30629 's own pre-defined styles:
30631 everything \SpecialChar LyX
30632 knows about the styles is contained in the layout files.
30633 And much the same is true as regards pre-defined textual insets,
30635 and various custom insets.
30639 \begin_layout Standard
30640 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
30641 output can be customized and extended:
30642 through layout files and modules.
30643 See chapter five of the
30647 manual for the details.
30650 \begin_layout Standard
30651 The remainder of this chapter contains more detailed information on XHTML output,
30653 and ways to work around those limitations.
30656 \begin_layout Section
30657 Math Output in XHTML
30660 \begin_layout Standard
30662 offers four choices for how math is rendered.
30663 These have various advantages and disadvantages:
30666 \begin_layout Itemize
30668 \begin_inset Newline newline
30671 MathML is a dialect of XML designed specifically for mathematics on the web,
30672 and it typically renders very well in browsers that support it.
30673 The disadvantage is that not all browsers support MathML,
30674 and support is not complete even in the Gecko-based browsers,
30676 \begin_inset Newline newline
30679 If \SpecialChar LyX
30680 is unable to render a formula as MathML—
30682 if the formula uses the
30683 \begin_inset Flex Code
30686 \begin_layout Plain Layout
30693 then it will instead output the formula as an image.
30697 \begin_layout Itemize
30699 \begin_inset Newline newline
30702 As mentioned above,
30704 \begin_inset Flex Code
30707 \begin_layout Plain Layout
30713 outputs math as HTML,
30718 \begin_layout Plain Layout
30720 has borrowed some of the CSS for its HTML output from
30721 \begin_inset Flex Code
30724 \begin_layout Plain Layout
30735 For simple formulae,
30736 this can work quite well,
30737 though with more complicated formulae it tends to break down.
30739 this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
30740 fairly simple math.
30741 \begin_inset Newline newline
30744 If Lyx is unable to render a formula as HTML—
30746 if the formula uses the
30747 \begin_inset Flex Code
30750 \begin_layout Plain Layout
30757 then it will instead output the formula as an image.
30761 \begin_layout Itemize
30763 \begin_inset Newline newline
30767 \begin_inset Flex Code
30770 \begin_layout Plain Layout
30778 will output formulae as images,
30779 the very same images,
30781 that are used for instant preview.
30785 \begin_layout Plain Layout
30786 Instant preview does
30790 have to be on for images to be output,
30796 The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
30798 so they are very accurate.
30800 as mentioned earlier,
30801 is that these are bitmapped images,
30802 so they do not scale terribly well,
30803 and one cannot copy them,
30805 \begin_inset Newline newline
30808 The size of the images can be controlled by setting the
30809 \begin_inset Quotes eld
30812 Math Images Scaling
30813 \begin_inset Quotes erd
30817 \change_deleted -712698321 1674917822
30819 \begin_inset Flex Noun
30822 \begin_layout Plain Layout
30823 Document\SpecialChar menuseparator
30824 Settings\SpecialChar menuseparator
30831 \change_inserted -712698321 1674917822
30834 Document\SpecialChar menuseparator
30835 Settings\SpecialChar menuseparator
30844 \begin_layout Plain Layout
30845 For those who want to know,
30846 this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
30852 \begin_inset Newline newline
30855 If \SpecialChar LyX
30856 for some reason fails to create an image for a formula (e.g.,
30857 if a required \SpecialChar LaTeX
30858 package is not installed),
30859 then it will fall back to outputing the raw \SpecialChar LaTeX
30863 \begin_layout Itemize
30866 \begin_inset Newline newline
30871 will happily output math as \SpecialChar LaTeX
30873 As well as being the output of last resort,
30874 this method can be used with such tools as
30875 \begin_inset CommandInset href
30878 target "http://www.math.union.edu/~dpvc/jsMath/"
30884 which uses JavaScript to render \SpecialChar LaTeX
30885 embedded in HTML documents.
30887 wraps the \SpecialChar LaTeX
30889 \begin_inset Flex Code
30892 \begin_layout Plain Layout
30898 (for inline formulas) or
30899 \begin_inset Flex Code
30902 \begin_layout Plain Layout
30908 (for displayed formulas) with
30909 \begin_inset Flex Code
30912 \begin_layout Plain Layout
30919 as is required for jsMath.
30922 \begin_layout Standard
30923 One of these output methods must be selected under
30924 \change_deleted -712698321 1674917830
30926 \begin_inset Flex Noun
30929 \begin_layout Plain Layout
30930 Document\SpecialChar menuseparator
30931 Settings\SpecialChar menuseparator
30938 \change_inserted -712698321 1674917830
30941 Document\SpecialChar menuseparator
30942 Settings\SpecialChar menuseparator
30951 This is a document-wide setting,
30955 \begin_layout Standard
30958 will offer the user the option to select an alternate output method for a particular inset,
30960 one that isn't being rendered very well by MathML.
30964 \begin_layout Plain Layout
30966 since \SpecialChar LyX
30967 falls back to images if the inset contains ERT,
30968 then one can force output as an image by putting some harmless ERT into the math,
30971 \begin_inset Formula $a=b\relax$
30982 \begin_layout Section
30983 Bibliography and Citations
30986 \begin_layout Standard
30987 XHTML output fully supports bibliographies and citations.
30991 \begin_layout Standard
30992 Citation labels are generated by the same machinery that generates \SpecialChar LyX
30993 's on-screen labels,
30994 so the labels will look in the output much as they do in \SpecialChar LyX
30997 If you are using numerical citations,
30998 then \SpecialChar LyX
30999 will output numerical labels,
31000 such as [1] or [17],
31001 rather than simply showing the citation key in square brackets,
31002 as it does on-screen.
31003 If you are using author-year citations,
31004 then \SpecialChar LyX
31005 will add lowercase letters to the years,
31006 just as Bib\SpecialChar TeX
31008 if it finds more than one citation for a given author-year combination.
31009 The labels will be printed with the bibliography entries.
31010 Note that there is,
31012 no way to customize the appearance of the labels,
31014 to choose between square brackets and parentheses.
31017 \begin_layout Standard
31018 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
31019 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.
31020 The formatting can be customized in your layout file or,
31027 manual for the details.
31030 \begin_layout Standard
31031 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
31032 So you can see things like this:
31035 \begin_layout Quote
31038 \begin_inset Quotes eld
31041 Context and Logical Form
31042 \begin_inset Quotes erd
31048 Language in Context:
31052 Oxford University Press,
31058 \begin_layout Quote
31061 \begin_inset Quotes eld
31064 Semantics in Context
31065 \begin_inset Quotes erd
31071 Language in Context:
31075 Oxford University Press,
31081 \begin_layout Standard
31082 This should be fixed before long.
31085 \begin_layout Standard
31086 There is no support at present for sectioned bibliographies.
31087 If you have multiple bibliographies,
31088 then \SpecialChar LyX
31089 will print the same bibliography over and over.
31092 \begin_layout Section
31096 \begin_layout Standard
31098 will happily export indexes as XHTML,
31099 but with certain limitations at the moment.
31102 \begin_layout Standard
31103 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
31111 \begin_layout Plain Layout
31112 The main issue here is that \SpecialChar LyX
31113 itself does not really handle these.
31114 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
31120 We'll describe how they are handled using the subsection headings from that section.
31123 \begin_layout Itemize
31124 Grouping Index Entries (aka,
31127 makes an effort to support these,
31128 but the entries must be separated by
31129 \begin_inset Quotes eld
31134 \begin_inset Quotes erd
31139 there must be spaces around the exclamation point.
31140 This is because it is otherwise too difficult to check for escaped exclamation points,
31145 \begin_layout Itemize
31147 There is no support at all for page ranges,
31148 since these make no sense with XHMTL.
31150 you will just get two index entries,
31154 \begin_layout Itemize
31156 There is no support for cross-referencing.
31157 If \SpecialChar LyX
31158 finds an entry containing the
31159 \begin_inset Quotes eld
31162 |see\SpecialChar ldots
31164 \begin_inset Quotes erd
31168 it is just dropped,
31169 and the rest is treated as an ordinary index entry.
31172 \begin_layout Itemize
31175 does support attempts to fix the sorting order.
31176 It will take what is before the first `@' it finds and use that for sorting,
31177 taking what follows the first `@' to be the actual entry.
31180 does not check for escaped `@',
31181 so do not try to index email addresses.
31184 \begin_layout Itemize
31185 Index Entry Layout:
31186 You can format entries by using the text style dialog,
31187 or by using any other method available within \SpecialChar LyX
31189 There is no support for constructs like:
31191 \begin_inset Quotes eld
31195 \begin_inset Quotes erd
31200 if \SpecialChar LyX
31201 finds a pipe symbol,
31204 it will delete it and everything that follows it.
31207 \begin_layout Itemize
31209 There is no support for multiple indexes.
31211 all index entries will be printed as one large index.
31212 To avoid our printing several versions of the index,
31213 we print only the main index,
31214 so make sure you have one.
31217 \begin_layout Section
31218 Nomenclature and Glossary
31221 \begin_layout Standard
31222 There is at present no support for glossaries.
31223 Adding it would be fairly trivial,
31227 \begin_layout Chapter
31229 \change_inserted 1075283030 1616534180
31233 \begin_layout Standard
31235 \change_inserted 1075283030 1616534386
31238 can generate documents in the DocBook XML vocabulary.
31239 With versions 2.3 and before,
31240 only select templates could be used to generate DocBook documents (only version 4).
31241 Starting with \SpecialChar LyX
31243 most \SpecialChar LyX
31244 layouts can generate valid DocBook documents (only version 5).
31245 This feature is built into \SpecialChar LyX
31246 and does not require the use of external tools.
31249 \begin_layout Standard
31251 \change_inserted 1075283030 1616534437
31252 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
31253 output can be customized and extended:
31254 through layout files and modules.
31255 See chapter five of the
31259 manual for the details.
31262 \begin_layout Standard
31264 \change_inserted 1075283030 1616534475
31265 Most \SpecialChar LyX
31266 features are supported with DocBook,
31270 \begin_layout Itemize
31272 \change_inserted 1075283030 1616534741
31273 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
31277 All formulae are also available in raw \SpecialChar TeX
31278 in the DocBook output for further processing.
31281 \begin_layout Itemize
31283 \change_inserted 1075283030 1616534852
31284 Bibliographies and citations are implemented,
31285 including with an external BibTeX file.
31286 Bibliography entries are not prerendered when the detailed information are available,
31287 but rather output with the standard DocBook constructs.
31288 The external DocBook processor is expected to handle the rendering of entries.
31291 \begin_layout Itemize
31293 \change_inserted 1075283030 1616534863
31294 Indexes are supported,
31295 including multiple indices.
31302 and cross-references (
31307 with the exception of the same symbols escaped.
31316 ) are not supported.
31317 There is no support for escaping of index entries.
31320 \begin_layout Itemize
31322 \change_inserted 1075283030 1616534884
31323 Glossaries are implemented.
31326 \begin_layout Standard
31328 \change_inserted 1075283030 1616534894
31329 Two major parameters can be set at the document level.
31332 \begin_layout Itemize
31334 \change_inserted 1075283030 1616534948
31337 can generate tables either as HTML (default value) or CALS,
31338 depending on the user's requirements.
31339 Most DocBook processors accept both formats.
31342 \begin_layout Itemize
31344 \change_inserted 1075283030 1616535006
31347 MathML is included within its own name space,
31349 The implication is that there must be an indication of the tags belonging to the MathML standard.
31350 Three choices are offered:
31355 \begin_layout Itemize
31357 \change_inserted 1075283030 1616535044
31359 the MathML name space is defined for each formula (using the
31363 attribute on each formula)
31366 \begin_layout Itemize
31368 \change_inserted 1075283030 1616535090
31374 the MathML name space is defined at the document level (using the
31378 attribute on the root element).
31379 Each MathML is prefixed with
31390 \begin_layout Itemize
31392 \change_inserted 1075283030 1616620405
31408 \begin_layout Standard
31410 \change_inserted 1075283030 1616620470
31411 This option is especially useful if you want \SpecialChar LyX
31412 to match your personal style or to work with buggy software that only accepts one prefix for MathML.
31418 \begin_layout Chapter
31419 The \SpecialChar LyX
31423 \begin_layout Section
31427 \begin_layout Standard
31428 The `\SpecialChar LyX
31429 server' allows other programs to talk to \SpecialChar LyX
31431 invoke \SpecialChar LyX
31433 and retrieve information about the \SpecialChar LyX
31435 This is only intended for advanced users,
31436 but they should find it useful.
31437 It is by writing to the \SpecialChar LyX
31440 that bibliography managers,
31443 \begin_inset Quotes eld
31447 \begin_inset Quotes erd
31450 citations to \SpecialChar LyX
31454 \begin_layout Section
31455 Starting the \SpecialChar LyX
31457 \begin_inset CommandInset label
31459 name "sec:Starting-the-Server"
31466 \begin_layout Standard
31467 The \SpecialChar LyX
31468 server works through the use of a pair of named pipes.
31469 These are usually located in
31470 \begin_inset Flex Code
31473 \begin_layout Plain Layout
31480 (except on Windows,
31485 named pipes are special objects located in
31486 \begin_inset Flex Code
31489 \begin_layout Plain Layout
31501 ) and have the names
31502 \begin_inset Quotes eld
31506 \begin_inset Flex Code
31509 \begin_layout Plain Layout
31516 \begin_inset Quotes erd
31520 \begin_inset Quotes eld
31524 \begin_inset Flex Code
31527 \begin_layout Plain Layout
31534 \begin_inset Quotes erd
31538 External programs write into
31539 \begin_inset Flex Code
31542 \begin_layout Plain Layout
31548 and read back data from
31549 \begin_inset Flex Code
31552 \begin_layout Plain Layout
31559 The stem of the pipe names can be defined in the
31560 \change_deleted -712698321 1674917840
31562 \begin_inset Flex Noun
31565 \begin_layout Plain Layout
31566 Tools\SpecialChar menuseparator
31573 \change_inserted -712698321 1674917840
31576 Tools\SpecialChar menuseparator
31583 \begin_inset Flex Code
31586 \begin_layout Plain Layout
31587 "/home/myhome/lyxpipe"
31594 \begin_inset Flex Code
31597 \begin_layout Plain Layout
31611 on Windows (where any working path instead of lyxpipe can be used,
31613 \begin_inset Flex Code
31616 \begin_layout Plain Layout
31639 configure this manually in order for the server to start.
31642 \begin_layout Standard
31645 \begin_inset Flex Code
31648 \begin_layout Plain Layout
31655 \begin_inset Flex Code
31658 \begin_layout Plain Layout
31664 ' to create the pipes.
31665 If one of the pipes already exists,
31667 will assume that another \SpecialChar LyX
31668 process is already running and will not start the server.
31669 On POSIX (Unix like) systems,
31670 if for some other reason,
31672 \begin_inset Quotes eld
31676 \begin_inset Quotes erd
31679 pipe is left in existence when \SpecialChar LyX
31681 then \SpecialChar LyX
31682 will try to delete it.
31683 If this fails for some reason,
31684 you will need to delete the pipes manually and then restart \SpecialChar LyX
31687 pipes are deleted by the OS on program termination or crash,
31689 \begin_inset Quotes eld
31693 \begin_inset Quotes erd
31696 pipes should not be possible.
31699 \begin_layout Standard
31700 To have several \SpecialChar LyX
31701 processes with servers at the same time,
31702 you have to use different configurations,
31703 perhaps by using separate user directories,
31705 \begin_inset Flex Code
31708 \begin_layout Plain Layout
31718 \begin_layout Standard
31719 If you are developing a client program,
31720 you might find it useful to enable debugging information from the \SpecialChar LyX
31722 Do this by starting \SpecialChar LyX
31724 \begin_inset Flex Code
31727 \begin_layout Plain Layout
31736 \begin_layout Standard
31737 You can find a complete example client written in C++ in the source distribution as
31738 \begin_inset Flex Code
31741 \begin_layout Plain Layout
31742 development/lyxserver/server_monitor.cpp
31750 \begin_layout Standard
31751 Another useful tool is the command-line based client found in
31752 \begin_inset Flex Code
31755 \begin_layout Plain Layout
31756 src/client/lyxclient
31764 \begin_layout Section
31765 Normal communication
31768 \begin_layout Standard
31769 To issue a \SpecialChar LyX
31771 the client writes a line of ASCII text into the input pipe.
31772 This line has the following format:
31775 \begin_layout Quote
31789 \begin_layout Description
31790 clientname is a name that the client can choose arbitrarily.
31791 Its only use is that \SpecialChar LyX
31792 will echo it if it sends an answer—
31793 so a client can dispatch results from different requesters.
31796 \begin_layout Description
31797 function is the function you want \SpecialChar LyX
31799 It is the same as the commands you'd use in the minibuffer.
31802 \begin_layout Description
31803 argument is an optional argument which is meaningful only to some functions (for instance,
31805 \begin_inset Quotes eld
31809 \begin_inset Quotes erd
31812 LFUN will insert the argument as text at the cursor position).
31815 \begin_layout Standard
31816 The answer from \SpecialChar LyX
31817 will arrive in the output pipe and be of the form
31820 \begin_layout Quote
31834 \begin_layout Standard
31843 are just echoed from the command request,
31848 is more or less useful information filled according to how the command execution worked out.
31851 \begin_inset Quotes eld
31855 \begin_inset Quotes erd
31859 will return information about the internal state of \SpecialChar LyX
31861 while other will return an empty data-response.
31862 This means that the command execution went fine.
31865 \begin_layout Standard
31867 the response from \SpecialChar LyX
31868 will have this form
31871 \begin_layout Quote
31885 \begin_layout Standard
31890 should contain an explanation of why the command failed.
31893 \begin_layout Standard
31897 \begin_layout LyX-Code
31898 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
31899 \begin_inset Newline newline
31902 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
31903 \begin_inset Newline newline
31906 read a <~/.lyxpipe.out
31907 \begin_inset Newline newline
31913 \begin_layout Subsection
31914 AppleScript (Mac OS X)
31917 \begin_layout Standard
31918 Since \SpecialChar LyX
31921 supports basic interactions with AppleScript for normal communication through the command run.
31922 This command takes a direct argument (the
31926 to perform) and an optional argument.
31927 It either returns the output of the function or triggers an error with the error message and code.
31930 \begin_layout Standard
31934 \begin_layout LyX-Code
31935 tell application "\SpecialChar LyX
31939 \begin_layout LyX-Code
31943 \begin_layout LyX-Code
31944 -- Stores the current file name into f
31947 \begin_layout LyX-Code
31948 set f to (run "server-get-filename" with argument "")
31951 \begin_layout LyX-Code
31952 on error the error_message number the error_number
31955 \begin_layout LyX-Code
31956 display dialog "Error:
31957 " & the error_number & ".
31961 \begin_layout LyX-Code
31962 & the error_message buttons {"OK"} default button 1
31965 \begin_layout LyX-Code
31969 \begin_layout LyX-Code
31973 \begin_layout Section
31977 \begin_layout Standard
31979 can notify clients of events going on asynchronously.
31980 Currently it will only do this if the user binds a key sequence with the function
31981 \begin_inset Quotes eld
31985 \begin_inset Quotes erd
31989 The format of the string \SpecialChar LyX
31990 sends is as follows:
31993 \begin_layout Quote
31994 \begin_inset Flex Code
31997 \begin_layout Plain Layout
32008 \begin_layout Standard
32013 is the printed representation of the key sequence that was actually typed by the user.
32016 \begin_layout Standard
32017 This mechanism can be used to extend \SpecialChar LyX
32018 's command set and implement macros.
32019 Bind some key sequence to
32020 \begin_inset Quotes eld
32024 \begin_inset Quotes erd
32028 Then start a client that listens on the output pipe,
32029 dispatches the command according to the sequence,
32030 and starts a function that may use \SpecialChar LyX
32031 calls and \SpecialChar LyX
32032 requests to issue a command or a series of commands to \SpecialChar LyX
32036 \begin_layout Section
32037 The simple \SpecialChar LyX
32041 \begin_layout Standard
32043 implements a simple protocol that can be used for session management.
32044 All messages are of the form
32047 \begin_layout Quote
32057 \begin_layout Standard
32063 \begin_inset Quotes eld
32067 \begin_inset Quotes erd
32071 \begin_inset Quotes eld
32075 \begin_inset Quotes erd
32080 \begin_inset Quotes eld
32084 \begin_inset Quotes erd
32087 is received from a client,
32089 will report back to inform the client that it's listening to it's messages,
32091 \begin_inset Quotes eld
32095 \begin_inset Quotes erd
32098 sent from \SpecialChar LyX
32099 will inform clients that \SpecialChar LyX
32103 \begin_layout Section
32104 Reverse DVI/PDF search
32107 \begin_layout Standard
32108 Some DVI/PDF viewers
32112 \begin_layout Plain Layout
32113 The following viewers offer the reverse PDF search feature:
32114 Okular on KDE/Linux,
32116 Skim on Mac OSX and SumatraPDF on Windows.
32125 facility (also called
32130 This means that you can tell \SpecialChar LyX
32131 to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
32133 the viewer must be able to communicate with \SpecialChar LyX
32135 This is done via the \SpecialChar LyX
32136 server either by using the named pipe (
32141 or the UNIX domain socket (
32145 ) that \SpecialChar LyX
32146 creates in its temporary directory (this is the way the
32147 \begin_inset Flex Code
32150 \begin_layout Plain Layout
32156 program communicates with \SpecialChar LyX
32159 you need a helper script that mediates between the viewer and \SpecialChar LyX
32162 the viewer can communicate with \SpecialChar LyX
32164 This depends on the selected viewer and on your operating system.
32165 The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
32167 we will thus describe how to setup reverse search for specific viewers.
32168 Before we turn to this,
32170 we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
32173 \begin_layout Subsection
32175 \begin_inset CommandInset label
32177 name "subsec:rev-search"
32184 \begin_layout Standard
32185 In most cases \SpecialChar LyX
32186 will do the work for you by pressing the following button in the toolbar:
32190 arg "buffer-toggle-output-sync"
32195 you can also enable the feature by checking
32197 Synchronize with Output
32200 \change_deleted -712698321 1674917848
32202 \begin_inset Flex Noun
32205 \begin_layout Plain Layout
32206 Document\SpecialChar menuseparator
32207 Settings\SpecialChar menuseparator
32214 \change_inserted -712698321 1674917848
32217 Document\SpecialChar menuseparator
32218 Settings\SpecialChar menuseparator
32224 In such a case \SpecialChar LyX
32225 will automatically insert the necessary Sync\SpecialChar TeX
32226 macro (for PDF) or load the srcltx package (for DVI) respectively.
32227 This option can be easily reached also on
32228 \begin_inset Flex Code
32231 \begin_layout Plain Layout
32240 \begin_layout Standard
32241 If you need a different setting,
32242 you can select or input a custom macro from the drop down box just below
32243 \change_deleted -712698321 1674917855
32245 \begin_inset Flex Noun
32248 \begin_layout Plain Layout
32249 Document\SpecialChar menuseparator
32250 Settings\SpecialChar menuseparator
32251 Output\SpecialChar menuseparator
32252 Synchronize with Output
32258 \change_inserted -712698321 1674917855
32261 Document\SpecialChar menuseparator
32262 Settings\SpecialChar menuseparator
32263 Output\SpecialChar menuseparator
32264 Synchronize with Output
32271 \begin_layout Standard
32272 Note that the method
32273 \begin_inset Flex Code
32276 \begin_layout Plain Layout
32284 enables gzip compression.
32285 If your viewer does not support it,
32286 you should instead use
32287 \begin_inset Flex Code
32290 \begin_layout Plain Layout
32301 \begin_layout Standard
32302 Please also note that including the
32303 \begin_inset Flex Code
32306 \begin_layout Plain Layout
32313 \begin_inset Flex Code
32316 \begin_layout Plain Layout
32322 sometimes has an undesired impact on the typesetting.
32324 you should switch output synchronization off for the final typesetting if you use the
32325 \begin_inset Flex Code
32328 \begin_layout Plain Layout
32335 \begin_inset Flex Code
32338 \begin_layout Plain Layout
32348 \begin_layout Standard
32349 In case you need some more special settings that are not covered by the automatic settings,
32350 read the next section about how to set up output synchronization manually.
32351 If the automatic setup suits your needs,
32352 you can readily jump to section
32353 \begin_inset space ~
32357 \begin_inset CommandInset ref
32359 reference "subsec:configuring-viewers"
32365 where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
32368 \begin_layout Subsection
32372 \begin_layout Standard
32374 provides several different methods for reverse search.
32375 Some are built-in in the
32376 \begin_inset Flex Code
32379 \begin_layout Plain Layout
32386 some are provided by external packages.
32387 Your choice depends on whether your \SpecialChar LaTeX
32388 distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
32389 The available methods are described in the following.
32392 \begin_layout Subsubsection*
32393 Built-in DVI-search via src-specials (DVI only)
32396 \begin_layout Standard
32397 This method provides the DVI file with the necessary information for reverse search.
32398 It is available in \SpecialChar LaTeX
32399 since quite some time (any somewhat recent \SpecialChar LaTeX
32400 distribution should include it),
32401 and it works reliably.
32404 \begin_inset Flex Noun
32407 \begin_layout Plain Layout
32418 \begin_inset Flex Noun
32421 \begin_layout Plain Layout
32432 \change_deleted -712698321 1674917875
32434 \begin_inset Flex Noun
32437 \begin_layout Plain Layout
32438 Preferences\SpecialChar menuseparator
32439 File Handling\SpecialChar menuseparator
32446 \change_inserted -712698321 1674917875
32449 Preferences\SpecialChar menuseparator
32450 File Handling\SpecialChar menuseparator
32456 \begin_inset Flex Code
32459 \begin_layout Plain Layout
32460 latex -src-specials $$i
32466 If this doesn't work,
32467 check if your \SpecialChar TeX
32468 engine needs different options (the syntax might differ in some distributions).
32471 \begin_layout Subsubsection*
32472 External Packages (PDFSync and scrltx)
32475 \begin_layout Standard
32484 provide reverse search facility for PDF output (via pdflatex) and DVI output,
32486 In order to enable it,
32487 load the packages in the \SpecialChar LyX
32492 \begin_layout Itemize
32493 \begin_inset Flex Code
32496 \begin_layout Plain Layout
32499 usepackage{pdfsync}
32504 for reverse PDF search,
32507 \begin_layout Itemize
32508 \begin_inset Flex Code
32511 \begin_layout Plain Layout
32514 usepackage[active]{srcltx}
32519 for reverse DVI search.
32522 \begin_layout Standard
32523 If you want to be able to perform both DVI and PDF reverse searches,
32524 you can also insert in the preamble the following lines
32527 \begin_layout LyX-Code
32531 \begin_inset Newline newline
32537 \begin_inset Newline newline
32542 usepackage{pdfsync}
32543 \begin_inset Newline newline
32549 \begin_inset Newline newline
32554 usepackage[active]{srcltx}
32555 \begin_inset Newline newline
32563 \begin_layout Standard
32565 you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
32568 \begin_layout Standard
32569 Note that PDFSync might affect the output layout of your document.
32570 It is therefore advised to disable PDFsync for final documents.
32573 \begin_layout Subsubsection*
32574 Built-in reverse search via Sync\SpecialChar TeX
32578 \begin_layout Standard
32580 \begin_inset Flex Code
32583 \begin_layout Plain Layout
32589 have built-in support for both PDF and DVI reverse search.
32592 Sync\SpecialChar TeX
32595 facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
32600 You need at least \SpecialChar TeX
32601 Live 2008 or a recent Mik\SpecialChar TeX
32602 distribution in order to use it.
32606 \begin_layout Plain Layout
32608 Mik\SpecialChar TeX
32609 does not understand/obey the command \SpecialChar LyX
32610 inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
32613 \begin_layout Plain Layout
32614 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
32615 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
32616 by adding the -synctex=1 switch).
32621 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
32623 SumatraPDF on Windows;
32624 see the next section for details) already provide Sync\SpecialChar TeX
32628 \begin_layout Standard
32629 To enable Sync\SpecialChar TeX
32632 \begin_inset Flex Noun
32635 \begin_layout Plain Layout
32646 \begin_inset Flex Noun
32649 \begin_layout Plain Layout
32654 (plain) -> DraftDVI
32660 \change_deleted -712698321 1674917887
32662 \begin_inset Flex Noun
32665 \begin_layout Plain Layout
32666 Preferences\SpecialChar menuseparator
32667 File Handling\SpecialChar menuseparator
32674 \change_inserted -712698321 1674917887
32677 Preferences\SpecialChar menuseparator
32678 File Handling\SpecialChar menuseparator
32684 \begin_inset Flex Code
32687 \begin_layout Plain Layout
32688 latex -synctex=1 $$i
32694 and for PDF output,
32696 \begin_inset Flex Noun
32699 \begin_layout Plain Layout
32704 (pdflatex) -> PDF (pdflatex)
32710 \begin_inset Flex Code
32713 \begin_layout Plain Layout
32714 pdflatex -synctex=1 $$i
32720 Should your viewer not be considered in the following description,
32721 or in case of missing success,
32722 please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
32727 \begin_layout Plain Layout
32728 Note that the option
32729 \begin_inset Flex Code
32732 \begin_layout Plain Layout
32738 option enables gzip compression.
32739 If your viewer does not support it,
32740 you should instead use
32741 \begin_inset Flex Code
32744 \begin_layout Plain Layout
32758 \begin_layout Subsection
32759 Configuring and using specific viewers
32760 \begin_inset CommandInset label
32762 name "subsec:configuring-viewers"
32769 \begin_layout Subsubsection*
32770 Xdvi (all platforms)
32773 \begin_layout Standard
32775 \begin_inset Flex Code
32778 \begin_layout Plain Layout
32785 you don't need to do anything else for performing a reverse DVI search,
32786 as \SpecialChar LyX
32787 already provides the necessary hooks for automatically using the
32788 \begin_inset Flex Code
32791 \begin_layout Plain Layout
32798 Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
32802 \begin_layout Standard
32804 if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
32806 simply change the DVI viewer in
32807 \change_deleted -712698321 1674917897
32809 \begin_inset Flex Noun
32812 \begin_layout Plain Layout
32813 Preferences\SpecialChar menuseparator
32814 File Handling\SpecialChar menuseparator
32821 \change_inserted -712698321 1674917897
32824 Preferences\SpecialChar menuseparator
32825 File Handling\SpecialChar menuseparator
32834 \begin_layout Plain Layout
32835 On Mac OSX you have to use
32836 \begin_inset Flex Code
32839 \begin_layout Plain Layout
32840 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
32851 \begin_inset Flex Code
32854 \begin_layout Plain Layout
32855 xdvi -editor "lyxeditor.sh %f %l"
32862 \begin_inset Flex Code
32865 \begin_layout Plain Layout
32871 is a suitable script.
32873 a minimal shell script is the following one:
32876 \begin_layout LyX-Code
32878 \begin_inset Newline newline
32881 LYXPIPE="/path/to/lyxpipe"
32882 \begin_inset Newline newline
32885 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
32886 \begin_inset Newline newline
32889 echo "$COMMAND" > "${LYXPIPE}".in || exit
32890 \begin_inset Newline newline
32893 read TMP < "${LYXPIPE}".out || exit
32896 \begin_layout Standard
32898 \begin_inset Flex Code
32901 \begin_layout Plain Layout
32907 is the LyXServer pipe path specified in
32908 \change_deleted -712698321 1674917907
32910 \begin_inset Flex Noun
32913 \begin_layout Plain Layout
32914 Preferences\SpecialChar menuseparator
32921 \change_inserted -712698321 1674917907
32924 Preferences\SpecialChar menuseparator
32933 \begin_layout Plain Layout
32935 \begin_inset Flex Code
32938 \begin_layout Plain Layout
32944 folder of a source distribution you can find a
32945 \begin_inset Flex Code
32948 \begin_layout Plain Layout
32954 script which is able to locate the
32958 based on your preferences.
32966 \begin_layout Subsubsection*
32970 \begin_layout Standard
32972 \begin_inset Flex Code
32975 \begin_layout Plain Layout
32976 /Applications/MacDviX_Folder/calleditor.script
32982 add the following lines:
32985 \begin_layout LyX-Code
32986 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
32987 \begin_inset Newline newline
32993 \begin_layout Standard
32994 Modify the lines accordingly if you install \SpecialChar LyX
32995 somewhere else than in the Applications folder.
32998 \begin_layout Standard
32999 Reverse search is triggered by Alt-click (OPTION-click).
33002 \begin_layout Subsubsection*
33006 \begin_layout Standard
33008 \begin_inset Flex Code
33011 \begin_layout Plain Layout
33012 open -a Skim.app $$i
33017 to the viewer setting in
33018 \change_deleted -712698321 1674917916
33020 \begin_inset Flex Noun
33023 \begin_layout Plain Layout
33024 Preferences\SpecialChar menuseparator
33025 File Handling\SpecialChar menuseparator
33026 File formats\SpecialChar menuseparator
33033 \change_inserted -712698321 1674917916
33036 Preferences\SpecialChar menuseparator
33037 File Handling\SpecialChar menuseparator
33038 File formats\SpecialChar menuseparator
33045 \change_deleted -712698321 1674917924
33047 \begin_inset Flex Noun
33050 \begin_layout Plain Layout
33051 Skim\SpecialChar menuseparator
33052 Preferences\SpecialChar menuseparator
33059 \change_inserted -712698321 1674917924
33062 Skim\SpecialChar menuseparator
33063 Preferences\SpecialChar menuseparator
33069 \change_deleted -712698321 1674917931
33071 \begin_inset Flex Noun
33074 \begin_layout Plain Layout
33081 \change_inserted -712698321 1674917931
33088 preset and enter command
33089 \begin_inset Flex Noun
33092 \begin_layout Plain Layout
33093 /Applications/\SpecialChar LyX
33094 .app/Contents/MacOS/lyxeditor
33102 \begin_layout Standard
33103 Reverse search is triggered by COMMAND-SHIFT-click
33106 \begin_layout Subsubsection*
33110 \begin_layout Standard
33111 Reverse search with evince does not work out of the box,
33112 but it can be achieved by means of some third party helper scripts.
33114 \begin_inset CommandInset href
33116 target "https://wiki.lyx.org/LyX/SyncTeX"
33124 \begin_layout Subsubsection*
33128 \begin_layout Standard
33130 \change_deleted -712698321 1674917941
33132 \begin_inset Flex Noun
33135 \begin_layout Plain Layout
33136 Settings\SpecialChar menuseparator
33137 Configure Okular\SpecialChar menuseparator
33144 \change_inserted -712698321 1674917941
33147 Settings\SpecialChar menuseparator
33148 Configure Okular\SpecialChar menuseparator
33154 \begin_inset Quotes erd
33158 This inserts the appropriate command (
33159 \begin_inset Flex Code
33162 \begin_layout Plain Layout
33171 \begin_layout Standard
33172 Reverse search is triggered by SHIFT-click.
33174 \change_inserted -712698321 1578211026
33175 Note that this only works if Okular is in
33176 \begin_inset Quotes eld
33180 \begin_inset Quotes erd
33184 \begin_inset space \thinspace{}
33188 the hand symbol is clicked).
33193 \begin_layout Subsubsection*
33197 \begin_layout Standard
33198 Qpdfview supports Sync\SpecialChar TeX
33199 since version 0.3.5.
33201 \change_deleted -712698321 1674917949
33203 \begin_inset Flex Noun
33206 \begin_layout Plain Layout
33207 Edit\SpecialChar menuseparator
33208 Settings\SpecialChar menuseparator
33215 \change_inserted -712698321 1674917949
33218 Edit\SpecialChar menuseparator
33219 Settings\SpecialChar menuseparator
33225 click on the input field of the
33226 \begin_inset Quotes eld
33230 \begin_inset Quotes erd
33233 item and add the command
33234 \begin_inset Flex Code
33237 \begin_layout Plain Layout
33246 \begin_layout Standard
33247 Reverse search is triggered by double-click or,
33248 in more recent versions,
33252 \begin_layout Subsubsection*
33256 \begin_layout Standard
33259 \change_deleted -712698321 1674917958
33261 \begin_inset Flex Noun
33264 \begin_layout Plain Layout
33265 View\SpecialChar menuseparator
33272 \change_inserted -712698321 1674917958
33275 View\SpecialChar menuseparator
33280 menu and select the
33281 \begin_inset Quotes eld
33285 \begin_inset Quotes erd
33290 \begin_inset Quotes eld
33293 New\SpecialChar ldots
33295 \begin_inset Quotes erd
33299 in the window that opens,
33301 \begin_inset Quotes eld
33306 \begin_inset Quotes erd
33309 (or any other name you like) in the
33310 \begin_inset Quotes eld
33314 \begin_inset Quotes erd
33318 Now click on the button labeled
33319 \begin_inset Quotes eld
33324 \begin_inset Quotes erd
33327 to open a file dialog and navigate to the directory containing the batch file
33328 \begin_inset Flex Code
33331 \begin_layout Plain Layout
33339 \begin_inset Flex Code
33342 \begin_layout Plain Layout
33348 and then specify the program arguments as
33349 \begin_inset Flex Code
33352 \begin_layout Plain Layout
33360 \begin_inset Flex Code
33363 \begin_layout Plain Layout
33369 wrapper is used for communicating with \SpecialChar LyX
33377 \begin_layout LyX-Code
33379 \begin_inset Newline newline
33382 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
33391 \begin_inset Newline newline
33405 \begin_layout Standard
33406 Make sure that the \SpecialChar LyX
33407 Server pipe path you specified in \SpecialChar LyX
33409 \begin_inset Flex Code
33412 \begin_layout Plain Layout
33427 otherwise change the
33428 \begin_inset Flex Code
33431 \begin_layout Plain Layout
33437 wrapper accordingly.
33440 \begin_layout Standard
33442 reverse search is triggered by double-click.
33445 \begin_layout Subsubsection*
33446 SumatraPDF (Windows)
33449 \begin_layout Standard
33450 In order to use SumatraPDF for inverse search,
33452 \begin_inset Flex Code
33455 \begin_layout Plain Layout
33456 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
33461 in the viewer setting in
33462 \change_deleted -712698321 1674917965
33464 \begin_inset Flex Noun
33467 \begin_layout Plain Layout
33468 Preferences\SpecialChar menuseparator
33469 File Handling\SpecialChar menuseparator
33470 File formats\SpecialChar menuseparator
33477 \change_inserted -712698321 1674917965
33480 Preferences\SpecialChar menuseparator
33481 File Handling\SpecialChar menuseparator
33482 File formats\SpecialChar menuseparator
33489 \begin_inset Flex Code
33492 \begin_layout Plain Layout
33498 is the previous wrapper.
33499 If SumatraPDF.exe is not in your command PATH,
33500 use its full file name.
33503 \begin_layout Standard
33504 Reverse search is triggered by double-click.
33507 \begin_layout Subsubsection*
33511 \begin_layout Standard
33513 make sure that yap is your default DVI viewer in the Windows environment,
33516 \change_deleted -712698321 1674917973
33518 \begin_inset Flex Noun
33521 \begin_layout Plain Layout
33522 View\SpecialChar menuseparator
33529 \change_inserted -712698321 1674917973
33532 View\SpecialChar menuseparator
33537 menu and select the
33538 \begin_inset Quotes eld
33542 \begin_inset Quotes erd
33547 \begin_inset Quotes eld
33550 New\SpecialChar ldots
33552 \begin_inset Quotes erd
33556 in the window that opens,
33558 \begin_inset Quotes eld
33563 \begin_inset Quotes erd
33566 (or any other name you like) in the
33567 \begin_inset Quotes eld
33571 \begin_inset Quotes erd
33575 Now click on the button labeled
33576 \begin_inset Quotes eld
33581 \begin_inset Quotes erd
33584 to open a file dialog and navigate to the directory containing the
33585 \begin_inset Flex Code
33588 \begin_layout Plain Layout
33594 program (which is installed by default on Cygwin along with the \SpecialChar LyX
33597 \begin_inset Flex Code
33600 \begin_layout Plain Layout
33606 and then specify the program arguments as
33607 \begin_inset Flex Code
33610 \begin_layout Plain Layout
33618 you will be using the
33622 for communicating with \SpecialChar LyX
33625 for whatever reason,
33626 you want to use the
33632 \begin_inset Flex Code
33635 \begin_layout Plain Layout
33641 option and be sure to specify the \SpecialChar LyX
33642 Server pipe path in the \SpecialChar LyX
33646 \begin_layout Standard
33648 reverse search is triggered by double-click.
33651 \begin_layout Subsubsection*
33652 SumatraPDF (Cygwin)
33655 \begin_layout Standard
33656 In order to use SumatraPDF for inverse search,
33658 \begin_inset Flex Code
33661 \begin_layout Plain Layout
33662 SumatraPDF -inverse-search "lyxeditor -g %f %l"
33667 in the viewer setting in
33668 \change_deleted -712698321 1674917986
33670 \begin_inset Flex Noun
33673 \begin_layout Plain Layout
33674 Preferences\SpecialChar menuseparator
33675 File Handling\SpecialChar menuseparator
33676 File formats\SpecialChar menuseparator
33683 \change_inserted -712698321 1674917986
33686 Preferences\SpecialChar menuseparator
33687 File Handling\SpecialChar menuseparator
33688 File formats\SpecialChar menuseparator
33694 If SumatraPDF.exe is not in your command PATH,
33695 use its full posix path.
33697 \begin_inset Flex Code
33700 \begin_layout Plain Layout
33706 enables communication via the
33713 \begin_inset Flex Code
33716 \begin_layout Plain Layout
33722 option if you want to use the
33727 and be sure to specify the \SpecialChar LyX
33728 Server pipe path in the \SpecialChar LyX
33732 \begin_layout Standard
33733 Reverse search is triggered by double-click.
33736 \begin_layout Section
33740 \begin_layout Standard
33742 as the name implies,
33744 \begin_inset Quotes eld
33748 \begin_inset Quotes erd
33752 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
33754 If forward search is set up (as described in what follows),
33755 you can put the cursor anywhere in your \SpecialChar LyX
33758 \change_deleted -712698321 1674917994
33760 \begin_inset Flex Noun
33763 \begin_layout Plain Layout
33764 Navigate\SpecialChar menuseparator
33771 \change_inserted -712698321 1674917994
33774 Navigate\SpecialChar menuseparator
33780 \change_deleted -712698321 1674918002
33784 \begin_inset Flex Noun
33787 \begin_layout Plain Layout
33796 \change_inserted -712698321 1674918002
33801 in the context menu via right mouse click),
33802 and then the viewer will jump to that position as well.
33805 that your viewer supports this function.
33808 \begin_layout Standard
33809 To make forward search possible,
33810 you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
33812 This can be done via the methods described in the section
33813 \begin_inset CommandInset ref
33815 reference "subsec:rev-search"
33823 \begin_layout Standard
33825 you need to configure \SpecialChar LyX
33826 for using your viewers in
33827 \change_deleted -712698321 1674918011
33829 \begin_inset Flex Noun
33832 \begin_layout Plain Layout
33833 Tools\SpecialChar menuseparator
33834 Preferences\SpecialChar menuseparator
33835 Output\SpecialChar menuseparator
33842 \change_inserted -712698321 1674918011
33845 Tools\SpecialChar menuseparator
33846 Preferences\SpecialChar menuseparator
33847 Output\SpecialChar menuseparator
33853 We provide a range of tested configurations for some viewers,
33854 which you can select from the drop down list.
33855 If none of these configurations suits you,
33856 you have to find out and enter a suitable configuration yourself.
33857 The definition syntax uses the following placeholders:
33860 \begin_layout Itemize
33862 \begin_inset Flex Code
33865 \begin_layout Plain Layout
33875 \begin_layout Itemize
33877 \begin_inset Flex Code
33880 \begin_layout Plain Layout
33887 name of the (temporary) exported .tex file (without path)
33890 \begin_layout Itemize
33892 \begin_inset Flex Code
33895 \begin_layout Plain Layout
33902 name of the (temporary) exported .tex file (including path)
33905 \begin_layout Itemize
33907 \begin_inset Flex Code
33910 \begin_layout Plain Layout
33917 name of the exported output file (either dvi or pdf,
33918 depending on which one exists in the temporary directory)
33921 \begin_layout Standard
33922 Note that only some of the viewers provide full and usable forward search functionality out of the box,
33929 \begin_layout Plain Layout
33930 You might want to set
33931 \begin_inset Flex Code
33934 \begin_layout Plain Layout
33941 \change_deleted -712698321 1674918020
33943 \begin_inset Flex Noun
33946 \begin_layout Plain Layout
33947 Tools\SpecialChar menuseparator
33948 Preferences\SpecialChar menuseparator
33949 File Handling\SpecialChar menuseparator
33951 \begin_inset space ~
33960 \change_inserted -712698321 1674918020
33963 Tools\SpecialChar menuseparator
33964 Preferences\SpecialChar menuseparator
33965 File Handling\SpecialChar menuseparator
33967 \begin_inset space ~
33983 \begin_layout Plain Layout
33984 SumatraPDF can also use DDE commands through the external program CMCDDE —
33986 \begin_inset CommandInset href
33988 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
34004 \begin_layout Plain Layout
34005 Forward search with evince can be achieved by means of third party helper scripts.
34007 \begin_inset CommandInset href
34009 target "https://wiki.lyx.org/LyX/SyncTeX"
34020 require some extra tools in order to use forward search.
34021 While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
34022 some other viewers – e.
34023 \begin_inset space \thinspace{}
34027 xpdf – allow at least to reload the document and jump to a specific page of the file,
34028 so you can at least navigate
34029 \begin_inset Quotes eld
34033 \begin_inset Quotes erd
34037 This latter functionality is provided by an external call of synctex (see the predefined example configurations).
34041 \begin_layout Standard
34042 Forward search works both with DVI and PDF output.
34044 simply checks which preview format you have used before (i.
34045 \begin_inset space \thinspace{}
34049 which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
34050 \change_deleted 564990737 1672743015
34054 \begin_layout Standard
34056 \change_deleted 564990737 1672743015
34057 Special Document Classes
34060 \begin_layout Standard
34062 \change_deleted 564990737 1669742044
34066 \begin_layout Standard
34068 \change_deleted 564990737 1669742044
34074 \begin_layout Standard
34076 \change_deleted 564990737 1669742044
34080 \begin_layout Standard
34082 \change_deleted 564990737 1669742044
34083 This section describes how \SpecialChar LyX
34084 can be used to write articles for submission to the scientific journal
34086 Astronomy and Astrophysics
34089 \begin_inset Flex URL
34092 \begin_layout Plain Layout
34094 https://www.aanda.org/
34099 ) using Version 5.01 of the document class
34104 This package can be downloaded from the ftp site
34107 \begin_layout Standard
34109 \change_deleted 564990737 1669742044
34110 \begin_inset VSpace medskip
34116 \begin_layout Standard
34119 \change_deleted 564990737 1669742044
34120 \begin_inset Flex URL
34123 \begin_layout Plain Layout
34125 ftp://ftp.edpsciences.org/pub/aa/readme.html
34133 \begin_layout Standard
34135 \change_deleted 564990737 1669742044
34136 \begin_inset VSpace medskip
34142 \begin_layout Standard
34144 \change_deleted 564990737 1669742044
34145 A manual comes together with that package,
34146 and this text is not meant to replace the original manual but is merely a short guide in how to realize the correct form of your paper.
34150 \begin_layout Standard
34152 \change_deleted 564990737 1669742044
34153 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
34155 That change involved also some slight changes to the style files,
34156 namely the removal of the thesaurus command.
34157 The \SpecialChar LyX
34158 class aa supports the newest version of these style files,
34160 If you have an older version installed,
34163 the old (version 4) layout has been kept as
34168 Please refer to the comments in
34171 Dir/layouts/aapaper.layout
34176 \begin_layout Standard
34178 \change_deleted 564990737 1669742044
34182 \begin_layout Standard
34184 \change_deleted 564990737 1669742044
34185 It is recommended you start from the example template distributed with \SpecialChar LyX
34187 If you are not using a template,
34188 note the following settings:
34191 \begin_layout Itemize
34193 \change_deleted 564990737 1669742044
34200 Document\SpecialChar menuseparator
34204 that one was obvious).
34207 \begin_layout Itemize
34209 \change_deleted 564990737 1669742044
34210 Don't change the option
34213 \begin_inset space ~
34224 The whole layout is done by the macros,
34225 you shouldn't change anything.
34228 \begin_layout Standard
34230 \change_deleted 564990737 1669742044
34234 \begin_layout Standard
34236 \change_deleted 564990737 1669742044
34237 First thing to enter is the header information.
34238 It consists of seven entries,
34239 of which some are optional.
34243 \begin_layout Itemize
34245 \change_deleted 564990737 1669742044
34254 \begin_layout Itemize
34256 \change_deleted 564990737 1669742044
34265 \begin_layout Itemize
34267 \change_deleted 564990737 1669742044
34276 \begin_layout Itemize
34278 \change_deleted 564990737 1669742044
34287 \begin_layout Itemize
34289 \change_deleted 564990737 1669742044
34295 [optional] if more than one author:
34296 whom to contact for offprint requests.
34299 \begin_layout Itemize
34301 \change_deleted 564990737 1669742044
34307 [optional] mail address for contacts.
34310 \begin_layout Itemize
34312 \change_deleted 564990737 1669742044
34319 Suggested format is
34326 \begin_layout Standard
34328 \change_deleted 564990737 1669742044
34329 There is no need to issue the
34336 this is done automatically by \SpecialChar LyX
34337 when the header is finished.
34338 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
34339 just to get the best optics and meets the layout of the real document.
34342 \begin_layout Standard
34344 \change_deleted 564990737 1669742044
34345 If you want to place footnotes in the header block,
34347 \begin_inset space \thinspace{}
34351 \begin_inset space \space{}
34354 to state your present address,
34355 just use the standard footnote via the menu
34357 Insert\SpecialChar menuseparator
34362 will automagically use the term
34371 \begin_layout Standard
34373 \change_deleted 564990737 1669742044
34376 Edit\SpecialChar menuseparator
34380 you'll find two insets which are relevant for the titling:
34383 \begin_layout Itemize
34385 \change_deleted 564990737 1669742044
34392 to mark corresponding author\SpecialChar breakableslash
34394 The institutes are numbered sequentially as they appear in the
34399 so you have to put a marker to each author.
34402 \begin_layout Itemize
34404 \change_deleted 564990737 1669742044
34409 to supply an email address for fast contact.
34412 \begin_layout Standard
34414 \change_deleted 564990737 1669742044
34415 In addition to these topics,
34416 the macros use one additional \SpecialChar LaTeX
34417 command that has no counterpart in \SpecialChar LyX
34421 \begin_layout Itemize
34423 \change_deleted 564990737 1669742044
34430 to separate different names for more than one author and institute,
34434 \begin_layout Standard
34436 \change_deleted 564990737 1669742044
34437 The appropriate command has to be entered in \SpecialChar LyX
34438 and marked as \SpecialChar LaTeX
34444 \begin_layout Standard
34446 \change_deleted 564990737 1669742044
34450 \begin_layout Standard
34452 \change_deleted 564990737 1669742044
34453 The abstract should immediately follow the header block.
34454 With version 5 the abstract environment was changed to a command,
34455 and there is now a restriction to only one paragraph.
34457 it should contain an entry with the keywords.
34458 This is done via the paragraph style
34463 Refer to the example paper.
34466 \begin_layout Standard
34468 \change_deleted 564990737 1669742044
34469 Supported environments
34472 \begin_layout Standard
34474 \change_deleted 564990737 1669742044
34475 The A&A paper layout supports the following environments for structuring your text:
34478 \begin_layout Itemize
34480 \change_deleted 564990737 1669742044
34486 \begin_layout Itemize
34488 \change_deleted 564990737 1669742044
34494 \begin_layout Itemize
34496 \change_deleted 564990737 1669742044
34502 \begin_layout Itemize
34504 \change_deleted 564990737 1669742044
34510 \begin_layout Itemize
34512 \change_deleted 564990737 1669742044
34518 \begin_layout Itemize
34520 \change_deleted 564990737 1669742044
34526 \begin_layout Itemize
34528 \change_deleted 564990737 1669742044
34534 \begin_layout Itemize
34536 \change_deleted 564990737 1669742044
34542 \begin_layout Itemize
34544 \change_deleted 564990737 1669742044
34550 \begin_layout Itemize
34552 \change_deleted 564990737 1669742044
34558 \begin_layout Itemize
34560 \change_deleted 564990737 1669742044
34566 \begin_layout Itemize
34568 \change_deleted 564990737 1669742044
34575 \begin_layout Standard
34577 \change_deleted 564990737 1669742044
34578 Commands not supported by \SpecialChar LyX
34582 \begin_layout Standard
34584 \change_deleted 564990737 1669742044
34585 Some commands are not yet supported by the
34589 layout for \SpecialChar LyX
34591 Some have already been mentioned.
34592 For the sake of completeness,
34593 they are listed all together here:
34596 \begin_layout Itemize
34598 \change_deleted 564990737 1669742044
34606 \begin_layout Itemize
34608 \change_deleted 564990737 1669742044
34616 \begin_layout Itemize
34618 \change_deleted 564990737 1669742044
34626 \begin_layout Itemize
34628 \change_deleted 564990737 1669742044
34636 \begin_layout Standard
34638 \change_deleted 564990737 1669742044
34639 If you want to use any of these commands,
34640 you have to enter them yourself.
34643 Do not forget to mark them as \SpecialChar LaTeX
34647 \begin_layout Standard
34649 \change_deleted 564990737 1669742044
34650 Figure and Table Floats
34653 \begin_layout Standard
34655 \change_deleted 564990737 1669742044
34657 provides support for the necessary float environments
34668 therefore we won't tell much about it here.
34672 \begin_inset space ~
34678 Just remember that tables should be left-aligned.
34680 select the table and change the alignment in
34682 Edit\SpecialChar menuseparator
34684 \begin_inset space ~
34690 \begin_layout Standard
34692 \change_deleted 564990737 1669742044
34693 There is only one special thing:
34694 the figures with caption besides the figure.
34695 To create such a figure,
34696 you have to do the following:
34699 \begin_layout Enumerate
34701 \change_deleted 564990737 1669742044
34702 Create a wide figure float:
34705 Insert\SpecialChar menuseparator
34706 Float\SpecialChar menuseparator
34710 then right click in the figure and select
34713 \begin_inset space ~
34721 \begin_layout Enumerate
34723 \change_deleted 564990737 1669742044
34724 Enter your caption text.
34727 \begin_layout Enumerate
34729 \change_deleted 564990737 1669742044
34734 to move the cursor above the caption.
34737 \begin_layout Enumerate
34739 \change_deleted 564990737 1669742044
34743 \begin_layout Enumerate
34745 \change_deleted 564990737 1669742044
34746 Position the cursor behind the figure and insert a horizontal fill:
34749 Insert\SpecialChar menuseparator
34751 \begin_inset space ~
34754 Character\SpecialChar menuseparator
34756 \begin_inset space ~
34764 \begin_layout Enumerate
34766 \change_deleted 564990737 1669742044
34767 Switch to \SpecialChar LaTeX
34772 \begin_inset space ~
34780 \begin_layout Enumerate
34782 \change_deleted 564990737 1669742044
34792 Do not close the brace!
34795 \begin_layout Enumerate
34797 \change_deleted 564990737 1669742044
34798 Position the cursor behind the caption text,
34799 switch to \SpecialChar LaTeX
34800 mode and insert the closing brace:
34804 \begin_inset space ~
34816 \begin_layout Standard
34818 \change_deleted 564990737 1669742044
34820 refer to the figures in the example paper.
34823 \begin_layout Standard
34825 \change_deleted 564990737 1669742044
34829 \begin_layout Standard
34831 \change_deleted 564990737 1669742044
34833 the paper has to be formated in a special double-spacing layout.
34835 you have to give the option
34839 to the document class.
34840 This must be done using the custom class options field in the
34842 Document\SpecialChar menuseparator
34846 Just enter the string
34853 \begin_layout Standard
34855 \change_deleted 564990737 1669742044
34859 \begin_layout Standard
34861 \change_deleted 564990737 1669742044
34866 directory contains an example paper written with \SpecialChar LyX
34868 It is the example paper from the original macro package,
34869 translated to \SpecialChar LyX
34871 Use it for inspiration,
34872 and compare the original \SpecialChar LaTeX
34873 code with \SpecialChar LyX
34877 \begin_layout Standard
34879 \change_deleted 564990737 1671097429
34883 \begin_layout Standard
34885 \change_deleted 564990737 1671097429
34890 can be used to type letters according to German conventions.
34891 A template file is included in
34893 .../lyx/share/templates
34895 for you to use as a starting point.
34898 \begin_layout Standard
34900 \change_deleted 564990737 1671097429
34904 \begin_layout Standard
34906 \change_deleted 564990737 1671097429
34907 See the \SpecialChar LyX
34913 It contains all infos you need.
34916 \begin_layout Standard
34918 \change_deleted 564990737 1669755802
34922 \begin_layout Standard
34924 \change_deleted 564990737 1669755802
34927 Panayotis Papasotiriou
34930 \begin_layout Standard
34932 \change_deleted 564990737 1669755802
34936 \begin_layout Standard
34938 \change_deleted 564990737 1669755802
34939 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
34941 International Journal of Modern Physics C
34945 the ijmpd package is for creating manuscripts to be submitted to the
34947 International Journal of Modern Physics D
34950 Both journals are published by World Scientific.
34951 The corresponding document classes are named
34962 together with instructions for the authors,
34963 can be downloaded from the sites
34964 \begin_inset Flex URL
34967 \begin_layout Plain Layout
34969 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
34975 \begin_inset Flex URL
34978 \begin_layout Plain Layout
34980 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
34986 Both packages are modified versions of the standard
34987 \begin_inset Quotes eld
34991 \begin_inset Quotes erd
34995 and they are almost (but not exactly) identical.
34996 Most of their features are supported by \SpecialChar LyX
34998 I have used \SpecialChar LyX
34999 successfully to write articles submitted to both journals without any problem.
35002 \begin_layout Standard
35004 \change_deleted 564990737 1669755802
35008 \begin_layout Standard
35010 \change_deleted 564990737 1669755802
35012 the easiest way to write a paper is to start with a template.
35015 File\SpecialChar menuseparator
35032 This will give an (almost) empty document that includes the most common fields found in a manuscript.
35033 Simply overwrite the existing text (including the brackets,
35039 You should keep in mind the following remarks.
35042 \begin_layout Enumerate
35044 \change_deleted 564990737 1669755802
35046 won't let you change the font size and the page style of the document,
35047 because such modifications are not allowed by both packages.
35050 \begin_layout Enumerate
35052 \change_deleted 564990737 1669755802
35053 The language of the document should not be changed.
35054 Before previewing your paper,
35055 be sure that the babel package is not used.
35060 arg "dialog-show document"
35065 \SpecialChar menuseparator
35070 \begin_inset Quotes eld
35074 \begin_inset Quotes erd
35084 \begin_layout Enumerate
35086 \change_deleted 564990737 1669755802
35088 \begin_inset Quotes eld
35092 \begin_inset Quotes erd
35095 style must be used to define keywords.
35098 \begin_layout Enumerate
35100 \change_deleted 564990737 1669755802
35101 The ijmpc package provides a style named
35102 \begin_inset Quotes eld
35105 Classification Codes
35106 \begin_inset Quotes erd
35110 which can be used to define classification codes,
35111 such as PACS numbers.
35112 Note that this facility is not supported by the ijmpd package.
35115 \begin_layout Enumerate
35117 \change_deleted 564990737 1669755802
35118 Several new environments are available:
35120 \begin_inset Quotes eld
35124 \begin_inset Quotes erd
35129 \begin_inset Quotes eld
35133 \begin_inset Quotes erd
35138 \begin_inset Quotes eld
35142 \begin_inset Quotes erd
35147 \begin_inset Quotes eld
35151 \begin_inset Quotes erd
35156 \begin_inset Quotes eld
35160 \begin_inset Quotes erd
35165 \begin_inset Quotes eld
35169 \begin_inset Quotes erd
35174 \begin_inset Quotes eld
35178 \begin_inset Quotes erd
35183 \begin_inset Quotes eld
35187 \begin_inset Quotes erd
35192 \begin_inset Quotes eld
35196 \begin_inset Quotes erd
35201 \begin_inset Quotes eld
35205 \begin_inset Quotes erd
35210 \begin_inset Quotes eld
35214 \begin_inset Quotes erd
35219 \begin_inset Quotes eld
35223 \begin_inset Quotes erd
35228 \begin_inset Quotes eld
35232 \begin_inset Quotes erd
35237 \begin_inset Quotes eld
35241 \begin_inset Quotes erd
35245 Their use is more or less obvious.
35247 supports all these environments;
35248 it will use the proper label,
35250 and numbering scheme for each of them.
35253 \begin_layout Enumerate
35255 \change_deleted 564990737 1669755802
35256 Both packages use basic citations;
35257 the natbib package should not be used.
35258 In \SpecialChar LyX
35260 citation references are shown as usual;
35262 citations are shown as superscripts.
35263 If you want to use a citation as normal text,
35270 \begin_inset space \thinspace{}
35274 \begin_inset space \space{}
35278 \begin_inset Quotes eld
35282 \begin_inset space \space{}
35292 \begin_inset Quotes erd
35298 \begin_layout Enumerate
35300 \change_deleted 564990737 1669755802
35302 \begin_inset Quotes eld
35306 \begin_inset Quotes erd
35309 section in both packages.
35310 To put acknowledgments,
35312 \begin_inset Quotes eld
35316 \begin_inset Quotes erd
35322 \begin_layout Enumerate
35324 \change_deleted 564990737 1669755802
35325 Appendices may be added to the paper,
35330 the Acknowledgments and
35336 provides a special environment,
35338 \begin_inset Quotes eld
35342 \begin_inset Quotes erd
35345 which marks the beginning of the appendices.
35346 This environment should be left blank;
35347 it just sends a \SpecialChar LaTeX
35349 but nothing is really printed.
35350 In \SpecialChar LyX
35353 \begin_inset Quotes eld
35357 \begin_inset Quotes erd
35360 is printed with blue letters,
35361 as a signal that all sections after that point are appendices.
35362 To write an appendix,
35364 \begin_inset Quotes eld
35368 \begin_inset Quotes erd
35373 will number each appendix with capital letters,
35374 as required by both journals.
35376 \begin_inset Quotes eld
35380 \begin_inset Quotes erd
35387 be present before the first appendix;
35389 all appendices will be numbered as normal sections in the output.
35392 \begin_layout Enumerate
35394 \change_deleted 564990737 1669755802
35395 The ijmpc and the ijmpd packages use the
35399 command to implement table captions.
35401 a table created by \SpecialChar LyX
35402 is printed correctly,
35403 but its caption is ignored.
35405 you can use some \SpecialChar TeX
35406 code to overcome this problem,
35407 so that captions are printed as expected.
35409 create a float table as usual,
35410 remove the caption,
35411 and replace it with the \SpecialChar TeX
35423 you must also the \SpecialChar TeX
35428 immediately after the tabular material.
35429 Study the example table included in the template files to see how this trick is implemented.
35431 If you need table captions,
35432 you should implement the whole table float in a
35437 then include this file to the \SpecialChar LyX
35440 Insert\SpecialChar menuseparator
35441 File\SpecialChar menuseparator
35443 \begin_inset space ~
35449 Details on how to create a table float can be found in the files
35458 included in the corresponding packages.
35461 \begin_layout Standard
35463 \change_deleted 564990737 1669755802
35464 Preparing a paper for submission
35467 \begin_layout Standard
35469 \change_deleted 564990737 1669755802
35470 Before you submit your paper you must export the \SpecialChar LyX
35471 document as a \SpecialChar LaTeX
35474 File\SpecialChar menuseparator
35475 Export\SpecialChar menuseparator
35483 \begin_layout Plain Layout
35484 Actually you have the choice between \SpecialChar LaTeX
35485 (plain) and pdflatex.
35486 If you intend to use pdflatex to prepare the paper,
35487 you should use the pdflatex option so that included graphics are converted to PDF format,
35488 ready for use by pdflatex.
35494 then make the following changes to the resulting
35501 \begin_layout Enumerate
35503 \change_deleted 564990737 1669755802
35504 Remove the comment lines before the
35513 \begin_layout Enumerate
35515 \change_deleted 564990737 1669755802
35516 Remove everything between (and including) the
35529 except for any commands you specifically put into the \SpecialChar LaTeX
35533 \begin_layout Standard
35535 \change_deleted 564990737 1672743015
35540 file should be saved and processed through \SpecialChar LaTeX
35541 as many times as necessary.
35542 You may also want to check the resulting
35549 \begin_layout Standard
35551 \change_deleted 564990737 1669801478
35555 \begin_layout Standard
35557 \change_deleted 564990737 1669801478
35563 \begin_layout Standard
35565 \change_deleted 564990737 1669801478
35569 \begin_layout Standard
35571 \change_deleted 564990737 1669801478
35572 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
35573 Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
35574 \begin_inset Flex URL
35577 \begin_layout Plain Layout
35579 ftp://ftp.iop.org/pub/journals/latex2e
35587 \begin_layout Standard
35589 \change_deleted 564990737 1669801478
35593 \begin_layout Standard
35595 \change_deleted 564990737 1669801478
35596 The easiest way to write a paper is to start with the template
35600 that is available via
35602 File\SpecialChar menuseparator
35605 The template explains how to use the special text environments.
35606 Here are the most important advices:
35609 \begin_layout Itemize
35611 \change_deleted 564990737 1669801478
35612 To be able to compile your document to a PDF,
35615 ensure that the no AMS packages are loaded in
35617 Document\SpecialChar menuseparator
35618 Settings\SpecialChar menuseparator
35624 \begin_layout Itemize
35626 \change_deleted 564990737 1669801478
35629 The title environment defines the kind of your paper.
35630 So use one of the following environments for the title:
35634 \begin_layout Itemize
35636 \change_deleted 564990737 1669801478
35645 \begin_layout Itemize
35647 \change_deleted 564990737 1669801478
35656 \begin_layout Itemize
35658 \change_deleted 564990737 1669801478
35664 for a Topical review
35667 \begin_layout Itemize
35669 \change_deleted 564990737 1669801478
35678 \begin_layout Itemize
35680 \change_deleted 564990737 1669801478
35689 \begin_layout Itemize
35691 \change_deleted 564990737 1669801478
35697 for a Paper (same as Title)
35700 \begin_layout Itemize
35702 \change_deleted 564990737 1669801478
35708 for a Preliminary communication
35711 \begin_layout Itemize
35713 \change_deleted 564990737 1669801478
35719 for a Rapid communication
35722 \begin_layout Itemize
35724 \change_deleted 564990737 1669801478
35730 for a Letter to the editor
35734 \begin_layout Itemize
35736 \change_deleted 564990737 1669801478
35739 All title environments except of
35743 can have an optional short title.
35746 \begin_layout Itemize
35748 \change_deleted 564990737 1669801478
35749 There is a general title environment
35753 which is not directly supported by \SpecialChar LyX
35755 This can be used as \SpecialChar TeX
35756 code when your document doesn't fit into one of the other title types.
35759 \begin_layout Standard
35761 \change_deleted 564990737 1672743015
35762 For more informations like hints for special table and formula formatting,
35763 look at the IOP author guidelines.
35766 \begin_layout Standard
35768 \change_deleted 564990737 1670317155
35772 \begin_layout Standard
35774 \change_deleted 564990737 1670317155
35777 Panayotis Papasotiriou
35780 \begin_layout Standard
35782 \change_deleted 564990737 1670317155
35786 \begin_layout Standard
35788 \change_deleted 564990737 1670317155
35789 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
35790 Most known of them (at least in my domain of interest) are
35792 Astrophysics and Space Science
35799 but there are many others (see a complete list at
35800 \begin_inset Flex URL
35803 \begin_layout Plain Layout
35805 http://www.wkap.nl/jrnllist.htm/JRNLHOME
35811 The Kluwer package may be downloaded from the site
35812 \begin_inset Flex URL
35815 \begin_layout Plain Layout
35817 http://www.wkap.nl/kaphtml.htm/STYLEFILES
35823 A complete user guide is contained in that package (but it can also be downloaded separately).
35826 \begin_layout Standard
35828 \change_deleted 564990737 1670317155
35830 supports many features of the package but not everything.
35832 the \SpecialChar TeX
35833 code needed is reduced to some
35834 \begin_inset Quotes eld
35838 \begin_inset Quotes erd
35841 commands of the package (see
35842 \begin_inset space ~
35846 \begin_inset CommandInset ref
35848 reference "subsec:kluwer_peculiarities"
35854 I have recently used \SpecialChar LyX
35855 to write an article submitted to the
35857 Astrophysics and Space Science
35859 without any problem.
35862 \begin_layout Standard
35864 \change_deleted 564990737 1670317155
35868 \begin_layout Standard
35870 \change_deleted 564990737 1670317155
35871 The easiest way to write a paper is to start with the Kluwer template file.
35874 File\SpecialChar menuseparator
35887 This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
35888 As in most templates,
35889 simply overwrite the existing text (including the brackets,
35894 ) with the correct information.
35897 \begin_layout Standard
35899 \change_deleted 564990737 1670317155
35900 Preparing a paper for submission
35903 \begin_layout Standard
35905 \change_deleted 564990737 1670317155
35906 As in the AAS\SpecialChar TeX
35908 before you submit your paper to a journal you must
35909 \begin_inset Quotes eld
35913 \begin_inset Quotes erd
35919 \begin_layout Enumerate
35921 \change_deleted 564990737 1670317155
35922 Export your paper as a \SpecialChar LaTeX
35927 File\SpecialChar menuseparator
35928 Export\SpecialChar menuseparator
35936 \begin_layout Enumerate
35938 \change_deleted 564990737 1670317155
35943 file with a text editor and make the following changes
35947 \begin_layout Enumerate
35949 \change_deleted 564990737 1670317155
35950 remove the comment lines before the
35959 \begin_layout Enumerate
35961 \change_deleted 564990737 1670317155
35962 remove everything between (and including) the
35975 except for any commands you specifically put into the \SpecialChar LaTeX
35979 \begin_layout Standard
35981 \change_deleted 564990737 1670317155
35990 \begin_layout Enumerate
35992 \change_deleted 564990737 1670317155
35997 file through \SpecialChar LaTeX
35998 as many times as necessary (usually up to three).
36001 \begin_layout Enumerate
36003 \change_deleted 564990737 1670317155
36010 \begin_inset space \thinspace{}
36014 \begin_inset space \space{}
36022 and check if everything is OK (it should,
36023 if you didn't make any mistake).
36026 \begin_layout Standard
36028 \change_deleted 564990737 1670317155
36029 \begin_inset Quotes eld
36033 \begin_inset Quotes erd
36036 of the Kluwer package
36037 \begin_inset CommandInset label
36039 name "subsec:kluwer_peculiarities"
36046 \begin_layout Standard
36048 \change_deleted 564990737 1670317155
36049 The Kluwer package has the following
36050 \begin_inset Quotes eld
36054 \begin_inset Quotes erd
36060 \begin_layout Enumerate
36062 \change_deleted 564990737 1670317155
36063 It is possible to write multiple articles in the same \SpecialChar LaTeX
36068 \begin_layout Plain Layout
36069 I can't imagine any good reason to do this.
36075 Each article must be included in the environment
36076 \begin_inset Quotes eld
36080 \begin_inset Quotes erd
36085 this environment cannot be omitted,
36086 even if you write just one article.
36088 each article starts with the command
36096 ends with the command
36103 Although this can be implemented in \SpecialChar LyX
36105 I didn't included it,
36106 since it looks ugly and can confuse the novice user.
36108 you need to enter them directly and mark them as \SpecialChar LaTeX
36109 code (the well-known
36110 \begin_inset Quotes eld
36115 \begin_inset Quotes erd
36121 \begin_layout Enumerate
36123 \change_deleted 564990737 1670317155
36124 Information given at the beginning of the article (i.
36125 \begin_inset space \thinspace{}
36129 \begin_inset space \space{}
36138 abstract and keywords) must be included in an environment called
36139 \begin_inset Quotes eld
36143 \begin_inset Quotes erd
36147 This is not implemented in \SpecialChar LyX
36149 so you must enter title,
36151 \begin_inset space ~
36154 between two \SpecialChar TeX
36170 \begin_layout Enumerate
36172 \change_deleted 564990737 1670317155
36173 According to the user manual,
36174 the label of each bibliography item must be written as
36197 \begin_layout Standard
36199 \change_deleted 564990737 1670317155
36204 template takes care of all these
36205 \begin_inset Quotes eld
36209 \begin_inset Quotes erd
36213 If you start a new paper using this template you don't need to do anything special.
36217 \begin_layout Enumerate
36219 \change_deleted 564990737 1670317155
36220 don't delete the \SpecialChar TeX
36221 code included in the template,
36225 \begin_layout Enumerate
36227 \change_deleted 564990737 1670317155
36228 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
36231 \begin_layout Standard
36233 \change_deleted 564990737 1671097446
36237 \begin_layout Standard
36239 \change_deleted 564990737 1671097446
36244 provides an alternative to the standard
36249 It provides similar functionality,
36250 but you might prefer this layout with sans serif sections,
36255 \begin_layout Standard
36257 \change_deleted 564990737 1671097446
36258 Springer Journals (
36265 \begin_layout Standard
36267 \change_deleted 564990737 1671097446
36273 \begin_layout Standard
36275 \change_deleted 564990737 1671097446
36279 \begin_layout Standard
36281 \change_deleted 564990737 1671097446
36282 These are the layout files for some of the journal formats used by Springer Verlag and listed on
36283 \begin_inset Flex URL
36286 \begin_layout Plain Layout
36288 http://www.springer.de/author/tex/help-journals.html
36294 where you should also go to fetch the class files (yes,
36295 these are \SpecialChar LaTeX2e
36297 It is a modular system:
36298 the things common to all journals are implemented in
36303 which journal-specific layout files (such as,
36305 \begin_inset space \thinspace{}
36309 \begin_inset space \space{}
36316 for Journal of Geodesy) can include.
36319 \begin_layout Standard
36321 \change_deleted 564990737 1671097446
36322 This means that implementing support for any other Springer journal on this list is as simple as writing your own
36330 file following the outline given in
36338 \begin_layout Standard
36340 \change_deleted 564990737 1671097446
36341 It is reasonably well tested only for the Journal of Geodesy.
36350 come with the standard \SpecialChar LyX
36352 Install the relevant class file (downloaded from Springer) in a proper directory,
36353 reconfigure \SpecialChar LaTeX
36354 (in the te\SpecialChar TeX
36360 as root if necessary —
36361 doesn't \SpecialChar LyX
36362 take care of this?),
36363 reconfigure \SpecialChar LyX
36364 and it should work.
36367 \begin_layout Standard
36369 \change_deleted 564990737 1671097446
36373 \begin_layout Standard
36375 \change_deleted 564990737 1671097446
36376 A large number of theorem-like styles —
36391 \begin_layout Standard
36393 \change_deleted 564990737 1671097446
36399 Running_\SpecialChar LaTeX
36410 See the Springer class file documentation for details.
36413 \begin_layout Standard
36415 \change_deleted 564990737 1671097446
36419 \begin_layout Itemize
36421 \change_deleted 564990737 1671097446
36435 \begin_layout Itemize
36437 \change_deleted 564990737 1671097446
36440 Probability Theory and Related Fields
36448 Jean-Marc Lasgouttes
36451 \begin_layout Standard
36453 \change_deleted 564990737 1671097446
36458 \begin_layout Standard
36460 \change_deleted 564990737 1671097446
36464 \begin_layout Standard
36466 \change_deleted 564990737 1671097446
36467 These files are partly based on the older
36472 which was again based on a tinkered-with version of an old \SpecialChar LaTeX
36473 2.09 style file from Springer.
36481 Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
36482 layout file mechanism.
36485 \begin_layout Standard
36487 \change_deleted 564990737 1671097446
36491 \begin_layout Standard
36493 \change_deleted 564990737 1671097446
36495 But probably less than in the old hacked-\SpecialChar LaTeX
36503 \begin_layout Chapter
36505 Features needing Extra Software
36508 \begin_layout Section
36509 Checking \SpecialChar TeX
36513 \begin_layout Standard
36519 \begin_layout Subsection
36523 \begin_layout Standard
36532 \begin_layout Plain Layout
36537 is not yet available when you are using the \SpecialChar LaTeX
36538 distribution MiK\SpecialChar TeX
36553 \begin_inset space ~
36564 \begin_inset Newline newline
36568 \begin_inset CommandInset href
36570 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
36578 \begin_layout Standard
36581 Chk\SpecialChar TeX
36584 package is a program that was written by
36585 \begin_inset Flex Noun
36588 \begin_layout Plain Layout
36590 \begin_inset space ~
36598 in frustration because some constructs in \SpecialChar LaTeX
36599 are sometimes non-intuitive,
36600 and easy to forget.
36601 The program runs over your \SpecialChar LaTeX
36603 checks the integrity of the file,
36604 and flags some common errors.
36605 In other technical words,
36610 for \SpecialChar LaTeX
36614 \begin_layout Standard
36616 what is a syntax checker doing in \SpecialChar LyX
36617 which is supposed to produce correct \SpecialChar LaTeX
36619 The answer is simple:
36624 not only checks the
36633 checks for type-errors,
36636 Chk\SpecialChar TeX
36639 catches some common
36644 in addition to the syntactical ones.
36648 Chk\SpecialChar TeX
36651 is capable of detecting several common errors,
36655 \begin_layout Itemize
36656 Ellipsis detection:
36657 \begin_inset Newline newline
36660 Use \SpecialChar ldots
36664 \begin_layout Itemize
36665 No space in front of/after parenthesis:
36666 \begin_inset Newline newline
36672 \begin_layout Itemize
36673 Enforcement of normal space after common abbreviations:
36674 \begin_inset Newline newline
36678 \begin_inset space \thinspace{}
36682 \begin_inset space \space{}
36685 is too wide spacing.
36688 \begin_layout Itemize
36689 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
36690 \begin_inset Newline newline
36694 And this is wrong spacing.
36697 \begin_layout Itemize
36698 Space in front of labels and similar commands:
36699 \begin_inset Newline newline
36702 The label should stick right up to the text to avoid falling to a wrong page.
36704 \begin_inset CommandInset label
36714 \begin_layout Plain Layout
36715 This footnote is in danger of falling off to a wrong page
36720 The label is separated too much.
36723 \begin_layout Itemize
36724 Space in front of references,
36725 instead of hard spaces:
36726 \begin_inset Newline newline
36729 If you have bad luck,
36730 the text will break right between the referenced text and reference number,
36733 \begin_inset CommandInset ref
36735 reference "sec:chktex"
36743 \begin_layout Itemize
36745 \begin_inset Quotes eld
36749 \begin_inset Quotes erd
36753 \begin_inset Formula $\times$
36757 \begin_inset Newline newline
36760 2x2 looks cheap compared to
36761 \begin_inset Formula $2\times2$
36767 \begin_layout Standard
36768 and more \SpecialChar ldots
36769 It is an invaluable tool when you are
36770 \begin_inset Quotes eld
36774 \begin_inset Quotes erd
36777 your document before printing,
36778 and you should run it right after the obligatory spelling check,
36779 and before you go fine tuning the typesetting.
36782 \begin_layout Subsection
36786 \begin_layout Standard
36787 If you have the program installed,
36788 usage is as simple as choosing
36790 Tools\SpecialChar menuseparator
36792 \begin_inset space ~
36798 This will make \SpecialChar LyX
36799 generate a \SpecialChar LaTeX
36800 file of your document,
36803 Chk\SpecialChar TeX
36807 and then make \SpecialChar LyX
36809 \begin_inset Quotes eld
36813 \begin_inset Quotes erd
36816 with the warnings from
36818 Chk\SpecialChar TeX
36823 The warnings will be placed close to the point of the mistake,
36824 and you can quickly find them by using the
36826 Navigate\SpecialChar menuseparator
36830 or the shortcut key
36839 Open the error boxes by clicking on them with the mouse,
36840 or use the shortcut key
36849 or the corresponding
36858 Read the warning and correct the mistake,
36859 if it is a mistake.
36860 If you have trouble understanding what the warning is about,
36861 you can safely ignore it.
36862 Remember that there is a hidden layer between the document on screen and the technical details in invoking
36864 Chk\SpecialChar TeX
36868 and this gap can make some warnings seem arcane or just plain silly.
36871 \begin_layout Standard
36872 This document is an excellent testing bed for the feature,
36873 and it should provide quite a few warnings for you to fiddle with.
36874 Since computers are only so smart,
36875 expect most of the warnings to be false alarms,
36879 \begin_layout Subsection
36880 How to fine tune it
36883 \begin_layout Standard
36887 Chk\SpecialChar TeX
36890 makes more noise than suits your mood.
36891 Then you can choose not to use it,
36892 wait until your mood changes,
36893 or try to customize
36895 Chk\SpecialChar TeX
36898 to get better along with you.
36901 \begin_layout Standard
36904 Chk\SpecialChar TeX
36911 very configurable and extensible,
36912 you should not expect to solve all problems with
36914 Chk\SpecialChar TeX
36917 in \SpecialChar LyX
36919 Since \SpecialChar LyX
36920 has to generate a somewhat special \SpecialChar LaTeX
36921 file to be able to match the line numbers from the
36923 Chk\SpecialChar TeX
36930 \begin_layout Plain Layout
36931 You can inspect the specific output from
36937 Document\SpecialChar menuseparator
36940 \begin_inset space ~
36954 to the internal document structure,
36955 some of the warnings will not appear correctly.
36956 There are two things you can do about this:
36959 \begin_layout Itemize
36962 Chk\SpecialChar TeX
36965 invocation command line in
36966 \change_deleted -712698321 1674918035
36968 \begin_inset Flex Noun
36971 \begin_layout Plain Layout
36972 Tools\SpecialChar menuseparator
36973 Preferences\SpecialChar menuseparator
36974 Output\SpecialChar menuseparator
36975 LaTeX\SpecialChar menuseparator
36982 \change_inserted -712698321 1674918035
36985 Tools\SpecialChar menuseparator
36986 Preferences\SpecialChar menuseparator
36987 Output\SpecialChar menuseparator
36988 LaTeX\SpecialChar menuseparator
36996 Chk\SpecialChar TeX
36999 installation configuration file (usually with the file
37004 See below to learn what warnings can be enabled and disabled on the command line.
37007 \begin_layout Itemize
37008 Export your document as a raw \SpecialChar LaTeX
37011 File\SpecialChar menuseparator
37012 Export\SpecialChar menuseparator
37021 Invoked in this way,
37022 it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
37024 but with a little patience,
37025 you should be able to do it.
37028 \begin_layout Standard
37029 Here follows the warning messages that can be enabled and disabled in
37038 to disable a warning,
37043 to enable a warning.
37044 The emphasized entries are disabled by default,
37045 because the default is "
37047 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
37052 \begin_layout Standard
37053 Notice that you should only use the options that enable and disable warnings,
37054 because \SpecialChar LyX
37055 relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
37062 \begin_layout Enumerate
37066 Command terminated with space.
37069 \begin_layout Enumerate
37072 Non-breaking space (
37073 \begin_inset Quotes eld
37081 \begin_inset Quotes erd
37084 ) should have been used.
37087 \begin_layout Enumerate
37091 You should enclose the previous parenthesis with
37092 \begin_inset Quotes eld
37100 \begin_inset Quotes erd
37106 \begin_layout Enumerate
37109 Italic correction (
37110 \begin_inset Quotes eld
37120 \begin_inset Quotes erd
37123 ) found in non-italic buffer.
37126 \begin_layout Enumerate
37129 Italic correction (
37130 \begin_inset Quotes eld
37140 \begin_inset Quotes erd
37143 ) found more than once.
37146 \begin_layout Enumerate
37150 No italic correction (
37151 \begin_inset Quotes eld
37161 \begin_inset Quotes erd
37167 \begin_layout Enumerate
37171 \begin_inset Quotes eld
37179 \begin_inset Quotes erd
37183 \begin_inset Quotes eld
37191 \begin_inset Quotes erd
37197 \begin_layout Enumerate
37200 Wrong length of dash may have been used.
37203 \begin_layout Enumerate
37207 \begin_inset Quotes eld
37215 \begin_inset Quotes erd
37220 \begin_inset Quotes eld
37228 \begin_inset Quotes erd
37234 \begin_layout Enumerate
37238 \begin_inset Quotes eld
37246 \begin_inset Quotes erd
37252 \begin_layout Enumerate
37256 \begin_inset Quotes eld
37264 \begin_inset Quotes erd
37267 to achieve an ellipsis.
37270 \begin_layout Enumerate
37273 Inter-word spacing (
37274 \begin_inset Quotes eld
37284 \begin_inset Quotes eld
37287 ) should perhaps be used.
37290 \begin_layout Enumerate
37293 Inter-sentence spacing (
37294 \begin_inset Quotes eld
37304 \begin_inset Quotes erd
37307 ) should perhaps be used.
37310 \begin_layout Enumerate
37313 Could not find argument for command.
37316 \begin_layout Enumerate
37320 \begin_inset Quotes eld
37328 \begin_inset Quotes erd
37334 \begin_layout Enumerate
37337 Math mode still on at end of \SpecialChar LaTeX
37341 \begin_layout Enumerate
37345 \begin_inset Quotes eld
37353 \begin_inset Quotes erd
37356 doesn't match the number of
37357 \begin_inset Quotes eld
37365 \begin_inset Quotes erd
37371 \begin_layout Enumerate
37374 You should use either
37377 \begin_inset Quotes eld
37385 \begin_inset Quotes erd
37390 as an alternative to
37391 \begin_inset Quotes eld
37399 \begin_inset Quotes erd
37405 \begin_layout Enumerate
37412 " (ASCII 39) instead of "
37419 \begin_layout Enumerate
37422 User-specified pattern found.
37425 \begin_layout Enumerate
37428 This command might not be intended.
37431 \begin_layout Enumerate
37438 \begin_layout Enumerate
37456 \begin_layout Enumerate
37459 Delete this space to maintain correct page references.
37462 \begin_layout Enumerate
37466 You might wish to put this between a pair of
37467 \begin_inset Quotes eld
37475 \begin_inset Quotes erd
37481 \begin_layout Enumerate
37484 You ought to remove spaces in front of punctuation.
37487 \begin_layout Enumerate
37490 Could not execute \SpecialChar LaTeX
37494 \begin_layout Enumerate
37503 in front of small punctuation.
37506 \begin_layout Enumerate
37514 may look prettier here.
37517 \begin_layout Enumerate
37521 Multiple spaces detected in output.
37524 \begin_layout Enumerate
37527 This text may be ignored.
37530 \begin_layout Enumerate
37536 \begin_inset Quotes eld
37541 to begin quotation,
37549 \begin_layout Enumerate
37560 \begin_inset Quotes eld
37568 \begin_layout Enumerate
37574 \begin_layout Enumerate
37577 You should perhaps use
37578 \begin_inset Quotes eld
37586 \begin_inset Quotes erd
37592 \begin_layout Enumerate
37595 You should put a space in front of/after parenthesis.
37598 \begin_layout Enumerate
37601 You should avoid spaces in front of/after parenthesis.
37604 \begin_layout Enumerate
37608 You should not use punctuation in front of/after quotes.
37611 \begin_layout Enumerate
37614 Double space found.
37617 \begin_layout Enumerate
37620 You should put punctuation outside inner/inside display math mode.
37623 \begin_layout Enumerate
37626 You ought to not use primitive \SpecialChar TeX
37627 in \SpecialChar LaTeX
37631 \begin_layout Enumerate
37634 You should remove spaces in front of
37635 \begin_inset Quotes eld
37643 \begin_inset Quotes erd
37649 \begin_layout Enumerate
37652 \begin_inset Quotes eld
37660 \begin_inset Quotes erd
37663 is normally not followed by
37664 \begin_inset Quotes eld
37672 \begin_inset Quotes erd
37678 \begin_layout Standard
37679 In later versions of \SpecialChar LyX
37681 we hope to provide a more complete interface to this tool (and it's smaller cousin
37685 ) to exploit the full power of it.
37686 But it's not exactly useless as it is now:
37687 go try it on one of your existing documents of a certain length and be surprised.
37690 \begin_layout Section
37691 Version Control in \SpecialChar LyX
37695 \begin_layout Standard
37698 Lars Gullik Bjønnes
37705 \begin_layout Subsection
37709 \begin_layout Standard
37711 supports some of the most basic RCS/CVS/SVN/GIT commands.
37712 If you need something a bit more sophisticated you will have to do that manually in a terminal
37713 \change_inserted 5863208 1685691238
37714 or your favourite client
37719 \begin_layout Standard
37720 Also note that CVS support is not as good as subversion support,
37721 so we advise using SVN instead.
37722 A good place to start learning Subversion is the SVN Book
37726 \begin_layout Plain Layout
37727 \begin_inset CommandInset href
37729 target "http://svnbook.red-bean.com/"
37740 In the case of RCS you should read
37741 \begin_inset Quotes eld
37745 \begin_inset Quotes erd
37754 This file describes all the basic features of RCS.
37755 You should especially notice the comment about a RCS directory,
37756 and the notion of a master RCS file (the file ending in
37763 \begin_layout Standard
37764 Before you begin to use the version control features in \SpecialChar LyX
37766 you should be familiar with RCS/CVS/SVN/GIT usage.
37767 The implementation in \SpecialChar LyX
37768 assumes a recent version of the GNU RCS or CVS/SVN package —
37769 no guarantees are made for older versions.
37770 Most of the log messages are not currently displayed after operations —
37771 you can check them in the Messages pane if you are unsure.
37772 Regular users of version control will appreciate the VC toolbar,
37773 which can be enabled via
37775 View\SpecialChar menuseparator
37776 Toolbars\SpecialChar menuseparator
37778 \begin_inset space ~
37786 \begin_layout Standard
37787 For introducing your own external commands consult
37788 \begin_inset Flex Code
37791 \begin_layout Plain Layout
37805 \begin_layout Standard
37806 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
37808 Document\SpecialChar menuseparator
37812 Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
37813 Compressed LyX documents are binary files,
37814 which cannot be merged by version control systems.
37816 \change_inserted 5863208 1685692758
37819 Also to avoid unnecessary merge conflicts we advise to disable document Document\SpecialChar menuseparator
37820 Settings\SpecialChar menuseparator
37821 Output\SpecialChar menuseparator
37822 Save transient properties when more users work on the same document.
37827 \begin_layout Subsection
37828 RCS commands in \SpecialChar LyX
37832 \begin_layout Standard
37833 The following sections describe the RCS commands supported by \SpecialChar LyX
37835 You can find them in the
37837 File\SpecialChar menuseparator
37839 \begin_inset space ~
37846 was tested against RCS 5.7/5.8
37847 \change_inserted 5863208 1685694069
37853 \begin_layout Subsubsection
37859 \begin_layout Standard
37860 If your document is not under revision control,
37861 this is the only item shown in the menu.
37862 And if it is under revision control,
37867 item is not visible.
37871 \begin_layout Standard
37872 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
37873 You are asked interactively to supply an initial description of the document.
37874 The document is now set in Read-Only mode and you have to
37877 \begin_inset space ~
37881 \begin_inset space ~
37885 \begin_inset space ~
37891 before making any changes to it.
37892 A document under revision control has a
37893 \begin_inset Quotes eld
37896 [RCS:<version> <locker>]
37897 \begin_inset Quotes erd
37900 item tagged to the filename in the minibuffer.
37903 \begin_layout Standard
37904 RCS command that is run:
37907 \begin_layout LyX-Code
37910 ci -q -u -i -t-"<initial description>" <file-name>
37913 \begin_layout Standard
37918 to understand the switches.
37922 \begin_layout Subsubsection
37928 \begin_layout Standard
37929 When you are finished editing a file,
37930 you check in your changes.
37932 you are asked for a description of the changes.
37933 This is stored in the history log.
37934 The version number is bumped,
37935 your changes are applied to the master RCS file,
37936 the document is unlocked and set to Read-Only mode.
37939 \begin_layout Itemize
37943 ci -q -u -m"<description>" <file-name>
37946 \begin_layout Subsubsection
37952 \begin_layout Standard
37953 By doing this you lock the document so that only you can edit it.
37954 This will also make the document Read-Write only for you.
37955 You will usually continue editing for a while and when you are finished you check in your changes.
37956 The status line is changed to reflect that you have locked the file.
37959 \begin_layout Itemize
37963 co -q -l <file-name>
37966 \begin_layout Subsubsection
37969 Revert To Repository Version
37972 \begin_layout Standard
37973 This will discard all changes made to the document since the last check in.
37974 You get a warning before changes are discarded.
37977 \begin_layout Itemize
37981 co -f -u<version> <file-name>
37984 \begin_layout Subsubsection
37990 \begin_layout Standard
37991 This will create a copy of the current document.
37992 Since RCS does not support copy operations natively,
37993 the version history is not preserved,
37994 and the copy is added as a new file.
37995 It requires a clean document without any changes since the last checkin.
37996 You are asked for a file name and a description of the copy operation.
37997 After that the copy is created,
37998 both locally and in the repository.
37999 If the parent directories of the copied and original document differ,
38000 all relative paths of included files of the copy are adjusted (like in
38002 File\SpecialChar menuseparator
38008 the copy is loaded instead of the original document.
38011 \begin_layout Labeling
38012 \labelwidthstring 00.00.0000
38014 \begin_inset space ~
38019 \begin_inset space ~
38023 \begin_inset Newline newline
38027 \begin_inset Flex Code
38030 \begin_layout Plain Layout
38033 \begin_inset Quotes qld
38037 \begin_inset Quotes qld
38046 \begin_inset Flex Code
38049 \begin_layout Plain Layout
38052 \begin_inset Quotes qld
38056 \begin_inset Quotes qld
38065 \begin_inset Newline newline
38069 \begin_inset Flex Code
38072 \begin_layout Plain Layout
38076 \begin_inset Quotes qld
38080 \begin_inset Quotes qld
38091 \begin_layout Subsubsection
38097 \begin_layout Standard
38098 This makes as if the last check in never happened.
38099 No changes are made to the document loaded into \SpecialChar LyX
38101 but the last version is removed from the master RCS file.
38104 \begin_layout Itemize
38108 rcs -o<version> <file-name>
38111 \begin_layout Subsubsection
38117 \begin_layout Standard
38118 This shows the complete history of the RCS document.
38123 is shown in a browser.
38131 \begin_layout Subsubsection
38135 \begin_layout Standard
38137 supports RCS version number,
38139 date and time of last commit.
38140 All those are extracted from
38142 rlog -r <file-name>
38146 \begin_inset CommandInset ref
38148 reference "subsec:VCS-Revision-Information"
38156 \begin_layout Subsection
38157 CVS commands in \SpecialChar LyX
38161 \begin_layout Standard
38162 A subset of CVS operations is supported by \SpecialChar LyX
38164 You can find the commands in the
38166 File\SpecialChar menuseparator
38168 \begin_inset space ~
38174 The version control system SVN is more powerful,
38175 so please use it instead of CVS if possible.
38178 \begin_layout Subsubsection
38184 \begin_layout Standard
38185 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
38186 If you're using a client-server setup you may need to login before doing the first repository checkout.
38189 \begin_layout Standard
38190 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.
38191 Standard CVS repositories don't operate with a file locking mechanism.
38192 This may be surprising,
38193 but conflicts only occur if people disagree on the proper content of the same part of a document.
38195 if co-workers are used to communicate regularly,
38196 these conflicts occur rarely.
38197 If they don't communicate they have a fundamental problem anyway.
38198 Nevertheless some people like to work with so called
38199 \begin_inset Quotes eld
38203 \begin_inset Quotes erd
38207 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.
38208 When the changes are checked in the working copy returns to readonly state.
38209 With \SpecialChar LyX
38210 one has to edit the
38211 \begin_inset Flex Code
38214 \begin_layout Plain Layout
38220 file and add the line
38221 \begin_inset Flex Code
38224 \begin_layout Plain Layout
38230 to work with reserved checkouts.
38231 The benefit is the possibility to see who is using a writable copy of some document.
38232 It's not guaranteed only one user makes a copy writable.
38235 \begin_layout Standard
38237 tries to guess if you're using reserved or non-reserved checkouts.
38238 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.
38239 When a reserved checkout is detected you have to use
38240 \begin_inset Flex Noun
38243 \begin_layout Plain Layout
38249 to make your working copy writable if it's readonly.
38251 \begin_inset Flex Noun
38254 \begin_layout Plain Layout
38260 operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
38263 \begin_layout Standard
38264 More information about CVS can be found here
38265 \begin_inset Flex URL
38268 \begin_layout Plain Layout
38270 http://www.nongnu.org/cvs
38276 \begin_inset Flex URL
38279 \begin_layout Plain Layout
38281 http://ximbiot.com/cvs
38289 \begin_layout Standard
38294 to understand the sub-commands and the switches mentioned below.
38297 \begin_layout Subsubsection
38303 \begin_layout Standard
38304 If your document is not under revision control,
38305 this is the only item shown in the menu.
38306 And if it is under revision control,
38311 item is not visible.
38315 \begin_layout Standard
38316 This command registers in CVS your document
38317 \begin_inset Flex Strong
38320 \begin_layout Plain Layout
38328 in the case you have already the documents directory under CVS control (in particular
38333 This means you have to create or checkout the archive by yourself using external tools.
38334 (In case you forget that step \SpecialChar LyX
38335 registers the document with RCS.)
38338 \begin_layout Standard
38339 Then you are asked interactively to supply an initial description of the document.
38340 Don't forget that registered file is not yet checked in.
38343 \begin_layout Standard
38344 CVS command that is run:
38347 cvs -q add -m"<entered message>" "<file-name>"
38350 \begin_layout Standard
38355 above and for all other CVS commands is an abbreviation for
38356 \begin_inset Quotes eld
38359 change the current working directory to file location and use the file name without path component as argument
38360 \begin_inset Quotes erd
38366 \begin_layout Subsubsection
38372 \begin_layout Standard
38373 When you are finished editing a file,
38374 you commit your changes.
38375 When you do this and you had changed the document,
38376 you are asked for a description of the changes.
38377 After that changes are written to the repository.
38378 In case you didn't change the document and a reserved checkout is detected the reservation made on
38379 \begin_inset Flex Noun
38382 \begin_layout Plain Layout
38391 \begin_layout Labeling
38392 \labelwidthstring 00.00.0000
38394 \begin_inset space ~
38399 \begin_inset space ~
38403 \begin_inset Newline newline
38407 \begin_inset Flex Code
38410 \begin_layout Plain Layout
38413 -q commit -m"<description>" "<file-name>"
38419 \begin_inset Newline newline
38423 \begin_inset Flex Code
38426 \begin_layout Plain Layout
38437 \begin_layout Subsubsection
38443 \begin_layout Standard
38444 When you are sharing a repository with others,
38445 you may have to incorporate their changes into your working copy.
38448 \begin_layout Standard
38452 cvs -q update "<file-name>"
38455 \begin_layout Standard
38456 If a readonly checkout is detected the working copy is made writable and reserved.
38459 \begin_layout Standard
38463 cvs -q edit "<file-name>"
38466 \begin_layout Subsubsection
38469 Revert To Repository Version
38472 \begin_layout Standard
38473 This will discard all changes made to the document since the last check in.
38474 You get a warning before changes are discarded.
38475 Firstly the file is deleted,
38476 secondly CVS update command is run.
38479 \begin_layout Standard
38483 cvs -q update "<file-name>"
38486 \begin_layout Standard
38487 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
38490 \begin_layout Standard
38494 cvs -q unedit "<file-name>"
38497 \begin_layout Subsubsection
38503 \begin_layout Standard
38504 This will create a copy of the current document.
38505 Since CVS does not support copy operations natively,
38506 the version history is not preserved,
38507 and the copy is added as a new file.
38508 It requires a clean document without any changes since the last checkin.
38509 You are asked for a file name and a description of the copy operation.
38510 After that the copy is created,
38511 both locally and in the repository.
38512 If the parent directories of the copied and original document differ,
38513 all relative paths of included files of the copy are adjusted (like in
38515 File\SpecialChar menuseparator
38521 the copy is loaded instead of the original document.
38524 \begin_layout Labeling
38525 \labelwidthstring 00.00.0000
38527 \begin_inset space ~
38532 \begin_inset space ~
38536 \begin_inset Newline newline
38540 \begin_inset Flex Code
38543 \begin_layout Plain Layout
38550 \begin_inset Flex Code
38553 \begin_layout Plain Layout
38560 \begin_inset Newline newline
38564 \begin_inset Flex Code
38567 \begin_layout Plain Layout
38568 cvs -q add "<new-file-name>"
38576 \begin_layout Subsubsection
38582 \begin_layout Standard
38583 This will rename the current document.
38584 Since CVS does not support rename operations natively,
38585 the version history is not preserved,
38586 the renamed document is added as a new file,
38587 and the original document is deleted.
38588 It requires a clean document without any changes since the last checkin.
38589 You are asked for a file name and a description of the rename operation.
38590 After that the document is renamed,
38591 both locally and in the repository.
38592 If the parent directories of the new and old file names differ,
38593 all relative paths of included files are adjusted (like in
38595 File\SpecialChar menuseparator
38601 the document is reloaded using the new name.
38604 \begin_layout Labeling
38605 \labelwidthstring 00.00.0000
38607 \begin_inset space ~
38612 \begin_inset space ~
38616 \begin_inset Newline newline
38620 \begin_inset Flex Code
38623 \begin_layout Plain Layout
38630 \begin_inset Flex Code
38633 \begin_layout Plain Layout
38640 \begin_inset Newline newline
38644 \begin_inset Flex Code
38647 \begin_layout Plain Layout
38648 cvs -q add "<new-file-name>"
38654 \begin_inset Newline newline
38658 \begin_inset Flex Code
38661 \begin_layout Plain Layout
38662 cvs -q remove "<file-name>"
38670 \begin_layout Subsubsection
38671 Update of the local directory checkout from repository
38674 \begin_layout Standard
38675 Once your documents gets more complex,
38676 containing sub-documents and pictures,
38678 \begin_inset Flex Code
38681 \begin_layout Plain Layout
38687 files and so on using version control becomes more complicated.
38689 supports updating the whole tree in which resides the document.
38690 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.
38691 You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
38692 It's good practice anyway to store multipart documents in an extra directory.
38695 \begin_layout Standard
38697 \begin_inset Flex Code
38700 \begin_layout Plain Layout
38701 Update local directory from repository
38706 command updates the whole directory.
38707 If local changes are detected user is warned before update starts.
38708 In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
38709 You have to review and correct the result of the merge.
38710 You'll find the conflicts enclosed in pairs of
38711 \begin_inset Flex Code
38714 \begin_layout Plain Layout
38721 \begin_inset Flex Code
38724 \begin_layout Plain Layout
38731 \begin_inset Flex Code
38734 \begin_layout Plain Layout
38741 The first part is your version as before the update operation with the document name prepended.
38742 The second one is the repository version with the version number after the sequence of
38743 \begin_inset Flex Code
38746 \begin_layout Plain Layout
38755 \begin_layout Labeling
38756 \labelwidthstring 00.00.0000
38758 \begin_inset space ~
38763 \begin_inset space ~
38767 \begin_inset Newline newline
38771 \begin_inset Flex Code
38774 \begin_layout Plain Layout
38783 (Ask if changes are detected.)
38784 \begin_inset Newline newline
38788 \begin_inset Flex Code
38791 \begin_layout Plain Layout
38803 \begin_layout Standard
38805 \begin_inset Flex Code
38808 \begin_layout Plain Layout
38814 stands for the path to the document.
38817 \begin_layout Subsubsection
38823 \begin_layout Standard
38824 This shows the complete history of the CVS document.
38827 cvs log "<file-name>"
38829 is shown in a browser.
38832 \begin_layout Subsubsection
38836 \begin_layout Standard
38838 supports CVS version number,
38840 date and time of last commit.
38841 All those are extracted from
38843 cvs log -r <file-name>
38847 \begin_inset CommandInset ref
38849 reference "subsec:VCS-Revision-Information"
38857 \begin_layout Subsection
38858 SVN commands in \SpecialChar LyX
38862 \begin_layout Standard
38863 SVN is now partially supported by \SpecialChar LyX
38865 You can find the commands in the
38867 File\SpecialChar menuseparator
38869 \begin_inset space ~
38875 Please note that if you use password protected access to repository via ssh,
38876 you will be asked in terminal window.
38878 was tested against SVN 1.5,
38884 \begin_layout Plain Layout
38885 Most of the commands will work with 1.4 too,
38887 \begin_inset CommandInset ref
38889 reference "subsec:SVN-Repo-Update"
38895 There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
38903 \begin_layout Subsubsection
38909 \begin_layout Standard
38910 If your document is not under revision control,
38911 this is the only item shown in the menu.
38912 And if it is under revision control,
38917 item is not visible.
38920 \begin_layout Standard
38921 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
38926 This means you have to checkout the archive by yourself.
38929 \begin_layout Standard
38930 Then you are asked interactively to supply an initial description of the document.
38931 Don't forget that registered file is not yet commited.
38934 \begin_layout Standard
38935 SVN command that is run:
38939 \begin_inset Quotes qld
38943 \begin_inset Quotes qld
38949 \begin_layout Standard
38954 to understand the switches.
38957 \begin_layout Subsubsection
38963 \begin_layout Standard
38964 When you are finished editing a file,
38965 you commit your changes.
38967 you are asked for a description of the changes.
38968 After that changes are commited.
38971 \begin_layout Standard
38976 \begin_layout Plain Layout
38977 In case locking is not enabled.
38979 \begin_inset CommandInset ref
38981 reference "subsec:SVN-File-Locking"
38993 svn commit -q -m"<description>" <file-name>
38996 \begin_layout Subsubsection
39002 \begin_layout Standard
39003 Updates the changes of this file from the repository.
39004 Be sure you understand SVN merging and conflicts resolving before using this function,
39005 because all conflicts has to be resolved manually by you!
39008 \begin_layout Standard
39013 \begin_layout Plain Layout
39021 svn update --non-interactive
39022 \begin_inset Quotes qld
39026 \begin_inset Quotes qld
39032 \begin_layout Subsubsection
39035 Revert To Repository Version
39038 \begin_layout Standard
39039 This will discard all changes made to the document since the last check in.
39040 You get a warning before changes are discarded.
39043 \begin_layout Standard
39048 \begin_inset Quotes qld
39052 \begin_inset Quotes qld
39058 \begin_layout Subsubsection
39064 \begin_layout Standard
39065 This will create a copy of the current document including the version history.
39066 It requires a clean document without any changes since the last checkin.
39067 You are asked for a file name and a description of the copy operation.
39068 After that the copy is created,
39069 both locally and in the repository.
39070 If the parent directories of the copied and original document differ,
39071 all relative paths of included files of the copy are adjusted (like in
39073 File\SpecialChar menuseparator
39079 the copy is loaded instead of the original document.
39082 \begin_layout Labeling
39083 \labelwidthstring 00.00.0000
39085 \begin_inset space ~
39090 \begin_inset space ~
39094 \begin_inset Newline newline
39098 \begin_inset Flex Code
39101 \begin_layout Plain Layout
39105 \begin_inset Quotes qld
39109 \begin_inset Quotes qld
39113 \begin_inset Quotes qld
39117 \begin_inset Quotes qld
39126 \begin_inset Newline newline
39130 \begin_inset Flex Code
39133 \begin_layout Plain Layout
39142 \begin_layout Subsubsection
39148 \begin_layout Standard
39149 This will rename the current document including the version history.
39150 It requires a clean document without any changes since the last checkin.
39151 You are asked for a file name and a description of the rename operation.
39152 After that the document is renamed,
39153 both locally and in the repository.
39154 If the parent directories of the new and old file names differ,
39155 all relative paths of included files are adjusted (like in
39157 File\SpecialChar menuseparator
39163 the document is reloaded using the new name.
39166 \begin_layout Labeling
39167 \labelwidthstring 00.00.0000
39169 \begin_inset space ~
39174 \begin_inset space ~
39178 \begin_inset Newline newline
39182 \begin_inset Flex Code
39185 \begin_layout Plain Layout
39189 \begin_inset Quotes qld
39193 \begin_inset Quotes qld
39197 \begin_inset Quotes qld
39201 \begin_inset Quotes qld
39210 \begin_inset Newline newline
39214 \begin_inset Flex Code
39217 \begin_layout Plain Layout
39226 \begin_layout Subsubsection
39227 \begin_inset CommandInset label
39229 name "subsec:SVN-Repo-Update"
39233 Update of the local directory checkout from repository
39237 \begin_layout Plain Layout
39238 Note that this command will work only with subversion
39239 \begin_inset Formula $\geqq1.5$
39250 \begin_layout Standard
39251 All the commands above have one shortcoming – they deal with the current document only.
39252 Once your document contains pictures,
39254 \begin_inset Flex Code
39257 \begin_layout Plain Layout
39263 files and so on administration becomes more complicated.
39265 now supports updating the whole tree in which resides the document
39269 \begin_layout Plain Layout
39270 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
39277 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.
39281 \begin_layout Standard
39282 \begin_inset Flex Code
39285 \begin_layout Plain Layout
39286 Update local directory from repository
39291 command updates the whole directory and in case of merge conflicts local version of the files are left,
39292 so no unintended data loss occurs.
39293 If local changes are detected user is warned before update starts.
39296 \begin_layout Labeling
39297 \labelwidthstring 00.00.0000
39299 \begin_inset space ~
39304 \begin_inset space ~
39308 \begin_inset Newline newline
39312 \begin_inset Flex Code
39315 \begin_layout Plain Layout
39321 (Ask if changes are detected.)
39322 \begin_inset Newline newline
39326 \begin_inset Flex Code
39329 \begin_layout Plain Layout
39330 svn update --accept mine-full $path
39338 \begin_layout Standard
39340 \begin_inset Flex Code
39343 \begin_layout Plain Layout
39349 stands for the path to the document.
39352 \begin_layout Subsubsection
39358 \begin_layout Standard
39359 This shows the complete history of the SVN document.
39363 \begin_inset Quotes qld
39367 \begin_inset Quotes qld
39372 is shown in a browser.
39375 \begin_layout Subsubsection
39377 \begin_inset CommandInset label
39379 name "subsec:SVN-File-Locking"
39386 \begin_layout Standard
39387 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.
39388 When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
39389 which guarantees that only one user is allowed to edit file at the given time.
39392 \begin_layout Standard
39393 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
39395 \begin_inset CommandInset ref
39397 reference "subsec:Automatical-Locking-Property"
39403 \begin_inset Flex Code
39406 \begin_layout Plain Layout
39416 \begin_layout Plain Layout
39417 \begin_inset Flex URL
39420 \begin_layout Plain Layout
39422 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
39433 If this property is detected for a given document \SpecialChar LyX
39434 starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
39435 This in particular means there are two different modes of file use in \SpecialChar LyX
39439 \begin_layout Itemize
39441 The loaded file is in the read-only mode.
39442 For editing on needs to check-out.
39447 consists of updating from the repository and gaining write lock.
39448 If the lock is not possible to obtain,
39449 we remain in unlocked state.
39452 \begin_layout Itemize
39454 The loaded file is in the
39455 \begin_inset Quotes els
39459 \begin_inset Quotes ers
39463 No other user is allowed to edit the file.
39468 consists of commiting changes and releasing write-lock.
39469 If no changes have been made to the document,
39470 no commit will be produced
39474 \begin_layout Plain Layout
39475 Don't be puzzled by the fact that you will be asked for commit message anyway.
39480 and only the write-lock will be released.
39483 \begin_layout Standard
39487 \begin_layout Labeling
39488 \labelwidthstring 00.00.0000
39492 svn commit -q -m"<description>" "<file-name>"
39493 \begin_inset Newline newline
39496 svn unlock "<file-name>"
39499 \begin_layout Labeling
39500 \labelwidthstring 00.00.0000
39504 svn update "<file-name>"
39505 \begin_inset Newline newline
39508 svn lock "<file-name>"
39511 \begin_layout Subsubsection
39514 \begin_inset CommandInset label
39516 name "subsec:Automatical-Locking-Property"
39522 Automatic Locking Property
39525 \begin_layout Standard
39526 The above mentioned automatic setting of write permissions of the .lyx file can be set through
39528 File\SpecialChar menuseparator
39530 \begin_inset space ~
39533 Control\SpecialChar menuseparator
39534 Use Locking Property
39537 This command is active only when the file is not locked on the svn server (i.e.
39538 you need to check-out before proceeding).
39541 \begin_layout Labeling
39542 \labelwidthstring 00.00.0000
39544 \begin_inset space ~
39550 \begin_layout Labeling
39551 \labelwidthstring 00.00.0000
39555 svn propset svn:needs-lock ON "<file-name>"
39558 \begin_layout Labeling
39559 \labelwidthstring 00.00.0000
39563 svn propdel svn:needs-lock "<file-name>"
39566 \begin_layout Subsubsection
39567 \begin_inset CommandInset label
39569 name "subsec:VCS-Revision-Information"
39573 Revision Information in Documents
39576 \begin_layout Standard
39577 There are more possibilities how to activate revision information in our document.
39580 \begin_layout Itemize
39586 \begin_layout Itemize
39587 tree revision information (
39588 \begin_inset Flex Code
39591 \begin_layout Plain Layout
39598 The result is the output of the
39599 \begin_inset Flex Code
39602 \begin_layout Plain Layout
39609 the following table gives you an idea,
39610 how to read the results.
39613 \begin_layout Standard
39615 \begin_inset Tabular
39616 <lyxtabular version="3" rows="6" columns="2">
39617 <features tabularvalignment="middle">
39618 <column alignment="left" valignment="top">
39619 <column alignment="left" valignment="top">
39621 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
39624 \begin_layout Plain Layout
39632 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
39635 \begin_layout Plain Layout
39645 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39648 \begin_layout Plain Layout
39654 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39657 \begin_layout Plain Layout
39658 mixed revision working copy
39665 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39668 \begin_layout Plain Layout
39674 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39677 \begin_layout Plain Layout
39678 modified working copy
39685 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39688 \begin_layout Plain Layout
39694 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39697 \begin_layout Plain Layout
39698 switched working copy
39705 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39708 \begin_layout Plain Layout
39714 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39717 \begin_layout Plain Layout
39718 partial working copy,
39719 from a sparse checkout
39726 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
39729 \begin_layout Plain Layout
39735 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
39738 \begin_layout Plain Layout
39741 switched working copy
39754 \begin_layout Itemize
39755 file revision information.
39756 The result comes from parsing the output of
39757 \begin_inset Flex Code
39760 \begin_layout Plain Layout
39762 \begin_inset space ~
39766 \begin_inset space ~
39770 \begin_inset space ~
39779 Supported flags are:
39783 \begin_layout Itemize
39784 version number of the last commit (
39785 \begin_inset Flex Code
39788 \begin_layout Plain Layout
39797 \begin_layout Itemize
39798 author of the last commit (
39799 \begin_inset Flex Code
39802 \begin_layout Plain Layout
39811 \begin_layout Itemize
39812 date of the last commit (
39813 \begin_inset Flex Code
39816 \begin_layout Plain Layout
39825 \begin_layout Itemize
39826 time of the last commit (
39827 \begin_inset Flex Code
39830 \begin_layout Plain Layout
39840 \begin_layout Standard
39841 You can obtain this info via InsetInfo (
39842 \change_inserted 5863208 1564400022
39845 Insert\SpecialChar menuseparator
39846 Field\SpecialChar menuseparator
39847 Version Control Revision
39848 \change_deleted 5863208 1564399852
39853 \begin_inset Flex Code
39856 \begin_layout Plain Layout
39857 info-insert buffer vcs-date
39865 The information will be available only when you have the file stored under svn managment (i.e.
39867 \begin_inset Flex Code
39870 \begin_layout Plain Layout
39876 directory is available with your document).
39880 \begin_layout Itemize
39883 possibility is to use svn keywords
39887 \begin_layout Plain Layout
39888 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
39894 In short – you set file keywords property (e.g.
39897 svn propset svn:keywords 'Rev' file.lyx
39899 ) and then paste keyword \SpecialChar TeX
39904 \begin_layout Plain Layout
39905 This is an easy way how to ensure that \SpecialChar LyX
39906 won't break the line in the middle of keyword tag.
39911 tag in your document (e.g.
39913 \begin_inset Flex Code
39916 \begin_layout Plain Layout
39923 This way svn client will automatically substitute revision number (e.g.
39925 \begin_inset Flex Code
39928 \begin_layout Plain Layout
39935 ) after each update and commit.
39936 There are more problems with this approach.
39938 the '$' character is used in \SpecialChar TeX
39939 world for math equations,
39940 so any occurence of math formula
39941 \begin_inset Formula $Rev$
39945 \begin_inset Formula $Rev:59$
39948 in your \SpecialChar LyX
39950 Similarly for other keywords like Id,
39954 Secondly svn output is dependent on your locales,
39955 so its very easy that svn would produce some problematic strings once Date is used.
39956 Thirdly you get the whole 'Rev:
39957 59' string in your document instead of the plain number.
39958 Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
39959 to support it directly.
39962 \begin_layout Subsection
39963 SVN and Windows Environment
39966 \begin_layout Quote
39967 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
39968 they would be well advised to use TortoiseSVN.
39975 \begin_layout Subsubsection
39979 \begin_layout Standard
39980 In addition to installing \SpecialChar LyX
39982 and having access to a Subversion repository,
39983 the user will need to install the Subversion client program.
39984 A Windows installer for the client program is available from
39985 \begin_inset CommandInset href
39988 target "http://www.collab.net/nonav/downloads/subversion/"
39994 The user may also want to install
39995 \begin_inset CommandInset href
39998 target "http://tortoisesvn.tigris.org/"
40004 which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
40005 Operations done outside \SpecialChar LyX
40006 will typically be more convenient using the Explorer context menu.
40007 Note that TortoiseSVN is not a replacement for the client program,
40008 which is what \SpecialChar LyX
40012 \begin_layout Subsubsection
40013 Bringing a document under Subversion control
40016 \begin_layout Standard
40017 Before a \SpecialChar LyX
40018 document can be brought under version control in Subversion,
40019 its parent directory needs to be under version control.
40020 If the document is being added to a project already in the repository,
40021 this is accomplished by checking the project out to the directory where the new document will be placed.
40022 If the project itself is not yet under version control (for instance,
40023 if this document starts a new project),
40024 the directory must be imported into the repository.
40025 This is done outside \SpecialChar LyX
40027 Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
40028 or alternatively can be done using the command line client at a DOS prompt.
40029 The procedure for importing the project using TortoiseSVN is described below,
40030 assuming an existing repository and a new project being started in
40037 For information on using the Subversion client program,
40045 \begin_layout Enumerate
40052 in Windows Explorer,
40056 TortoiseSVN\SpecialChar menuseparator
40061 adjust the URL for the repository,
40065 \begin_layout Enumerate
40066 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
40070 Supply a name for the project folder and click OK.
40071 Add a message for the log file if desired,
40072 then click OK again.
40073 The new project folder should appear in the repository.
40075 click OK again to exit the repository browser.
40078 \begin_layout Enumerate
40079 Once again right click
40086 this time selecting SVN Checkout\SpecialChar ldots
40087 Select the URL of the project folder you just created in the repository,
40088 and set the checkout directory to
40096 You will be warned about a non-empty folder;
40097 click OK to proceed.
40098 You should now have a
40109 \begin_layout Enumerate
40110 Create or open your document in \SpecialChar LyX
40113 File\SpecialChar menuseparator
40115 \begin_inset space ~
40118 Control\SpecialChar menuseparator
40122 Add a log message and click OK to commit the document to version control.
40125 \begin_layout Standard
40126 From this point onward,
40127 you should have full functionality in the
40129 File\SpecialChar menuseparator
40131 \begin_inset space ~
40137 You also have the option of checking the document in and out,
40138 viewing its history,
40140 using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
40143 \begin_layout Subsubsection
40144 SSH tunnel used with SVN under Windows
40147 \begin_layout Standard
40148 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
40149 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,
40150 also be prepared for a great deal of frustration\SpecialChar ldots
40154 \begin_layout Enumerate
40155 Get an svn client for windows,
40156 as described in the previous sections.
40157 When it is a fresh install run some svn command (e.g.
40159 \begin_inset Flex Code
40162 \begin_layout Plain Layout
40168 ) to create config files,
40169 which you will need to change later on.
40172 \begin_layout Enumerate
40173 Choose an ssh client for Windows.
40174 There are several possibilities,
40175 we will use the one from Putty tools
40179 \begin_layout Plain Layout
40180 \begin_inset Flex URL
40183 \begin_layout Plain Layout
40185 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
40196 You will need to set the connection up so that the client doesn't ask for any password from you.
40197 To keep things easy we will use only keys without any additional password protection etc.
40201 \begin_layout Enumerate
40203 \begin_inset Flex Code
40206 \begin_layout Plain Layout
40213 Save your private .ppk key file and put the public one on the server side.
40214 If the SVN server runs on Linux,
40215 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
40216 \begin_inset Quotes eld
40221 Public key for pasting into OpenSSH authorized_keys file
40224 \begin_inset Quotes erd
40227 edit field into the server's
40228 \begin_inset Flex Code
40231 \begin_layout Plain Layout
40232 ~/.ssh/authorized_keys
40238 \begin_inset Flex Code
40241 \begin_layout Plain Layout
40250 \begin_layout Enumerate
40252 \begin_inset Flex Code
40255 \begin_layout Plain Layout
40262 In the SVN config file
40266 \begin_layout Plain Layout
40267 Exact path depends on Windows version,
40268 usually somewhere around
40269 \begin_inset Flex Code
40272 \begin_layout Plain Layout
40275 Documents and Settings
40289 \begin_inset Flex Code
40292 \begin_layout Plain Layout
40312 \begin_inset Flex Code
40315 \begin_layout Plain Layout
40316 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
40325 \begin_layout Plain Layout
40326 It will usually take a lot of time to get exact command right and it depends on many things.
40327 For example do not have some remote server saved as a default session in Putty etc.
40329 try to connect via plink without SVN first.
40338 \begin_layout Enumerate
40339 Checkout the SVN archive,
40341 \begin_inset space \thinspace{}
40345 \begin_inset Newline newline
40349 \begin_inset Flex Code
40352 \begin_layout Plain Layout
40353 svn co svn+ssh://user@server/repository_path
40361 \begin_layout Subsubsection
40362 End-of-Line Conversions
40365 \begin_layout Standard
40366 When the collaborators are mixing Linux and Windows environments,
40368 will use different line endings inside the .lyx files.
40369 This is not a problem as far as \SpecialChar LyX
40370 functionality is concerned,
40371 but the commit diffs will be huge and merge-conflicts prone.
40372 Fortunately SVN itself knows
40376 \begin_layout Plain Layout
40377 \begin_inset Flex URL
40380 \begin_layout Plain Layout
40382 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
40392 how to deal with CR/LF problems when switching .lyx files to the
40393 \begin_inset Flex Code
40396 \begin_layout Plain Layout
40406 \begin_layout Plain Layout
40409 \begin_inset Flex Code
40412 \begin_layout Plain Layout
40413 svn propset svn:eol-style native FILE_NAME
40426 \begin_layout Subsection
40427 GIT commands in \SpecialChar LyX
40431 \begin_layout Standard
40432 A minimal subset of GIT commands is now supported by \SpecialChar LyX
40434 You can find the commands in the
40436 File\SpecialChar menuseparator
40438 \begin_inset space ~
40444 Please note that if you use password protected access to repository via ssh,
40445 you will be asked in terminal window.
40447 was tested against GIT 1.7
40448 \change_inserted 5863208 1685694088
40455 \begin_layout Plain Layout
40456 Windows users please note that you need to ensure that git is on the path.
40457 This can be set from within \SpecialChar LyX
40460 Tools\SpecialChar menuseparator
40461 Preferences\SpecialChar menuseparator
40462 Paths\SpecialChar menuseparator
40473 \begin_layout Standard
40474 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
40475 With traditional version control systems there is one central server which hosts the repository.
40476 Users commit their changes to the server,
40477 and get updates made by other users from it.
40479 users commit to a local repository.
40480 The local repository can be synchronized with one or more remote repositories using the
40481 \begin_inset Flex Code
40484 \begin_layout Plain Layout
40491 \begin_inset Flex Code
40494 \begin_layout Plain Layout
40502 does not interact in any way with remote GIT repositories.
40503 It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
40504 If you use remote GIT repositories you need to do the
40505 \begin_inset Flex Code
40508 \begin_layout Plain Layout
40515 \begin_inset Flex Code
40518 \begin_layout Plain Layout
40524 operations with your favourite GIT client.
40527 \begin_layout Subsubsection
40533 \begin_layout Standard
40534 If your document is not under revision control,
40535 this is the only item shown in the menu.
40536 And if it is under revision control,
40541 item is not visible.
40544 \begin_layout Standard
40545 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
40550 \change_inserted 5863208 1685693727
40555 \begin_layout Plain Layout
40557 \change_inserted 5863208 1685693727
40562 *and* initial repository commit (or at least
40566 ) needs to be manually done.
40576 This means you have to checkout the archive by yourself.
40579 \begin_layout Standard
40580 Then you are asked interactively to supply an initial description of the document.
40581 Don't forget that registered file is not yet committed.
40584 \begin_layout Standard
40585 GIT command that is run:
40589 \begin_inset Quotes qld
40593 \begin_inset Quotes qld
40599 \begin_layout Standard
40604 to understand the switches.
40607 \begin_layout Subsubsection
40613 \begin_layout Standard
40614 When you are finished editing a file,
40615 you commit your changes.
40617 you are asked for a description of the changes.
40618 After that changes are committed.
40621 \begin_layout Standard
40625 git commit -q -m"<description>" <file-name>
40628 \begin_layout Subsubsection
40631 Revert To Repository Version
40634 \begin_layout Standard
40635 This will discard all changes made to the document since the last check in.
40636 You get a warning before changes are discarded.
40639 \begin_layout Standard
40644 \begin_inset Quotes qld
40648 \begin_inset Quotes qld
40654 \begin_layout Subsubsection
40660 \begin_layout Standard
40661 This will rename the current document including the version history.
40662 It requires a clean document without any changes since the last checkin.
40663 You are asked for a file name and a description of the rename operation.
40664 After that the document is renamed,
40665 both locally and in the repository.
40666 If the parent directories of the new and old file names differ,
40667 all relative paths of included files are adjusted (like in
40669 File\SpecialChar menuseparator
40675 the document is reloaded using the new name.
40678 \begin_layout Labeling
40679 \labelwidthstring 00.00.0000
40681 \begin_inset space ~
40686 \begin_inset space ~
40690 \begin_inset Newline newline
40694 \begin_inset Flex Code
40697 \begin_layout Plain Layout
40701 \begin_inset Quotes qld
40705 \begin_inset Quotes qld
40709 \begin_inset Quotes qld
40713 \begin_inset Quotes qld
40722 \begin_inset Newline newline
40726 \begin_inset Flex Code
40729 \begin_layout Plain Layout
40738 \begin_layout Subsubsection
40744 \begin_layout Standard
40745 This shows the complete history of the GIT document.
40749 \begin_inset Quotes qld
40753 \begin_inset Quotes qld
40758 is shown in a browser.
40761 \begin_layout Subsubsection
40765 \begin_layout Standard
40767 supports GIT hash number of the last commit to the file,
40769 \change_inserted 1119979965 1564297456
40770 its abbreviated form,
40774 date and time of last commit.
40775 All those are extracted from
40777 git log -n 1 --pretty=format:%H%n
40778 \change_inserted 1119979965 1564297427
40784 Tree version information is obtained via
40786 git describe --abbrev --dirty --long
40790 \begin_inset CommandInset ref
40792 reference "subsec:VCS-Revision-Information"
40800 \begin_layout Subsection
40804 \begin_layout Standard
40805 With the recent addition of the
40806 \begin_inset Flex Code
40809 \begin_layout Plain Layout
40815 function \SpecialChar LyX
40816 power users are allowed to create their own commands for revision control.
40819 \begin_layout Standard
40820 As an example you can see how two TortoiseSVN commands could be integrated directly:
40823 \begin_layout Description
40826 \begin_inset Flex Code
40829 \begin_layout Plain Layout
40830 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
40838 \begin_layout Description
40841 \begin_inset Flex Code
40844 \begin_layout Plain Layout
40845 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
40853 \begin_layout Subsection
40854 Version control and Document comparison
40857 \begin_layout Standard
40858 One of the typical uses of version control is to inspect the changes between revisions,
40859 usually by creating
40860 \begin_inset Flex Code
40863 \begin_layout Plain Layout
40870 While this is useful for plain text files,
40871 it is much less useful in the case of \SpecialChar LyX
40873 which have more a complicated structure.
40874 Hence we provide binding to the Document comparison feature.
40875 There are two ways of calling this feature – either by direct call of
40876 \begin_inset Flex Code
40879 \begin_layout Plain Layout
40886 function (for details see \SpecialChar LyX
40887 functions manual) or by the toolbar icon
40901 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 '
40902 \begin_inset Flex Noun
40905 \begin_layout Plain Layout
40911 ' revisions back means comparison of the edited file with last commited revision).
40915 \begin_layout Standard
40916 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,
40917 numbers always point to the last number in RCS revision number,
40920 We don't currently support GIT addressing of revisions,
40921 one can just compare edited document with its revision X steps backs,
40922 where X is addressed as
40923 \begin_inset Flex Code
40926 \begin_layout Plain Layout
40935 \begin_layout Section
40937 \change_inserted 564990737 1672161575
40938 \begin_inset CommandInset label
40940 name "sec:Literate-Programming"
40946 Literate Programming
40949 \begin_layout Standard
40954 (kayvan@sylvan.com)
40959 original documentation written by
40961 Edmar Wienskoski Jr.
40964 (edmar-w-jr@technologist.com)
40967 \begin_layout Subsection
40971 \begin_layout Standard
40972 The main purpose of this documentation is to show you how to use \SpecialChar LyX
40973 for literate programming,
40974 where it is assumed that you are familiar with this programming technique,
40976 \begin_inset Quotes eld
40980 \begin_inset Quotes erd
40984 \begin_inset Quotes eld
40988 \begin_inset Quotes erd
40992 If that is not the case,
40993 please follow the web links provided in the following sections.
40994 There is a lot of good documentation out there covering old development history to the latest tools tips.
40997 \begin_layout Standard
40998 It is also assumed that you are familiar with \SpecialChar LyX
40999 itself to a point that you are comfortable changing your \SpecialChar LyX
41001 and X resources file.
41002 If that is not the case please refer to other \SpecialChar LyX
41003 documentation to cover your specific needs.
41006 \begin_layout Subsection
41007 Literate Programming
41010 \begin_layout Standard
41011 From the Literate Programming FAQ:
41015 \begin_layout Quotation
41016 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
41018 literate programs should be enjoyable reading,
41021 I couldn't resist!) In general,
41022 literate programs combine source and documentation in a single file.
41023 Literate programming tools then parse the file to produce either readable documentation or compilable source.
41024 The WEB style of literate programming was created by D.
41025 \begin_inset space \thinspace{}
41029 Knuth during the development of his \SpecialChar TeX
41030 typesetting software.
41034 \begin_layout Standard
41035 Another excerpt says:
41038 \begin_layout Quotation
41041 How is literate programming different from verbose commenting?
41044 \begin_layout Quotation
41045 There are three distinguishing characteristics.
41046 In order of importance,
41052 \begin_layout Itemize
41053 flexible order of elaboration
41056 \begin_layout Itemize
41057 automatic support for browsing
41060 \begin_layout Itemize
41061 typeset documentation,
41062 especially diagrams and mathematics
41066 \begin_layout Standard
41067 Now that I sparked your curiosity,
41068 take a look in the references.
41071 \begin_layout Subsubsection
41075 \begin_layout Standard
41076 The complete Literate Programming FAQ can be found at:
41079 \begin_layout Quote
41080 Literate Programming FAQ
41081 \begin_inset Flex URL
41084 \begin_layout Plain Layout
41086 http://www.literateprogramming.com/lpfaq.pdf
41094 \begin_layout Standard
41095 The FAQ lists 23 (twenty three!) different literate programming tools.
41096 Where some are specialized or
41097 \begin_inset Quotes eld
41101 \begin_inset Quotes erd
41104 for particular programming languages,
41105 while other have general scope.
41110 for my own use for several reasons:
41113 \begin_layout Itemize
41114 It can generate the documentation either in \SpecialChar LaTeX
41118 \begin_layout Itemize
41119 It has a open architecture,
41121 \begin_inset space \thinspace{}
41125 \begin_inset space \space{}
41128 it is easy to plug in new filters
41132 \begin_layout Plain Layout
41137 are programs that read a given data stream and output a manipulated data stream.
41139 a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
41145 and to perform special processing that you may need.
41149 \begin_layout Itemize
41150 There is a good selection of filters available already (the HTML is one of them).
41153 \begin_layout Itemize
41157 \begin_layout Standard
41158 The Noweb web page can be found at:
41162 \begin_layout Quote
41164 \begin_inset Flex URL
41167 \begin_layout Plain Layout
41169 https://www.cs.tufts.edu/~nr/noweb/
41177 \begin_layout Standard
41178 Starting from there you can reach many other interesting links and even some literate program examples.
41181 \begin_layout Subsection
41183 and Literate Programming with Noweb
41186 \begin_layout Standard
41187 The \SpecialChar LyX
41188 support for Literate Programming is provided by using the generic \SpecialChar LyX
41189 converters mechanism.
41190 This support is provided in a
41191 \begin_inset Quotes eld
41195 \begin_inset Quotes erd
41200 \begin_inset space \thinspace{}
41204 \begin_inset space \space{}
41207 you will be able to use this new \SpecialChar LyX
41208 feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
41212 \begin_layout Subsubsection
41213 Generating documents and code (weaving and tangling)
41216 \begin_layout Paragraph
41217 Using the noweb module
41220 \begin_layout Standard
41221 If you have installed Noweb and \SpecialChar LyX
41223 whenever you open a new document,
41224 after you have chosen its document class,
41227 Document\SpecialChar menuseparator
41231 \begin_inset Quotes eld
41235 \begin_inset Quotes erd
41239 If Noweb is correctly installed,
41240 when you click on the
41241 \begin_inset Quotes eld
41245 \begin_inset Quotes erd
41250 \begin_inset Quotes eld
41254 \begin_inset Quotes erd
41257 module in the available list and you can add it to your document.
41260 \begin_layout Paragraph
41264 \begin_layout Standard
41266 enables you to write code with a custom inset named
41267 \begin_inset Flex Noun
41270 \begin_layout Plain Layout
41277 Noweb delimits chunks like this:
41280 \begin_layout LyX-Code
41284 \begin_layout LyX-Code
41288 \begin_layout LyX-Code
41292 \begin_layout LyX-Code
41296 \begin_layout LyX-Code
41300 \begin_layout Standard
41301 The problem is that whatever is written in between the << and the
41305 must be taken literally,
41307 \begin_inset space \thinspace{}
41311 \begin_inset space \space{}
41315 should be prevented from making any special interpretation of what has been written.
41316 This is also handled by
41317 \begin_inset Flex Noun
41320 \begin_layout Plain Layout
41327 that works like a normal text inset but has a free spacing capability.
41330 \begin_layout Standard
41332 you can also use the
41333 \begin_inset Quotes eld
41337 \begin_inset Quotes erd
41340 construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
41343 \begin_layout LyX-Code
41347 \begin_layout LyX-Code
41348 def some_function(args):
41351 \begin_layout LyX-Code
41352 "This is the doc string for this function."
41355 \begin_layout LyX-Code
41361 \begin_layout LyX-Code
41362 @ %def some_function
41365 \begin_layout Standard
41366 For an example of this usage and the resulting cross-reference output,
41367 look at the Literate python program in
41369 LIBDIR/examples/listerrors.lyx
41371 which should make this all clear.
41374 \begin_layout Paragraph
41375 Generating the documentation
41378 \begin_layout Standard
41379 At this point you already have a new document file with a proper document class,
41380 and with some code and text on it.
41382 The answer is simple,
41385 View\SpecialChar menuseparator
41390 Just like you would do for a plain document.
41391 No special procedure is required.
41394 \begin_layout Standard
41395 To help orientate you,
41396 I will now explain what happens inside \SpecialChar LyX
41400 \begin_layout Enumerate
41403 Update\SpecialChar menuseparator
41406 menu option is chosen,
41407 a \SpecialChar LaTeX
41413 \begin_layout Standard
41414 If the document is of any literate class the generated file will be named with an extension name defined by the
41415 \begin_inset Quotes eld
41419 \begin_inset Quotes erd
41422 format (defined in the Preferences panel),
41423 otherwise the file will have the usual
41431 \begin_layout Enumerate
41432 Note that the only difference so far is in the name of the file,
41433 no special processing is required by \SpecialChar LyX
41435 Given that you formatted the code using the
41436 \begin_inset Flex Noun
41439 \begin_layout Plain Layout
41447 takes care of the business.
41450 \begin_layout Enumerate
41451 If the document is of any literate class \SpecialChar LyX
41452 will then use the internal \SpecialChar LyX
41453 to Noweb converter,
41454 followed by the Noweb to \SpecialChar LaTeX
41459 \begin_layout Plain Layout
41460 The converters are defined in the
41462 Tools\SpecialChar menuseparator
41467 \begin_inset Quotes eld
41471 \begin_inset Quotes erd
41483 manual for general information about converters.
41488 to generate the \SpecialChar LaTeX
41493 \begin_layout Standard
41494 Otherwise it will just skip this step.
41498 \begin_layout Enumerate
41501 is invoked and the regular post processing continues as in a plain document.
41504 \begin_layout Standard
41505 Independence from a particular
41506 \begin_inset Quotes eld
41510 \begin_inset Quotes erd
41513 is easily achieved by changing the commands that are run by the various converters.
41516 \begin_layout Paragraph
41517 Generating the code
41520 \begin_layout Standard
41521 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
41522 a \SpecialChar LaTeX
41523 file is generated just like step 1 above.
41531 This converter needs to be defined by the user and is not installed by default,
41532 though the Program format is.
41533 This converter (like any other converter) will have two parts:
41536 \begin_layout Enumerate
41537 The converter program itself.
41538 This program performs the conversion from the one format to the other (in this case,
41539 from the Noweb format to the Program pseudo-format).
41542 \begin_layout Enumerate
41543 The error log parser.
41544 This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
41546 This makes it possible for \SpecialChar LyX
41547 to place error boxes in the right places in the file buffer.
41550 \begin_layout Standard
41553 \begin_inset Quotes eld
41557 \begin_inset Quotes erd
41564 \begin_layout LyX-Code
41572 \begin_layout Standard
41573 This basically means that \SpecialChar LyX
41575 \begin_inset Quotes eld
41579 \begin_inset Quotes erd
41582 (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
41583 temp directory) and the directory path of the original \SpecialChar LyX
41588 \begin_layout Standard
41589 This is an implementation of
41590 \begin_inset Quotes eld
41594 \begin_inset Quotes erd
41597 that you can place in a directory on your path:
41600 \begin_layout LyX-Code
41606 \begin_layout LyX-Code
41612 \begin_layout LyX-Code
41615 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
41618 \begin_layout Standard
41619 The next part of the converter setting is the
41620 \begin_inset Quotes eld
41624 \begin_inset Quotes erd
41627 which is to be set to
41630 \begin_layout LyX-Code
41633 parselog=$$s/scripts/listerrors
41636 \begin_layout Standard
41637 This will run any errors that are generated by the
41638 \begin_inset Quotes eld
41642 \begin_inset Quotes erd
41645 process through the
41646 \begin_inset Quotes eld
41650 \begin_inset Quotes erd
41656 \begin_layout Standard
41657 The build will normally take place in \SpecialChar LyX
41658 's temporary directory,
41659 so the files produced by the conversion will be in that directory.
41661 will copy out what it regards as the `main' file,
41666 conversion may produce several files,
41667 and so most of these would then be deleted when \SpecialChar LyX
41669 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.
41672 \begin_layout Paragraph
41673 Build instructions in the document
41676 \begin_layout Standard
41677 The last piece of the integration between \SpecialChar LyX
41679 \begin_inset Quotes eld
41683 \begin_inset Quotes erd
41688 the instructions for building your program should be embedded in a chunk of its own.
41690 \begin_inset Quotes eld
41694 \begin_inset Quotes erd
41697 above uses the notangle command to look for this chunk (called
41698 \begin_inset Quotes eld
41702 \begin_inset Quotes erd
41705 ) and runs its contents through
41706 \begin_inset Quotes eld
41710 \begin_inset Quotes erd
41716 \begin_layout Standard
41718 such a chunk would look something like this:
41721 \begin_layout LyX-Code
41725 \begin_layout LyX-Code
41727 \begin_inset Newline newline
41730 if [ -z "${NOWEB_SOURCE}" ]
41731 \begin_inset Newline newline
41737 \begin_layout LyX-Code
41738 NOWEB_SOURCE=myfile.nw
41739 \begin_inset Newline newline
41743 \begin_inset Newline newline
41747 code to extract files ...
41748 use NOWEB_OUTPUT_DIR here ...]
41749 \begin_inset Newline newline
41753 code to compile files ...]
41754 \begin_inset Newline newline
41760 \begin_layout Standard
41762 \change_deleted 564990737 1672161716
41765 LIBDIR/examples/listerrors.lyx
41769 LIBDIR/examples/Literate.lyx
41770 \change_inserted 564990737 1672161716
41774 File\SpecialChar menuseparator
41775 Open Example\SpecialChar menuseparator
41776 Modules\SpecialChar menuseparator
41782 \change_inserted -712698321 1674917096
41785 File\SpecialChar menuseparator
41786 Open Example\SpecialChar menuseparator
41787 Modules\SpecialChar menuseparator
41793 \change_deleted 564990737 1672161729
41797 \begin_inset Quotes eld
41801 \begin_inset Quotes erd
41804 program for some illustrations of how all of these pieces go together
41805 \change_deleted -712698321 1674917093
41807 \change_deleted 564990737 1672161756
41810 LIBDIR/examples/noweb2lyx.lyx
41811 \change_deleted -712698321 1674917093
41815 File\SpecialChar menuseparator
41816 Open Example\SpecialChar menuseparator
41817 Modules\SpecialChar menuseparator
41818 Noweb2\SpecialChar LyX
41829 \change_deleted 564990737 1672161767
41832 files show off the language-indepence of the \SpecialChar LyX
41833 literate programming support since they are written in Python
41834 \change_deleted 564990737 1672161782
41838 and Perl respectively.
41841 \begin_layout Subsubsection
41842 Configuring \SpecialChar LyX
41846 \begin_layout Standard
41847 All the Literate Programming support is configured by the
41849 Tools\SpecialChar menuseparator
41853 \begin_inset Quotes eld
41857 \begin_inset Quotes erd
41861 The important parts are:
41864 \begin_layout Description
41866 \begin_inset space ~
41870 \begin_inset Quotes eld
41874 \begin_inset Quotes erd
41878 \begin_inset space ~
41881 format Set up via the File Formats tab,
41882 this is where the Noweb-specific pieces are set up.
41892 the file extension is set to
41897 This tells \SpecialChar LyX
41898 to create a file with a
41902 extension in the first step of the conversion process.
41905 \begin_layout Description
41907 \begin_inset space ~
41915 \begin_inset space ~
41918 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).
41921 \begin_layout Description
41931 This converter performs the
41932 \begin_inset Quotes eld
41936 \begin_inset Quotes erd
41939 of the literate document.
41942 \begin_inset Quotes eld
41947 noweave -delay -index $$i > $$o
41950 \begin_inset Quotes erd
41956 \begin_layout Description
41966 \begin_inset Quotes eld
41970 \begin_inset Quotes erd
41975 the Converter is set to
41976 \begin_inset Quotes eld
41984 \begin_inset Quotes erd
41989 \begin_inset Newline newline
41993 \begin_inset Quotes eld
41998 parselog=$$s/scripts/listerrors
42001 \begin_inset Quotes erd
42007 \begin_layout Subsubsection
42011 \begin_layout Standard
42012 There is also a new function implemented in the \SpecialChar LyX
42015 \begin_inset Quotes eld
42018 server-goto-file-row" function,
42019 to be used with ddd/gdb or other debugger.
42023 \begin_layout Standard
42024 When debugging code with ddd/gdb,
42025 it is possible to invoke a text editor at the current execution position with a single key stroke.
42026 The default ddd configuration for that is shift-ctrl-V.
42027 It happens that you can define the editor command line invocation in ddd by accessing the
42029 Edit\SpecialChar menuseparator
42030 Preferences\SpecialChar menuseparator
42033 dialog and changing the "Edit Sources" entry.
42036 \begin_layout Standard
42037 I take advantage of the newly created \SpecialChar LyX
42038 server function and this ddd feature,
42040 \begin_inset Quotes eld
42044 \begin_inset Quotes erd
42050 \begin_layout LyX-Code
42051 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
42054 \begin_layout Standard
42056 whenever you are using ddd and find a point in the program that you want to edit,
42057 you just press shift-ctrl-V (in the ddd window),
42058 and ddd will forward this information to \SpecialChar LyX
42059 through the \SpecialChar LyX
42060 server and then the \SpecialChar LyX
42061 window will show the same file with the cursor at the same position ddd was pointing to.
42062 No more guessing or long scrolling to locate a point in the program back from debugging !
42065 \begin_layout Standard
42066 Note however that you must enable the \SpecialChar LyX
42067 server to get this feature working (it is disabled by default).
42069 \begin_inset space ~
42073 \begin_inset CommandInset ref
42075 reference "sec:Starting-the-Server"
42080 explains how to do that.
42083 \begin_layout Subsubsection
42087 \begin_layout Standard
42088 There are six new buttons that can be added to your \SpecialChar LyX
42090 Four of these buttons are short cuts to layout styles:
42113 one for the custom inset
42118 The last one is a short cut to the
42119 \begin_inset Quotes eld
42123 \begin_inset Quotes erd
42130 \begin_layout Standard
42132 has a range of buttons that are available for tool bar customization.
42133 In my toolbar I like to combine the six short cuts above with two more:
42138 \SpecialChar menuseparator
42143 \SpecialChar menuseparator
42150 Document\SpecialChar menuseparator
42151 View\SpecialChar menuseparator
42155 Here is how it looks like:
42158 \begin_layout LyX-Code
42162 \begin_layout LyX-Code
42166 \begin_layout LyX-Code
42167 Icon "layout Standard"
42170 \begin_layout LyX-Code
42171 Icon "layout Section"
42174 \begin_layout LyX-Code
42175 Icon "layout \SpecialChar LaTeX
42179 \begin_layout LyX-Code
42180 Icon "layout \SpecialChar LyX
42184 \begin_layout LyX-Code
42185 Icon "flex.insert Chunk"
42188 \begin_layout LyX-Code
42192 \begin_layout LyX-Code
42196 \begin_layout LyX-Code
42197 Icon "buffer-typeset"
42200 \begin_layout LyX-Code
42201 Icon "build-program"
42204 \begin_layout LyX-Code
42208 \begin_layout LyX-Code
42212 \begin_layout LyX-Code
42216 \begin_layout LyX-Code
42220 \begin_layout LyX-Code
42224 \begin_layout Subsubsection
42225 Colors customization
42228 \begin_layout Standard
42229 There are a number of colors in \SpecialChar LyX
42230 that can be customized in
42235 One of the things that bothers people is the \SpecialChar LaTeX
42237 The default color is red,
42238 since the chunks uses \SpecialChar LaTeX
42240 and there is a lot of chunks in literate documents,
42241 you may get tired of seeing everything in red.
42242 You can change it by going to the tabs
42252 \begin_layout Standard
42253 The next thing is the visible presence of the newline character in the screen.
42254 You can choose the color of this particular character and make it blend in the background.
42255 I recommend you choosing a color that is close to the background but not equal,
42256 that way you still can see it is there,
42257 but it is not bothering you anymore.
42260 \begin_layout Subsection
42265 \begin_layout Standard
42275 \change_inserted 564990737 1672161863
42278 Help\SpecialChar menuseparator
42279 Specific Manuals\SpecialChar menuseparator
42285 \change_deleted 564990737 1671643409
42291 \change_inserted 564990737 1672161856
42294 File\SpecialChar menuseparator
42295 Open Example\SpecialChar menuseparator
42296 Modules\SpecialChar menuseparator
42302 \change_deleted 564990737 1671643461
42303 the Sweave manual (menu
42305 Help\SpecialChar menuseparator
42309 \change_inserted 564990737 1672161856
42312 Help\SpecialChar menuseparator
42313 Specific Manuals\SpecialChar menuseparator
42315 \change_deleted 564990737 1672161921
42320 \change_inserted 564990737 1672161917
42323 File\SpecialChar menuseparator
42324 Open Example\SpecialChar menuseparator
42325 Modules\SpecialChar menuseparator
42329 \change_deleted 564990737 1672742969
42333 \begin_layout Standard
42335 \change_deleted 564990737 1671355343
42339 \begin_layout Standard
42341 \change_deleted 564990737 1671355343
42342 You can do everything with \SpecialChar LyX
42343 that you can do with \SpecialChar LaTeX
42347 cannot support every \SpecialChar LaTeX
42349 But you can always use \SpecialChar TeX
42351 This chapter shows you some more special things you might want to use.
42352 For other special things you can do with figures,
42359 \begin_inset space ~
42365 \change_inserted -712698321 1674917293
42369 \begin_layout Standard
42371 \change_inserted -712698321 1674917303
42372 \begin_inset CommandInset index_print
42373 LatexCommand printindex