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
110 \notefontcolor #0000ff
117 \paragraph_separation indent
118 \paragraph_indentation default
120 \math_indentation default
121 \math_numbering_side default
122 \quotes_style english
126 \paperpagestyle headings
128 \tracking_changes true
129 \output_changes false
131 \postpone_fragile_content false
135 \docbook_table_output 0
136 \docbook_mathml_prefix 1
137 \author -712698321 "Jürgen Spitzmüller"
140 \author 244031559 "Yuriy"
141 \author 274215730 "scott"
142 \author 545138413 "Koji Yokota" yokota6@gmail.com
143 \author 564990737 "John Lyx"
144 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
145 \author 1075283030 "Thibaut"
146 \author 1119979965 "Joel A. Kulesza"
152 Additional \SpecialChar LyX
156 \begin_layout Subtitle
158 \change_deleted 630872221 1622909155
160 \change_inserted 630872221 1622909155
167 by the \SpecialChar LyX
172 \begin_layout Plain Layout
174 Principal maintainer of this file is
176 Richard Kimberly Heck
179 If you have comments or error corrections,
180 please send them to the \SpecialChar LyX
181 Documentation mailing list,
183 \begin_inset Flex Code
186 \begin_layout Plain Layout
187 <lyx-docs@lists.lyx.org>
200 \begin_layout Standard
201 \begin_inset CommandInset toc
202 LatexCommand tableofcontents
209 \begin_layout Standard
211 \change_inserted 5863208 1672865652
212 \begin_inset Note Note
215 \begin_layout Plain Layout
217 \change_inserted 5863208 1672865674
218 Note to all translators:
221 \begin_layout Plain Layout
223 \change_inserted 5863208 1672865817
224 This manual was restructured for LyX 2.4.
225 Attached are notes for translators to help them to find their way round the new structure of Additional.lyx.
226 This note itself will be deleted in the final 2.4 release.
227 \begin_inset Newline newline
233 \begin_layout Plain Layout
235 \change_inserted 5863208 1672865801
238 Additional.lyx 2.4 Changes
241 \begin_layout Itemize
243 \change_inserted 5863208 1672865801
248 \begin_layout Itemize
250 \change_inserted 5863208 1672865801
255 \begin_layout Itemize
257 \change_inserted 5863208 1672865801
264 \begin_layout Itemize
266 \change_inserted 5863208 1672865801
268 moved and minor edits
271 \begin_layout Itemize
273 \change_inserted 5863208 1672865801
278 \begin_layout Itemize
280 \change_inserted 5863208 1672865801
285 \begin_layout Itemize
287 \change_inserted 5863208 1672865801
292 \begin_layout Itemize
294 \change_inserted 5863208 1672865801
296 moved and significant edits
299 \begin_layout Itemize
301 \change_inserted 5863208 1672865801
306 \begin_layout Itemize
308 \change_inserted 5863208 1672865801
313 \begin_layout Itemize
315 \change_inserted 5863208 1672865801
317 moved and minor edits
320 \begin_layout Itemize
322 \change_inserted 5863208 1672865801
327 \begin_layout Itemize
329 \change_inserted 5863208 1672865801
334 \begin_layout Itemize
336 \change_inserted 5863208 1672865801
341 \begin_layout Itemize
343 \change_inserted 5863208 1672865801
348 \begin_layout Itemize
350 \change_inserted 5863208 1672865824
355 \begin_layout Itemize
357 \change_inserted 5863208 1672865831
362 \begin_layout Itemize
364 \change_inserted 5863208 1672865831
369 \begin_layout Itemize
371 \change_inserted 5863208 1672865831
376 \begin_layout Itemize
378 \change_inserted 5863208 1672865831
383 \begin_layout Itemize
385 \change_inserted 5863208 1672865831
390 \begin_layout Itemize
392 \change_inserted 5863208 1672865831
397 \begin_layout Itemize
399 \change_inserted 5863208 1672865831
401 moved with minor edits
404 \begin_layout Itemize
406 \change_inserted 5863208 1672865831
411 \begin_layout Itemize
413 \change_inserted 5863208 1672865831
418 \begin_layout Itemize
420 \change_inserted 5863208 1672865831
422 moved with minor edits
425 \begin_layout Itemize
427 \change_inserted 5863208 1672865831
432 \begin_layout Itemize
434 \change_inserted 5863208 1672865831
439 \begin_layout Itemize
441 \change_inserted 5863208 1672865831
446 \begin_layout Itemize
448 \change_inserted 5863208 1672865831
449 (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.)
453 \begin_layout Itemize
455 \change_inserted 5863208 1672865831
462 \begin_layout Itemize
464 \change_inserted 5863208 1672865831
465 All module descriptions new except:
468 \begin_layout Itemize
470 \change_inserted 5863208 1672865831
472 moved with minor edits
475 \begin_layout Itemize
477 \change_inserted 5863208 1672865831
478 Custom header/footer text:
479 moved with minor edits
482 \begin_layout Itemize
484 \change_inserted 5863208 1672865831
486 moved with minor edits
489 \begin_layout Itemize
491 \change_inserted 5863208 1672865831
492 Custom paragraph shapes:
493 moved with minor edits
496 \begin_layout Itemize
498 \change_inserted 5863208 1672865831
500 moved with minor edits
504 \begin_layout Itemize
506 \change_inserted 5863208 1672865831
513 \begin_layout Itemize
515 \change_inserted 5863208 1672865831
516 Content moved but unchanged
520 \begin_layout Itemize
522 \change_inserted 5863208 1672865831
529 \begin_layout Itemize
531 \change_inserted 5863208 1672865845
532 Content moved but unchanged
536 \begin_layout Itemize
538 \change_inserted 5863208 1672865845
541 new chapter and content
544 \begin_layout Itemize
546 \change_inserted 5863208 1672865845
547 All other chapters unchanged but renumbered except:
550 \begin_layout Itemize
552 \change_inserted 5863208 1672865845
553 section 11.3 Literate programming:
564 \begin_layout Chapter
568 \begin_layout Standard
569 This manual is essentially Part II of the
571 User's Guide\SpecialChar endofsentence
574 The reason for separating the two documents is simple:
579 is already quite lengthy,
580 and it contains information on all of the basic features one needs to know in order to prepare most documents.
583 Team has worked to make \SpecialChar LyX
584 extensible through various configuration files and external packages.
585 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
587 you can create a layout file (or module) for it without having to alter \SpecialChar LyX
589 We've already had contributions of several new features this way,
590 and some of them are documented here.
591 There are also some more `advanced' features,
592 such as how to control the presentation of bibliographies and how to work with multi-part documents,
593 that are not covered in the
597 and are discussed here.
600 \begin_layout Standard
601 This manual also documents some special features,
603 \change_deleted 244031559 1603802929
606 \change_inserted 244031559 1603802931
610 \change_deleted 244031559 1603802954
615 which require additional software to work properly.
616 There is also a chapter on \SpecialChar LyX
619 there's a chapter of \SpecialChar LaTeX
621 things you can use to spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
629 only WYSIWYM and will only ever interface to some,
635 \begin_layout Standard
636 If you haven't read the
641 you are definitely in the wrong manual.
646 is the first place to go,
647 since it describes the notation and format of all of the manuals.
648 You should also be thoroughly familiar with the
652 and all of the basic features of \SpecialChar LyX
653 before attempting to read this one.
656 \begin_layout Standard
657 Since many of the topics in this manual depend heavily on \SpecialChar LyX
658 's interaction with \SpecialChar LaTeX
660 this first chapter covers the inner workings of \SpecialChar LyX
661 and how to direct \SpecialChar LyX
662 to generate exactly the \SpecialChar LaTeX
664 It is obviously for more seasoned \SpecialChar LyX
668 \begin_layout Chapter
670 and \SpecialChar LaTeX
674 \begin_layout Section
676 Uses \SpecialChar LaTeX
680 \begin_layout Standard
681 This chapter is for both \SpecialChar TeX
682 -nicians and the \SpecialChar LaTeX
685 we'll explain how \SpecialChar LyX
686 and \SpecialChar LaTeX
687 work together to produce printable output.
688 This is the only place in any of the manuals where we assume you know something about \SpecialChar LaTeX
692 \begin_layout Standard
696 \begin_inset Quotes eld
699 WYSIWYM frontend to \SpecialChar LaTeX
701 \begin_inset Quotes erd
704 but that's no longer true.
705 There are frontends to \SpecialChar LaTeX
710 \begin_layout Plain Layout
711 Some familar ones are \SpecialChar TeX
717 There are also the \SpecialChar LaTeX
718 modes for vi and emacs,
724 These are basically text editors with the ability to run \SpecialChar LaTeX
725 and mark any errors in the file you're editing.
726 Although \SpecialChar LyX
736 run \SpecialChar LaTeX
738 and it also indicates errors in the file,
742 you don't need to know \SpecialChar LaTeX
743 to use \SpecialChar LyX
746 has added its own extensions to \SpecialChar LaTeX
748 Try the following sometime:
750 \change_deleted -712698321 1674917358
754 \begin_inset Flex Noun
757 \begin_layout Plain Layout
760 Export\SpecialChar menuseparator
767 \change_inserted -712698321 1674917358
768 Export\SpecialChar menuseparator
774 \change_deleted -712698321 1674917366
776 \begin_inset Flex Noun
779 \begin_layout Plain Layout
786 \change_inserted -712698321 1674917366
794 \change_deleted -712698321 1674917371
796 \begin_inset Flex Noun
799 \begin_layout Plain Layout
800 View\SpecialChar menuseparator
811 \change_inserted -712698321 1674917371
814 View\SpecialChar menuseparator
824 then look at the preamble of the resulting
825 \begin_inset Flex Code
828 \begin_layout Plain Layout
835 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
837 These macros are defined automatically,
838 according to the features you use in the document.
841 \begin_layout Standard
842 There are several commands that automatically invoke \SpecialChar LaTeX
847 \begin_layout Itemize
849 \change_deleted -712698321 1674917379
850 \begin_inset Flex Noun
853 \begin_layout Plain Layout
854 Document\SpecialChar menuseparator
861 \change_inserted -712698321 1674917379
864 Document\SpecialChar menuseparator
870 \begin_layout Itemize
872 \change_deleted -712698321 1674917381
873 \begin_inset Flex Noun
876 \begin_layout Plain Layout
877 Document\SpecialChar menuseparator
884 \change_inserted -712698321 1674917381
887 Document\SpecialChar menuseparator
893 \begin_layout Standard
894 They will only invoke \SpecialChar LaTeX
895 if the file has changed since the last time \SpecialChar LaTeX
900 \begin_layout Standard
901 When \SpecialChar LyX
902 runs \SpecialChar LaTeX
903 on the file you're editing,
904 it performs these steps:
907 \begin_layout Enumerate
908 Convert the document to \SpecialChar LaTeX
909 and save to a file with the extension
910 \begin_inset Flex Code
913 \begin_layout Plain Layout
920 \begin_inset Flex Code
923 \begin_layout Plain Layout
932 \begin_layout Enumerate
933 Run \SpecialChar LaTeX
935 \begin_inset Flex Code
938 \begin_layout Plain Layout
944 file (maybe several times),
945 and run any other commands (such as
946 \begin_inset Flex Code
949 \begin_layout Plain Layout
956 \begin_inset Flex Code
959 \begin_layout Plain Layout
965 ) needed to compile the \SpecialChar LaTeX
969 \begin_layout Enumerate
970 If there are any errors,
974 \begin_layout Standard
975 If you have run \SpecialChar LaTeX
977 \change_deleted -712698321 1674917394
979 \begin_inset Flex Noun
982 \begin_layout Plain Layout
983 View\SpecialChar menuseparator
990 \change_inserted -712698321 1674917394
993 View\SpecialChar menuseparator
1000 then runs a DVI viewer to display the DVI-file.
1002 \change_deleted -712698321 1674917400
1004 \begin_inset Flex Noun
1007 \begin_layout Plain Layout
1008 View\SpecialChar menuseparator
1015 \change_inserted -712698321 1674917400
1018 View\SpecialChar menuseparator
1025 performs further steps:
1028 \begin_layout Enumerate
1030 \begin_inset Flex Code
1033 \begin_layout Plain Layout
1039 to convert the DVI file to PostScript.
1042 \begin_layout Enumerate
1043 Run a PostScript viewer,
1045 \begin_inset Flex Code
1048 \begin_layout Plain Layout
1055 to display the PostScript file.
1058 \begin_layout Standard
1060 does similar things when viewing,
1065 \begin_layout Section
1066 Translating \SpecialChar LaTeX
1067 files into \SpecialChar LyX
1071 \begin_layout Standard
1072 You can import a \SpecialChar LaTeX
1073 file into \SpecialChar LyX
1075 \change_deleted -712698321 1674917408
1077 \begin_inset Flex Noun
1080 \begin_layout Plain Layout
1081 File\SpecialChar menuseparator
1082 Import\SpecialChar menuseparator
1089 \change_inserted -712698321 1674917408
1092 File\SpecialChar menuseparator
1093 Import\SpecialChar menuseparator
1098 command in \SpecialChar LyX
1100 This will call a program named
1101 \begin_inset Flex Code
1104 \begin_layout Plain Layout
1110 which will create a file
1111 \begin_inset Flex Code
1114 \begin_layout Plain Layout
1121 \begin_inset Flex Code
1124 \begin_layout Plain Layout
1132 will then open that file.
1136 \begin_layout Plain Layout
1137 \begin_inset Flex Code
1140 \begin_layout Plain Layout
1146 can also be run from the command line,
1155 \begin_layout Standard
1156 \begin_inset Flex Code
1159 \begin_layout Plain Layout
1165 will translate most legal \SpecialChar LaTeX
1168 It will put things it doesn't understand into \SpecialChar TeX
1170 so after translating a file with
1171 \begin_inset Flex Code
1174 \begin_layout Plain Layout
1181 you can look for \SpecialChar TeX
1182 code and hand-edit it until it looks right.
1185 \begin_layout Standard
1186 If you don't know what \SpecialChar TeX
1188 read the next section.
1191 \begin_layout Section
1192 \begin_inset CommandInset label
1194 name "sec:Inserting-TeX-Code"
1198 Inserting \SpecialChar TeX
1199 Code into \SpecialChar LyX
1203 \begin_layout Standard
1204 Anything you can do in \SpecialChar LaTeX
1205 you can do in \SpecialChar LyX
1207 for a very simple reason:
1208 You can always insert \SpecialChar TeX
1209 code into any \SpecialChar LyX
1213 and will never be able to,
1214 display every possible \SpecialChar LaTeX
1216 If ever you need to insert \SpecialChar LaTeX
1217 commands into your \SpecialChar LyX
1220 \begin_inset Flex Code
1223 \begin_layout Plain Layout
1231 which you can insert into your document with
1232 \change_deleted -712698321 1674917417
1234 \begin_inset Flex Noun
1237 \begin_layout Plain Layout
1238 Insert\SpecialChar menuseparator
1249 \change_inserted -712698321 1674917417
1252 Insert\SpecialChar menuseparator
1257 or the keyboard shortcut
1266 \begin_layout Standard
1267 Here's an example of inserting \SpecialChar LaTeX
1268 commands in a \SpecialChar LyX
1270 The code looks like this:
1273 \begin_layout LyX-Code
1277 \begin_inset Newline newline
1282 begin{minipage}{5cm}
1283 \begin_inset Newline newline
1286 This is an example of a minipage environment.
1288 \begin_inset Newline newline
1291 can put nearly everything in it,
1293 \begin_inset Newline newline
1298 \begin_inset Newline newline
1304 \begin_inset Newline newline
1308 \begin_inset Newline newline
1313 begin{minipage}{5cm}
1314 \begin_inset Newline newline
1320 \begin_inset Newline newline
1325 begin{minipage}{5cm}
1326 \begin_inset Newline newline
1331 \begin_inset Newline newline
1337 \begin_inset Newline newline
1343 \begin_inset Newline newline
1349 \begin_inset Newline newline
1357 \begin_layout LyX-Code
1361 \begin_layout Standard
1363 \begin_inset Flex Code
1366 \begin_layout Plain Layout
1373 box containing this text is directly after this paragraph.
1374 Those of you reading the manual in \SpecialChar LyX
1375 will only see the \SpecialChar TeX
1377 Those reading a printed version of the manuals will see the actual results:
1378 \begin_inset VSpace bigskip
1384 \begin_layout Standard
1388 \begin_layout Plain Layout
1395 \begin_layout Plain Layout
1399 begin{minipage}{5cm}
1402 \begin_layout Plain Layout
1404 This is an example of a minipage environment.
1405 You can put nearly everything in it,
1406 even (non-floating) figures and tables.
1410 \begin_layout Plain Layout
1417 \begin_layout Plain Layout
1422 \begin_layout Plain Layout
1426 begin{minipage}{5cm}
1429 \begin_layout Plain Layout
1436 \begin_layout Plain Layout
1440 begin{minipage}{5cm}
1443 \begin_layout Plain Layout
1449 \begin_layout Plain Layout
1456 \begin_layout Plain Layout
1463 \begin_layout Plain Layout
1470 \begin_layout Plain Layout
1480 \begin_inset VSpace bigskip
1486 \begin_layout Standard
1487 In addition to using \SpecialChar TeX
1489 you can also create a separate file containing some complex \SpecialChar LaTeX
1490 structure and then use
1491 \change_deleted -712698321 1674917427
1493 \begin_inset Flex Noun
1496 \begin_layout Plain Layout
1497 Insert\SpecialChar menuseparator
1499 \begin_inset space ~
1508 \change_inserted -712698321 1674917427
1511 Insert\SpecialChar menuseparator
1513 \begin_inset space ~
1520 to include your file (you should select the type
1521 \begin_inset Flex Code
1524 \begin_layout Plain Layout
1531 We recommend that you only do this if you have a
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1547 you'll have a big job tracking down \SpecialChar LaTeX
1551 \begin_layout Standard
1552 There are a few last points to emphasize:
1555 \begin_layout Itemize
1561 check if your \SpecialChar LaTeX
1565 \begin_layout Itemize
1566 Beware of reinventing the wheel.
1569 \begin_layout Standard
1572 does have quite a few features tucked into it,
1573 and more are coming.
1574 Be sure to check the manuals to make sure that \SpecialChar LyX
1575 doesn't have such-and-such feature before you decide you have to do it by hand.
1577 there are numerous \SpecialChar LaTeX
1578 packages out there to do all sorts of things,
1579 from labels to envelopes to fancy multipage tables.
1581 \change_inserted 244031559 1603815732
1583 \begin_inset CommandInset href
1586 target "https://www.ctan.org/"
1592 \change_deleted 244031559 1603815732
1594 \begin_inset CommandInset href
1597 target "http://www.ctan.org/"
1607 \begin_layout Standard
1608 If you do need to do some wild and fancy things within your document,
1609 be sure to check out a good \SpecialChar LaTeX
1610 book for assistance.
1611 There are a number of them listed in the bibliography of the
1618 \begin_layout Section
1620 and the \SpecialChar LaTeX
1624 \begin_layout Subsection
1625 About the \SpecialChar LaTeX
1629 \begin_layout Standard
1630 If you already know \SpecialChar LaTeX
1632 there is no need to explain here what the preamble is good for.
1634 the following will give you some ideas—
1635 we recommend again that you consult a \SpecialChar LaTeX
1636 book for further information.
1638 you should read the points below,
1639 because they explain what you can do and what you don't need to do in the \SpecialChar LaTeX
1640 preamble of a \SpecialChar LyX
1644 \begin_layout Standard
1645 The \SpecialChar LaTeX
1646 preamble comes at the very beginning of a document,
1655 \begin_layout Itemize
1656 Declare the document class.
1658 \begin_inset Newline newline
1662 already does this for you.
1663 If you're a seasoned \SpecialChar LaTeX
1665 and you have a custom document class you want to use,
1668 Customization Manual
1670 for information on how to make \SpecialChar LyX
1674 \begin_layout Itemize
1675 Declare the usage of packages.
1677 \begin_inset Newline newline
1681 packages provide special commands,
1682 which are only available within a document when the package has been declared in the preamble.
1683 In addition to providing special commands,
1684 the inclusion of a package can change the document.
1687 \begin_inset Flex Code
1690 \begin_layout Plain Layout
1696 forces all paragraphs to be indented.
1697 There are other packages for labels,
1704 \begin_layout Itemize
1709 \begin_inset Newline newline
1712 There are several \SpecialChar LaTeX
1713 counters and variables that
1717 be set globally from within the preamble in order to have the desired effect.
1718 (There are variables that you can set and reset inside the document,
1719 too.) Margins are a good example of something that must be set in the preamble.
1720 Another example is the label format for lists.
1721 You can actually set these just about anywhere,
1722 but it's best to do it just once,
1723 inside the preamble.
1726 \begin_layout Itemize
1727 Declare user defined commands (with
1728 \begin_inset Flex Code
1731 \begin_layout Plain Layout
1740 \begin_inset Flex Code
1743 \begin_layout Plain Layout
1752 \begin_inset Newline newline
1755 These are abbreviations for \SpecialChar LaTeX
1756 commands which appear very often inside a document.
1757 Although the preamble is a good place to declare such commands,
1762 be declared anywhere (before they are used for the first time,
1764 This can be useful if there is a lot of raw \SpecialChar LaTeX
1765 code in your document,
1766 which normally should not be the case.
1769 \begin_layout Standard
1771 adds its own set of definitions to the preamble of the
1772 \begin_inset Flex Code
1775 \begin_layout Plain Layout
1782 This makes \SpecialChar LaTeX
1783 files generated by \SpecialChar LyX
1787 \begin_layout Subsection
1788 Changing the Preamble
1791 \begin_layout Standard
1792 The commands which \SpecialChar LyX
1793 adds to the preamble of a \SpecialChar LaTeX
1795 you can't change them without patching \SpecialChar LyX
1799 add your own stuff to the preamble by selecting
1800 \begin_inset Flex Noun
1803 \begin_layout Plain Layout
1806 \begin_inset space ~
1815 \change_deleted -712698321 1674917437
1817 \begin_inset Flex Noun
1820 \begin_layout Plain Layout
1821 Document\SpecialChar menuseparator
1828 \change_inserted -712698321 1674917437
1831 Document\SpecialChar menuseparator
1838 adds anything in the
1839 \begin_inset Flex Noun
1842 \begin_layout Plain Layout
1848 dialog to its own built-in preamble.
1849 Before adding your own declarations in the preamble,
1850 you should make sure that \SpecialChar LyX
1851 doesn't already support what you want to do.
1852 (Remember what we said about reinventing the wheel?) Also,
1855 make sure your preamble code is correct
1859 doesn't check it for you.
1860 If there is an error,
1861 you're likely to get an error like
1862 \begin_inset Quotes eld
1866 \begin_inset Flex Code
1869 \begin_layout Plain Layout
1878 \begin_inset Quotes erd
1882 If you see this error,
1883 check your preamble.
1886 \begin_layout Subsection
1890 \begin_layout Standard
1891 Here are some examples of what you can add to a preamble,
1895 \begin_layout Subsubsection
1900 \begin_layout Standard
1901 There are two variables under \SpecialChar LaTeX
1902 that control page position:
1904 \begin_inset Flex Code
1907 \begin_layout Plain Layout
1916 \begin_inset Flex Code
1919 \begin_layout Plain Layout
1928 Their names should be self-explanatory.
1929 These variables are useful if you think for a moment about computer labels.
1931 the size of a print medium and the area of the medium that you can actually print on aren't the same.
1933 \begin_inset Flex Code
1936 \begin_layout Plain Layout
1945 \begin_inset Flex Code
1948 \begin_layout Plain Layout
1959 \begin_layout Standard
1960 The default values for
1961 \begin_inset Flex Code
1964 \begin_layout Plain Layout
1973 \begin_inset Flex Code
1976 \begin_layout Plain Layout
1985 \begin_inset space \thinspace{}
1990 \begin_inset space \thinspace{}
1994 \begin_inset space \space{}
1997 the page isn't shifted.
1999 some DVI drivers always seem to shift the page.
2000 We have no idea why,
2001 or why the sysadmin hasn't fixed such behavior.
2002 If you're using \SpecialChar LyX
2003 on a system that you don't personally maintain,
2004 and your sysadmin is a doofus,
2006 \begin_inset Flex Code
2009 \begin_layout Plain Layout
2018 \begin_inset Flex Code
2021 \begin_layout Plain Layout
2030 Suppose your left and top margins are always 0.5
2031 \begin_inset space \thinspace{}
2035 You can add this to the preamble:
2038 \begin_layout LyX-Code
2046 \begin_layout LyX-Code
2054 \begin_layout Standard
2055 and your margins should now be correct.
2058 \begin_layout Subsubsection
2063 \begin_layout Standard
2065 suppose you wanted to print out a bunch of address labels.
2066 There's a rather nice package,
2067 available at your nearest CTAN archive,
2068 for printing sheets of labels:
2070 \begin_inset Flex Code
2073 \begin_layout Plain Layout
2081 your system may not have this package installed by default.
2082 We leave that up to you to check.
2083 You'll also want to read the documentation for it;
2084 we're not going to do that for you.
2085 Since this is an example,
2087 we'll give you an example of how you use this package.
2090 \begin_layout Standard
2092 make sure you're using the
2093 \begin_inset Flex Code
2096 \begin_layout Plain Layout
2104 you need to put the following in your preamble:
2107 \begin_layout LyX-Code
2113 \begin_layout LyX-Code
2119 \begin_layout LyX-Code
2125 \begin_layout LyX-Code
2131 \begin_layout LyX-Code
2137 \begin_layout LyX-Code
2143 \begin_layout LyX-Code
2149 \begin_layout Standard
2150 This sets things up for Avery label sheets,
2152 You're now ready to print labels,
2153 but you'll need to insert \SpecialChar LaTeX
2155 placing the commands
2156 \begin_inset Flex Code
2159 \begin_layout Plain Layout
2168 \begin_inset Flex Code
2171 \begin_layout Plain Layout
2179 around each label text.
2180 This and other special features of
2181 \begin_inset Flex Code
2184 \begin_layout Plain Layout
2190 are explained in its documentation.
2193 \begin_layout Standard
2195 someone may write a \SpecialChar LyX
2196 layout file to support this package directly.
2197 Maybe that someone is you.
2200 \begin_layout Subsubsection
2202 Paragraph Indentation
2205 \begin_layout Standard
2206 Americans are trained to indent the first line of
2211 As with all of their other weird quirks,
2212 most Americans will whine and moan until they can have their way and indent the first line of all paragraphs.
2223 \begin_layout Standard
2225 this behavior isn't standard typography.
2227 you typically only indent the first line of a paragraph
2231 it follows another one.
2232 The idea behind indenting the first line of a paragraph is to distinguish neighboring paragraphs from one another.
2233 If there is no previous paragraph—
2235 if it follows a figure or is the first paragraph in a section—
2236 then there is no need for indentation.
2240 \begin_layout Standard
2241 If you're a typical American (we're still joking!),
2243 you don't care about such esoteric things;
2244 you want your indentation!
2245 Add this to the preamble:
2248 \begin_layout LyX-Code
2251 usepackage{indentfirst}
2254 \begin_layout Standard
2255 If your \SpecialChar TeX
2256 distribution isn't braindead,
2257 you'll have this package,
2258 and all of your paragraphs will get the indentation the Founding Fathers intended they should have.
2261 \begin_layout Subsubsection
2266 \begin_layout Standard
2267 You can also check out the preamble of this document to get an idea of some of the advanced things you can do.
2270 \begin_layout Section
2272 and \SpecialChar LaTeX
2276 \begin_layout Standard
2277 When \SpecialChar LyX
2278 calls \SpecialChar LaTeX
2280 it tells \SpecialChar LaTeX
2281 to blithely ignore any errors and keep going.
2282 It then uses the logfile from the \SpecialChar LaTeX
2283 run to do a post-mortem.
2284 After analyzing the logfile,
2286 displays a dialog listing the errors.
2287 Clicking on any one of them will take you to the position in your \SpecialChar LyX
2288 file where the error occurred.
2292 \begin_layout Plain Layout
2295 Analyzing the logfile is a tough job,
2296 and \SpecialChar LyX
2297 doesn't always go to the right line.
2298 There are also cases where \SpecialChar LaTeX
2299 reports the error on one line,
2300 but the actual error is earlier.
2301 This is not unlike forgetting a closing brace in a program:
2302 You'll get an error,
2311 \begin_layout Standard
2312 Some folks also like to look at the log file directly:
2313 It is available from
2314 \change_deleted -712698321 1674917444
2316 \begin_inset Flex Noun
2319 \begin_layout Plain Layout
2320 Document\SpecialChar menuseparator
2322 \begin_inset space ~
2331 \change_inserted -712698321 1674917444
2334 Document\SpecialChar menuseparator
2336 \begin_inset space ~
2344 There are some fairly common error messages and warnings.
2345 We'll cover those here.
2346 You should look at a good \SpecialChar LaTeX
2347 book for a complete listing.
2350 \begin_layout Itemize
2351 \begin_inset Flex Code
2354 \begin_layout Plain Layout
2361 \begin_inset Newline newline
2364 Anything beginning with these words is a warning message for the purpose of
2365 \begin_inset Quotes eld
2369 \begin_inset Quotes erd
2372 the \SpecialChar LaTeX
2374 You'll get messages like this if you added or changed cross-references or bibliography entries,
2377 is trying to tell you that you need to make another run.
2378 You can by-and-large ignore these.
2381 \begin_layout Itemize
2382 \begin_inset Flex Code
2385 \begin_layout Plain Layout
2392 \begin_inset Newline newline
2395 Another warning message,
2396 this time about fonts which \SpecialChar LaTeX
2398 The rest of the message will often say something about a replacement font that \SpecialChar LaTeX
2400 You can safely ignore these,
2404 \begin_layout Itemize
2405 \begin_inset Flex Code
2408 \begin_layout Plain Layout
2417 \begin_inset Newline newline
2426 It seems to generate at least one of these messages for just about any document you write.
2427 They are warnings about lines that were too long and run past the right margin.
2428 This happens if \SpecialChar LaTeX
2429 does not find a reasonable way to break the lines (notoriously often with typewriter font,
2430 since this does not allow for automatic break points).
2432 this is unnoticeable in the final output.
2433 (It can be just a point or two.) Sometimes,
2435 the lines run rather visibly into the margin;
2436 something you will not want to have in your final print.
2438 \begin_inset Newline newline
2441 There are several global ways to try to minimize the overfull lines.
2444 Enable micro-typographic extensions
2448 Document\SpecialChar menuseparator
2449 Settings\SpecialChar menuseparator
2452 might already improve things a lot.
2455 code such as the following in
2457 Document\SpecialChar menuseparator
2458 Settings\SpecialChar menuseparator
2461 usually reduces the overfull lines drastically (we use this in the preamble of this document):
2465 \begin_layout LyX-Code
2469 \begin_inset Newline newline
2475 \begin_inset Newline newline
2480 emergencystretch 1.5em
2481 \begin_inset Newline newline
2489 \begin_layout Standard
2492 you eventually have to rewrite the text to get the line breaking right.
2496 \begin_layout Plain Layout
2497 For more information,
2499 \begin_inset Flex URL
2502 \begin_layout Plain Layout
2504 http://www.tex.ac.uk/FAQ-overfull.html
2517 \begin_layout Standard
2519 you should check the respective lines,
2520 at least for the final version of your document.
2521 Your eyes will tell you if there's a problem with something that's too wide.
2525 \begin_layout Plain Layout
2526 You can also enable the `draft' option in
2527 \change_deleted -712698321 1674917458
2529 \begin_inset Flex Noun
2532 \begin_layout Plain Layout
2533 Document\SpecialChar menuseparator
2540 \change_inserted -712698321 1674917458
2543 Document\SpecialChar menuseparator
2549 and then \SpecialChar LaTeX
2550 will draw a black box in the margin of lines that are overfull.
2559 \begin_layout Itemize
2560 \begin_inset Flex Code
2563 \begin_layout Plain Layout
2572 \begin_inset Newline newline
2575 Not quite as common as its cousin.
2576 This happens again if \SpecialChar LaTeX
2577 does not find a reasonable break point and consequently generates too loose lines.
2578 As with the overfull lines,
2579 you should check if this is a visible problem.
2582 \begin_layout Itemize
2583 \begin_inset Flex Code
2586 \begin_layout Plain Layout
2595 \begin_inset Flex Code
2598 \begin_layout Plain Layout
2607 \begin_inset Newline newline
2610 Warnings about troubles breaking the page.
2612 just look at the output.
2613 Your eyes will tell you where something has gone wrong.
2616 \begin_layout Itemize
2617 \begin_inset Flex Code
2620 \begin_layout Plain Layout
2623 \begin_inset Quotes els
2627 \begin_inset Quotes ers
2636 \begin_inset Newline newline
2640 \begin_inset Quotes eld
2644 \begin_inset Quotes erd
2647 isn't installed on this system.
2648 This usually appears because some package your document needs isn't installed.
2649 If you didn't touch the preamble or didn't use the
2650 \begin_inset Flex Code
2653 \begin_layout Plain Layout
2662 then one of the packages \SpecialChar LyX
2663 tried to load is missing.
2665 \change_deleted -712698321 1674917468
2667 \begin_inset Flex Noun
2670 \begin_layout Plain Layout
2671 Help\SpecialChar menuseparator
2679 \change_inserted -712698321 1674917478
2682 Help\SpecialChar menuseparator
2687 to get a list of packages that \SpecialChar LyX
2689 This file is updated whenever you reconfigure \SpecialChar LyX
2691 \change_deleted -712698321 1674917484
2693 \begin_inset Flex Noun
2696 \begin_layout Plain Layout
2697 Tools\SpecialChar menuseparator
2704 \change_inserted -712698321 1674917484
2707 Tools\SpecialChar menuseparator
2712 ) and tells you which packages have been detected and what they do.
2713 \begin_inset Newline newline
2717 \begin_inset Flex Code
2720 \begin_layout Plain Layout
2728 command and the package in question isn't installed,
2729 then you'll need to install it yourself.
2732 \begin_layout Itemize
2733 \begin_inset Flex Code
2736 \begin_layout Plain Layout
2744 \begin_inset Newline newline
2747 Error messages beginning with this are trying to tell you that you specified a bad or undefined option to a package.
2748 Check the package's documentation.
2751 \begin_layout Itemize
2752 \begin_inset Flex Code
2755 \begin_layout Plain Layout
2756 Undefined control sequence
2762 \begin_inset Newline newline
2765 If you've inserted \SpecialChar LaTeX
2766 code into your document,
2768 you'll get one of these.
2769 You may have forgotten to load a package.
2771 this error message usually means that you used an undefined command.
2775 \begin_layout Standard
2776 There are other error and warning messages.
2777 Some are self-explanatory.
2778 These are usually \SpecialChar LaTeX
2780 Others are downright cryptic.
2781 These are usually \SpecialChar TeX
2787 what they mean or how to decipher them.
2791 \begin_layout Standard
2792 There's a general sequence you should follow if you get error messages:
2795 \begin_layout Enumerate
2796 Look at the \SpecialChar LaTeX
2797 code you inserted for typos.
2800 \begin_layout Enumerate
2801 If there are no typos,
2802 check that you used the command(s) correctly.
2805 \begin_layout Enumerate
2806 If you get a bunch of error boxes piled up at the very top of the document—
2807 and especially if you see a
2808 \begin_inset Quotes eld
2812 \begin_inset Flex Code
2815 \begin_layout Plain Layout
2824 \begin_inset Quotes erd
2828 it means that there are errors in the preamble.
2829 Start debugging your preamble.
2832 \begin_layout Enumerate
2833 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2834 code to the document,
2835 the first suspect is your \SpecialChar LaTeX
2836 distribution itself.
2837 Check for missing packages and install them.
2840 \begin_layout Enumerate
2842 so there are no missing packages.
2843 Did you use any of the fine-tuning options in \SpecialChar LyX
2851 like trying to manually insert lots of
2852 \begin_inset Flex Code
2855 \begin_layout Plain Layout
2857 \change_deleted 177693 1654669036
2859 \change_inserted 177693 1654669038
2863 \begin_inset space ~
2867 \change_deleted 177693 1654669040
2869 \change_inserted 177693 1654669041
2879 \begin_inset Flex Code
2882 \begin_layout Plain Layout
2890 \begin_inset Flex Code
2893 \begin_layout Plain Layout
2900 Did you try to kludge something together with these instead of using the appropriate paragraph environment?
2903 \begin_layout Enumerate
2905 you didn't use any of the fine-tuning options,
2906 you played by the rules.
2907 Did you try to pull a fancy maneuver?
2908 Did you do something funky inside a table or an equation,
2909 like inserting a graphic into a table cell?
2912 \begin_layout Enumerate
2913 Do you have long sections of text where \SpecialChar LaTeX
2914 cannot find a place to break a line?
2917 is rather strict about how much extra inter-word spacing it will add in order to break a line.
2919 you should rework the paragraph to avoid the problem.
2922 \begin_layout Enumerate
2923 Did you go overboard with the nesting?
2925 (currently) doesn't check to make sure you're in the limits for nesting environments.
2926 If you nested a bunch of environments to the
2927 \begin_inset Formula $17^{\mathrm{th}}$
2932 (The limit in \SpecialChar LaTeX
2936 \begin_layout Enumerate
2938 you didn't get any error messages,
2939 but your output looks awful.
2940 If you have a table or figure that's too wide or long for the page,
2945 \begin_layout Enumerate
2946 rescale the figure so it fits.
2949 \begin_layout Enumerate
2950 trim down the table so it fits.
2954 \begin_layout Enumerate
2955 If something else is wrong with the output,
2956 and you didn't try to pull anything fancy or kludge the fine-tuning options,
2957 we're not sure what's wrong.
2960 \begin_layout Standard
2961 If all this doesn't help—
2967 you might have found a bug in \SpecialChar LyX
2972 \begin_layout Chapter
2974 \change_inserted 564990737 1672345271
2978 \begin_layout Standard
2980 \change_inserted 564990737 1672345272
2987 originally offered four standard document classes,
2991 but individuals and organizations,
2992 most notably the American Mathematical Society in the early days,
2993 have made many contributions to extending the range of document classes.
2994 In this chapter we summarize the main externally maintained classes,
2995 some of which are marked “Unavailable:” in the pull-down
2998 \begin_inset space ~
3012 ocument\SpecialChar menuseparator
3017 ettings\SpecialChar menuseparator
3019 \begin_inset space ~
3024 dialog and which you will need to install as described in the
3026 Installing New Document Classes
3032 manual if you want to use them.
3036 \begin_layout Section
3038 \change_inserted 564990737 1670439533
3039 \begin_inset CommandInset label
3041 name "sec:Collections"
3048 \begin_layout Subsection
3050 \change_inserted 564990737 1672345298
3051 \begin_inset CommandInset label
3053 name "subsec:AMS-LaTeX-(American-Mathematical"
3057 AMS-\SpecialChar LaTeX
3058 (American Mathematical Society)
3061 \begin_layout Standard
3063 \change_inserted 564990737 1672345298
3064 The \SpecialChar LyX
3065 supported document classes
3073 are maintained by the Society;
3074 use of their features is described in the Math manual and on their website
3075 \begin_inset Flex URL
3078 \begin_layout Plain Layout
3080 \change_inserted 564990737 1672345298
3082 http://www.ams.org/publications/authors/tex/amslatex
3090 The following summary was originally provided by
3097 \change_inserted -712698321 1673082716
3099 \change_inserted 564990737 1672345298
3102 and the \SpecialChar LyX
3106 \change_deleted 564990737 1672345297
3109 AMS \SpecialChar LaTeX
3113 \begin_layout Standard
3115 \change_deleted 564990737 1672345297
3123 Richard Kimberly Heck
3128 \begin_layout Standard
3129 \begin_inset VSpace bigskip
3135 \begin_layout Standard
3137 The AMS \SpecialChar LaTeX
3138 layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
3139 The layouts are not tailored to a specific journal,
3141 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
3143 That documentation is available on the Web at
3144 \begin_inset Flex URL
3147 \begin_layout Plain Layout
3155 \begin_inset Flex URL
3158 \begin_layout Plain Layout
3160 ftp://ftp.ams.org/pub/tex/amslatex/
3166 These layouts are appropriate,
3168 for any mathematical writing.
3172 \begin_layout Standard
3174 \change_deleted -712698321 1673083001
3176 \change_inserted -712698321 1673083002
3179 basic AMS \SpecialChar LaTeX
3184 \begin_layout Itemize
3186 The standard AMS article format
3187 \change_inserted 564990737 1672345333
3191 File\SpecialChar menuseparator
3192 Open Example\SpecialChar menuseparator
3193 Articles\SpecialChar menuseparator
3194 American Mathematical Society (AMS)
3201 \begin_layout Itemize
3203 the standard AMS book (really,
3205 \change_inserted 564990737 1672345366
3209 File\SpecialChar menuseparator
3210 Open Example\SpecialChar menuseparator
3211 Books\SpecialChar menuseparator
3212 American Mathematical Society (AMS)
3217 \change_inserted 564990737 1672345369
3221 \begin_layout Itemize
3223 \change_inserted 564990737 1672345383
3225 the standard AMS proceedings format.
3228 \begin_layout Standard
3230 \change_inserted 564990737 1672345383
3232 only supports the first two natively;
3235 Installing New Document Classes
3241 manual if you want to use
3248 \begin_layout Standard
3249 The layouts themselves contain only the minimum necessary to use the AMS classes.
3252 contain any of the `theorem' environments used for setting theorems,
3255 These are contained,
3258 \change_deleted 564990737 1672345416
3260 \begin_inset Flex Code
3263 \begin_layout Plain Layout
3270 \change_inserted 564990737 1672345416
3278 which is loaded by default when you select one of the AMS classes.
3279 (It can also be used with other classes and can be removed,
3280 if you would rather use something else.) Less commonly used environments are in the
3281 \change_deleted 564990737 1672345436
3283 \begin_inset Flex Code
3286 \begin_layout Plain Layout
3287 Theorems (AMS-Extended)
3293 \change_inserted 564990737 1672345436
3296 AMS Theorems (Extended)
3301 which must be loaded manually.
3304 \begin_layout Standard
3306 theorems and the like are numbered consecutively throughout the document,
3307 but this may be modified by loading the module
3308 \change_deleted 564990737 1672345461
3310 \begin_inset Flex Code
3313 \begin_layout Plain Layout
3314 Theorems (Order by Section)
3320 \change_inserted 564990737 1672345461
3323 Standard Theorems (Numbered by Section)
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3340 \change_deleted 564990737 1672345479
3342 \begin_inset Flex Code
3345 \begin_layout Plain Layout
3346 Theorems (Order by Chapter)
3352 \change_inserted 564990737 1672345480
3355 Standard Theorems (Numbered by Chapter)
3360 These will number the results as
3361 \begin_inset Formula $n.m$
3365 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).
3366 Many environments are also available unnumbered.
3367 These are indicated by an asterisk at the end.
3368 If you happen to want
3374 \change_deleted 564990737 1672345498
3376 \begin_inset Flex Code
3379 \begin_layout Plain Layout
3386 \change_inserted 564990737 1672345498
3389 Standard Theorems (Unnumbered)
3393 provides that option.
3396 \begin_layout Standard
3397 Note that these modules do not
3401 to be used with the AMS classes.
3402 It is perfectly possible to use the
3403 \change_deleted 564990737 1672345520
3405 \begin_inset Flex Code
3408 \begin_layout Plain Layout
3415 \change_inserted 564990737 1672345520
3423 and the others mentioned,
3426 \begin_inset Flex Code
3429 \begin_layout Plain Layout
3431 \change_deleted -712698321 1673083855
3433 \change_inserted -712698321 1673083855
3434 Article (Standard Class)
3443 \begin_inset Flex Code
3446 \begin_layout Plain Layout
3448 \change_deleted -712698321 1673083858
3450 \change_inserted -712698321 1673083862
3451 Report (Standard Class)
3460 \begin_inset Flex Code
3463 \begin_layout Plain Layout
3465 \change_deleted -712698321 1673083819
3467 \change_inserted -712698321 1673083822
3479 \begin_layout Subsubsection
3480 What these layouts provide
3483 \begin_layout Standard
3484 There is a long list of included environments provided by these layouts.
3485 In AMS-\SpecialChar LaTeX
3489 an opportunity to define an unlimited variety of `theorem' environments.
3491 the AMS recommends the environments that are available in \SpecialChar LyX
3496 \begin_layout Standard
3497 The following environments—
3498 as well as the standard environments,
3500 \begin_inset Flex Noun
3503 \begin_layout Plain Layout
3511 \begin_inset Flex Noun
3514 \begin_layout Plain Layout
3522 \begin_inset Flex Noun
3525 \begin_layout Plain Layout
3533 \begin_inset Flex Noun
3536 \begin_layout Plain Layout
3544 \begin_inset Flex Noun
3547 \begin_layout Plain Layout
3555 \begin_inset Flex Code
3558 \begin_layout Plain Layout
3565 \begin_inset Flex Code
3568 \begin_layout Plain Layout
3577 \begin_layout Description
3578 Address This should be the author's permanent address.
3581 \begin_layout Description
3583 \begin_inset space ~
3586 Address This should be the author's temporary address at the time of submission,
3587 if different from the Address.
3590 \begin_layout Description
3591 Email Author's e-mail address
3594 \begin_layout Description
3595 URL Author's Web address,
3599 \begin_layout Description
3600 Keywords Key words or phrases used to identify specific topics discussed in the paper.
3603 \begin_layout Description
3604 Subjectclass These refer to the AMS Subject Classifications,
3605 published and described in
3607 Mathematical Reviews
3610 These are also available online at the AMS cites listed above.
3613 \begin_layout Description
3617 \begin_layout Description
3621 \begin_layout Description
3625 \begin_layout Standard
3626 The following environments are provided by both the
3627 \change_deleted 564990737 1672345566
3629 \begin_inset Flex Code
3632 \begin_layout Plain Layout
3639 \change_inserted 564990737 1672345566
3647 \change_deleted 564990737 1672345580
3649 \begin_inset Flex Code
3652 \begin_layout Plain Layout
3659 \change_inserted 564990737 1672345580
3667 in the latter case in both
3668 \change_deleted -712698321 1673084072
3672 \change_deleted -712698321 1673084073
3676 \change_deleted -712698321 1673084075
3680 \change_deleted -712698321 1673084077
3684 These same environments are provided only in the starred versions by the
3685 \change_deleted 564990737 1672345596
3687 \begin_inset Flex Code
3690 \begin_layout Plain Layout
3697 \change_inserted 564990737 1672345596
3701 \change_inserted -712698321 1673084060
3709 \begin_layout Theorem
3710 This is typically used for the statements of major results.
3714 \begin_layout Corollary*
3715 This is used for statements which follow fairly directly from previous statements.
3717 these can be major results.
3722 These are smaller results needed to prove other statements.
3725 \begin_layout Proposition
3726 These are less major results which (hopefully) add to the general theory being discussed.
3729 \begin_layout Conjecture
3730 These are statements provided without justification,
3731 which the author does not know how to prove,
3732 but which seem to be true (to the author,
3736 \begin_layout Definition*
3737 Guess what this is for.
3738 The font is different for this environment than for the previous ones.
3742 \begin_layout Example*
3743 Used for examples illustrating proven results.
3746 \begin_layout Problem
3747 It's not really known what this is for.
3748 You should figure it out.
3751 \begin_layout Exercise*
3752 Write a description for this one.
3755 \begin_layout Remark
3756 This environment is also a type of theorem,
3757 usually a lesser sort of observation.
3760 \begin_layout Claim*
3761 Often used in the course of giving a proof of a larger result.
3766 these are used to break up long arguments,
3767 using specific instances of some condition.
3772 The numbering scheme for cases is on its own,
3773 not together with other numbered statements.
3778 At the end of this environment,
3779 a QED symbol (usually a square,
3780 but it can vary with different styles) is placed.
3781 If you want to have other environments within this one—
3784 and have the QED symbol appear only after them,
3785 then the other environments need to be nested within the proof environment.
3788 Nesting Environments
3794 for information on nesting.
3799 \change_inserted 564990737 1672345651
3800 Used in a way similar to Proposition,
3801 though perhaps lower on the scale.
3804 \begin_layout Standard
3805 And these environments are provided by
3806 \change_deleted 564990737 1672345684
3808 \begin_inset Flex Code
3811 \begin_layout Plain Layout
3812 Theorems (AMS-Extended)
3818 \change_inserted 564990737 1672345689
3821 AMS Theorems (Extended
3828 \begin_layout Criterion*
3829 A required condition.
3832 \begin_layout Algorithm*
3833 A general procedure to be used.
3836 \begin_layout Axiom*
3837 This is a property or statement taken as true within the system being discussed.
3840 \begin_layout Condition*
3841 Sometimes used to state a condition assumed within the present context of discussion.
3845 Similar to a Remark.
3848 \begin_layout Notation*
3849 Used for the explanation of,
3854 \begin_layout Summary
3855 Do we really need to tell you?
3859 \begin_layout Standard
3861 \change_deleted -712698321 1675595089
3867 \begin_layout Conclusion*
3868 Sometimes used at the end of a long train of argument.
3869 \change_deleted 564990737 1672345729
3875 \change_deleted 564990737 1672345638
3876 Used in a way similar to Proposition,
3877 though perhaps lower on the scale.
3878 \change_inserted 564990737 1672345720
3882 \begin_layout Assumption*
3884 \change_inserted 564990737 1672345721
3888 \begin_layout Question*
3890 \change_inserted 564990737 1672345721
3894 \begin_layout Standard
3896 \change_inserted 564990737 1672345721
3897 There are ten more Maths modules available including several offering options ordered on
3899 (Numbered by Type \SpecialChar ldots
3907 \begin_layout Standard
3909 the AMS classes automatically provide the AMS \SpecialChar LaTeX
3910 and AMS fonts packages.
3911 They need to be available on your system in order to use these environments.
3914 \begin_layout Subsection
3916 \change_inserted 564990737 1671383236
3917 \begin_inset CommandInset label
3919 name "subsec:Extra-font-sizes"
3926 \begin_layout Standard
3928 \change_inserted 564990737 1671383236
3929 The “Extra font sizes” collection provides the document classes
3932 \begin_inset space \thinspace{}
3935 (with extra font sizes)
3941 \begin_inset space \thinspace{}
3944 (with extra font sizes)
3950 \begin_inset space \thinspace{}
3953 (with extra font sizes)
3958 \begin_inset space \thinspace{}
3961 (with extra font sizes)
3981 document classes respectively but offer the additional
3987 \begin_inset space ~
4000 ocument\SpecialChar menuseparator
4005 ettings\SpecialChar menuseparator
4011 \begin_layout Subsection
4013 \change_inserted 564990737 1671383236
4017 \begin_layout Standard
4019 \change_inserted 564990737 1671383236
4020 The document classes
4023 \begin_inset space \thinspace{}
4031 \begin_inset space \thinspace{}
4046 document classes to facilitate the use of Hebrew in \SpecialChar LyX
4050 \begin_layout Subsection
4052 \change_inserted 564990737 1671383236
4053 \begin_inset CommandInset label
4055 name "subsec:Japanese"
4060 \change_inserted -712698321 1675848645
4062 \change_inserted 564990737 1671383236
4066 \begin_layout Standard
4068 \change_inserted -712698321 1676025662
4070 included a collection of several bundles that aim to facilitate typesetting Japanese documents.
4071 The bundles have been developed at different times,
4072 they thus support different typesetting engines and features.
4073 This collection is the oldest one.
4074 It adjusts the \SpecialChar LaTeX
4075 standard classes to requirements of Japanese typesetting,
4076 for horizontal and vertical writing.
4077 The collection includes
4080 \change_deleted 545138413 1676132735
4082 \change_inserted 545138413 1676132735
4084 \begin_inset space \thinspace{}
4088 \change_inserted -712698321 1676533466
4095 \begin_inset space \thinspace{}
4105 \begin_inset space \thinspace{}
4114 \begin_inset space \thinspace{}
4124 \begin_inset space \thinspace{}
4127 (Japanese Standard Class)
4133 \begin_inset space \thinspace{}
4141 \begin_inset Quotes eld
4145 \begin_inset Quotes erd
4148 engines tailored for Japanese,
4150 and up\SpecialChar LaTeX
4154 \begin_layout Standard
4156 \change_inserted -712698321 1676026113
4157 For the use with the more modern Lua\SpecialChar LaTeX
4159 the collection also includes dedicated classes
4162 \change_deleted 545138413 1676132664
4164 \change_inserted 545138413 1676132730
4166 \begin_inset space \thinspace{}
4170 \change_inserted -712698321 1676533517
4171 (Standard Class for LuaTeX),
4173 \begin_inset space \thinspace{}
4176 (Standard Class for LuaTeX,
4179 \begin_inset space \thinspace{}
4182 (Standard Class for LuaTeX)
4188 \begin_inset space \thinspace{}
4191 (Standard Class for LuaTeX,
4196 \change_deleted 545138413 1676132664
4198 \change_inserted -712698321 1676533501
4202 \begin_inset space \thinspace{}
4205 (Japanese Standard Class for LuaTeX)
4209 \change_deleted -712698321 1676533511
4213 \begin_inset space \thinspace{}
4216 (Standard Class for LuaTeX,
4219 \begin_inset space \thinspace{}
4222 (Standard Class for LuaTeX,
4227 \change_inserted 545138413 1676132454
4231 \begin_inset space \thinspace{}
4234 (Japanese Standard Class for LuaTeX,
4236 \change_deleted -712698321 1676533483
4238 \change_inserted -712698321 1676533501
4240 \change_inserted 545138413 1676132454
4245 \change_inserted -712698321 1676533501
4253 \change_deleted 545138413 1676132664
4254 These classes support both horizontal and vertical writing.
4255 \change_inserted -712698321 1676534105
4259 \begin_layout Standard
4261 \change_inserted -712698321 1676534227
4262 Templates for the Lua\SpecialChar LaTeX
4263 classes can be found in
4265 File\SpecialChar menuseparator
4268 in the respective category (
4287 \begin_layout Subsection
4289 \change_inserted -712698321 1675848929
4290 \begin_inset CommandInset label
4292 name "subsec:Japanese-JS"
4296 Japanese (JS Bundle)
4301 \begin_layout Standard
4303 \change_inserted -712698321 1675849034
4304 This collection includes improved versions of the classes included in
4306 Japanese (Standard Classes)
4309 \begin_inset space ~
4313 \begin_inset CommandInset ref
4315 reference "subsec:Japanese"
4321 \change_deleted -712698321 1675849038
4322 The document classes
4323 \change_inserted -712698321 1673089024
4327 \change_deleted -712698321 1673089025
4329 \change_inserted -712698321 1673089025
4331 \change_inserted 564990737 1671383236
4333 \begin_inset space \thinspace{}
4337 \change_deleted -712698321 1673089027
4339 \change_inserted 564990737 1671383236
4341 \change_deleted -712698321 1675848222
4343 \change_inserted -712698321 1675848223
4345 \change_inserted 564990737 1671383236
4347 \change_deleted -712698321 1675849103
4352 \change_inserted 564990737 1671383236
4356 \change_deleted -712698321 1675849055
4358 \begin_inset space \thinspace{}
4361 (Japanese Standard Class Vertical Writing)
4367 \begin_inset space \thinspace{}
4370 (Japanese Standard Class)
4374 \change_inserted -712698321 1675849107
4378 \change_deleted -712698321 1673089053
4380 \change_inserted -712698321 1673089064
4382 \change_inserted 564990737 1671383236
4384 \begin_inset space \thinspace{}
4388 \change_deleted -712698321 1673089067
4390 \change_inserted 564990737 1671383236
4392 \change_deleted -712698321 1675849059
4394 \change_inserted -712698321 1675849059
4396 \change_inserted 564990737 1671383236
4398 \change_deleted -712698321 1675849095
4405 \begin_inset space \thinspace{}
4408 (Japanese Standard Class Vertical Writing)
4414 \begin_inset space \thinspace{}
4417 (Japanese Standard Class)
4423 \begin_inset space \thinspace{}
4426 (Japanese Vertical Writing)
4431 \begin_inset space \thinspace{}
4434 (Japanese Standard Class)
4436 provide document classes for the Japanese language
4437 \change_inserted 564990737 1671383236
4440 \change_inserted -712698321 1676026196
4441 A report class can be obtained by using
4444 \begin_inset space \thinspace{}
4455 Document\SpecialChar menuseparator
4456 Settings\SpecialChar menuseparator
4457 Document Class\SpecialChar menuseparator
4458 Class Options\SpecialChar menuseparator
4462 All these classes work with
4463 \begin_inset Quotes eld
4467 \begin_inset Quotes erd
4470 engines tailored for Japanese,
4472 and up\SpecialChar LaTeX
4476 \begin_layout Standard
4478 \change_inserted -712698321 1676026178
4479 For the use with the more modern Lua\SpecialChar LaTeX
4481 the collection also includes dedicated classes
4483 Japanese Article (JS Bundle for LuaTeX),
4485 \begin_inset space \thinspace{}
4488 (JS Bundle for LuaTeX)
4494 \begin_inset space \thinspace{}
4507 \change_deleted 545138413 1676132499
4508 These classes support both horizontal and vertical writing.
4509 \change_inserted -712698321 1676534250
4513 \begin_layout Standard
4515 \change_inserted -712698321 1676534251
4516 Templates for the Lua\SpecialChar LaTeX
4517 classes can be found in
4519 File\SpecialChar menuseparator
4522 in the respective category (
4541 \begin_layout Subsection
4543 \change_inserted -712698321 1675848572
4544 \begin_inset CommandInset label
4546 name "subsec:Japanese-BX"
4550 Japanese (BX Bundle)
4553 \begin_layout Standard
4555 \change_inserted -712698321 1676026685
4556 This bundle contains the document classes
4559 \begin_inset space \thinspace{}
4568 \begin_inset space \thinspace{}
4577 \begin_inset space \thinspace{}
4582 which provide alternative document classes for Japanese documents.
4586 Japanese Slides (BX Bundle)
4588 for presentation slides,
4590 As opposed to the classes of the
4600 \begin_inset CommandInset ref
4602 reference "subsec:Japanese"
4607 \begin_inset CommandInset ref
4609 reference "subsec:Japanese-JS"
4614 which support only p\SpecialChar LaTeX
4615 and up\SpecialChar LaTeX
4616 out of the box (and Lua\SpecialChar LaTeX
4617 only through the extra classes added by the
4623 the classes of this bundle also support pdf\SpecialChar LaTeX
4625 Xe\SpecialChar LaTeX
4626 and Lua\SpecialChar LaTeX
4628 with the aid of suitable packages that provide capability of Japanese typesetting.
4631 \begin_layout Subsection
4633 \change_inserted -712698321 1675850366
4634 \begin_inset CommandInset label
4636 name "subsec:Japanese-JLReq"
4640 Japanese (JLReq Class)
4643 \begin_layout Standard
4645 \change_inserted -712698321 1675850768
4646 This bundle draws on the
4650 class which faithfully traces the standard of
4652 Requirements for Japanese Text Layout
4654 set by the World Wide Web Consortium (W3C,
4656 \begin_inset Flex URL
4659 \begin_layout Plain Layout
4661 \change_inserted -712698321 1675850769
4663 https://www.w3.org/TR/jlreq/?lang=en
4671 It can be used with Lua\SpecialChar LaTeX
4672 as well as p\SpecialChar LaTeX
4673 and up\SpecialChar LaTeX
4677 \begin_layout Standard
4679 \change_inserted -712698321 1675850585
4680 LyX provides layouts for
4683 \begin_inset space \thinspace{}
4692 \begin_inset space \thinspace{}
4701 \begin_inset space \thinspace{}
4706 which are all derived from the
4711 class via specific class options.
4714 \begin_layout Standard
4716 \change_inserted -712698321 1675850701
4717 An example article document is available at
4719 File\SpecialChar menuseparator
4720 Open Example\SpecialChar menuseparator
4721 Articles\SpecialChar menuseparator
4722 Japanese Article (JLReq Class)
4725 English documentation is available at
4726 \begin_inset Flex URL
4729 \begin_layout Plain Layout
4731 \change_inserted -712698321 1675850350
4733 http://mirrors.ctan.org/macros/jptex/latex/jlreq/jlreq.pdf
4741 \change_inserted 564990737 1671383236
4745 \begin_layout Subsection
4747 \change_inserted 564990737 1672429136
4748 \begin_inset CommandInset label
4750 name "subsec:KOMA-Script"
4757 \begin_layout Standard
4759 \change_inserted 564990737 1672429136
4769 and the \SpecialChar LyX
4771 \change_deleted 564990737 1672429136
4775 \begin_layout Standard
4777 \change_deleted 564990737 1672429136
4785 \begin_layout Subsubsection
4787 \change_inserted 564990737 1672429161
4791 \begin_layout Standard
4793 \change_inserted 564990737 1672429162
4794 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
4795 it was formally launched with the addition of a letter class in 1994.
4797 a second letter class has been added.
4798 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.
4804 \begin_layout Standard
4805 The \SpecialChar LyX
4807 \change_deleted -712698321 1673089779
4810 article (koma-script)
4811 \change_inserted -712698321 1673089784
4818 \change_deleted -712698321 1673089790
4821 report (koma-script)
4822 \change_inserted -712698321 1673089794
4829 \change_deleted -712698321 1673089790
4837 \change_inserted -712698321 1673089771
4844 \change_inserted -712698321 1673089799
4848 \change_deleted -712698321 1673089802
4850 \change_inserted -712698321 1673089802
4854 \change_deleted -712698321 1673089811
4863 correspond to the \SpecialChar LaTeX
4885 \begin_inset space ~
4888 of the Koma-Script family.
4889 They are replacements for the standard document classes
4909 and fit better to European typography conventions in a number of points.
4912 \begin_layout Itemize
4914 \change_deleted 564990737 1672429262
4915 Standard character size is
4916 \change_inserted 564990737 1672429263
4917 The base character sizes when you select a KOMA-Script class are
4920 \change_deleted -712698321 1673089877
4923 article (koma-script)
4924 \change_inserted -712698321 1673089877
4931 \change_deleted -712698321 1673089886
4934 report (koma-script)
4935 \change_inserted -712698321 1673089886
4942 \change_deleted -712698321 1673089893
4946 \change_inserted -712698321 1673089893
4948 \change_deleted 564990737 1672429267
4955 \change_deleted -712698321 1673089903
4958 letter (koma-script)
4959 \change_inserted -712698321 1673089903
4967 \begin_layout Itemize
4969 labels of the description environment,
4970 and a number of elements of the
4971 \change_deleted -712698321 1673089925
4974 letter (koma-script)
4975 \change_inserted -712698321 1673089925
4980 document class are set in a bold sans serif font.
4984 \begin_layout Plain Layout
4985 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
4986 especially in the appearance of headings.
4988 the ec bold sans serif fonts look a bit thin.
4989 Here the \SpecialChar LaTeX
4998 helps to produce the
4999 \begin_inset Quotes eld
5003 \begin_inset Quotes erd
5006 appearance when using the ec fonts.
5011 The numbering of chapter headings is made in the same way as the numbering of section headings,
5012 that is without the extra line
5013 \begin_inset Quotes eld
5016 Chapter\SpecialChar ldots
5018 \begin_inset Quotes erd
5023 the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
5024 to be entered in the field
5027 \begin_inset space ~
5034 Layout\SpecialChar menuseparator
5041 \begin_layout Itemize
5043 \change_deleted 564990737 1672429310
5044 The main means in the Koma-Script document classes to design the type area are the options
5052 (in \SpecialChar LyX
5053 to be entered in the extra class options field in the dialog
5055 Document\SpecialChar menuseparator
5059 They make a clearer modification of page margins possible as do the options of the dialog
5061 Document\SpecialChar menuseparator
5066 \change_inserted 564990737 1672429310
5067 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.
5068 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.
5069 You can change the sizes of the margins by changing the factor by which the page is divided into strips;
5070 the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
5075 \begin_layout Standard
5077 \change_inserted 564990737 1672429310
5078 Whatever the factor,
5079 two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
5080 leaving a text area occupying around half the page.
5081 Since most two-sided documents have a binding,
5082 this can make the inner margins appear too narrow;
5083 so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
5087 \begin_layout Standard
5089 \change_inserted 564990737 1672429310
5090 The main means in the Koma-Script document classes to design the type area are the options
5100 Document\SpecialChar menuseparator
5101 Settings\SpecialChar menuseparator
5102 Document Class\SpecialChar menuseparator
5103 Class Options\SpecialChar menuseparator
5110 \begin_layout Standard
5112 \change_inserted 564990737 1672429310
5114 the binding correction is 7.5mm which is added in the form
5121 \begin_inset space ~
5124 options\SpecialChar menuseparator
5132 To change the factor to 11,
5138 to the comma separated list of entries in the
5149 \begin_inset space ~
5155 If you want the default value of this factor for a page size other than A4,
5163 \begin_layout Standard
5165 \change_inserted 564990737 1672429310
5166 To use the circle method of calculating the page layout,
5177 \begin_layout Itemize
5178 The \SpecialChar LaTeX
5179 document classes of the Koma-Script family define a number of additional commands.
5180 Those part of it which makes sense in \SpecialChar LyX
5181 is implemented in corresponding paragraph types.
5184 \begin_layout Standard
5185 Detailed descriptions of the \SpecialChar LaTeX
5186 document classes of the Koma-Script family can be found in the Koma-Script documentation
5197 \begin_layout Subsubsection
5199 \change_inserted 564990737 1672429358
5202 \begin_inset CommandInset label
5204 name "subsec:article-(KOMA-Script),-report"
5209 \change_deleted -712698321 1673090826
5212 article (KOMA-Script)
5213 \change_inserted -712698321 1673090826
5217 \change_inserted 564990737 1672429358
5222 \change_deleted -712698321 1673090830
5223 report (KOMA-Script)
5224 \change_inserted -712698321 1673090840
5228 \change_inserted 564990737 1672429358
5233 \change_deleted -712698321 1673090835
5235 \change_inserted -712698321 1673090844
5239 \change_deleted 564990737 1672429367
5242 article (koma-script),
5243 report (koma-script),
5244 and book (koma-script)
5249 \begin_layout Standard
5250 The document classes
5251 \change_deleted -712698321 1673090858
5254 article (koma-script)
5255 \change_inserted -712698321 1673090858
5262 \change_deleted -712698321 1673090862
5265 report (koma-script)
5266 \change_inserted -712698321 1673090869
5273 \change_deleted -712698321 1673090866
5281 \change_inserted -712698321 1673090874
5286 are implemented in the layout files
5302 They contain all the paragraph types of the corresponding standard document classes
5319 with the exception of the \SpecialChar LyX
5325 which is replaced by the new
5329 -type having the same functionality.
5334 -Type there is a number of new paragraph types added.
5341 letter (koma-script)
5346 \begin_layout Itemize
5369 additionally inserting an entry in the table of contents.
5378 are not contained in
5380 article (koma-script)
5385 \begin_layout Itemize
5406 additionally clearing running heads.
5413 article (koma-script)
5419 \begin_layout Plain Layout
5432 report (koma-script)
5435 but since this is identical to
5440 is has not been implemented in \SpecialChar LyX
5449 \begin_layout Itemize
5455 generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
5458 \begin_layout Itemize
5467 are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
5468 you might want to place table captions always above the table).
5469 You can also use the class option
5487 You need at least Koma-Script version 2.8q to use this.
5490 \begin_layout Itemize
5496 can be used to set a bonmot,
5498 \begin_inset space \thinspace{}
5502 \begin_inset space \space{}
5505 at the beginning of a chapter.
5506 If you use the optional argument (
5508 Insert\SpecialChar menuseparator
5510 \begin_inset space ~
5516 you can insert the dictum's author there.
5517 Dictum and author are separated by a line.
5518 You need at least Koma-Script version 2.8q to use this.
5525 article (koma-script)
5530 \begin_layout Standard
5531 The following types,
5532 together with the standard types
5547 form the title area of the document.
5548 They must be entered ahead of the first
5549 \begin_inset Quotes eld
5553 \begin_inset Quotes erd
5560 \begin_layout Plain Layout
5561 The corresponding \SpecialChar LaTeX
5562 commands must appear before the
5573 When such a type is used more than once,
5574 the latter usage overwrites the former one,
5576 for every type only the latest usage is valid.
5577 The order of the different types however has,
5593 no effect on the appearance of the produced document.
5596 \begin_layout Itemize
5602 produces a centered paragraph above the ordinary title (
5616 ) for the subject of the document.
5619 \begin_layout Itemize
5625 produces a centered paragraph below the ordinary title (
5639 ) for the publishers' name.
5642 \begin_layout Itemize
5650 report (koma-script)
5656 produces a centered paragraph on its own page behind the title page,
5659 article (koma-script)
5661 produces a centered paragraph below the ordinary title (
5683 \begin_layout Itemize
5689 produces a left aligned paragraph above the ordinary title (
5708 ) for a document`s head.
5711 \begin_layout Itemize
5717 produces in a double-sided print in
5719 report (koma-script)
5725 a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
5727 article (koma-script)
5732 \begin_layout Itemize
5738 produces in a double-sided print in
5740 report (koma-script)
5746 a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
5748 article (koma-script)
5753 \begin_layout Itemize
5760 \begin_inset Quotes eld
5764 \begin_inset Quotes erd
5767 page ahead of the actual document containing a paragraph without special formatting.
5770 \begin_layout Standard
5772 \change_inserted 564990737 1672429680
5773 KOMA-Script offers a wide range of
5780 \begin_inset space ~
5790 ocument\SpecialChar menuseparator
5795 ettings\SpecialChar menuseparator
5797 \begin_inset space ~
5802 dialog which you can apply to the whole document,
5806 \begin_layout Description
5808 \change_inserted 564990737 1672429680
5815 which produces a PDF with a small black box at the end any line in which a formatting error occurs;
5816 the default setting is
5821 \begin_layout Description
5823 \change_inserted 564990737 1672429680
5830 which may take the values
5844 the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
5847 \begin_layout Description
5849 \change_inserted 564990737 1672429680
5856 which may take the values
5870 the first leaves it up to KOMA-Script to add periods after chapter,
5873 the second forces the addition of periods and third suppresses them
5876 \begin_layout Standard
5878 \change_inserted 564990737 1672429680
5879 and the math options:
5882 \begin_layout Description
5884 \change_inserted 564990737 1672429680
5891 which causes equations to be numbered on the left rather than on the right,
5895 \begin_layout Description
5897 \change_inserted 564990737 1672429680
5904 which causes equations to be left justified rather than centered.
5907 \begin_layout Standard
5909 \change_inserted 564990737 1672429680
5910 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
5911 commands and packages;
5913 if you want your captions in bold add
5916 \begin_layout Standard
5918 \change_inserted 564990737 1672429680
5923 setkomafont{captionlabel}{
5928 \begin_layout Standard
5930 \change_inserted 564990737 1672429680
5936 ocument\SpecialChar menuseparator
5943 \SpecialChar menuseparator
5948 \begin_inset space ~
5953 ) and the problem is solved.
5956 \begin_layout Standard
5958 \change_inserted 564990737 1672429680
5959 If you are writing a book,
5960 it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
5961 If you use the Chapter* environment,
5962 your Foreword and Preface will not appear in the Table of Contents;
5963 to make them to appear in the Table of contents,
5964 you need to use Chapter environments and add the \SpecialChar TeX
5968 \begin_layout Standard
5970 \change_inserted 564990737 1672429680
5978 \begin_layout Standard
5980 \change_inserted 564990737 1672429680
5981 at the very start of the book (not in the \SpecialChar LaTeX
5985 \begin_layout Standard
5987 \change_inserted 564990737 1672429680
5995 \begin_layout Standard
5997 \change_inserted 564990737 1672429680
5998 before the first chapter of the body of the text.
6000 \change_inserted -712698321 1673092640
6009 \begin_layout Standard
6011 \change_inserted 564990737 1672429680
6012 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
6017 \begin_layout Plain Layout
6019 \change_inserted 564990737 1672429680
6020 Appendices are normally “numbered” with letters.
6025 If you use the Chapter* environment,
6026 they will not appear in the Table of Contents;
6027 so add the \SpecialChar TeX
6031 \begin_layout Standard
6033 \change_inserted 564990737 1672429680
6041 \begin_layout Standard
6043 \change_inserted 564990737 1672429682
6044 before the first of these headings and use the Chapter environment.
6045 These commands will have no effect on the numbering in \SpecialChar LyX
6047 only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
6050 \begin_layout Standard
6051 The layout files for the document classes
6053 article (koma-script)
6058 report (koma-script)
6070 This is thought of as a place to define your own types.
6075 in your personal layout directory and edit the file!
6076 \change_deleted 564990737 1672430255
6080 \begin_layout Standard
6082 \change_deleted 564990737 1672430255
6083 letter (koma-script)
6086 \begin_layout Description
6088 \change_deleted 564990737 1672429749
6090 This section discusses the obsolete
6092 KOMA-Script-Letter (v.
6093 \begin_inset space ~
6099 which is not even included anymore in recent KOMA releases.
6100 Please refer to the next section for the current KOMA-Script-Letter class (v.
6101 \begin_inset space ~
6107 \begin_layout Standard
6110 \change_deleted 564990737 1672429749
6113 letter (koma-script)
6115 is implemented in the layout file
6120 It contains all the paragraph types of the corresponding standard document class
6126 with the exception of the \SpecialChar LyX
6141 which is replaced by the new
6148 in contrast to the standard document class,
6171 there are a number of new letter specific types.
6174 \begin_layout Standard
6176 \change_deleted 564990737 1672429749
6177 The appearance of the letter produced by this document class can be controlled by a number of \SpecialChar LaTeX
6179 which you can put in the \SpecialChar LaTeX
6184 \begin_layout Plain Layout
6186 the standard appearance of the letter`s heading,
6187 consisting of name and address,
6188 is quite self-willed.
6190 \begin_inset Quotes eld
6194 \begin_inset Quotes erd
6197 heading is produced by the following \SpecialChar LaTeX
6198 commands in the preamble:
6201 \begin_layout LyX-Code
6211 \begin_layout LyX-Code
6227 \begin_layout LyX-Code
6237 \begin_layout LyX-Code
6257 A detailed German description of such \SpecialChar LaTeX
6258 commands can be found in the Koma-Script documentation
6264 the letter's author can produce his personal letter layout.
6267 \begin_layout Standard
6269 \change_deleted 564990737 1672429749
6278 define the beginning of the letter and must be used in every letter.
6279 To emphasize them in the \SpecialChar LyX
6281 they are marked with the letter
6291 \begin_inset space ~
6295 It is possible to write any number of letters in one file.
6300 type produces a new letter using the same addressee and a
6304 type produces a new addressee.
6324 are ordinary paragraph types and can also be used several times in one and the same letter.
6327 \begin_layout Itemize
6329 \change_deleted 564990737 1672429749
6335 produces a paragraph for the addressee and implicitly defines the beginning of the letter.
6338 \begin_layout Itemize
6340 \change_deleted 564990737 1672429749
6346 produces a paragraph for the form of address and implicitly produces a new letter.
6349 \begin_layout Itemize
6351 \change_deleted 564990737 1672429749
6357 produces a paragraph for a close.
6360 \begin_layout Itemize
6362 \change_deleted 564990737 1672429749
6368 produces a paragraph for a postscript.
6371 \begin_layout Itemize
6373 \change_deleted 564990737 1672429749
6379 produces a paragraph for a distribution list.
6382 \begin_layout Itemize
6384 \change_deleted 564990737 1672429749
6390 produces a paragraph for enclosures.
6393 \begin_layout Standard
6395 \change_deleted 564990737 1672429749
6445 are input types provided with a label to enter information,
6446 which will be processed by the document class.
6450 \begin_layout Plain Layout
6451 It could be seen as a matter of inconsequence,
6460 described above are not such input types as well.
6461 Because of the special meaning of those types,
6463 I have implemented them as ordinary paragraph types with a one letter mark in the left margin.
6465 it would affect my feeling of symmetry,
6474 type had such a serious different appearance.
6479 The types must be used ahead of the corresponding
6486 \begin_layout Standard
6488 \change_deleted 564990737 1672429749
6489 An implementation of these types in a WYSIWYG fashion does not seem to make sense,
6490 because the real appearance of the produced letter does not only depend on the usage of the particular type,
6491 but also on other factors.
6493 a signature entered in the
6497 type will in the standard behavior appear in the produced letter only,
6498 when in the same letter also a
6503 The entered value of the
6507 type will in the standard behavior not appear in the produced letter at all.
6508 The possibility to design the letter`s heading freely is already indicated in a footnote above.
6511 \begin_layout Standard
6513 \change_deleted 564990737 1672429749
6514 The input types can also be used as empty paragraphs.
6516 \begin_inset space \thinspace{}
6520 \begin_inset space \space{}
6532 type is not used at all,
6533 in the standard behavior the value of the
6537 type is used as signature,
6543 no signature value is defined.
6546 \begin_layout Standard
6548 \change_deleted 564990737 1672429749
6549 By using the input types it is possible to write a letter template,
6550 containing filled input types with your personal dates (name,
6552 etc.) and empty input types for other dates you want to enter.
6555 \begin_layout Itemize
6557 \change_deleted 564990737 1672429749
6564 in the standard behavior appears as a centered paragraph in small caps in the letter`s heading.
6567 \begin_layout Itemize
6569 \change_deleted 564990737 1672429749
6576 in the standard behavior appears below the
6590 type appears instead.
6593 \begin_layout Itemize
6595 \change_deleted 564990737 1672429749
6602 in the standard behavior appears in a centered paragraph in the letter`s heading below the sender's name.
6605 \begin_layout Itemize
6607 \change_deleted 564990737 1672429749
6613 sender's telephone number,
6614 in the standard behavior only sets the \SpecialChar LaTeX
6624 \begin_layout Itemize
6626 \change_deleted 564990737 1672429749
6632 place of the letter`s making.
6635 \begin_layout Itemize
6637 \change_deleted 564990737 1672429749
6643 date of the letter`s making.
6653 in the standard behavior,
6654 produce the place and the date in a right-aligned line below the addressee's field.
6660 neither place nor date appear,
6661 independent of the value of the
6671 the date of the letter `s production is used.
6674 \begin_layout Itemize
6676 \change_deleted 564990737 1672429749
6682 sender`s back address,
6683 in the standard behavior appears above the addressee's field in a small sans serif font.
6686 \begin_layout Itemize
6688 \change_deleted 564990737 1672429749
6694 special mail information,
6695 in the standard behavior appears underlined above the addressee's field below the back address.
6698 \begin_layout Itemize
6700 \change_deleted 564990737 1672429749
6706 additional information,
6707 in the standard behavior appears on right side below the addressee`s field.
6710 \begin_layout Itemize
6712 \change_deleted 564990737 1672429749
6719 in the standard behavior appears in a big,
6721 sans serif font above the subject.
6724 \begin_layout Itemize
6726 \change_deleted 564990737 1672429749
6732 the letter's subject,
6733 in the standard behavior appears in a bold font above the
6740 \begin_layout Standard
6742 \change_deleted 564990737 1672429749
6767 produce a business letter like line above the
6771 line containing the fields
6772 \begin_inset Quotes eld
6776 \begin_inset Quotes erd
6781 \begin_inset Quotes eld
6785 \begin_inset Quotes erd
6790 \begin_inset Quotes eld
6794 \begin_inset Quotes erd
6799 \begin_inset Quotes eld
6803 \begin_inset Quotes erd
6808 \begin_inset Quotes eld
6812 \begin_inset Quotes erd
6817 \begin_inset Quotes eld
6821 \begin_inset Quotes erd
6832 \begin_inset Quotes eld
6835 business letter types
6836 \begin_inset Quotes erd
6844 type however does not appear,
6845 but only the \SpecialChar LaTeX
6853 The ordinary output of place and date in a right-aligned line below the addressee`s field is suppressed.
6854 The types are implemented as input types provided with a label and must be used ahead of the corresponding
6861 \begin_layout Itemize
6863 \change_deleted 564990737 1672429749
6872 \begin_layout Itemize
6874 \change_deleted 564990737 1672429749
6883 \begin_layout Itemize
6885 \change_deleted 564990737 1672429749
6894 \begin_layout Itemize
6896 \change_deleted 564990737 1672429749
6905 \begin_layout Itemize
6907 \change_deleted 564990737 1672429749
6918 \begin_layout Subsubsection
6920 \change_deleted 564990737 1672429773
6921 The new letter class:
6922 letter (koma-script v.2)
6923 \change_inserted 564990737 1672429774
6925 \begin_inset CommandInset label
6927 name "subsec:The-new-letter"
6931 The new letter class:
6933 \change_inserted -712698321 1673092709
6935 \change_deleted -712698321 1673092710
6937 \change_inserted -712698321 1673092710
6939 \change_inserted 564990737 1672429774
6941 \change_deleted -712698321 1673092713
6943 \change_inserted -712698321 1673092714
6945 \change_inserted 564990737 1672429774
6948 \change_inserted -712698321 1673092715
6950 \change_inserted 564990737 1672429774
6956 \begin_layout Standard
6962 \begin_layout Standard
6963 \begin_inset VSpace medskip
6969 \begin_layout Standard
6971 Koma-Script version 2.8 has introduced a new letter class
6975 which supersedes the now unsupported
6981 on the \SpecialChar LaTeX
6983 a completely new interface and is not compatible with the old class.
6987 though it is recommended you use the new class.
6990 \begin_layout Standard
6991 This class covers the same functionality as
6993 letter (koma-script),
7001 (receiver's address,
7021 will start a new letter (i.
7022 \begin_inset space \thinspace{}
7026 \begin_inset space \space{}
7029 you can write several letters per document).
7030 New elements are sender's
7049 and the possibility to use a
7055 Insert\SpecialChar menuseparator
7061 \begin_layout Standard
7062 The biggest improvement is,
7064 that the letter's layout is configurable to meet almost any needs.
7065 This can be done via the preamble or with a special style file (Letter Class Option,
7071 that will be read in as a class option.
7075 \begin_layout Plain Layout
7076 The KOMA package comes with some default
7087 file that follows german typesetting rules,
7092 that provides the default layout of the old
7097 The latter can be loaded with the class option
7104 Layout\SpecialChar menuseparator
7105 Document\SpecialChar menuseparator
7114 \change_deleted 564990737 1671617922
7122 \change_deleted 564990737 1671617938
7123 that is included in \SpecialChar LyX
7125 \change_inserted 564990737 1671617997
7131 ile\SpecialChar menuseparator
7133 \begin_inset space ~
7141 \begin_inset space ~
7144 Template\SpecialChar menuseparator
7145 Letters\SpecialChar menuseparator
7146 KOMA-Script Letter (V.2)
7151 A detailed description is to be found in the Koma-Script documentation (
7158 \begin_layout Subsubsection
7162 \begin_layout Standard
7163 Visualizing the Koma-Script document classes in \SpecialChar LyX
7165 the \SpecialChar LyX
7166 internals cause some problems.
7169 \begin_layout Itemize
7170 The chapter number of a
7174 type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
7175 The cause for that is the \SpecialChar LyX
7176 internal behavior for the labeltype
7183 \begin_layout Itemize
7184 The headings of the types
7193 \begin_inset Quotes eld
7197 \begin_inset Quotes erd
7202 but not in the \SpecialChar LyX
7205 Document\SpecialChar menuseparator
7207 \begin_inset space ~
7211 \begin_inset space ~
7219 \begin_layout Itemize
7224 document class appear in a skip separation mode,
7226 This is the standard behavior,
7227 no special \SpecialChar LaTeX
7228 commands are needed for that.
7231 Document\SpecialChar menuseparator
7234 dialog the corresponding radio button indicates
7243 value always has the effect that extra \SpecialChar LaTeX
7244 commands are inserted in the document to produce the gap,
7245 which is not what is wanted in this case.
7248 \begin_layout Subsection
7250 \change_inserted 564990737 1672743555
7251 \begin_inset CommandInset label
7253 name "subsec:Polish-M.W.collection"
7258 \begin_inset space \thinspace{}
7262 \begin_inset space \space{}
7266 \change_deleted 564990737 1670924933
7268 book (mwbk) and report (mwrep)
7269 \begin_inset Argument status
7272 \begin_layout Plain Layout
7287 \begin_layout Standard
7293 \begin_layout Standard
7294 The \SpecialChar LyX
7296 \change_deleted -712698321 1673094342
7300 \change_inserted -712698321 1673094343
7301 Polish Article (MW Bundle)
7307 \change_deleted -712698321 1673094349
7311 \change_inserted -712698321 1673094356
7312 Polish Report (MW Bundle)
7317 \change_deleted -712698321 1673094352
7325 \change_inserted -712698321 1673094359
7326 Polish Book (MW Bundle)
7330 correspond to the \SpecialChar LaTeX
7346 They are replacements for the standard document classes
7361 and fit better to Polish typography conventions in a number of points.
7365 \begin_layout Standard
7369 \begin_layout Itemize
7370 Unnumbered titles (with star,
7372 \begin_inset space \thinspace{}
7376 \begin_inset space \space{}
7383 ) are added into table of contents,
7386 \begin_layout Itemize
7387 Additional page styles:
7391 \begin_layout Description
7392 uheadings header with separated lines,
7395 \begin_layout Description
7396 myheadings custom header,
7397 contents headers via commands:
7413 \begin_layout Description
7414 myuheadings custom header with separated lines,
7417 \begin_layout Description
7418 outer page number is placed on outer side of page
7422 \begin_layout Itemize
7427 \begin_layout Description
7428 rmheadings serif titles —
7432 \begin_layout Description
7433 sfheadings sansserif titles,
7436 \begin_layout Description
7437 authortitle on title page first placed is author next title —
7441 \begin_layout Description
7442 titleauthor on title page first placed is title next author,
7445 \begin_layout Description
7446 withmarginpar reserve place on page for margins.
7450 \begin_layout Subsection
7452 \change_inserted 564990737 1672652245
7456 \begin_layout Standard
7458 \change_inserted 564990737 1672652245
7459 The document classes
7460 \change_deleted -712698321 1673094404
7464 \begin_inset space \thinspace{}
7468 \change_inserted -712698321 1673094404
7470 \change_inserted 564990737 1672652245
7474 \change_deleted -712698321 1673094408
7478 \begin_inset space \thinspace{}
7482 \change_inserted -712698321 1673094411
7484 \change_inserted 564990737 1672652245
7496 Detailed information about these document classes can be found in
7498 File\SpecialChar menuseparator
7499 Open Example\SpecialChar menuseparator
7500 Books\SpecialChar menuseparator
7505 File\SpecialChar menuseparator
7506 Open Example\SpecialChar menuseparator
7507 Handouts\SpecialChar menuseparator
7513 \begin_layout Section
7515 \change_inserted 564990737 1670439534
7519 \begin_layout Standard
7521 \change_inserted 564990737 1670794710
7522 See also the document classes in the Collections (section
7523 \begin_inset space ~
7527 \begin_inset CommandInset ref
7529 reference "sec:Collections"
7537 \begin_layout Subsection
7539 \change_deleted -712698321 1673095198
7541 \change_inserted -712698321 1673095198
7542 Astronomy & Astrophysics
7543 \change_inserted 564990737 1670794716
7547 \begin_layout Standard
7549 \change_inserted 564990737 1670794716
7555 updated by the \SpecialChar LyX
7559 \begin_layout Subsubsection
7561 \change_inserted 564990737 1670794716
7565 \begin_layout Standard
7567 \change_inserted 564990737 1670794716
7568 This section describes how \SpecialChar LyX
7569 can be used to write articles for submission to the scientific journal
7572 \change_deleted -712698321 1673095254
7574 \change_inserted -712698321 1673095254
7576 \change_inserted 564990737 1670794716
7580 \begin_inset CommandInset href
7583 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
7588 ) using Version 9.1 of the document class
7593 information about it is available at
7594 \begin_inset Flex URL
7597 \begin_layout Plain Layout
7599 \change_inserted 564990737 1670794716
7601 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
7611 \begin_layout Standard
7613 \change_inserted 564990737 1670794716
7614 A manual comes together with the package and should be consulted before installing this document class as described in the
7616 Installing New Document Classe
7626 \begin_layout Standard
7628 \change_inserted 564990737 1670794716
7629 \begin_inset Note Greyedout
7632 \begin_layout Plain Layout
7634 \change_inserted 564990737 1670794716
7635 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
7637 That change also involved some slight changes to the style files,
7638 namely the removal of the thesaurus command.
7639 If you have an older version installed,
7641 For information about compatibility with the old (version 4) layout,
7642 please refer to the comments in
7645 Dir/layouts/aapaper.layout
7655 \begin_layout Subsubsection
7657 \change_inserted 564990737 1670794716
7661 \begin_layout Standard
7663 \change_inserted 564990737 1671617129
7664 It is recommended you start from the template in the menu
7669 ile\SpecialChar menuseparator
7671 \begin_inset space ~
7679 \begin_inset space ~
7682 Template\SpecialChar menuseparator
7683 Articles\SpecialChar menuseparator
7684 Astronomy & Astrophysics
7687 If you are not using the template,
7688 note the following settings:
7691 \begin_layout Itemize
7693 \change_inserted 564990737 1670794716
7695 \change_deleted -712698321 1673095619
7699 \change_inserted -712698321 1673095619
7700 Astronomy & Astrophysics
7701 \change_inserted 564990737 1670794716
7709 ocument\SpecialChar menuseparator
7714 ettings\SpecialChar menuseparator
7716 \begin_inset space ~
7722 that one was obvious).
7725 \begin_layout Itemize
7727 \change_inserted 564990737 1670794716
7731 \begin_inset space ~
7743 \begin_inset space ~
7754 The whole layout is done by the macros,
7755 you shouldn't change anything.
7758 \begin_layout Subsubsection
7760 \change_inserted 564990737 1670794716
7764 \begin_layout Standard
7766 \change_inserted 564990737 1670794716
7767 First thing to enter is the header information.
7769 \change_deleted -712698321 1673167006
7771 \change_inserted -712698321 1673167007
7773 \change_inserted 564990737 1670794716
7775 of which one is optional.
7779 \begin_layout Itemize
7781 \change_inserted 564990737 1670794716
7790 \begin_layout Itemize
7792 \change_inserted 564990737 1670794716
7801 \begin_layout Itemize
7803 \change_inserted 564990737 1670794716
7812 \begin_layout Itemize
7814 \change_deleted -712698321 1673167065
7818 \change_inserted -712698321 1673167065
7820 \change_inserted 564990737 1670794716
7825 \change_inserted -712698321 1673167087
7829 \begin_layout Itemize
7831 \change_inserted -712698321 1673168577
7837 Determines to whom correspondence and reprints are to be sent.
7840 \begin_layout Itemize
7842 \change_inserted -712698321 1673168590
7847 [optional] Snail mail address for contacts.
7848 \change_inserted 564990737 1670794716
7852 \begin_layout Itemize
7854 \change_inserted 564990737 1670794716
7868 \begin_layout Standard
7870 \change_inserted -712698321 1673168612
7871 There is no need to issue the
7878 this is done automatically by \SpecialChar LyX
7879 when the header is finished.
7881 \change_inserted 564990737 1670794716
7882 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
7883 just to get the best optics and meets the layout of the real document.
7886 \begin_layout Standard
7888 \change_inserted 564990737 1670794716
7889 If you want to place footnotes in the header block,
7891 \begin_inset space \thinspace{}
7895 \begin_inset space \space{}
7898 to state your present address,
7899 just use the standard footnote via the menu
7904 nsert\SpecialChar menuseparator
7913 will automagically use the term
7920 \change_inserted -712698321 1673168649
7924 \begin_layout Standard
7926 \change_inserted -712698321 1673168649
7929 Edit\SpecialChar menuseparator
7933 you'll find two insets which are relevant for the titling:
7936 \begin_layout Itemize
7938 \change_inserted -712698321 1673168649
7945 to mark corresponding author\SpecialChar breakableslash
7947 The institutes are numbered sequentially as they appear in the
7952 so you have to put a marker to each author.
7955 \begin_layout Itemize
7957 \change_inserted -712698321 1673168649
7962 to supply an email address for fast contact.
7963 \change_inserted 564990737 1670794716
7967 \begin_layout Standard
7969 \change_inserted 564990737 1670794716
7970 In addition to these topics,
7971 the macros use three additional \SpecialChar LaTeX
7972 commands that have no counterpart in \SpecialChar LyX
7976 \begin_layout Itemize
7978 \change_inserted 564990737 1670794716
7985 to separate different names for more than one author and institute,
7989 \begin_layout Itemize
7991 \change_deleted -712698321 1673168671
7998 to mark corresponding author/institute pairs.
7999 The institutes are numbered sequentially as they appear in the
8004 so you have to put a marker to each author.
8007 \begin_layout Itemize
8009 \change_deleted -712698321 1673168671
8016 to supply an email address for fast contact.
8017 \change_inserted 564990737 1670794716
8021 \begin_layout Standard
8023 \change_deleted -712698321 1673168684
8026 \change_inserted -712698321 1673168684
8028 \change_inserted 564990737 1671642374
8029 he appropriate command has to be entered as \SpecialChar TeX
8030 code in \SpecialChar LyX
8032 See the examples in the template and in
8034 File\SpecialChar menuseparator
8035 Open Example\SpecialChar menuseparator
8036 Articles\SpecialChar menuseparator
8037 Astronomy & Astrophysics
8044 \begin_layout Subsubsection
8046 \change_inserted 564990737 1670794716
8050 \begin_layout Standard
8052 \change_inserted -712698321 1673168754
8053 The abstract should immediately follow the header block.
8054 With version 5 the abstract environment was changed to a command,
8055 and there is now a restriction to only one paragraph.
8057 it should contain an entry with the keywords.
8058 This is done via the paragraph style
8063 Refer to the example paper.
8064 \change_deleted -712698321 1673168754
8065 The abstract should immediately follow the header block and must contain five tokens:
8075 \begin_layout Enumerate
8077 \change_deleted -712698321 1673168754
8082 (optional) {} leave it empty if necessary
8085 \begin_layout Enumerate
8087 \change_deleted -712698321 1673168754
8095 \begin_layout Enumerate
8097 \change_deleted -712698321 1673168754
8105 \begin_layout Enumerate
8107 \change_deleted -712698321 1673168754
8115 \begin_layout Enumerate
8117 \change_deleted -712698321 1673168754
8122 (optional) {} leave it empty if necessary
8125 \begin_layout Standard
8127 \change_deleted -712698321 1673168754
8129 This structure not shown in
8134 \change_inserted 564990737 1670794716
8138 \begin_layout Subsubsection
8140 \change_inserted 564990737 1670794716
8141 Supported environments
8144 \begin_layout Standard
8146 \change_inserted 564990737 1670794716
8147 The A&A paper layout supports the following environments for structuring your text:
8150 \begin_layout Standard
8152 \change_inserted -712698321 1673169058
8155 \begin_inset Flex Multiple Columns
8158 \begin_layout Itemize
8160 \change_inserted -712698321 1673169058
8166 \begin_layout Itemize
8168 \change_inserted -712698321 1673169058
8174 \begin_layout Itemize
8176 \change_inserted -712698321 1673169058
8182 \begin_layout Itemize
8184 \change_inserted -712698321 1673169058
8190 \begin_layout Itemize
8192 \change_inserted -712698321 1673169058
8198 \begin_layout Itemize
8200 \change_inserted -712698321 1673169058
8206 \begin_layout Itemize
8208 \change_inserted -712698321 1673169058
8214 \begin_layout Itemize
8216 \change_inserted -712698321 1673169058
8222 \begin_layout Itemize
8224 \change_inserted -712698321 1673169058
8230 \begin_layout Itemize
8232 \change_inserted -712698321 1673169058
8238 \begin_layout Itemize
8240 \change_inserted -712698321 1673169058
8246 \begin_layout Itemize
8248 \change_inserted -712698321 1673169078
8257 \change_deleted -712698321 1673169058
8261 \begin_layout Itemize
8263 \change_deleted -712698321 1673169058
8269 \begin_layout Itemize
8271 \change_deleted -712698321 1673169058
8277 \begin_layout Itemize
8279 \change_deleted -712698321 1673169058
8285 \begin_layout Itemize
8287 \change_deleted -712698321 1673169058
8293 \begin_layout Itemize
8295 \change_deleted -712698321 1673169058
8301 \begin_layout Itemize
8303 \change_deleted -712698321 1673169058
8309 \begin_layout Itemize
8311 \change_deleted -712698321 1673169058
8317 \begin_layout Itemize
8319 \change_deleted -712698321 1673169058
8325 \begin_layout Itemize
8327 \change_deleted -712698321 1673169058
8333 \begin_layout Itemize
8335 \change_deleted -712698321 1673169058
8341 \begin_layout Itemize
8343 \change_deleted -712698321 1673169058
8348 \change_inserted 564990737 1670794716
8352 \begin_layout Subsubsection
8354 \change_inserted 564990737 1670794716
8355 Commands not supported by \SpecialChar LyX
8359 \begin_layout Standard
8361 \change_inserted 564990737 1670794716
8362 Some commands are not yet supported by the
8363 \change_deleted -712698321 1673169117
8367 \change_inserted -712698321 1673169117
8368 Astronomy & Astrophysics
8369 \change_inserted 564990737 1670794716
8372 layout for \SpecialChar LyX
8374 Some have already been mentioned.
8375 For the sake of completeness,
8376 they are listed all together here:
8379 \begin_layout Itemize
8381 \change_inserted 564990737 1670794716
8389 \begin_layout Itemize
8391 \change_inserted -712698321 1673168793
8399 \begin_layout Itemize
8401 \change_inserted -712698321 1673168793
8409 \begin_layout Itemize
8411 \change_inserted -712698321 1673168793
8417 \change_deleted -712698321 1673168793
8423 \begin_layout Itemize
8425 \change_deleted -712698321 1673168793
8433 \begin_layout Itemize
8435 \change_deleted -712698321 1673168793
8443 \begin_layout Itemize
8445 \change_deleted -712698321 1673168793
8451 \change_inserted 564990737 1670794716
8455 \begin_layout Standard
8457 \change_inserted 564990737 1670794716
8458 If you want to use any of these commands,
8459 you have to enter them yourself.
8460 Do not forget to use
8466 nsert\SpecialChar menuseparator
8469 \begin_inset space ~
8477 \begin_layout Subsubsection
8479 \change_inserted 564990737 1670794716
8480 Figure and Table Floats
8483 \begin_layout Standard
8485 \change_inserted 564990737 1670794716
8487 provides support for the necessary float environments
8498 therefore we won't tell much about it here.
8502 \begin_inset space ~
8508 Just remember that tables should be left-aligned.
8510 select the table and change the alignment in
8515 dit\SpecialChar menuseparator
8521 \begin_inset space ~
8525 \change_inserted -712698321 1673169201
8531 arg "layout-paragraph"
8535 \change_inserted 564990737 1670794716
8541 \begin_layout Standard
8543 \change_inserted 564990737 1670794716
8544 There is only one special thing:
8545 the figures with a caption beside the figure.
8546 To create such a figure,
8547 you have to do the following:
8550 \begin_layout Enumerate
8552 \change_inserted 564990737 1670794716
8553 Create a wide figure float:
8559 nsert\SpecialChar menuseparator
8564 t\SpecialChar menuseparator
8569 from within the float,
8575 dit\SpecialChar menuseparator
8581 \begin_inset space ~
8592 \begin_inset space ~
8604 \begin_layout Enumerate
8606 \change_inserted 564990737 1670794716
8607 Enter your caption text.
8610 \begin_layout Enumerate
8612 \change_inserted 564990737 1670794716
8617 to move the cursor above the caption.
8620 \begin_layout Enumerate
8622 \change_inserted 564990737 1670794716
8626 \begin_layout Enumerate
8628 \change_inserted 564990737 1670794716
8629 Position the cursor after the figure and insert a horizontal fill by using the menu:
8635 nsert\SpecialChar menuseparator
8640 rmatting\SpecialChar menuseparator
8646 \begin_inset space ~
8655 dialog and select the
8667 \change_deleted -712698321 1673169720
8669 \change_inserted -712698321 1673169724
8671 \change_inserted 564990737 1670794716
8675 \begin_layout Enumerate
8677 \change_inserted 564990737 1670794716
8678 Switch to \SpecialChar LaTeX
8683 \begin_inset space ~
8691 \begin_layout Enumerate
8693 \change_inserted 564990737 1670794716
8702 Do not close the brace!
8705 \begin_layout Enumerate
8707 \change_inserted 564990737 1670794716
8708 Position the cursor behind the caption text,
8709 switch to \SpecialChar LaTeX
8710 mode and insert the closing brace:
8714 \begin_inset space ~
8726 \begin_layout Standard
8728 \change_inserted 564990737 1671642458
8730 refer to the figures in the file in
8732 File\SpecialChar menuseparator
8733 Open Example\SpecialChar menuseparator
8734 Articles\SpecialChar menuseparator
8735 Astronomy & Astrophysics
8740 \begin_layout Subsubsection
8742 \change_inserted 564990737 1670794716
8746 \begin_layout Standard
8748 \change_inserted 564990737 1670794716
8750 the paper has to be formatted in a special double-spacing layout.
8752 you have to add the option
8763 \begin_inset space ~
8773 ocument\SpecialChar menuseparator
8778 ettings\SpecialChar menuseparator
8780 \begin_inset space ~
8789 \begin_layout Subsubsection
8791 \change_inserted 564990737 1670794716
8795 \begin_layout Standard
8797 \change_inserted 564990737 1671642520
8800 File\SpecialChar menuseparator
8801 Open Example\SpecialChar menuseparator
8802 Articles\SpecialChar menuseparator
8803 Astronomy & Astrophysics
8805 was written with \SpecialChar LyX
8807 It is the example paper from the original macro package,
8813 \begin_inset CommandInset href
8816 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
8822 but translated to \SpecialChar LyX
8823 using the older unstructured abstract type.
8824 Use it for inspiration,
8825 and compare the \SpecialChar LaTeX
8830 with the \SpecialChar LyX
8834 \begin_layout Subsection
8839 \begin_layout Standard
8845 \begin_layout Subsubsection
8849 \begin_layout Standard
8851 is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
8852 the Astrophysical Journal (including the Letters and Supplement),
8853 the Astronomical Journal,
8854 and the Publications of the Astronomical Society of the Pacific.
8856 has proven to be an excellent tool for generating these documents,
8857 especially given its equation,
8859 and figure handling capabilities.
8861 requires version 5.0 (or higher) of these macros;
8863 which is the version described here,
8865 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8866 2.09 and are fundamentally incompatible with \SpecialChar LyX
8868 The AAS\SpecialChar TeX
8869 package may be downloaded from the AAS\SpecialChar TeX
8873 \begin_layout Standard
8874 \begin_inset VSpace medskip
8880 \begin_layout Standard
8882 \begin_inset Flex URL
8885 \begin_layout Plain Layout
8887 https://aas.org/aastex/aastex-downloads
8895 \begin_layout Standard
8896 \begin_inset VSpace medskip
8902 \begin_layout Standard
8903 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
8906 will not reduce the need to figure out all the AAS\SpecialChar TeX
8908 it will only reduce the drudgery of typing everything in.
8909 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8910 document conforms completely to the requirements of the journal to which you are submitting your paper.
8913 \begin_layout Subsubsection
8914 Starting a New Paper
8917 \begin_layout Standard
8918 I strongly suggest that you start with the AAS\SpecialChar TeX
8922 File\SpecialChar menuseparator
8928 \change_inserted 564990737 1671617265
8929 \SpecialChar menuseparator
8930 Articles\SpecialChar menuseparator
8931 American Astronomical Society
8932 \change_deleted 564990737 1671617310
8936 enter the new file name,
8944 This will show the most common fields found in a manuscript.
8945 Simply overwrite the existing text (including the brackets,
8950 ) with the correct information.
8951 Many of the AAS\SpecialChar TeX
8952 commands and environments can be implemented directly in \SpecialChar LyX
8955 For commands such as these,
8956 the \SpecialChar LaTeX
8957 code must be entered directly and marked as such.
8958 Such commands are referred to as \SpecialChar TeX
8961 I tried to minimize the amount of \SpecialChar TeX
8962 code needed in an AAS\SpecialChar TeX
8966 \begin_layout Subsubsection
8967 Finishing Your Paper
8970 \begin_layout Standard
8971 When the paper is finished to your satisfaction and previews/prints correctly,
8973 \begin_inset Quotes eld
8977 \begin_inset Quotes erd
8980 actions which need to be done before you submit it to the journals.
8984 \begin_layout Enumerate
8985 Export your paper as a \SpecialChar LaTeX
8988 File\SpecialChar menuseparator
8989 Export\SpecialChar menuseparator
8997 \begin_layout Enumerate
9002 file with your favorite text editor
9006 \begin_layout Enumerate
9007 remove the comment lines before the
9016 \begin_layout Enumerate
9021 usepackage...{fontenc}
9023 line if it appears (usually just after
9039 \begin_layout Enumerate
9040 remove everything between (and including) the
9053 except for any commands you specifically put into the \SpecialChar LaTeX
9054 preamble (which should appear immediately after the
9055 \begin_inset Quotes eld
9058 User specified \SpecialChar LaTeX
9060 \begin_inset Quotes erd
9071 \begin_layout Enumerate
9072 Run the resulting file through \SpecialChar LaTeX
9073 to make sure it still processes correctly.
9076 \begin_layout Enumerate
9077 Reread the journal requirements to make sure your filenames and formats are correct.
9080 \begin_layout Enumerate
9084 \begin_layout Subsubsection
9085 Comments On Specific Commands
9088 \begin_layout Standard
9089 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9091 the AAS\SpecialChar TeX
9096 ) gives a good description of each.
9097 Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
9098 So let's begin \SpecialChar ldots
9102 \begin_layout Paragraph
9103 Things that work as expected
9106 \begin_layout Standard
9107 Because they work as you might expect,
9108 I simply list them and the section they are found in:
9225 begin{thebibliography}
9235 all the cite commands and their variations (2.13.2),
9236 the generic graphicx figure commands (2.14.1),
9265 amongst other places),
9296 \begin_layout Standard
9297 The following style options also work correctly:
9323 Simply put them in the
9329 Layout\SpecialChar menuseparator
9335 \begin_layout Paragraph
9337 but require more comment
9340 \begin_layout Standard
9341 The following items work,
9342 but require a little more discussion:
9345 \begin_layout Itemize
9346 These items are reserved for use by the journal editors,
9347 but you can put them into the \SpecialChar LaTeX
9348 preamble if you feel compelled to do so:
9386 \begin_layout Itemize
9387 These items may be placed in the \SpecialChar LaTeX
9389 and are included as blanks in the template file:
9413 \begin_layout Itemize
9420 (2.3) – can only be used
9421 \begin_inset Quotes eld
9425 \begin_inset Quotes erd
9429 not in the middle of a paragraph.
9430 Use \SpecialChar TeX
9431 code if you need to embed it.
9434 \begin_layout Itemize
9441 (2.3) – will have extra {} after it.
9442 This should not cause an error.
9445 \begin_layout Itemize
9452 (2.6) – can only be used
9453 \begin_inset Quotes eld
9457 \begin_inset Quotes erd
9461 not in the middle of a paragraph.
9462 Use \SpecialChar TeX
9463 code if you need to embed it.
9466 \begin_layout Itemize
9473 (2.8) – can't insert a cross-reference tag,
9474 you must type the tag name by hand
9477 \begin_layout Itemize
9491 \begin_layout Itemize
9498 (2.9) – will have extra {} after it.
9499 This should not cause an error.
9502 \begin_layout Itemize
9509 (2.11) – will have extra {} after it.
9510 This should not cause an error.
9513 \begin_layout Itemize
9520 (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
9522 Insert\SpecialChar menuseparator
9527 \begin_inset Quotes eld
9531 \begin_inset Quotes erd
9534 inserts an optional argument of the type needed by
9541 Hopefully it will be renamed someday.
9544 \begin_layout Itemize
9557 for the catalog ID optional parameter
9560 \begin_layout Itemize
9573 for the catalog ID optional parameter
9576 \begin_layout Paragraph
9577 Things not implemented,
9578 use \SpecialChar TeX
9582 \begin_layout Standard
9594 setcounter{equation}
9597 Journal name abbreviations (2.13.4),
9640 insert it as the first element in the lefthand cell after where you want it.
9641 Don't use any of \SpecialChar LyX
9642 's rules in the table),
9717 \begin_layout Paragraph
9718 Things that cannot be implemented
9721 \begin_layout Standard
9723 at least in any meaningful sort of way,
9724 so I suggest ignoring them.
9725 They are the references environment (2.13.3),
9726 and the deluxetable environment (2.15).
9728 really need to use deluxetable,
9729 I suggest editing it in a separate file with a text editor,
9732 Insert\SpecialChar menuseparator
9734 \begin_inset space ~
9739 to include it in your \SpecialChar LyX
9742 \change_deleted 564990737 1671642564
9748 \change_inserted 564990737 1671642618
9751 File\SpecialChar menuseparator
9752 Open Example\SpecialChar menuseparator
9753 Articles\SpecialChar menuseparator
9754 American Astronomical Society
9759 \change_inserted 564990737 1671642621
9765 \begin_layout Subsubsection
9769 and Other Ruminations
9772 \begin_layout Paragraph
9773 Getting \SpecialChar LyX
9774 and AAS\SpecialChar TeX
9778 \begin_layout Standard
9779 It can be a bit tricky to get \SpecialChar LyX
9780 to recognize a new layout and document class.
9781 When all else fails,
9785 \begin_layout Enumerate
9786 Make certain that \SpecialChar LaTeX
9787 can find AAS\SpecialChar TeX
9789 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9790 distribution into a directory completely unrelated to \SpecialChar LaTeX
9791 or AAS\SpecialChar TeX
9792 and run \SpecialChar LaTeX
9800 \begin_layout Enumerate
9805 appears in \SpecialChar LyX
9813 \begin_layout Enumerate
9816 Tools\SpecialChar menuseparator
9821 then restart \SpecialChar LyX
9825 \begin_layout Enumerate
9826 Open a regular new file,
9827 not from a template.
9829 \change_deleted -712698321 1673170671
9832 \change_inserted -712698321 1673170671
9835 American Astronomical Society (AASTeX V.
9836 \begin_inset space \thinspace{}
9843 appear in the class list in
9845 Document\SpecialChar menuseparator
9851 \begin_layout Standard
9852 If you get a warning from an existing AAS\SpecialChar TeX
9853 document about not being able to find the AAS\SpecialChar TeX
9854 layout or a message about
9855 \begin_inset Quotes eld
9858 You should not mix title layouts with normal ones
9859 \begin_inset Quotes erd
9863 things haven't been installed correctly.
9866 \begin_layout Paragraph
9868 error processing a table
9871 \begin_layout Standard
9875 attempts to center the table caption/title.
9876 This seems to produce a bad interaction in AAS\SpecialChar TeX
9877 so you should click somewhere in the caption/title,
9880 Edit\SpecialChar menuseparator
9882 \begin_inset space ~
9897 This took care of it for me.
9900 \begin_layout Paragraph
9904 \begin_layout Standard
9907 \change_inserted -712698321 1673170733
9911 \begin_layout Enumerate
9913 \change_deleted -712698321 1673170736
9916 I have noticed some funny spacing in the reference entries in the text.
9917 When you enter the bibliography item data,
9922 space between the last author and the parenthesis setting off the year;
9926 \begin_inset space \thinspace{}
9930 \begin_inset space \space{}
9946 \change_deleted -712698321 1673170741
9948 \change_inserted -712698321 1673170741
9952 \begin_layout Enumerate
9953 Entering the references at all is not obvious.
9954 The easiest thing is to start typing your first reference at the end of the document,
9955 then mark it as type
9960 That will put a small gray box in front of what you just typed.
9961 Click on the box to fill in the rest of the information.
9963 go to the end of an existing reference and press return.
9964 That will create a new line with its own box,
9968 \begin_layout Paragraph
9972 \begin_layout Standard
9973 Even though AAS\SpecialChar TeX
9974 provides its own figure commands (
9982 I much prefer \SpecialChar LaTeX
9983 's standard figure commands (with the default graphicx).
9992 \begin_inset space ~
9995 commands as \SpecialChar TeX
9996 code into a Figure Float box if you desire,
9997 but I never have much luck getting the layout right.
9998 With the standard graphics,
10004 usepackage{graphicx}
10006 command into the \SpecialChar LaTeX
10007 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10009 interspersing the figures in the text.
10010 I believe ApJ accepts figures exactly this way now;
10011 AJ might still use the
10012 \begin_inset Quotes eld
10015 stack everything at the end
10016 \begin_inset Quotes erd
10022 \begin_layout Paragraph
10023 Things I could have done,
10027 \begin_layout Standard
10029 \begin_inset Quotes eld
10033 \begin_inset Quotes erd
10036 things I could have implemented,
10039 I saw no point in double-spacing the text in the \SpecialChar LyX
10041 even though it is double-spaced in the paper manuscript.
10043 I chose not to make separate layouts for the preprint and preprint2 styles.
10044 Since I assume you will spend most of your time in the plain manuscript mode anyway,
10045 I decided not to chew up more disk space with this.
10049 \begin_layout Subsubsection
10053 \begin_layout Standard
10054 Your mileage may vary.
10055 I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
10057 the last 2% was the \SpecialChar LaTeX
10058 post-processing and a few cleanups.
10059 I have had no trouble with the submission process,
10060 and I'm sure the journals were never aware that there might be a difference.
10062 go forth and publish!
10065 \begin_layout Subsection
10067 \change_inserted 564990737 1671442131
10071 \begin_layout Standard
10073 \change_inserted 564990737 1671642768
10075 \change_deleted -712698321 1673171415
10079 \begin_inset space \thinspace{}
10083 \change_inserted 564990737 1671642768
10085 \change_deleted -712698321 1673171417
10087 \change_inserted 564990737 1671642768
10091 \change_deleted -712698321 1673171421
10097 \change_inserted -712698321 1673171424
10099 \change_inserted 564990737 1671642768
10100 document class together with the
10101 \change_deleted -712698321 1673171428
10103 \change_inserted -712698321 1673171429
10105 \change_inserted 564990737 1671642768
10109 \change_deleted -712698321 1673171431
10111 \change_inserted 564990737 1671642768
10114 to facilitate the description of chess games.
10117 File\SpecialChar menuseparator
10118 Open Example\SpecialChar menuseparator
10119 Articles\SpecialChar menuseparator
10122 where you will find
10133 \begin_layout Subsection
10135 \change_inserted 564990737 1671042028
10139 \begin_layout Standard
10141 \change_inserted 564990737 1671617396
10143 \change_deleted -712698321 1673171640
10147 \begin_inset space \thinspace{}
10151 \change_inserted 564990737 1671617396
10153 \change_deleted -712698321 1673171643
10155 \change_inserted 564990737 1671617396
10159 \change_inserted -712698321 1673171717
10161 \change_inserted 564990737 1671617396
10165 \change_deleted -712698321 1673171720
10167 \change_inserted 564990737 1671617396
10171 \change_deleted -712698321 1673171728
10173 \change_inserted -712698321 1673171728
10176 \change_inserted 564990737 1671617396
10178 \change_inserted -712698321 1673171744
10179 for journals in the Elsevier publishing house
10180 \change_inserted 564990737 1671617396
10182 This provides the following additional environments:
10186 \begin_inset space ~
10195 \begin_inset space ~
10204 \begin_inset space ~
10225 \change_inserted -712698321 1673172045
10229 \begin_layout Standard
10231 \change_inserted 564990737 1671617396
10232 A template is available in the menu
10237 ile\SpecialChar menuseparator
10239 \begin_inset space ~
10247 \begin_inset space ~
10250 Template\SpecialChar menuseparator
10251 Articles\SpecialChar menuseparator
10255 It has been customized with further environments and contains all the information you may need.
10257 the documentation is also available from
10258 \begin_inset CommandInset href
10261 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
10269 \begin_layout Subsection
10271 \change_inserted 564990737 1671042046
10275 \begin_layout Standard
10277 \change_inserted 564990737 1671042046
10279 \change_deleted -712698321 1673172423
10283 \begin_inset space \thinspace{}
10287 \change_inserted -712698321 1673172423
10288 Paper (Standard Class)
10289 \change_deleted -712698321 1673172423
10291 \change_inserted 564990737 1671042046
10294 provides an alternative to the
10295 \change_deleted -712698321 1673172092
10299 \change_inserted -712698321 1673172435
10302 Article (Standard Class)
10303 \change_inserted 564990737 1671042046
10307 It provides similar functionality,
10308 but you might prefer this layout with sans serif sections,
10313 \begin_layout Subsection
10314 Rev\SpecialChar TeX
10318 \begin_layout Standard
10324 \begin_layout Standard
10325 \begin_inset VSpace bigskip
10331 \begin_layout Standard
10336 \change_deleted -712698321 1673172482
10338 \begin_inset space ~
10342 \change_inserted -712698321 1673172487
10344 \begin_inset space \thinspace{}
10351 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
10353 \begin_inset Formula $\beta$
10360 \begin_layout Standard
10365 \change_deleted -712698321 1673172511
10367 \change_inserted -712698321 1673172517
10373 which works with Rev\SpecialChar TeX
10376 v3.1 is basically obsolete,
10377 as it works with \SpecialChar LaTeX
10379 That means that it doesn't interact very well with \SpecialChar LyX
10381 which requires \SpecialChar LaTeX2e
10383 although it has been kludged to work.
10384 Since Rev\SpecialChar TeX
10385 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
10389 \change_deleted -712698321 1673172538
10392 Rev\SpecialChar TeX
10394 \begin_inset space ~
10398 \change_inserted -712698321 1673172538
10400 \begin_inset space ~
10404 \begin_inset space \thinspace{}
10411 textclass should also be pretty easy to use.
10414 \begin_layout Standard
10415 These documents are supposed to be used in
10419 to the Rev\SpecialChar TeX
10421 so we don't describe any of the special Rev\SpecialChar TeX
10423 and assume you'll know what to put in the preamble if necessary.
10426 \begin_layout Subsubsection
10430 \begin_layout Standard
10431 All you need to do is install Rev\SpecialChar TeX
10433 as described in the package's README file.
10434 The package can be found at The Rev\SpecialChar TeX
10436 \begin_inset Flex URL
10439 \begin_layout Plain Layout
10441 http://publish.aps.org/revtex4/
10447 Install it somewhere that \SpecialChar LaTeX
10449 Test it by trying to \SpecialChar LaTeX
10450 a short Rev\SpecialChar TeX
10451 4 document in some random directory (i.
10452 \begin_inset space \thinspace{}
10456 \begin_inset space \space{}
10459 not the directory where you installed the class file.) Then,
10460 if you reconfigure \SpecialChar LyX
10462 it will find the class file and let you use the Rev\SpecialChar TeX
10466 \begin_layout Standard
10467 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
10476 \begin_inset space ~
10483 \change_deleted -712698321 1673172641
10484 the templates directory
10485 \change_inserted -712698321 1673172687
10488 File\SpecialChar menuseparator
10489 New From Templates\SpecialChar menuseparator
10497 \begin_layout Subsubsection
10501 \begin_layout Standard
10502 Optional arguments to
10510 \begin_inset Quotes eld
10514 \begin_inset Quotes erd
10518 \begin_inset Quotes eld
10522 \begin_inset Quotes erd
10529 \begin_inset space ~
10537 \begin_inset space ~
10544 Remember that in Rev\SpecialChar TeX
10546 at least one optional argument is required!
10550 \begin_layout Standard
10551 Other preamble matter,
10559 \begin_inset space ~
10566 \begin_inset space ~
10575 \begin_layout Subsubsection
10579 \begin_layout Standard
10580 The layouts basically correspond to the commands in Rev\SpecialChar TeX
10583 the Email layout corresponds to
10590 Note that (at least as of Rev\SpecialChar TeX
10600 layouts are exactly equivalent,
10601 so you shouldn't need to use both.
10605 \begin_layout Plain Layout
10606 In case you're curious,
10607 both were included so that
10611 would be able to translate both
10631 \begin_layout Subsubsection
10635 \begin_layout Standard
10636 There are a couple of important unique aspects of Rev\SpecialChar TeX
10637 4 which might cause bugs that will be even more confusing in \SpecialChar LyX
10641 \begin_layout Standard
10642 In Rev\SpecialChar TeX
10661 The \SpecialChar LyX
10662 equivalent is that there is a separate Thanks layout.
10667 write footnotes in the
10672 or weird things may happen.
10673 See the Rev\SpecialChar TeX
10674 4 documentation for more details.
10677 \begin_layout Standard
10682 \begin_inset space ~
10691 \begin_inset space ~
10701 layouts must be placed
10709 layout and the corresponding
10727 the \SpecialChar LaTeX
10731 \begin_layout Subsection
10733 \change_inserted 564990737 1671042072
10737 \begin_layout Standard
10739 \change_inserted 564990737 1671042072
10744 classes were replaced
10745 \change_deleted -712698321 1673176131
10747 \change_inserted 564990737 1671042072
10748 with a completely new
10749 \change_deleted -712698321 1673175919
10755 This package provides a \SpecialChar LaTeX
10756 class and templates for books to be published at Springer Gabler Research,
10757 Springer Vieweg Research,
10758 Springer Spektrum Research,
10759 Springer VS Research,
10760 or Springer VS Forschung.
10761 The documentation is available in German from
10762 \begin_inset CommandInset href
10765 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
10772 \change_inserted -712698321 1673176125
10779 Please find information at
10780 \begin_inset Flex URL
10783 \begin_layout Plain Layout
10785 \change_inserted -712698321 1673176047
10787 https://www.springernature.com/gp/authors/campaigns/latex-author-support
10795 Native \SpecialChar LyX
10796 support is not available yet.
10797 \change_inserted 564990737 1671042072
10801 \begin_layout Section
10803 \change_inserted 564990737 1670439560
10807 \begin_layout Standard
10809 \change_inserted 564990737 1670439581
10810 See also the document classes in the Collections (section
10811 \begin_inset space ~
10815 \begin_inset CommandInset ref
10817 reference "sec:Collections"
10825 \begin_layout Subsection
10829 \begin_layout Standard
10835 \begin_layout Subsubsection
10839 \begin_layout Standard
10840 Memoir is a very powerful and constantly evolving class.
10841 It has been designed with regard to fictional and non-fictional literature.
10842 Its aim is to let the user have maximum control over the typesetting of his document.
10843 Memoir is based on the standard book class,
10844 but it can also emulate the article class (see below).
10847 \begin_layout Standard
10849 the developer of Memoir,
10850 is known as the author of lots of useful packages in the \SpecialChar LaTeX
10852 Most of them have been merged with Memoir.
10854 it is much easier to layout the table of contents,
10856 chapter designs and such.
10860 does not support all of these goodies natively.
10861 Some of them might be added to forthcoming releases
10865 \begin_layout Plain Layout
10866 You are invited to send suggestions to
10867 \begin_inset Flex URL
10870 \begin_layout Plain Layout
10872 lyx-devel@lists.lyx.org
10883 lots will probably never be supported,
10884 due to the limitations of \SpecialChar LyX
10886 Of course you can still use all features with the help of some native \SpecialChar LaTeX
10887 commands (\SpecialChar TeX
10892 \begin_layout Plain Layout
10897 \begin_layout Plain Layout
10907 \begin_inset space ~
10911 \begin_inset CommandInset ref
10913 reference "sec:Inserting-TeX-Code"
10925 we can only list those features that are natively supported by \SpecialChar LyX
10927 For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
10931 \begin_layout Plain Layout
10936 \begin_layout Plain Layout
10946 \begin_inset Flex URL
10949 \begin_layout Plain Layout
10951 CTAN:/macros/latex/memoir/memman.pdf
10962 which is not only a user guide for the class,
10963 but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
10966 \begin_layout Subsubsection
10967 Basic features and restrictions
10970 \begin_layout Standard
10971 Memoir supports basically all features of the standard book classes.
10978 \begin_layout Description
10980 \begin_inset space ~
10984 Memoir has a broader range of font sizes:
10993 \begin_layout Description
10995 \begin_inset space ~
10999 The fancy page style is not supported,
11000 due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
11001 which confuses \SpecialChar LaTeX
11004 Memoir comes with a number of its own page styles (see
11006 Document\SpecialChar menuseparator
11007 Settings\SpecialChar menuseparator
11009 \begin_inset space ~
11015 If you want to use these for the chapter pages,
11016 you have to use the command
11022 in the main text or in preamble (e.
11023 \begin_inset space \thinspace{}
11027 \begin_inset space \space{}
11034 chapterstyle{companion}
11039 \begin_layout Description
11041 Sectionings (chapter,
11043 subsection etc.) come with an optional argument in the standard classes.
11045 you can specify an alternative version of the title for the table of contents and the headers (for instance,
11046 if the title is too long).
11047 In \SpecialChar LyX
11049 you can do this via
11051 Insert\SpecialChar menuseparator
11053 \begin_inset space ~
11058 at the beginning of a chapter/section.
11059 Memoir features a second optional argument and thus separates the table of contents from the header.
11060 You can define three variants of a title with this:
11061 one for the main text,
11062 one for the table of contents,
11063 and one for the headers.
11065 makes these available in form of specific
11076 \begin_layout Description
11078 In the standard classes (and in many other classes),
11079 the table of contents,
11080 the list of figures and the list of table start a new page automatically.
11081 Memoir does not follow this route.
11082 You have to insert a page break yourself,
11083 if you want to have one.
11086 \begin_layout Description
11088 For some unknown reason,
11089 Memoir uses pagination on the title page (in the standard classes,
11091 \begin_inset Quotes eld
11095 \begin_inset Quotes erd
11099 If you want an empty title page,
11104 aliaspagestyle{title}{empty}
11109 \begin_layout Description
11111 With the class option
11117 Document\SpecialChar menuseparator
11118 Settings\SpecialChar menuseparator
11119 Class Settings\SpecialChar menuseparator
11121 \begin_inset space ~
11127 you can emulate article style.
11129 counters (footnotes,
11131 tables etc.) will not be reset on new chapters,
11132 chapters don't start a new page (but are—
11134 \begin_inset Quotes eld
11138 \begin_inset Quotes erd
11145 use their own page,
11149 \begin_layout Description
11152 Memoir does not allow the use of the deprecated font commands,
11153 which have been used in the old \SpecialChar LaTeX
11155 \begin_inset space \thinspace{}
11159 \begin_inset space \space{}
11176 It produces an error and stops \SpecialChar LaTeX
11177 whenever such a command appears.
11182 reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
11184 Since a lot of packages and particularly Bib\SpecialChar TeX
11185 style files are still using those commands,
11186 we have decided to use this option by default.
11189 \begin_layout Subsubsection
11193 \begin_layout Standard
11194 We will only describe the features supported by \SpecialChar LyX
11195 (which is not much currently).
11196 Please consult the Memoir manual
11200 \begin_layout Plain Layout
11205 \begin_layout Plain Layout
11215 \begin_inset Flex URL
11218 \begin_layout Plain Layout
11220 CTAN:/macros/latex/memoir/memman.pdf
11233 \begin_layout Description
11235 You may wonder why an abstract is an extra feature.
11237 it is in book class.
11238 Usually books don't have abstracts.
11242 You can use it wherever and how often you like.
11245 \begin_layout Description
11247 You may know this older typesetting style:
11248 The contents of a chapter are summarized below the title and also in the table of contents (e.
11249 \begin_inset space \thinspace{}
11253 \begin_inset space \space{}
11258 Our hero arrives in Troia;
11259 he loses some friends;
11263 Chapterprecis does exactly this.
11264 It is therefore only sensible below a chapter.
11267 \begin_layout Description
11269 An epigraph is a smart slogan or motto at the beginning of a chapter.
11270 The epigraph environment provides an elegant way of typesetting such a motto.
11271 The motto itself (text) and its (optional) author (source) are divided by a short line.
11272 The author (source) can be inserted via
11274 Insert\SpecialChar menuseparator
11281 \begin_layout Description
11283 Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
11285 can only support a few of them.
11287 which is a centered title for poems,
11288 which will also be added to the table of contents (verse is the standard environment for poems.
11289 Memoir has some enhanced versions of verse,
11290 but you need to use \SpecialChar TeX
11292 because they have to be nested inside regular verse environments,
11293 which is not possible with \SpecialChar LyX
11297 \begin_layout Description
11300 but it adds no entry to the table of contents.
11303 \begin_layout Subsection
11305 \change_inserted 564990737 1671442175
11309 \begin_layout Standard
11311 \change_inserted 564990737 1671442175
11315 \change_inserted -712698321 1673182264
11317 \change_inserted 564990737 1671442175
11319 \change_deleted -712698321 1673182266
11323 \change_inserted 564990737 1671442175
11327 \change_deleted -712698321 1673182282
11331 \begin_inset space \thinspace{}
11335 \change_inserted 564990737 1671442175
11337 \change_inserted -712698321 1673182287
11339 \change_deleted -712698321 1673182290
11341 \change_inserted 564990737 1671442175
11344 document class but adds two environments:
11347 \begin_layout Description
11349 \change_inserted 564990737 1671442175
11350 Recipe a numbered section environment at the
11354 level which generates a bold centered heading above a double horizontal rule
11357 \begin_layout Description
11359 \change_inserted 564990737 1671442175
11370 are what are being described and the environment ends with a horizontal rule.
11373 \begin_layout Standard
11375 \change_inserted 564990737 1671642866
11378 File\SpecialChar menuseparator
11379 Open Example\SpecialChar menuseparator
11380 Books\SpecialChar menuseparator
11383 illustrates its use.
11386 \begin_layout Standard
11388 \change_deleted -712698321 1673186391
11390 \change_inserted -712698321 1673186393
11392 \change_inserted 564990737 1671442175
11393 is designed for typesetting one or two recipes per page
11394 \change_deleted -712698321 1673199172
11396 with dimensions of 5.5
11397 \begin_inset Quotes qrd
11401 \begin_inset Quotes qrd
11405 \change_inserted 564990737 1671442175
11407 The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient
11408 \change_inserted -712698321 1673186486
11410 \change_deleted -712698321 1673186487
11413 \change_inserted 564990737 1671442175
11415 \change_deleted -712698321 1673199346
11416 and the pages can be joined together or printed 2 per page to normal letterpaper easily.
11417 The size was chosen to work in half-page 3-ring binder cover sheets,
11418 because un-laminated paper just doesn't last in the kitchen.
11421 \begin_layout Standard
11423 \change_deleted -712698321 1673199346
11424 The half-letter pages can be printed two per page using your printer driver,
11425 or bound together using
11427 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
11437 is the compiled version of your recipes.
11438 \change_inserted -712698321 1673175424
11442 \begin_layout Section
11444 \change_inserted 564990737 1671442207
11446 \change_deleted -712698321 1673186818
11448 \change_inserted -712698321 1673186818
11450 \change_inserted 564990737 1671442207
11454 \begin_layout Subsection
11456 \change_inserted 564990737 1671442208
11458 \change_inserted -712698321 1673187876
11460 \change_inserted 564990737 1671442208
11464 \begin_layout Standard
11466 \change_inserted 564990737 1671642942
11468 \change_deleted -712698321 1673187623
11472 \begin_inset space \space{}
11476 \begin_inset space \thinspace{}
11480 \change_inserted 564990737 1671642942
11482 \change_inserted -712698321 1673187655
11484 \change_deleted -712698321 1673187624
11486 \change_inserted 564990737 1671642942
11494 an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
11497 File\SpecialChar menuseparator
11498 Open Example\SpecialChar menuseparator
11499 Curricula Vitae\SpecialChar menuseparator
11501 \change_deleted -712698321 1673187728
11503 \change_inserted 564990737 1671642942
11506 offers guidance on its use.
11507 Its documentation is available from
11508 \begin_inset CommandInset href
11511 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
11519 \begin_layout Subsection
11521 \change_inserted 564990737 1671442208
11523 \change_deleted -712698321 1673187829
11525 \change_inserted -712698321 1673187829
11527 \change_inserted 564990737 1671442208
11531 \begin_layout Standard
11533 \change_inserted 564990737 1671642984
11535 \change_deleted -712698321 1673187820
11539 \begin_inset space \space{}
11543 \begin_inset space \thinspace{}
11547 \change_inserted 564990737 1671642984
11549 \change_inserted -712698321 1673187823
11551 \change_deleted -712698321 1673187824
11553 \change_inserted 564990737 1671642984
11561 an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
11564 File\SpecialChar menuseparator
11565 Open Example\SpecialChar menuseparator
11566 Curricula Vitae\SpecialChar menuseparator
11569 offers guidance on its use.
11570 Its documentation is available from
11571 \begin_inset CommandInset href
11574 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
11582 \begin_layout Subsection
11584 \change_inserted 564990737 1671442208
11586 \change_inserted -712698321 1673187869
11588 \change_inserted 564990737 1671442208
11592 \begin_layout Standard
11594 \change_inserted 564990737 1671643003
11596 \change_deleted -712698321 1673187880
11600 \begin_inset space \space{}
11604 \begin_inset space \thinspace{}
11608 \change_inserted -712698321 1673187880
11610 \change_inserted 564990737 1671643003
11612 \change_inserted -712698321 1673187884
11614 \change_deleted -712698321 1673187884
11616 \change_inserted 564990737 1671643003
11624 This allows the creation of customizable CVs.
11627 File\SpecialChar menuseparator
11628 Open Example\SpecialChar menuseparator
11629 Curricula Vitae\SpecialChar menuseparator
11632 offers guidance on its use.
11633 Its documentation is available from
11634 \begin_inset CommandInset href
11637 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
11645 \begin_layout Subsection
11647 \change_inserted 564990737 1671442208
11649 \change_inserted -712698321 1673187900
11651 \change_inserted 564990737 1671442208
11655 \begin_layout Standard
11657 \change_inserted 564990737 1671643024
11659 \change_deleted -712698321 1673187895
11663 \begin_inset space \space{}
11667 \begin_inset space \thinspace{}
11671 \change_inserted -712698321 1673187895
11673 \change_inserted 564990737 1671643024
11675 \change_inserted -712698321 1673187897
11677 \change_deleted -712698321 1673187898
11679 \change_inserted 564990737 1671643024
11687 originally developed for use with \SpecialChar LyX
11691 File\SpecialChar menuseparator
11692 Open Example\SpecialChar menuseparator
11693 Curricula Vitae\SpecialChar menuseparator
11696 offers guidance on its use.
11697 Its documentation is available from
11698 \begin_inset CommandInset href
11701 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
11709 \begin_layout Section
11711 \change_inserted 564990737 1672652454
11715 \begin_layout Standard
11717 \change_inserted 564990737 1672652455
11719 \change_deleted -712698321 1673245882
11723 \begin_inset space \space{}
11727 \change_inserted -712698321 1673245882
11730 KOMA-Script Letter (V.
11732 \change_inserted 564990737 1672652455
11736 \begin_inset space ~
11740 \begin_inset CommandInset ref
11742 reference "subsec:The-new-letter"
11748 \change_deleted -712698321 1673245908
11752 \begin_inset space \space{}
11755 (with extra font sizes)
11756 \change_inserted -712698321 1673245908
11759 Letter (Standard Class with Extra Font Sizes)
11760 \change_inserted 564990737 1672652455
11764 \begin_inset space ~
11768 \begin_inset CommandInset ref
11770 reference "subsec:Extra-font-sizes"
11775 ) document classes .
11778 \begin_layout Subsection
11780 \change_inserted 564990737 1671041970
11782 \change_deleted -712698321 1673246109
11784 \change_inserted -712698321 1673246110
11786 \change_inserted 564990737 1671041970
11790 \begin_layout Standard
11792 \change_inserted 564990737 1671617528
11796 \change_deleted -712698321 1673246116
11798 \change_inserted -712698321 1673246116
11800 \change_inserted 564990737 1671617528
11804 \change_inserted -712698321 1673246192
11806 \change_inserted 564990737 1671617528
11812 \change_deleted -712698321 1673246242
11814 \change_inserted -712698321 1673246242
11817 \change_inserted 564990737 1671617528
11818 class for writing letters according to the
11819 \change_inserted -712698321 1673246140
11820 standards of the German Standards Institute (
11821 \change_deleted -712698321 1673246141
11823 \change_inserted 564990737 1671617528
11826 Deutsches Institut für Normung
11827 \change_inserted -712698321 1673246324
11830 \change_deleted -712698321 1673246131
11834 \change_inserted 564990737 1671617528
11836 The file in the menu
11841 ile\SpecialChar menuseparator
11843 \begin_inset space ~
11851 \begin_inset space ~
11854 Template\SpecialChar menuseparator
11855 Letters\SpecialChar menuseparator
11858 offers guidance on its use.
11859 The documentation is available from
11860 \begin_inset CommandInset href
11863 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
11871 \begin_layout Subsection
11873 \change_deleted -712698321 1673246778
11875 \change_inserted -712698321 1673246778
11877 \begin_inset space \space{}
11885 \begin_layout Standard
11887 \change_inserted 564990737 1672652499
11891 \begin_inset space \space{}
11897 \change_inserted -712698321 1673246198
11899 \change_inserted 564990737 1672652499
11905 \change_deleted -712698321 1673246247
11907 \change_inserted -712698321 1673246247
11910 \change_inserted 564990737 1672652499
11911 class for writing letters according to French conventions.
11912 The file in the menu
11917 ile\SpecialChar menuseparator
11919 \begin_inset space ~
11927 \begin_inset space ~
11930 Template\SpecialChar menuseparator
11931 Letters\SpecialChar menuseparator
11933 \begin_inset space \space{}
11938 offers guidance on its use.
11939 \change_inserted -712698321 1673246876
11943 \begin_layout Subsection
11945 \change_inserted -712698321 1673246876
11947 \begin_inset space \space{}
11953 \begin_layout Standard
11955 \change_inserted -712698321 1673246917
11959 \begin_inset space \space{}
11964 provides support for
11969 another \SpecialChar LaTeX
11970 class for writing letters,
11971 but also faxes and envelopes,
11973 The file in the menu
11978 ile\SpecialChar menuseparator
11980 \begin_inset space ~
11988 \begin_inset space ~
11991 Template\SpecialChar menuseparator
11992 Letters\SpecialChar menuseparator
11994 \begin_inset space \space{}
11999 offers guidance on its use.
12000 The documentation is available from
12001 \begin_inset CommandInset href
12004 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
12010 \change_inserted 564990737 1672652499
12014 \begin_layout Subsection
12016 \change_inserted 564990737 1672652499
12018 \change_inserted -712698321 1673246804
12020 \begin_inset space \thinspace{}
12024 \change_inserted 564990737 1672652499
12028 \begin_layout Standard
12030 \change_inserted 564990737 1672652499
12034 \begin_inset space \thinspace{}
12040 \change_inserted -712698321 1673246202
12042 \change_inserted 564990737 1672652499
12044 \change_deleted -712698321 1673246498
12046 \change_inserted 564990737 1672652499
12052 \change_deleted -712698321 1673246249
12054 \change_inserted -712698321 1673246249
12057 \change_inserted 564990737 1672652499
12058 class for writing letters in German.
12059 The file in the menu
12064 ile\SpecialChar menuseparator
12066 \begin_inset space ~
12074 \begin_inset space ~
12077 Template\SpecialChar menuseparator
12078 Letters\SpecialChar menuseparator
12080 \begin_inset space \thinspace{}
12085 offers guidance on its use.
12086 The documentation is available from
12087 \begin_inset CommandInset href
12090 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
12098 \begin_layout Subsection
12100 \change_deleted -712698321 1673246462
12104 \begin_layout Standard
12106 \change_deleted -712698321 1673246462
12115 document class for English letters and to create mailing labels.
12116 The file in the menu
12121 ile\SpecialChar menuseparator
12123 \begin_inset space ~
12131 \begin_inset space ~
12134 Template\SpecialChar menuseparator
12135 Letters\SpecialChar menuseparator
12136 Letter (Standard Class)
12138 offers guidance on its use.
12139 \change_inserted 564990737 1671617591
12143 \begin_layout Subsection
12145 \change_deleted -712698321 1673246872
12149 \begin_layout Standard
12151 \change_deleted -712698321 1673246872
12155 \begin_inset space \space{}
12164 document class for writing letters,
12165 faxes and envelopes in French.
12166 The file in the menu
12171 ile\SpecialChar menuseparator
12173 \begin_inset space ~
12181 \begin_inset space ~
12184 Template\SpecialChar menuseparator
12185 Letters\SpecialChar menuseparator
12187 \begin_inset space \space{}
12192 offers guidance on its use.
12193 The documentation is available from
12194 \begin_inset CommandInset href
12197 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
12203 \change_inserted 564990737 1672652527
12207 \begin_layout Section
12209 \change_inserted 564990737 1670439660
12213 \begin_layout Subsection
12215 \change_inserted 564990737 1671458922
12219 \begin_layout Standard
12221 \change_inserted 564990737 1671617655
12223 \change_deleted -712698321 1673255475
12227 \begin_inset space \thinspace{}
12231 \change_inserted -712698321 1673255475
12233 \change_inserted 564990737 1671617655
12235 \change_deleted -712698321 1673255477
12237 \change_inserted 564990737 1671617655
12245 \change_deleted -712698321 1673255496
12247 \change_inserted -712698321 1673255496
12250 \change_inserted 564990737 1671617655
12251 class for creating presentations.
12252 The file in the menu
12257 ile\SpecialChar menuseparator
12259 \begin_inset space ~
12267 \begin_inset space ~
12270 Template\SpecialChar menuseparator
12271 Presentations\SpecialChar menuseparator
12275 \change_inserted -712698321 1673257500
12278 Help\SpecialChar menuseparator
12279 Specific Manuals\SpecialChar menuseparator
12280 Beamer Presentations
12283 \change_inserted 564990737 1671617655
12284 offers guidance on its use.
12285 The documentation is available from
12286 \begin_inset CommandInset href
12289 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
12297 \begin_layout Subsection
12299 \change_deleted -712698321 1673255766
12304 Foil\SpecialChar TeX
12306 \change_deleted -712698321 1673255767
12312 \begin_inset CommandInset label
12321 \begin_layout Standard
12323 \change_inserted 564990737 1672743383
12329 updated by the \SpecialChar LyX
12333 \begin_layout Subsubsection
12335 \change_inserted 564990737 1672743383
12339 \begin_layout Standard
12341 \change_inserted 564990737 1672743396
12343 \change_deleted -712698321 1673255761
12347 \begin_inset space \thinspace{}
12351 \change_inserted 564990737 1672743396
12352 Foil\SpecialChar TeX
12354 \change_deleted -712698321 1673255763
12356 \change_inserted 564990737 1672743396
12363 document class to make slides for overhead projectors.
12364 There are two document classes that can do this:
12366 \change_deleted -712698321 1673256124
12370 \begin_inset space \thinspace{}
12374 \change_inserted -712698321 1673256124
12376 \change_inserted 564990737 1672743396
12378 \change_deleted -712698321 1673256130
12380 \change_inserted 564990737 1672743396
12383 document class (section
12384 \begin_inset space ~
12388 \begin_inset CommandInset ref
12390 reference "sec:slitex"
12400 Foil\SpecialChar TeX
12404 As of 2023 the former has continued to be maintained whereas
12406 Foil\SpecialChar TeX
12409 has not been maintained since 2008.
12410 This section documents the latter.
12411 If your machine doesn’t have the
12412 \change_deleted -712698321 1673256264
12416 \begin_inset space \thinspace{}
12420 \change_inserted 564990737 1672743396
12421 Foil\SpecialChar TeX
12423 \change_deleted -712698321 1673256265
12425 \change_inserted 564990737 1672743396
12428 document class installed,
12429 you’ll probably have to use the
12430 \change_deleted -712698321 1673256271
12434 \begin_inset space \thinspace{}
12438 \change_inserted -712698321 1673256271
12440 \change_inserted 564990737 1672743396
12442 \change_deleted -712698321 1673256273
12444 \change_inserted 564990737 1672743396
12448 If you want to install the
12453 it is available from
12454 \begin_inset CommandInset href
12457 target "https://www.ctan.org/pkg/foiltex"
12463 You should also read the
12465 Installing New Document Classes
12472 \change_deleted 564990737 1672743436
12478 \begin_layout Standard
12480 \change_deleted 564990737 1672743383
12484 \begin_layout Standard
12486 \change_deleted 564990737 1672743383
12487 This section describes how to use \SpecialChar LyX
12488 to make slides for overhead projectors.
12489 There are two document classes that can do this:
12490 the default slides class and the
12492 Foil\SpecialChar TeX
12496 This section documents the latter.
12499 \begin_layout Standard
12501 \change_deleted 564990737 1672743383
12502 I'm going to say this again,
12504 so that there's no misunderstanding:
12507 \begin_layout Standard
12509 \change_deleted 564990737 1672743383
12510 \begin_inset VSpace bigskip
12516 \begin_layout Standard
12519 \change_deleted 564990737 1672743383
12522 This section documents the class
12523 \begin_inset Quotes eld
12531 \begin_inset Quotes erd
12539 \begin_layout Standard
12541 \change_deleted 564990737 1672743383
12542 \begin_inset VSpace bigskip
12548 \begin_layout Standard
12550 \change_deleted 564990737 1672743383
12551 If you're looking for the documentation for
12552 \begin_inset Quotes eld
12560 \begin_inset Quotes erd
12565 \begin_inset space ~
12569 \begin_inset CommandInset ref
12571 reference "sec:slitex"
12577 If your machine doesn't have the
12586 you'll probably have to use the default
12591 which isn't quite as good as
12596 \begin_layout Standard
12598 \change_deleted 564990737 1672743383
12603 class is designed for use with version
12604 \begin_inset space ~
12612 class file which is now an integral part of \SpecialChar LaTeX2e
12618 \begin_layout Subsubsection
12622 \begin_layout Standard
12624 to use this document class,
12636 \begin_inset space ~
12642 There are some settings in the
12645 \begin_inset space ~
12650 dialog that you should know about that are specific to this class:
12653 \begin_layout Itemize
12654 Don't change the options
12665 \begin_inset space ~
12671 They're ignored by the
12678 \begin_layout Itemize
12679 The default font size is 20
12680 \begin_inset space \thinspace{}
12683 pt with the other options being 17
12684 \begin_inset space \thinspace{}
12689 \begin_inset space \thinspace{}
12693 \begin_inset space \thinspace{}
12699 \begin_layout Itemize
12700 The default font is
12708 but all math equations are still typeset in the usual roman font.
12711 \begin_layout Itemize
12714 Foil\SpecialChar TeX
12717 supports A4 and Letter paper sizes as well as a special size for working with 35
12718 \begin_inset space \thinspace{}
12722 It doesn't support A5,
12724 legal or executive paper sizes.
12727 \begin_layout Itemize
12728 Don't bother changing the
12732 settings because they are ignored anyway.
12733 All floats appear where they are defined in the text.
12736 \begin_layout Itemize
12741 setting behaves a bit differently for this class.
12744 Foil\SpecialChar TeX
12747 provides extensive footer and header capabilities including a user-defined logo.
12749 \begin_inset space ~
12753 \begin_inset CommandInset ref
12755 reference "sec:foilfoot"
12761 The title page is treated differently to all other pages in the document and is
12769 has the logo centered at the bottom of the page (if one is defined).
12770 The possible page style choices and what they do are as follows:
12774 \begin_layout Labeling
12775 \labelwidthstring MMMMMMM
12782 The final output contains no page numbers,
12783 or other headers or footers (except footnotes of course).
12787 \begin_layout Labeling
12788 \labelwidthstring MMMMMMM
12795 The final output contains page numbers centered at the bottom of the page.
12796 No other headings or footers (other than footnotes).
12799 \begin_layout Labeling
12800 \labelwidthstring MMMMMMM
12805 Page numbers in lower right corner.
12806 Additional headers and footers are also shown.
12807 This is also the default.
12810 \begin_layout Labeling
12811 \labelwidthstring MMMMMMM
12816 Gives you access to the
12820 package although its use with
12822 Foil\SpecialChar TeX
12825 is discouraged by the writer of the
12827 Foil\SpecialChar TeX
12830 package because of some potential page layout clashes.
12834 \begin_layout Paragraph
12838 \begin_layout Standard
12839 The following options may be used in the extra class options in the
12841 Document\SpecialChar menuseparator
12847 \begin_layout Labeling
12848 \labelwidthstring MMMMMMx
12853 This sets up the page layout for 7.33
12854 \begin_inset space \thinspace{}
12858 \begin_inset space \thinspace{}
12862 which is about the same aspect ratio as a 35
12863 \begin_inset space \thinspace{}
12867 making it a bit easier to work with this medium.
12870 \begin_layout Labeling
12871 \labelwidthstring MMMMMMx
12876 Places a rule across the page below the header on every page except the title page.
12879 \begin_layout Labeling
12880 \labelwidthstring MMMMMMx
12885 Places a rule across the page above the footer on every page except the title page.
12888 \begin_layout Labeling
12889 \labelwidthstring MMMMMMx
12894 This is automatically set each time you create a new
12901 Foil\SpecialChar TeX
12904 to use the dvips driver to rotate those pages that are set as landscape foils.
12907 \begin_layout Labeling
12908 \labelwidthstring MMMMMMx
12913 Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
12914 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.
12915 Note that this option effectively reverses the roles of the
12923 environments (don't worry these are described in the next section).
12926 \begin_layout Labeling
12927 \labelwidthstring MMMMMMx
12932 Equation numbers on the left.
12935 \begin_layout Labeling
12936 \labelwidthstring MMMMMMx
12941 Flush-left equations.
12944 \begin_layout Subsubsection
12945 Supported Environments
12948 \begin_layout Standard
12949 Most of the environments commonly supported in other classes are also supported by the
12950 \change_deleted -712698321 1673256683
12954 \change_inserted -712698321 1673256683
12955 Foil\SpecialChar TeX
12961 There are several additional environments provided by
12963 Foil\SpecialChar TeX
12966 as well as a couple added by \SpecialChar LyX
12968 The following environments are shared with other classes:
12971 \begin_layout Standard
12972 \begin_inset Flex Multiple Columns
12975 \begin_layout Itemize
12981 \begin_layout Itemize
12987 \begin_layout Itemize
12993 \begin_layout Itemize
12999 \begin_layout Itemize
13005 \begin_layout Itemize
13012 \begin_layout Itemize
13018 \begin_layout Itemize
13024 \begin_layout Itemize
13030 \begin_layout Itemize
13034 \change_inserted -712698321 1673256734
13038 \begin_layout Itemize
13044 \begin_layout Itemize
13050 \begin_layout Itemize
13056 \begin_layout Itemize
13062 \begin_layout Itemize
13068 \begin_layout Itemize
13079 \begin_layout Standard
13081 all the major environments apart from the sectioning environments.
13082 Since foils are essentially self-contained sections,
13083 with a title and body,
13086 Foil\SpecialChar TeX
13089 provides specific commands for starting new foils and these are:
13092 \begin_layout Itemize
13098 \begin_layout Itemize
13104 \begin_layout Standard
13106 also provides slightly modified versions of these two environments called:
13109 \begin_layout Itemize
13115 \begin_layout Itemize
13118 ShortRotatefoilhead
13121 \begin_layout Standard
13122 and the differences will be explained in the next section.
13125 \begin_layout Standard
13126 Since foils are often used in presenting ideas or new theorems and such
13128 Foil\SpecialChar TeX
13131 also provides a comprehensive box of goodies for presenting them:
13134 \begin_layout Standard
13135 \begin_inset Flex Multiple Columns
13138 \begin_layout Itemize
13144 \begin_layout Itemize
13150 \begin_layout Itemize
13156 \begin_layout Itemize
13162 \begin_layout Itemize
13168 \begin_layout Itemize
13174 \begin_layout Itemize
13180 \begin_layout Itemize
13186 \begin_layout Itemize
13192 \begin_layout Itemize
13198 \begin_layout Itemize
13209 \begin_layout Standard
13210 The starred versions are unnumbered while the unstarred versions are numbered.
13211 There are also two list environments added by \SpecialChar LyX
13215 \begin_layout Itemize
13221 \begin_layout Itemize
13227 \begin_layout Standard
13230 Foil\SpecialChar TeX
13233 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.
13234 If you want to change these settings in your document the best place to do so is at the very top of a foil,
13236 \begin_inset space \thinspace{}
13242 \begin_inset space \space{}
13247 straight after the foilhead.
13250 \begin_layout Standard
13252 the following command styles are provided [
13259 \begin_layout Standard
13260 \begin_inset Flex Multiple Columns
13263 \begin_layout Itemize
13267 \begin_inset space ~
13273 \begin_layout Itemize
13279 \begin_layout Itemize
13283 \begin_inset space ~
13289 \begin_layout Itemize
13293 \begin_inset space ~
13299 \begin_layout Itemize
13303 \begin_inset space ~
13310 \begin_layout Plain Layout
13311 \begin_inset space ~
13323 \begin_layout Standard
13324 There are also a few commands provided by
13326 Foil\SpecialChar TeX
13329 that aren't directly supported by \SpecialChar LyX
13330 but I'll tell you what they do and how to use them in section
13331 \begin_inset space ~
13335 \begin_inset CommandInset ref
13337 reference "sec:unsuppfoils"
13345 \begin_layout Subsubsection
13346 Building a Set of Foils
13349 \begin_layout Standard
13350 This section will give a simple introduction to using the different environments to build a set of foils.
13351 If you want to see an example set of foils,
13353 \change_deleted 564990737 1671643085
13358 file you find in \SpecialChar LyX
13364 \change_inserted 564990737 1671643099
13367 File\SpecialChar menuseparator
13368 Open Example\SpecialChar menuseparator
13369 Presentations\SpecialChar menuseparator
13377 \begin_layout Paragraph
13378 Give It a Title Page
13381 \begin_layout Standard
13382 Unlike other classes that provide
13402 \change_deleted -712698321 1673256940
13406 \change_inserted -712698321 1673256940
13414 creates the title on a page of its own.
13415 If you leave out the
13419 environment \SpecialChar LaTeX
13420 will substitute the current date (every time you regenerate the output).
13423 \begin_layout Paragraph
13427 \begin_layout Standard
13428 As I mentioned earlier,
13429 there are four ways of starting a new foil.
13430 For portrait foils you should use
13439 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.
13442 \begin_layout Standard
13443 Landscape foils are generated using the
13449 ShortRotatefoilhead
13452 Again the only difference is the spacing between foilhead and body.
13453 Both of the short versions have 0.5
13454 \begin_inset space ~
13457 inches less separation between the foilhead and the body.
13461 \begin_layout Standard
13462 One problem with the support for landscape foils is the requirement that you have to use the
13466 driver to generate the PostScript output otherwise the foils won't be rotated.
13467 It is possible to get landscape foils even if you haven't got the
13471 driver provided you can feed your foils sideways through your printer ;-)
13474 \begin_layout Paragraph
13480 \begin_layout Standard
13481 You can't have two of the same type of these environments directly following each other.
13482 If you use a normal paragraph break,
13484 you will just be extending the previous environment as if you had merged the two environments together.
13486 you need to insert a so-called separator.
13487 Please refer to the section entitled
13498 \begin_layout Paragraph
13502 \begin_layout Standard
13503 You get all the commonly supported list styles found in other classes as well as two new ones.
13504 I'll only describe the new ones here.
13505 If you want to find out more about the other list environments check out the
13510 If you intend to use itemized lists you might also want to read about the
13513 \begin_inset space ~
13517 \begin_inset space ~
13522 dialog described above in section
13523 \begin_inset space ~
13527 \change_inserted 564990737 1671355684
13529 \begin_inset CommandInset ref
13531 reference "chap:bullets"
13537 \change_deleted 564990737 1671355684
13539 \begin_inset CommandInset ref
13541 reference "sec:bullet"
13551 \begin_layout Standard
13552 The two new list styles,
13562 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.
13563 These lists are in fact dedicated variants of the
13568 They do however require that you have the
13572 packages installed.
13575 \begin_layout Paragraph
13579 \begin_layout Standard
13582 Foil\SpecialChar TeX
13585 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.
13586 In fact if you change the float placement settings they are simply ignored.
13589 \begin_layout Paragraph
13590 Page Headers and Footers
13591 \begin_inset CommandInset label
13593 name "sec:foilfoot"
13600 \begin_layout Standard
13604 \begin_inset space ~
13613 are two commands used to control the left-footer text string.
13614 The first is meant to allow you to include a graphic logo on your foils and defaults to
13615 \begin_inset Quotes eld
13620 Foil\SpecialChar TeX
13624 \begin_inset Quotes erd
13628 While the second is meant to provide a classification for the audience,
13632 \begin_inset space \thinspace{}
13638 \begin_inset space \space{}
13642 It is empty by default.
13645 \begin_layout Standard
13646 The remaining page corners can be filled by
13649 \begin_inset space ~
13654 (which defaults to page numbers),
13658 \begin_inset space ~
13666 \begin_inset space ~
13674 \begin_layout Subsubsection
13677 Foil\SpecialChar TeX
13681 \begin_inset CommandInset label
13683 name "sec:unsuppfoils"
13690 \begin_layout Standard
13691 All the commands mentioned below need to be set in a
13701 within another environment.
13704 \begin_layout Paragraph
13708 \begin_layout Standard
13709 All lengths are adjusted using the
13732 should be replaced by the name given to the length you want to change and
13736 is the length value.
13737 All lengths should be specified in units of length such as inches (
13750 ) or relative to some document or font-based length such as
13760 \begin_layout Standard
13761 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
13774 \begin_inset space \space{}
13777 in closer to their bodies put the following in the preamble:
13784 foilheadskip}{-0.5in}
13787 \begin_layout Standard
13788 The spacings around floats can be adjusted by setting these lengths:
13791 \begin_layout Labeling
13792 \labelwidthstring MMMMMMMMMMM
13799 Separation between the text and the top of the float
13802 \begin_layout Labeling
13803 \labelwidthstring MMMMMMMMMMM
13810 Separation between the float and the caption
13813 \begin_layout Labeling
13814 \labelwidthstring MMMMMMMMMMM
13821 Separation between the caption and the following text
13824 \begin_layout Labeling
13825 \labelwidthstring MMMMMMMMMMM
13832 You can make the captions narrower than the surrounding text by adjusting this length.
13833 Best done relative to
13842 \begin_layout Standard
13843 There are also several title page related lengths that you may find useful if you have a long title or several authors:
13846 \begin_layout Labeling
13847 \labelwidthstring MMMMMMMMMMM
13854 Separation from headers to
13859 \begin_layout Labeling
13860 \labelwidthstring MMMMMMMMMMM
13878 \begin_layout Labeling
13879 \labelwidthstring MMMMMMMMMMM
13893 \begin_layout Labeling
13894 \labelwidthstring MMMMMMMMMMM
13910 \begin_layout Labeling
13911 \labelwidthstring MMMMMMMMMMM
13927 \begin_layout Standard
13928 The last length related command affects all the list environments.
13939 a list environment then all the vertical spacing between the list items is removed.
13940 Note that this is a command not a length so it doesn't require
13946 like the stuff mentioned above.
13949 \begin_layout Paragraph
13950 Headers and Footers
13953 \begin_layout Standard
13966 commands control whether the logo in the
13970 definition appear on a given page.
13977 in the preamble then none of the foils will have the logo on them.
13978 If you don't want the logo on a particular page place the
13984 directly after the foilhead of that page and the
13990 directly after the next foilhead.
13993 \begin_layout Standard
13994 If you decide to use the
13998 page style setting in the
14001 \begin_inset space ~
14006 dialog you should probably add
14016 to your preamble so headers and footers on landscape pages are correctly placed when rotated.
14017 This is due to some clashes between the page layouts provided by the
14022 \change_deleted -712698321 1673257120
14026 \change_inserted -712698321 1673257120
14037 \begin_layout Subsection
14039 \change_inserted 564990737 1671459032
14043 \begin_layout Standard
14045 \change_inserted 564990737 1671643165
14047 \change_deleted -712698321 1673257152
14051 \begin_inset space \thinspace{}
14055 \change_inserted -712698321 1673257152
14057 \change_inserted 564990737 1671643165
14059 \change_deleted -712698321 1673257154
14061 \change_inserted 564990737 1671643165
14069 \change_deleted -712698321 1673257280
14071 \change_inserted -712698321 1673257280
14074 \change_inserted 564990737 1671643165
14075 class for creating presentations.
14078 File\SpecialChar menuseparator
14079 Open Example\SpecialChar menuseparator
14080 Presentations\SpecialChar menuseparator
14083 offers guidance on its use.
14084 The documentation is available from
14085 \begin_inset CommandInset href
14088 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
14096 \begin_layout Subsection
14098 \change_inserted 564990737 1671459032
14099 \begin_inset CommandInset label
14101 name "subsec:Seminar"
14110 \begin_layout Standard
14112 \change_inserted 564990737 1671643194
14114 \change_deleted -712698321 1673257295
14118 \begin_inset space \thinspace{}
14122 \change_inserted -712698321 1673257295
14124 \change_inserted 564990737 1671643194
14126 \change_deleted -712698321 1673257296
14128 \change_inserted 564990737 1671643194
14135 document class for creating presentations.
14138 File\SpecialChar menuseparator
14139 Open Example\SpecialChar menuseparator
14140 Presentations\SpecialChar menuseparator
14143 offers guidance on its use.
14144 The documentation is available from
14145 \begin_inset CommandInset href
14148 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
14156 \begin_layout Subsection
14159 Sli\SpecialChar TeX
14163 \begin_inset CommandInset label
14172 \begin_layout Standard
14174 \change_inserted 564990737 1672743492
14180 updated by the \SpecialChar LyX
14184 \begin_layout Subsubsection
14186 \change_inserted 564990737 1672743492
14190 \begin_layout Standard
14192 \change_inserted 564990737 1672743492
14193 This section describes how to use \SpecialChar LyX
14194 to make slides for overhead projectors.
14195 There are two document classes that can do this:
14197 \change_deleted -712698321 1673257697
14201 \begin_inset space \thinspace{}
14205 \change_inserted -712698321 1673257697
14209 \change_inserted 564990737 1672743492
14211 \change_deleted -712698321 1673257698
14215 \change_inserted 564990737 1672743492
14218 document class and the
14219 \change_deleted -712698321 1673257705
14223 \begin_inset space \thinspace{}
14227 \change_inserted 564990737 1672743492
14228 Foil\SpecialChar TeX
14230 \change_deleted -712698321 1673257707
14232 \change_inserted 564990737 1672743492
14236 This section documents the former.
14237 If you’re looking for the documentation for
14238 \change_deleted -712698321 1673257759
14242 \begin_inset space \thinspace{}
14246 \change_inserted 564990737 1672743492
14247 Foil\SpecialChar TeX
14249 \change_deleted -712698321 1673257760
14251 \change_inserted 564990737 1672743492
14256 \begin_inset space ~
14260 \change_inserted -712698321 1673257749
14262 \begin_inset CommandInset ref
14264 reference "sec:foiltex"
14273 \change_deleted -712698321 1673257749
14275 \begin_inset CommandInset ref
14277 reference "sec:Foiltex"
14283 \change_inserted 564990737 1672743492
14286 \change_deleted -712698321 1673257899
14288 \change_inserted -712698321 1673257899
14292 \change_inserted 564990737 1672743492
14295 has continued to be maintained whereas
14297 Foil\SpecialChar TeX
14300 has not been maintained since 2008.
14302 \change_deleted 564990737 1672743492
14310 \begin_layout Standard
14312 \change_deleted 564990737 1672743492
14316 \begin_layout Standard
14318 \change_deleted 564990737 1672743492
14319 This section describes how to use \SpecialChar LyX
14320 to make slides for overhead projectors.
14321 There are two document classes that can do this:
14322 the default slides class and the
14324 Foil\SpecialChar TeX
14328 This section documents the former.
14331 \begin_layout Standard
14333 \change_deleted 564990737 1672743492
14334 I'm going to say this again,
14336 so that there's no misunderstanding:
14339 \begin_layout Standard
14341 \change_deleted 564990737 1672743492
14342 \begin_inset VSpace bigskip
14348 \begin_layout Standard
14351 \change_deleted 564990737 1672743492
14354 This section documents the class
14355 \begin_inset Quotes eld
14363 \begin_inset Quotes erd
14371 \begin_layout Standard
14373 \change_deleted 564990737 1672743492
14374 \begin_inset VSpace bigskip
14380 \begin_layout Standard
14382 \change_deleted 564990737 1672743492
14383 If you're looking for the documentation for
14384 \begin_inset Quotes eld
14389 slides (Foil\SpecialChar TeX
14393 \begin_inset Quotes erd
14398 \begin_inset space ~
14402 \begin_inset CommandInset ref
14404 reference "sec:foiltex"
14415 \begin_inset Quotes eld
14420 slides (Foil\SpecialChar TeX
14424 \begin_inset Quotes erd
14427 ] is actually somewhat better than the default
14435 \begin_layout Plain Layout
14437 or so I've been told repeatedly by its advocates.
14438 Having never used it,
14439 I have no idea if this claim is true or not.
14444 which this section documents.
14447 \begin_layout Standard
14449 \change_deleted 564990737 1672743492
14450 This class is the \SpecialChar LaTeX2e
14451 improvement of the old
14453 Sli\SpecialChar TeX
14457 Every \SpecialChar LaTeX2e
14458 distribution includes this class [which I'll just refer to as
14459 \begin_inset Quotes eld
14467 \begin_inset Quotes erd
14471 so you're bound to have it.
14472 As I noted earlier,
14473 there are other classes,
14479 which also produce slides for overhead projectors and do a better job at it.
14481 there are some things which
14485 can do which the others can't,
14486 such as generate overlays.
14487 Read on to learn more!
14492 \begin_layout Subsubsection
14494 \begin_inset CommandInset label
14496 name "sec:slidesetup"
14503 \begin_layout Standard
14505 to use this document class,
14507 \begin_inset Quotes eld
14511 \change_deleted -712698321 1673257922
14515 \change_inserted -712698321 1673257922
14519 \change_deleted -712698321 1673257925
14525 \begin_inset Quotes erd
14528 from the class list in the
14530 Document\SpecialChar menuseparator
14534 There are some other special things you should know about this class:
14537 \begin_layout Itemize
14538 Don't bother changing the options
14543 They're not supported by the
14544 \change_deleted -712698321 1673257960
14548 \change_inserted -712698321 1673257960
14557 \begin_layout Itemize
14561 \begin_inset space ~
14566 behaves a bit differently for this class.
14567 The possible choices and what they do are as follows:
14571 \begin_layout Description
14576 The final output contains page numbers in the lower right corner.
14579 \begin_layout Description
14589 but also prints out any time markers you've put in.
14590 This is the default.
14593 \begin_layout Description
14598 The final output contains no page numbers,
14600 or alignment markers.
14604 \begin_layout Itemize
14606 \change_deleted -712698321 1673257971
14610 \change_inserted -712698321 1673257971
14615 class has an extra option:
14623 \begin_inset Quotes eld
14631 \begin_inset Quotes erd
14634 in the extra class options.
14638 \begin_layout Standard
14639 Using this options allows you to add time markers to
14645 \begin_inset space ~
14649 \begin_inset CommandInset ref
14651 reference "sec:slideNote"
14660 \begin_layout Standard
14661 You can also use the template file
14662 \change_deleted 564990737 1671617694
14664 \begin_inset Quotes eld
14672 \begin_inset Quotes erd
14677 to automatically set up a document to use the
14682 \change_deleted 564990737 1671617699
14687 File\SpecialChar menuseparator
14689 \begin_inset space ~
14693 \begin_inset space ~
14697 \change_inserted 564990737 1671617723
14698 \SpecialChar menuseparator
14699 Presentations\SpecialChar menuseparator
14704 to open your new document
14705 \change_deleted 564990737 1671617728
14709 The template file also contains some examples of the special paragraph environments used by this class.
14710 I'll describe those next.
14713 \begin_layout Subsubsection
14714 Paragraph Environments
14717 \begin_layout Paragraph
14718 Supported Environments
14721 \begin_layout Standard
14722 The first thing you'll notice when you start up a new
14723 \change_deleted -712698321 1673258063
14727 \change_inserted -712698321 1673258063
14732 document is the font size and type:
14733 it's the equivalent of the size
14734 \begin_inset Quotes eld
14742 \begin_inset Quotes erd
14748 \begin_inset space ~
14754 This is also what's used in the output.
14756 \begin_inset Quotes eld
14760 \begin_inset Quotes erd
14763 to remind you that this is a slide.
14764 Your final slides will use a larger font;
14766 you'll have less space.
14768 the larger default screen font isn't WYSIWYG,
14772 \begin_layout Standard
14773 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
14774 Most of the paragraph environments you're used to seeing are missing.
14775 There are also five new ones.
14777 \change_deleted -712698321 1673258093
14781 \change_inserted -712698321 1673258093
14786 class itself only supports certain paragraph environments:
14789 \begin_layout Standard
14791 \change_inserted -712698321 1673258082
14794 \begin_inset Flex Multiple Columns
14797 \begin_layout Itemize
14799 \change_inserted -712698321 1673258082
14805 \begin_layout Itemize
14807 \change_inserted -712698321 1673258082
14813 \begin_layout Itemize
14815 \change_inserted -712698321 1673258082
14821 \begin_layout Itemize
14823 \change_inserted -712698321 1673258082
14829 \begin_layout Itemize
14831 \change_inserted -712698321 1673258082
14837 \begin_layout Itemize
14839 \change_inserted -712698321 1673258082
14845 \begin_layout Itemize
14847 \change_inserted -712698321 1673258082
14853 \begin_layout Itemize
14855 \change_inserted -712698321 1673258082
14861 \begin_layout Itemize
14863 \change_inserted -712698321 1673258082
14869 \begin_layout Itemize
14871 \change_inserted -712698321 1673258082
14883 \change_deleted -712698321 1673258082
14887 \begin_layout Itemize
14889 \change_deleted -712698321 1673258082
14895 \begin_layout Itemize
14897 \change_deleted -712698321 1673258082
14903 \begin_layout Itemize
14905 \change_deleted -712698321 1673258082
14911 \begin_layout Itemize
14913 \change_deleted -712698321 1673258082
14919 \begin_layout Itemize
14921 \change_deleted -712698321 1673258082
14927 \begin_layout Itemize
14929 \change_deleted -712698321 1673258082
14935 \begin_layout Itemize
14937 \change_deleted -712698321 1673258082
14943 \begin_layout Itemize
14945 \change_deleted -712698321 1673258082
14951 \begin_layout Itemize
14953 \change_deleted -712698321 1673258082
14962 \begin_layout Standard
14963 All of the other standard environments,
14964 including the section-heading environments,
14966 \change_deleted -712698321 1673258102
14970 \change_inserted -712698321 1673258102
14978 \begin_layout Standard
14980 you'll notice the following new environments:
14983 \begin_layout Standard
14985 \change_inserted -712698321 1673258111
14988 \begin_inset Flex Multiple Columns
14991 \begin_layout Itemize
14993 \change_inserted -712698321 1673258111
14999 \begin_layout Itemize
15001 \change_inserted -712698321 1673258111
15007 \begin_layout Itemize
15009 \change_inserted -712698321 1673258111
15015 \begin_layout Itemize
15017 \change_inserted -712698321 1673258111
15023 \begin_layout Itemize
15025 \change_inserted -712698321 1673258119
15032 \begin_layout Plain Layout
15034 \change_inserted -712698321 1673258133
15035 \begin_inset space ~
15047 \change_deleted -712698321 1673258111
15051 \begin_layout Itemize
15053 \change_deleted -712698321 1673258111
15059 \begin_layout Itemize
15061 \change_deleted -712698321 1673258111
15067 \begin_layout Itemize
15069 \change_deleted -712698321 1673258111
15075 \begin_layout Itemize
15077 \change_deleted -712698321 1673258111
15085 \begin_layout Standard
15086 These five are kind of quirky,
15088 \begin_inset Quotes eld
15092 \begin_inset Quotes erd
15095 in \SpecialChar LyX
15099 doesn't permit you to nest any other paragraph environment into an empty environment.
15101 that's fine and dandy,
15102 but it means that you wouldn't be able to start a slide with anything except plain text.
15104 I've performed a little
15105 \begin_inset Quotes eld
15110 \begin_inset Quotes erd
15116 \begin_layout Paragraph
15117 Quirks of the New Environments
15118 \begin_inset CommandInset label
15120 name "sec:slideQuirk"
15127 \begin_layout Standard
15128 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
15130 As I just mentioned,
15132 forbids environments that begin with another environment.
15133 To get around this,
15138 environment isn't a paragraph environment as described in the
15146 \begin_layout Standard
15147 You should consider
15162 \begin_inset Quotes eld
15165 pseudo-environments.
15166 \begin_inset Quotes erd
15169 They look like a section heading or a
15170 \begin_inset Quotes eld
15178 \begin_inset Quotes erd
15181 but really begin a [and,
15183 end the previous] paragraph environment.
15194 \begin_inset Quotes eld
15198 \begin_inset Quotes erd
15201 These two perform some action.
15204 \begin_layout Standard
15205 A common feature of all five environments,
15230 is a rather long-ish label.
15231 The text following this label —
15232 ordinarily the contents of the paragraph environment —
15233 is utterly irrelevant for
15258 completely ignores it.
15260 you can leave these five environments completely empty.
15264 \begin_layout Standard
15269 to put any text after the rather long-ish label,
15271 This could be a short description of the contents of the
15278 enter your descriptive comment and hit
15282 as you normally would.
15285 \begin_layout Standard
15287 \change_deleted -712698321 1673258321
15290 you don't want to enter any descriptive text,
15291 you'll hit another \SpecialChar LyX
15297 and will not let you start a new paragraph environment until you put something in the old one.
15302 \begin_layout Itemize
15304 \change_deleted -712698321 1673258321
15305 Start entering the text that will
15336 \begin_layout Itemize
15338 \change_deleted -712698321 1673258321
15339 Now move to the beginning of that paragraph.
15343 \begin_layout Itemize
15345 \change_deleted -712698321 1673258321
15355 \begin_layout Itemize
15357 \change_deleted -712698321 1673258321
15360 empty paragraph to a
15387 \begin_layout Standard
15389 \change_deleted -712698321 1673258321
15390 Some future version of \SpecialChar LyX
15393 resolve this quirkiness\SpecialChar ldots
15399 \begin_layout Subsubsection
15400 Making a Presentation with
15414 \begin_layout Paragraph
15422 \begin_layout Standard
15423 If you're expecting this section to teach you how to actually make a presentation,
15424 you'll be sorely disappointed.
15426 I'll describe all of the ways the
15427 \change_deleted -712698321 1673258368
15431 \change_inserted -712698321 1673258368
15436 class can assist you in preparing the materials for a presentation.
15437 Filling in the contents,
15445 the \SpecialChar LyX
15449 \begin_layout Standard
15454 environment [in the manner described in section
15455 \begin_inset space ~
15459 \begin_inset CommandInset ref
15461 reference "sec:slideQuirk"
15466 ] tells \SpecialChar LyX
15467 to begin a new slide [duh].
15468 The label for this environment/
15469 \change_inserted -712698321 1673258390
15471 \begin_inset Quotes eld
15475 \change_deleted -712698321 1673258391
15477 \begin_inset Quotes erd
15483 \begin_inset Quotes erd
15487 \begin_inset Quotes eld
15491 \begin_inset Quotes erd
15495 followed by the label,
15497 \begin_inset Quotes eld
15501 \begin_inset Quotes erd
15505 Any text or paragraph environments that follow this one go on the new slide.
15509 \begin_layout Standard
15510 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
15511 (this can be specified in the
15518 once you finish entering the contents of one slide.
15519 If you've entered more text than can physically fit on a slide,
15520 the extra overflows onto a new slide.
15521 I don't recommend doing this,
15523 since the overflow slide won't have any page number on it.
15525 it may interfere with any
15529 you've made to accompany the oversized
15536 \begin_layout Standard
15545 environments work the same way as the
15550 They both create an
15551 \begin_inset Quotes eld
15555 \begin_inset Quotes erd
15558 followed by a label [
15559 \begin_inset Quotes eld
15563 \begin_inset Quotes erd
15567 \begin_inset Quotes eld
15571 \begin_inset Quotes erd
15576 The color is a stunning magenta instead of blue,
15578 \begin_inset Quotes eld
15582 \begin_inset Quotes erd
15585 will look different,
15586 in style and in length.
15587 The label fonts of all three also differ from one another.
15590 \begin_layout Standard
15596 if the contents of a
15604 exceed the physical size of a slide or sheet of paper,
15605 the extra will overflow onto a new sheet.
15607 you should avoid this.
15608 It defeats the whole purpose of
15619 \begin_layout Paragraph
15629 \begin_layout Standard
15634 is a slide that sits atop another slide.
15635 Perhaps you wish to discuss a figure on the main
15639 before displaying the text associated with it.
15640 One way to accomplish this is tape a flap of dark paper over the part of the
15644 you want to display later.
15647 if you wish to overlap one graph with another,
15649 You would then have to fumble while speaking to align the two separate,
15654 s to align the two graphs.
15659 environment in both cases makes life much easier.
15662 \begin_layout Standard
15667 receives the page number of its
15668 \begin_inset Quotes eld
15672 \begin_inset Quotes erd
15681 \begin_inset Quotes eld
15689 \begin_inset Quotes erd
15696 \begin_layout Plain Layout
15703 \begin_inset Quotes eld
15711 \begin_inset Quotes erd
15716 \begin_inset Quotes eld
15724 \begin_inset Quotes erd
15729 \begin_inset Quotes eld
15737 \begin_inset Quotes erd
15742 \begin_inset space ~
15745 appended to the page number of the parent
15756 you want the contents of both the
15764 to each fit on a single physical slide!
15765 You should probably consider an
15770 \begin_inset Quotes eld
15774 \begin_inset Quotes erd
15783 the \SpecialChar LyX
15788 class provides a visual cue for this:
15789 the label at the start of an
15793 is shorter than that at the start of a
15799 when you generate printable output,
15800 you'll find alignment markers in all four corners of both the
15804 page and its parent
15809 These will assist you in lining up the two physical slides.
15812 \begin_layout Standard
15813 The major problem in overlaying two slides is aligning the contents of the two transparencies.
15814 How much space should you leave for that graph on the second slide?
15816 what if you want a graph and a sentence on second slide,
15817 but there is text on the main transparency that goes in between them?
15818 You could try and insert vertical space of the right size.
15819 The better way is to use
15830 \begin_layout Standard
15831 As their names imply,
15840 are two command-like paragraph environments that make all subsequent text invisible and visible,
15843 \begin_inset space ~
15847 \begin_inset CommandInset ref
15849 reference "sec:slideQuirk"
15854 that you don't place anything
15858 these two environments,
15865 it inserts a centered,
15866 sky-blue label into the page reading
15867 \begin_inset Quotes eld
15870 <Invisible Text Follows>
15871 \begin_inset Quotes erd
15875 For paragraphs following this label,
15885 it doesn't matter which] where they would be contain instead blank space.
15889 \begin_layout Standard
15895 the corresponding centered label is
15896 \begin_inset Quotes eld
15899 <Visible Text Follows>
15900 \begin_inset Quotes erd
15904 Paragraphs following this label behave normally.
15905 Note that the beginning of a new
15919 automatically shuts off an
15924 It's therefore not necessary to use
15935 \begin_layout Standard
15937 it should be obvious how to create overlay transparencies using the proper combination of
15956 \begin_layout Enumerate
15962 including everything that will appear on it,
15963 whether on the main slide or on the
15970 \begin_layout Enumerate
15971 Before each figure or paragraph that will appear only on the
15986 environment after the
15993 \begin_layout Enumerate
15998 immediately following the
16005 \begin_layout Enumerate
16006 Copy the contents of this
16017 \begin_layout Enumerate
16034 \begin_layout Standard
16036 You've just made an
16043 \begin_layout Standard
16044 There's one problem with the way I've designed the \SpecialChar LyX
16050 you can't make text in the middle of a paragraph invisible,
16051 nor make text in the middle of an invisible paragraph visible again.
16052 To accomplish this feat,
16053 you'll need to use some inlined \SpecialChar LaTeX
16058 \begin_layout Plain Layout
16059 The commands of interest are:
16063 \begin_layout Itemize
16068 invisible \SpecialChar ldots
16072 \begin_layout Itemize
16077 visible \SpecialChar ldots
16081 \begin_layout Plain Layout
16083 and need to be marked as \SpecialChar TeX
16086 \begin_inset Quotes eld
16090 \begin_inset Quotes erd
16093 you wish to change goes in between the brackets [and after the
16106 If you don't know how to mark text as \SpecialChar TeX
16108 see the appropriate section of the
16120 \begin_layout Paragraph
16130 \begin_inset CommandInset label
16132 name "sec:slideNote"
16139 \begin_layout Standard
16149 is associated with a
16150 \begin_inset Quotes eld
16154 \begin_inset Quotes erd
16164 the \SpecialChar LyX
16169 class provides visual cues.
16174 is shorter than that of a
16178 [yet longer than that of an
16183 like the label of an
16187 is shockingly magenta.
16193 has the page number of its
16194 \begin_inset Quotes eld
16198 \begin_inset Quotes erd
16207 \begin_inset Quotes eld
16215 \begin_inset Quotes erd
16220 \begin_inset Quotes eld
16228 \begin_inset Quotes erd
16233 \begin_inset Quotes eld
16241 \begin_inset Quotes erd
16246 You can have multiple
16250 s associated with a single
16265 you'll probably want to break up long
16269 s so that they fit on a single sheet of paper.
16272 \begin_layout Standard
16278 it contains anything additional you might want to say about a
16283 It could also be used as a sheet of reminders for a particular
16288 In the case of the latter,
16289 you might want to make use of time markers.
16291 the \SpecialChar LyX
16297 \begin_inset Quotes eld
16301 \begin_inset Quotes erd
16304 support for time markers,
16307 Sli\SpecialChar TeX
16312 you'll have to resort to using the \SpecialChar LaTeX
16316 \begin_layout Standard
16317 To use time markers,
16318 you'll need to specify the extra class option
16319 \begin_inset Quotes eld
16327 \begin_inset Quotes erd
16331 \begin_inset space ~
16335 \begin_inset CommandInset ref
16337 reference "sec:slidesetup"
16343 This option turns on timing marks,
16344 which will appear in the lower-left-hand corner of every
16349 To set what appears in the time marker,
16350 you use the \SpecialChar LaTeX
16352 \begin_inset Quotes eld
16362 \begin_inset Quotes erd
16366 \begin_inset Quotes eld
16376 \begin_inset Quotes erd
16380 The arguments of both commands are time measured in seconds.
16382 \begin_inset Quotes eld
16392 \begin_inset Quotes erd
16395 sets the time marker to a given time.
16397 \begin_inset Quotes eld
16407 \begin_inset Quotes erd
16410 increments the time marker by the specified amount.
16411 Using time markers and
16416 you can remind yourself how much time to spend on a particular
16423 \begin_layout Standard
16424 There's one last feature to describe.
16426 you'd like to print out all of your
16434 s on transparencies while printing all of your
16452 with which it is associated.
16453 What's a person to do?
16456 \begin_layout Standard
16458 there are two \SpecialChar LaTeX
16459 commands that allow you to select what to print out.
16460 Both must be placed into the preamble of your document.
16462 \begin_inset Quotes eld
16474 \begin_inset Quotes erd
16477 will cause the output to contain only the
16488 \begin_inset Quotes eld
16500 \begin_inset Quotes erd
16503 prevents the output of anything but
16508 I'd advise placing both commands in the preamble and initially comment both out.
16509 You can then preview your entire presentation as you write.
16510 When you're done writing,
16511 you can then uncomment one of the two to select what you want to print.
16512 I like to uncomment
16513 \begin_inset Quotes eld
16525 \begin_inset Quotes erd
16529 print to a file with
16530 \begin_inset Quotes eld
16538 \begin_inset Quotes erd
16542 comment it back out,
16544 \begin_inset Quotes eld
16556 \begin_inset Quotes erd
16560 \begin_inset Quotes eld
16568 \begin_inset Quotes erd
16572 I can then send either file to a printer,
16573 loading transparencies or plain paper as appropriate.
16576 \begin_layout Standard
16577 You can also provide other arguments to the
16578 \begin_inset Quotes eld
16588 \begin_inset Quotes erd
16592 \begin_inset Quotes eld
16602 \begin_inset Quotes erd
16606 See a good \SpecialChar LaTeX
16610 \begin_layout Subsubsection
16615 Class Template File
16618 \begin_layout Standard
16619 I have also provided a template file
16620 \change_deleted 564990737 1671617750
16623 \begin_inset Quotes eld
16631 \begin_inset Quotes erd
16643 begin your new presentation with
16645 File\SpecialChar menuseparator
16647 \begin_inset space ~
16651 \begin_inset space ~
16655 \change_inserted 564990737 1671616988
16656 \SpecialChar menuseparator
16657 Presentations\SpecialChar menuseparator
16663 Your new \SpecialChar LyX
16664 presentation file will contain an example
16685 additionally contain an example of the use of
16695 the preamble will contain:
16698 \begin_layout LyX-Code
16699 % Uncomment to print out only slides and overlays
16702 \begin_layout LyX-Code
16706 \begin_layout LyX-Code
16712 \begin_inset Newline newline
16718 \begin_layout LyX-Code
16719 % Uncomment to print out only notes
16722 \begin_layout LyX-Code
16726 \begin_layout LyX-Code
16734 \begin_layout Standard
16736 I created this class to support the \SpecialChar LaTeX2e
16738 \begin_inset Quotes eld
16743 Sli\SpecialChar TeX
16747 \begin_inset Quotes erd
16751 one of the built-in \SpecialChar LaTeX2e
16753 Neither I nor the rest of the \SpecialChar LyX
16754 Team endorse or oppose the use of this built-in slide class.
16755 It's here if you want it or need it.
16756 There exist other \SpecialChar LaTeX2e
16757 classes for creating presentations,
16759 \change_deleted -712698321 1673258708
16767 \change_deleted -712698321 1673258709
16769 \change_inserted -712698321 1673258699
16771 \change_deleted -712698321 1673258700
16775 \begin_inset space ~
16779 \begin_inset CommandInset ref
16781 reference "sec:foiltex"
16787 \change_deleted -712698321 1673258703
16789 \change_inserted -712698321 1673258705
16793 \change_deleted -712698321 1673258714
16795 \begin_inset Quotes eld
16803 \begin_inset Quotes erd
16806 package [present on some \SpecialChar TeX
16808 The latter is not yet supported under \SpecialChar LyX
16813 \begin_layout Plain Layout
16814 Perhaps you can take on the task\SpecialChar ldots
16821 \change_inserted -712698321 1673258738
16827 \begin_inset space ~
16831 \begin_inset CommandInset ref
16833 reference "subsec:Seminar"
16845 \change_deleted -712698321 1673258749
16846 I know nothing about these other classes.
16849 Try them out to see what sort of alternative they provide.
16852 \begin_layout Section
16854 \change_inserted 564990737 1670439661
16858 \begin_layout Subsection
16860 \change_inserted 564990737 1670439661
16864 \begin_layout Standard
16866 \change_inserted -712698321 1673689969
16867 Report classes are sort of a hybrid between book and article classes:
16870 \change_deleted -712698321 1673689899
16879 document class for preparing reports.
16886 \change_inserted 564990737 1670439661
16888 \change_deleted -712698321 1673689904
16890 \change_inserted 564990737 1670439661
16892 chapters and sections but does not provide
16893 \change_deleted -712698321 1673690062
16894 the paragraph styles needed for a book
16895 \change_inserted -712698321 1673690073
16899 \change_inserted 564990737 1670439661
16902 \change_deleted -712698321 1673690088
16908 \change_inserted -712698321 1673690083
16910 \change_inserted 564990737 1670439661
16912 \change_inserted -712698321 1673690085
16914 \change_inserted 564990737 1670439661
16917 \change_deleted -712698321 1673690094
16919 \change_inserted -712698321 1673690094
16921 \change_inserted 564990737 1670439661
16923 \change_deleted -712698321 1673690097
16925 \change_inserted 564990737 1670439661
16927 \change_deleted -712698321 1673690101
16929 \change_inserted 564990737 1670439661
16930 abstract paragraph style
16931 \change_inserted -712698321 1673690514
16932 s and are one-sided by default.
16934 \change_deleted -712698321 1673690134
16938 \change_inserted -712698321 1673690520
16941 \change_inserted 564990737 1670439661
16942 not start a new chapter on the right hand page
16943 \change_inserted -712698321 1673690150
16944 (even in two-side mode)
16945 \change_inserted 564990737 1670439661
16949 \begin_layout Standard
16951 \change_deleted -712698321 1673690173
16953 \change_inserted -712698321 1673690287
16954 All externally maintained
16955 \change_inserted 564990737 1672743528
16961 \change_inserted -712698321 1673690678
16962 that are officially supported by \SpecialChar LyX
16964 \change_inserted 564990737 1672743528
16965 are described in the Collections (section
16966 \begin_inset space ~
16970 \begin_inset CommandInset ref
16972 reference "sec:Collections"
16978 \change_inserted -712698321 1673690301
16980 \change_deleted -712698321 1673690300
16982 \change_inserted 564990737 1672743528
16986 \begin_layout Itemize
16988 \change_inserted 564990737 1672743530
16990 \change_deleted -712698321 1673690794
16994 \begin_inset space \thinspace{}
16997 (Japanese in vertical writing)
16998 \change_inserted -712698321 1675851188
16999 Japanese Report (Standard Class,
17001 \change_inserted 564990737 1672743530
17005 \change_deleted -712698321 1673690762
17009 \begin_inset space \thinspace{}
17013 \change_inserted -712698321 1673690762
17014 Japanese Report (Standard Class)
17015 \change_inserted 564990737 1672743530
17020 \begin_inset space ~
17024 \begin_inset CommandInset ref
17026 reference "subsec:Japanese"
17034 \begin_layout Itemize
17036 \change_inserted 564990737 1672743530
17038 \change_deleted -712698321 1673690718
17042 \begin_inset space \thinspace{}
17046 \change_inserted -712698321 1673690718
17048 \change_inserted 564990737 1672743530
17053 \begin_inset space ~
17057 \begin_inset CommandInset ref
17059 reference "subsec:KOMA-Script"
17067 \begin_layout Itemize
17069 \change_inserted 564990737 1672743530
17071 \change_deleted -712698321 1673690815
17075 \begin_inset space \thinspace{}
17078 (with extra font sizes)
17079 \change_inserted -712698321 1673690815
17080 Report (Standard Class with Extra Font Sizes)
17081 \change_inserted 564990737 1672743530
17086 \begin_inset space ~
17090 \begin_inset CommandInset ref
17092 reference "subsec:Extra-font-sizes"
17100 \begin_layout Itemize
17102 \change_inserted 564990737 1672743569
17104 \change_deleted -712698321 1673690833
17108 \begin_inset space \thinspace{}
17111 (Polish version by M.
17112 \begin_inset space \thinspace{}
17116 \change_inserted -712698321 1673690833
17117 Polish Report (MW Bundle)
17118 \change_inserted 564990737 1672743569
17123 \begin_inset space ~
17127 \begin_inset CommandInset ref
17129 reference "subsec:Polish-M.W.collection"
17140 \begin_layout Section
17142 \change_inserted 564990737 1670439674
17144 \change_deleted -712698321 1673691106
17146 \change_inserted -712698321 1673691108
17150 \begin_layout Standard
17152 \change_inserted -712698321 1673691276
17158 we assemble document classes that help to write drama or movie scripts.
17159 The category is also open for other scripts,
17160 such as lecture scripts,
17161 for which no classes are officially supported yet by \SpecialChar LyX
17163 \change_inserted 564990737 1670439674
17167 \begin_layout Subsection
17171 \begin_layout Standard
17177 \begin_layout Subsubsection
17181 \begin_layout Standard
17186 is for writing plays.
17187 The format is more decorative than
17190 \change_inserted -712698321 1673691568
17194 \begin_inset space ~
17198 \begin_inset CommandInset ref
17200 reference "subsec:Hollywood"
17207 and much less standardized.
17208 This format should be suitable for workshops.
17211 \begin_layout Subsubsection
17215 \begin_layout Standard
17219 \change_inserted -712698321 1673691609
17223 \begin_inset space ~
17227 \begin_inset CommandInset ref
17229 reference "subsec:Special-problems-Hollywood"
17238 \begin_layout Subsubsection
17242 \begin_layout Standard
17247 names as labels then cross-reference the label to insert the name.
17248 The cross-reference dialog will show the current cast of characters.
17251 \begin_layout Subsubsection
17252 Paper size and Margins
17255 \begin_layout Standard
17263 \begin_layout Subsubsection
17267 \begin_layout Standard
17268 The following environments are available.
17273 to get the bind keys shown at the right.
17276 \begin_layout Itemize
17280 \begin_inset Newline newline
17285 You should not have to use this,
17286 but it is here for anything that does not fit otherwise.
17289 \begin_layout Itemize
17293 \begin_inset space \hfill{}
17297 \begin_inset Newline newline
17302 Used to describe stage setting and the action.
17303 First use of speaker names in all CAPs.
17306 \begin_layout Itemize
17310 \begin_inset space \hfill{}
17314 \begin_inset Newline newline
17319 Automatically numbered.
17320 On screen it will be arabic,
17321 but will print as Roman.
17324 \begin_layout Itemize
17328 \begin_inset space \hfill{}
17332 \begin_inset Newline newline
17342 It is just centered text.
17345 \begin_layout Itemize
17349 \begin_inset space \hfill{}
17353 \begin_inset Newline newline
17358 Not automatically numbered.
17359 You supply the number.
17360 This is because I couldn't figure out how.
17363 \begin_layout Itemize
17367 \begin_inset space \hfill{}
17371 \begin_inset Newline newline
17376 A special case of Narrative to describe the setting and action as the curtain rises.
17379 \begin_layout Itemize
17383 \begin_inset space \hfill{}
17387 \begin_inset Newline newline
17392 The speaker's (actor's) title,
17393 centered in all CAPS.
17396 \begin_layout Itemize
17400 \begin_inset space \hfill{}
17404 \begin_inset Newline newline
17409 Instructions to the speaker.
17410 The parentheses are automatically inserted.
17411 The ( will appear on screen,
17412 but both will be in the printed play.
17413 This environment is only used within
17420 \begin_layout Itemize
17424 \begin_inset space \hfill{}
17428 \begin_inset Newline newline
17433 What the Speaker says.
17436 \begin_layout Itemize
17440 \begin_inset space \hfill{}
17444 \begin_inset Newline newline
17449 The curtain comes down.
17452 \begin_layout Itemize
17456 \begin_inset space \hfill{}
17462 \begin_layout Itemize
17466 \begin_inset space \hfill{}
17472 \begin_layout Itemize
17476 \begin_inset space \hfill{}
17482 \begin_layout Standard
17486 \begin_layout Subsection
17488 \change_inserted -712698321 1673691551
17489 \begin_inset CommandInset label
17491 name "subsec:Hollywood"
17497 Hollywood (Hollywood spec scripts)
17500 \begin_layout Standard
17506 \begin_layout Subsubsection
17510 \begin_layout Standard
17511 Getting the format of a Hollywood script right is a
17512 \begin_inset Quotes eld
17516 \begin_inset Quotes erd
17519 It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
17520 Each page of a script should be one minute of film.
17521 Nothing goes in a script that you cannot see or hear on screen.
17522 The courier 12 pt font should be used throughout.
17526 \begin_layout Subsubsection
17528 \change_inserted -712698321 1673691597
17529 \begin_inset CommandInset label
17531 name "subsec:Special-problems-Hollywood"
17540 \begin_layout Standard
17541 Speakers' lines should
17542 \change_deleted -712698321 1673691805
17546 \change_inserted -712698321 1673691805
17551 break in mid-sentence.
17552 If a speaker's lines continue over a page break,
17557 title followed by (Cont'd).
17560 \begin_layout Subsubsection
17564 \begin_layout Standard
17569 names as labels then cross-reference the label to insert the name.
17570 The cross-reference dialog will show the current cast of characters.
17571 You can use this to insert the speaker name in narratives also.
17574 \begin_layout Subsubsection
17575 Paper size and Margins
17578 \begin_layout Standard
17586 \begin_layout Subsubsection
17590 \begin_layout Standard
17591 The following environments are available.
17596 to get the bind keys shown at the right.
17599 \begin_layout Itemize
17603 \begin_inset Newline newline
17608 Used where nothing else works.
17612 \begin_layout Itemize
17618 \begin_inset space \hfill{}
17626 \begin_inset Newline newline
17629 Usually followed by something like
17630 \begin_inset Quotes eld
17633 on Sally waking up.
17634 \begin_inset Quotes erd
17640 \begin_layout Itemize
17644 \begin_inset space \hfill{}
17648 \begin_inset Newline newline
17653 Introduces a new INTERIOR camera set-up.
17654 Always followed by DAY or NIGHT,
17655 or something similar to define the lighting required.
17656 Everthing on this line in CAPS.
17659 \begin_layout Itemize
17663 \begin_inset space \hfill{}
17667 \begin_inset Newline newline
17672 Introduces a new EXTERIOR camera set-up.
17673 Everthing on this line in CAPS.
17676 \begin_layout Itemize
17680 \begin_inset space \hfill{}
17684 \begin_inset Newline newline
17689 The character speaking.
17692 \begin_layout Itemize
17696 \begin_inset space \hfill{}
17700 \begin_inset Newline newline
17705 Instructions to the speaker.
17706 The () are automatically inserted.
17709 \begin_layout Itemize
17713 \begin_inset space \hfill{}
17717 \begin_inset Newline newline
17729 \begin_layout Itemize
17733 \begin_inset space \hfill{}
17737 \begin_inset Newline newline
17742 Camera movement instruction.
17744 \begin_inset space \thinspace{}
17748 \begin_inset space \space{}
17754 \begin_layout Itemize
17758 \begin_inset space \hfill{}
17764 \begin_layout Itemize
17768 \begin_inset space \hfill{}
17774 \begin_layout Itemize
17778 \begin_inset space \hfill{}
17784 \begin_layout Itemize
17788 \begin_inset space \hfill{}
17794 \begin_layout Subsubsection
17798 \begin_layout Itemize
17803 \begin_layout Itemize
17808 \begin_layout Itemize
17810 \begin_inset space \thinspace{}
17818 \begin_layout Itemize
17824 \begin_layout Itemize
17829 \begin_layout Itemize
17834 \begin_layout Chapter
17836 \change_inserted 564990737 1671185876
17840 \begin_layout Section
17842 \change_inserted 564990737 1671716212
17843 Academic Field Specifics
17846 \begin_layout Subsection
17848 \change_inserted 564990737 1671716212
17850 Hazard and Precautionary Statements
17853 \begin_layout Standard
17855 \change_inserted 564990737 1671716212
17856 This module provides two insets
17857 \change_inserted -712698321 1673779038
17858 and a paragraph style
17859 \change_inserted 564990737 1671716212
17860 to typeset numbers and phrases of chemical hazard and precautionary statements.
17861 For a description see
17863 File\SpecialChar menuseparator
17864 Open Example\SpecialChar menuseparator
17865 Modules\SpecialChar menuseparator
17866 Hazard and Precautionary Statements
17870 Help\SpecialChar menuseparator
17871 Specific Manuals\SpecialChar menuseparator
17872 Hazard and Precautionary Statements
17877 \begin_layout Subsection
17879 \change_inserted 564990737 1671716212
17883 Risk and Safety Statements
17886 \begin_layout Standard
17888 \change_inserted 564990737 1671716212
17889 This module provides two insets,
17899 accessible via the menu
17904 nsert\SpecialChar menuseparator
17906 \begin_inset space ~
17911 and an environment to typeset numbers and phrases of chemical risk and safety statements.
17914 \begin_layout Subsection
17916 \change_inserted 564990737 1671716212
17920 \begin_layout Standard
17922 \change_inserted 564990737 1671716212
17924 \change_deleted -712698321 1673779847
17930 \change_inserted -712698321 1673779869
17932 \change_inserted 564990737 1671716212
17933 environments useful for linguistics (numbered examples,
17937 \change_inserted -712698321 1673779891
17939 \change_inserted 564990737 1671716212
17941 You can obtain information about this module in
17946 elp\SpecialChar menuseparator
17952 \begin_inset space ~
17955 Manuals\SpecialChar menuseparator
17964 File\SpecialChar menuseparator
17965 Open Example\SpecialChar menuseparator
17966 Modules\SpecialChar menuseparator
17972 \begin_layout Section
17974 \change_inserted 564990737 1671788778
17978 \begin_layout Subsection
17980 \change_inserted 564990737 1671788778
17984 \begin_layout Standard
17986 \change_inserted 564990737 1671788778
17987 This module supports the Braille
17988 \change_deleted -712698321 1673779995
17990 \change_inserted -712698321 1673779996
17992 \change_inserted 564990737 1671788778
17994 It requires the \SpecialChar LaTeX
18000 This and its documentation can be obtained from
18001 \begin_inset CommandInset href
18004 target "https://www.ctan.org/pkg/braille"
18011 \change_deleted -712698321 1673780105
18012 You do not have to reconfigure your system after installing it.
18014 \change_inserted 564990737 1671788778
18020 elp\SpecialChar menuseparator
18026 \begin_inset space ~
18029 Manuals\SpecialChar menuseparator
18038 File\SpecialChar menuseparator
18039 Open Example\SpecialChar menuseparator
18040 Modules\SpecialChar menuseparator
18046 \begin_layout Section
18048 \change_inserted 564990737 1671788778
18049 Annotation & Revision
18052 \begin_layout Subsection
18054 \change_inserted 564990737 1671788778
18058 \begin_layout Standard
18060 \change_inserted 564990737 1671788778
18061 This module provides “FiXme” (marginal) annotations for document revision purposes.
18062 A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
18063 The annotations are customizable via the LaTeX preamble.
18065 \change_inserted -712698321 1673780478
18069 \change_deleted -712698321 1673780479
18071 \change_inserted 564990737 1671788778
18074 documentation which can be obtained from
18075 \begin_inset CommandInset href
18078 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
18087 \begin_layout Paragraph
18089 \change_inserted 564990737 1671788778
18093 \begin_layout Standard
18095 \change_inserted 564990737 1671788778
18097 the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
18099 Document\SpecialChar menuseparator
18100 Settings\SpecialChar menuseparator
18101 Document Class\SpecialChar menuseparator
18102 Class Options\SpecialChar menuseparator
18106 To display them always,
18115 Document\SpecialChar menuseparator
18116 Settings\SpecialChar menuseparator
18124 \begin_layout Subsection
18126 \change_inserted 564990737 1671788778
18130 \begin_layout Standard
18132 \change_inserted 564990737 1671788778
18133 This module provides various kinds of annotations for PDF output.
18136 Help\SpecialChar menuseparator
18137 Specific Manuals\SpecialChar menuseparator
18142 File\SpecialChar menuseparator
18143 Open Example\SpecialChar menuseparator
18144 Modules\SpecialChar menuseparator
18150 \begin_layout Subsection
18152 \change_inserted 564990737 1671788778
18158 \begin_layout Standard
18160 \change_inserted 564990737 1671788778
18161 This module provides fields and buttons for PDF forms.
18163 \begin_inset CommandInset href
18165 name "hyperref documentation"
18166 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
18174 Help\SpecialChar menuseparator
18175 Specific Manuals\SpecialChar menuseparator
18180 File\SpecialChar menuseparator
18181 Open Example\SpecialChar menuseparator
18182 Modules\SpecialChar menuseparator
18188 \begin_layout Subsection
18190 \change_inserted 564990737 1671788778
18196 \begin_layout Standard
18198 \change_inserted 564990737 1671788778
18199 This module defines an inset to typeset reading aids (ruby,
18200 furigana) to Chinese characters.
18202 \change_deleted -712698321 1673781076
18204 \change_inserted 564990737 1671788778
18210 \change_deleted -712698321 1673781078
18212 \change_inserted 564990737 1671788778
18214 \change_deleted -712698321 1673781079
18216 \change_inserted 564990737 1671788778
18220 \change_deleted -712698321 1673781080
18224 \change_inserted 564990737 1671788778
18226 \change_deleted -712698321 1673781082
18228 \change_inserted 564990737 1671788778
18232 \change_deleted -712698321 1673781083
18236 \change_inserted 564990737 1671788778
18237 package (depending on the TeX engine) or a fallback definition.
18241 \begin_layout Subsection
18243 \change_inserted 564990737 1671788778
18249 \begin_layout Standard
18251 \change_inserted 564990737 1671788778
18252 This module provides custom insets to insert TODO items in your document.
18253 In order to generate a “List of TODOs,” the module provides a paragraph style.
18255 \change_deleted -712698321 1673781223
18257 \change_inserted 564990737 1671788778
18261 \change_deleted -712698321 1673781224
18265 \change_inserted 564990737 1671788778
18268 Document\SpecialChar menuseparator
18269 Settings\SpecialChar menuseparator
18270 Document Class\SpecialChar menuseparator
18271 Class Options\SpecialChar menuseparator
18274 ) suppresses the output of TODO notes.
18276 \begin_inset CommandInset href
18278 name "todonotes documentation"
18279 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
18287 \begin_layout Section
18289 \change_inserted 564990737 1671829045
18293 \begin_layout Subsection
18295 \change_inserted 564990737 1671829045
18297 \change_deleted -712698321 1673781454
18299 \change_inserted -712698321 1673781454
18301 \change_inserted 564990737 1671829045
18305 \begin_layout Standard
18307 \change_inserted 564990737 1671829045
18308 This module adds support for using natbib together with apacite (the bibliography style need not be
18323 or any bibliography that works with both the natbib and apacite packages.)
18326 \begin_layout Section
18328 \change_inserted 564990737 1671829045
18332 \begin_layout Subsection
18334 \change_inserted 564990737 1671829045
18335 Fancy Colored Boxes
18338 \begin_layout Standard
18340 \change_inserted 564990737 1671829045
18341 This module adds ten custom insets that support colored boxes via the
18348 Help\SpecialChar menuseparator
18349 Specific Manuals\SpecialChar menuseparator
18355 File\SpecialChar menuseparator
18356 Open Example\SpecialChar menuseparator
18357 Modules\SpecialChar menuseparator
18361 \change_inserted -712698321 1673854244
18363 \change_inserted 564990737 1671829045
18365 \begin_inset CommandInset href
18367 name "tcolorbox documentation"
18368 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
18377 \begin_layout Subsection
18379 \change_inserted 564990737 1671829045
18383 \begin_layout Standard
18385 \change_inserted 564990737 1671829045
18386 This provides the custom insets
18404 to scale and rotate its content.
18407 \begin_layout Standard
18409 \change_inserted 564990737 1671829045
18414 is a simple way of reversing text without any other enhancement:
18417 \begin_layout Standard
18419 \change_inserted 564990737 1671829045
18420 \begin_inset Flex Reflectbox
18423 \begin_layout Plain Layout
18425 \change_inserted 564990737 1671829045
18426 Great Western Railway
18436 \begin_layout Standard
18438 \change_inserted 564990737 1671829045
18439 (You will need to use Ctrl-R to see any of these examples.)
18442 \begin_layout Standard
18444 \change_inserted 564990737 1671829045
18449 allows you to specify the dimensions of the text or image;
18450 permissible units are em,
18472 it scales by the width factor:
18475 \begin_layout Standard
18477 \change_inserted 564990737 1671829045
18478 \begin_inset Flex Resizebox
18481 \begin_layout Plain Layout
18483 \change_inserted 564990737 1671829045
18484 \begin_inset Argument 1
18487 \begin_layout Plain Layout
18489 \change_inserted 564990737 1671829045
18498 \begin_inset Argument 2
18501 \begin_layout Plain Layout
18503 \change_inserted 564990737 1671829045
18511 Great Western Railway
18521 \begin_layout Standard
18523 \change_inserted 564990737 1671829045
18528 allows you to rotate
18529 \change_deleted -712698321 1673856297
18531 \change_inserted -712698321 1673856302
18533 \change_inserted 564990737 1671829045
18534 around the reference point of the box.
18535 If you wish to rotate the box around a different origin,
18536 place the cursor inside the box and select Insert\SpecialChar menuseparator
18566 or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
18570 \begin_layout Standard
18572 \change_inserted 564990737 1671829045
18573 \begin_inset Flex Rotatebox
18576 \begin_layout Plain Layout
18578 \change_inserted 564990737 1671829045
18579 \begin_inset Argument 1
18582 \begin_layout Plain Layout
18584 \change_inserted 274215730 1672888693
18586 \change_inserted 564990737 1671829045
18595 \begin_inset Argument 2
18598 \begin_layout Plain Layout
18600 \change_inserted 564990737 1671829045
18608 Great Western Railway
18618 \begin_layout Standard
18620 \change_inserted 564990737 1671829045
18621 You can combine boxes as in:
18624 \begin_layout Standard
18626 \change_inserted 564990737 1671829045
18627 \begin_inset Flex Rotatebox
18630 \begin_layout Plain Layout
18632 \change_inserted 564990737 1671829045
18633 \begin_inset Argument 1
18636 \begin_layout Plain Layout
18638 \change_inserted 274215730 1672888702
18640 \change_inserted 564990737 1671829045
18649 \begin_inset Argument 2
18652 \begin_layout Plain Layout
18654 \change_inserted 564990737 1671829045
18663 \begin_inset Flex Resizebox
18666 \begin_layout Plain Layout
18668 \change_inserted 564990737 1671829045
18669 \begin_inset Argument 1
18672 \begin_layout Plain Layout
18674 \change_inserted 564990737 1671829045
18683 \begin_inset Argument 2
18686 \begin_layout Plain Layout
18688 \change_inserted 564990737 1671829045
18697 \begin_inset Flex Reflectbox
18700 \begin_layout Plain Layout
18702 \change_inserted 564990737 1671829045
18703 Great Western Railway
18727 \begin_layout Standard
18729 \change_inserted 564990737 1671829045
18735 \change_deleted -712698321 1673856306
18737 \change_inserted -712698321 1673856308
18739 \change_inserted 564990737 1671829045
18741 select Insert\SpecialChar menuseparator
18742 V-Factor to add a vertical factor.
18743 If the vertical factor is omitted,
18744 the horizontal is used.
18745 Adding different horizontal and vertical values creates distortion as in
18748 \begin_layout Standard
18750 \change_inserted 564990737 1671829045
18753 \begin_inset Flex Scalebox
18756 \begin_layout Plain Layout
18758 \change_inserted 564990737 1671829045
18759 \begin_inset Argument 1
18762 \begin_layout Plain Layout
18764 \change_inserted 564990737 1671829045
18773 \begin_inset Argument 2
18776 \begin_layout Plain Layout
18778 \change_inserted 564990737 1671829045
18788 Great Western Railway
18798 \begin_layout Standard
18800 \change_inserted 564990737 1671829045
18801 A negative horizontal value reverses the text
18802 \change_inserted -712698321 1673856686
18803 on the horizontal axis,
18805 \change_deleted -712698321 1673856688
18807 \change_inserted 564990737 1671829045
18808 a negative vertical value
18809 \change_deleted -712698321 1673856694
18811 \change_inserted -712698321 1673856702
18812 on the vertical axis,
18814 \change_inserted 564990737 1671829045
18816 \change_deleted -712698321 1673856704
18818 \change_inserted 564990737 1671829045
18822 \begin_layout Standard
18824 \change_inserted 564990737 1671829045
18825 \begin_inset Flex Scalebox
18828 \begin_layout Plain Layout
18830 \change_inserted 564990737 1671829045
18831 \begin_inset Argument 1
18834 \begin_layout Plain Layout
18836 \change_inserted 564990737 1671829045
18845 \begin_inset Argument 2
18848 \begin_layout Plain Layout
18850 \change_inserted 564990737 1671829045
18858 Great Western Railway
18866 \begin_inset Flex Scalebox
18869 \begin_layout Plain Layout
18871 \change_inserted 564990737 1671829045
18872 \begin_inset Argument 1
18875 \begin_layout Plain Layout
18877 \change_inserted 564990737 1671829045
18886 \begin_inset Argument 2
18889 \begin_layout Plain Layout
18891 \change_inserted 564990737 1671829045
18899 Great Western Railway
18909 \begin_layout Subsection
18911 \change_inserted 564990737 1671884699
18915 \begin_layout Standard
18917 \change_inserted 564990737 1671884699
18918 This module defines Boxes with section header.
18919 It is mainly intended for the SciPoster Document class.
18923 \begin_layout Subsection
18925 \change_inserted 564990737 1671884699
18926 Variable-width Minipages
18929 \begin_layout Standard
18931 \change_inserted 564990737 1671884699
18935 \begin_inset space \thinspace{}
18942 Insert\SpecialChar menuseparator
18954 package provides a variable-width minipage,
18955 whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
18956 The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
18958 Insert\SpecialChar menuseparator
18960 \begin_inset space \thinspace{}
18971 Insert\SpecialChar menuseparator
18973 \begin_inset space \thinspace{}
18987 File\SpecialChar menuseparator
18988 Open Example\SpecialChar menuseparator
18989 Variable-width Minipages
18995 \begin_layout Section
18997 \change_inserted 564990737 1671884699
19001 \begin_layout Subsection
19003 \change_inserted 564990737 1671884699
19004 Fix Computer Modern Fonts
19007 \begin_layout Standard
19009 \change_inserted 564990737 1671884699
19010 This module uses the
19014 package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
19016 \begin_inset CommandInset href
19018 name "fix-cm documentation"
19019 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
19028 \begin_layout Subsection
19030 \change_inserted 564990737 1671884699
19032 Kernel Fixes (Obsolete)
19035 \begin_layout Standard
19037 \change_inserted 564990737 1671884699
19038 This module loads the \SpecialChar LaTeX
19043 which contains some bug fixes for \SpecialChar LaTeX
19045 If you use this module your typeset document may look different when you process it,
19046 depending on the respective version of
19054 \begin_layout Paragraph
19056 \change_inserted 564990737 1671884699
19060 \begin_layout Standard
19062 \change_inserted 564990737 1671884699
19063 recent \SpecialChar LaTeX
19064 kernels (as of 2015/01/01) include the functionality of
19073 module is obsolete with newer \SpecialChar LaTeX
19076 \change_deleted -712698321 1673857809
19078 \change_inserted 564990737 1671884699
19082 \begin_layout Subsection
19084 \change_inserted 564990737 1671884699
19085 Minimalistic Insets
19088 \begin_layout Standard
19090 \change_inserted 564990737 1671884699
19091 This module redefines several insets (Index,
19093 URL) as being Minimalistic.
19096 \begin_layout Subsection
19098 \change_inserted 564990737 1671884699
19099 Title and Preamble Hacks
19102 \begin_layout Standard
19104 \change_inserted 564990737 1671884699
19105 This module provides two new paragraph styles:
19109 \begin_layout Enumerate
19111 \change_inserted 564990737 1671884699
19116 which puts whatever is entered into it into the preamble.
19119 to include preamble code in the body of a LyX document.
19123 \begin_layout Enumerate
19125 \change_inserted 564990737 1671884699
19130 which that will put its contents into the body of the LaTeX document,
19138 This is useful for making branches and notes in title-related material.
19140 if you put these in a
19145 this signals to LyX to output
19152 which may then come too early.)
19155 \begin_layout Section
19157 \change_inserted 564990737 1672081439
19161 \begin_layout Subsection
19163 \change_inserted 564990737 1672081439
19167 \begin_layout Standard
19169 \change_inserted 564990737 1672081439
19170 This module uses the
19174 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
19175 Use the Algorithm paragraph style to enter and indent the algorithm.
19177 \begin_inset CommandInset href
19179 name "algorithm2e documentation"
19180 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
19188 \begin_layout Subsection
19190 \change_inserted 564990737 1672081439
19191 Bilingual Captions AKA Multilingual Captions
19194 \begin_layout Standard
19196 \change_inserted 564990737 1672081439
19197 This module provides the paragraph style
19200 \begin_inset space ~
19205 with which to typeset
19206 \change_deleted -712698321 1673859156
19208 \change_inserted -712698321 1673859156
19210 \change_inserted 564990737 1672081439
19212 Within this paragraph style
19214 Insert\SpecialChar menuseparator
19217 allows you to enter the desired
19218 \change_inserted -712698321 1673859387
19220 \change_inserted 564990737 1672081439
19221 language using one of the babel names.
19224 File\SpecialChar menuseparator
19225 Open Example\SpecialChar menuseparator
19227 \change_inserted -712698321 1673859558
19228 Modules\SpecialChar menuseparator
19230 \change_inserted 564990737 1672081439
19231 Multilingual Captions
19235 Help\SpecialChar menuseparator
19236 Specific Manuals\SpecialChar menuseparator
19237 Multilingual Captions
19239 further information on its use.
19242 \begin_layout Subsection
19244 \change_inserted 564990737 1672081439
19245 Number Figures by Section
19248 \begin_layout Standard
19250 \change_inserted 564990737 1672081439
19251 This module resets the figure number at section start and prepends the section number to the figure number,
19252 as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
19255 \begin_layout Subsection
19257 \change_inserted 564990737 1672081439
19258 Number Tables by Section
19261 \begin_layout Standard
19263 \change_inserted 564990737 1672081439
19264 This module resets the table number at section start and prepends the section number to the table number,
19265 as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
19268 \begin_layout Section
19270 \change_inserted 564990737 1672081439
19274 \begin_layout Subsection
19276 \change_inserted 564990737 1672081439
19280 \begin_layout Standard
19282 \change_inserted 564990737 1672081439
19283 This module adds an endnote inset,
19284 in addition to footnotes.
19290 which has some limitations but works with older
19291 \change_deleted -712698321 1673861636
19293 \change_inserted -712698321 1673861636
19296 \change_inserted 564990737 1672081439
19297 distributions as well.
19300 Insert\SpecialChar menuseparator
19301 Custom Inset\SpecialChar menuseparator
19304 to insert an endnote and
19306 Insert\SpecialChar menuseparator
19307 List/Contents/References\SpecialChar menuseparator
19310 to insert the endnotes list where you want the endnotes to appear.
19313 Help\SpecialChar menuseparator
19315 \change_deleted -712698321 1673861792
19316 \SpecialChar menuseparator
19318 \change_inserted 564990737 1672081439
19320 \change_deleted -712698321 1673861963
19321 \SpecialChar menuseparator
19322 Notes\SpecialChar menuseparator
19324 \change_inserted -712698321 1673861963
19331 \change_inserted 564990737 1672081439
19337 \begin_layout Subsection
19339 \change_inserted 564990737 1672081439
19340 Endnotes (Extended)
19343 \begin_layout Standard
19345 \change_inserted 564990737 1672081439
19346 This module adds an endnote inset,
19347 in addition to footnotes.
19352 package which is more powerful and customizable than the
19357 but requires a fairly modern
19358 \change_deleted -712698321 1673861643
19360 \change_inserted -712698321 1673861643
19363 \change_inserted 564990737 1672081439
19365 \change_deleted -712698321 1673861645
19367 \change_inserted -712698321 1673861645
19370 \change_inserted 564990737 1672081439
19374 Insert\SpecialChar menuseparator
19375 Custom Inset\SpecialChar menuseparator
19378 to insert an endnote and
19380 Insert\SpecialChar menuseparator
19381 List/Contents/References\SpecialChar menuseparator
19384 to insert the endnotes list where you want the endnotes to appear.
19387 Help\SpecialChar menuseparator
19389 \change_deleted -712698321 1673861798
19390 \SpecialChar menuseparator
19392 \change_inserted 564990737 1672081439
19394 \change_inserted -712698321 1673861924
19403 \change_deleted -712698321 1673861927
19406 \SpecialChar menuseparator
19407 Notes\SpecialChar menuseparator
19409 \change_inserted 564990737 1672081439
19415 \begin_layout Subsection
19417 \change_inserted 564990737 1672081439
19418 Footnotes as Endnotes (Basic)
19421 \begin_layout Standard
19423 \change_inserted 564990737 1672081439
19424 This module sets all footnotes as endnotes.
19430 which has some limitations but works with older
19431 \change_deleted -712698321 1673861650
19433 \change_inserted -712698321 1673861650
19436 \change_inserted 564990737 1672081439
19437 distributions as well.
19440 Insert\SpecialChar menuseparator
19441 List/Contents/References\SpecialChar menuseparator
19444 to insert the endnotes list where you want the endnotes to appear.
19447 Help\SpecialChar menuseparator
19449 \change_deleted -712698321 1673861805
19450 \SpecialChar menuseparator
19452 \change_inserted 564990737 1672081439
19454 \change_deleted -712698321 1673861947
19455 \SpecialChar menuseparator
19456 Notes\SpecialChar menuseparator
19458 \change_inserted -712698321 1673861947
19465 \change_inserted 564990737 1672081439
19471 \begin_layout Subsection
19473 \change_inserted 564990737 1672081439
19474 Footnotes as Endnotes (Extended)
19477 \begin_layout Standard
19479 \change_inserted 564990737 1672081439
19480 This module sets all footnotes as endnotes.
19485 package which is more powerful and customizable than then
19490 but requires a fairly modern
19491 \change_deleted -712698321 1673861654
19493 \change_inserted -712698321 1673861654
19496 \change_inserted 564990737 1672081439
19498 \change_deleted -712698321 1673861656
19500 \change_inserted -712698321 1673861656
19503 \change_inserted 564990737 1672081439
19507 Insert\SpecialChar menuseparator
19508 List/Contents/References\SpecialChar menuseparator
19511 to insert the endnotes list where you want the endnotes to appear.
19514 Help\SpecialChar menuseparator
19516 \change_deleted -712698321 1673861808
19517 \SpecialChar menuseparator
19519 \change_inserted 564990737 1672081439
19521 \change_deleted -712698321 1673861955
19522 \SpecialChar menuseparator
19523 Notes\SpecialChar menuseparator
19525 \change_inserted -712698321 1673861989
19534 \change_deleted -712698321 1673861956
19536 \change_inserted 564990737 1672081439
19540 \begin_layout Section
19542 \change_inserted 564990737 1672081439
19547 \begin_layout Subsection
19549 \change_inserted 564990737 1672081439
19553 \begin_layout Standard
19555 \change_inserted 564990737 1672081439
19556 This module provides support for the
19560 package to print chess games.
19563 File\SpecialChar menuseparator
19564 Open Example\SpecialChar menuseparator
19565 Articles\SpecialChar menuseparator
19568 where you will find
19577 \begin_inset CommandInset href
19579 name "chessboard documentation"
19580 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
19588 \begin_layout Subsection
19590 \change_inserted 564990737 1672081439
19591 Lilypond Music Notation
19594 \begin_layout Standard
19596 \change_inserted 564990737 1672081439
19597 This module provides an inset via
19602 nsert\SpecialChar menuseparator
19603 Custom Inset\SpecialChar menuseparator
19606 in which to enter code for the LilyPond music editor.
19607 It will then be processed in the output.
19610 Help\SpecialChar menuseparator
19611 Specific Manuals\SpecialChar menuseparator
19616 File\SpecialChar menuseparator
19617 Open Example\SpecialChar menuseparator
19618 Modules\SpecialChar menuseparator
19622 It cannot be used if the modules
19625 \begin_inset space \thinspace{}
19637 \begin_layout Section
19639 \change_inserted 564990737 1672138150
19643 \begin_layout Subsection
19645 \change_inserted 564990737 1672138150
19647 \begin_inset CommandInset label
19649 name "subsec:Customizable-Lists"
19656 \begin_layout Standard
19658 \change_inserted 564990737 1672138150
19659 This module uses the
19663 package to enable the customization of various list environments.
19666 \begin_layout Subsubsection
19668 \change_inserted 564990737 1672138150
19669 Custom Enumerate Lists
19672 \begin_layout Standard
19675 \change_inserted 564990737 1672138150
19676 The default numbering of numbered lists can be changed by adding an optional argument (menu
19681 nsert\SpecialChar menuseparator
19688 ) to the first item of each level in the list.
19689 There you add the command
19692 \begin_layout Standard
19694 \change_inserted 564990737 1672138150
19702 \begin_layout Standard
19704 \change_inserted 564990737 1672138150
19705 in \SpecialChar TeX
19715 \begin_layout Standard
19717 \change_inserted 564990737 1672138150
19722 is the first level counter of the enumeration.
19723 To change the numbering for the list sublevels,
19728 ” in the command by the small Roman numeral of the level (
19750 \begin_layout Standard
19752 \change_inserted 564990737 1672138150
19759 outputs the counter as a small Roman numeral.
19760 For capital Roman numerals replace
19772 in the command above.
19773 For Arabic numerals use
19781 \begin_inset Quotes eld
19785 \begin_inset Quotes erd
19788 items with capital or small Latin letters use
19804 \begin_layout Standard
19807 \change_inserted 564990737 1672138150
19808 \begin_inset Note Greyedout
19811 \begin_layout Plain Layout
19813 \change_inserted 564990737 1672138150
19819 You can only number 26
19820 \begin_inset space ~
19823 items with Latin letters,
19824 because this numbering is limited to single letters.
19832 \begin_layout Standard
19834 \change_inserted 564990737 1672138150
19835 Here is a list with custom numbering:
19838 \begin_layout Enumerate
19840 \change_inserted 564990737 1672138150
19841 \begin_inset Argument 1
19844 \begin_layout Plain Layout
19846 \change_inserted 564990737 1672138150
19850 \begin_layout Plain Layout
19852 \change_inserted 564990737 1672138150
19873 \begin_inset Separator latexpar
19880 \begin_layout Enumerate
19882 \change_inserted 564990737 1672138150
19883 \begin_inset Argument 1
19886 \begin_layout Plain Layout
19888 \change_inserted 564990737 1672138150
19892 \begin_layout Plain Layout
19894 \change_inserted 564990737 1672138150
19915 \begin_layout Enumerate
19917 \change_inserted 564990737 1672138150
19919 \begin_inset Separator latexpar
19926 \begin_layout Enumerate
19928 \change_inserted 564990737 1672138150
19929 \begin_inset Argument 1
19932 \begin_layout Plain Layout
19934 \change_inserted 564990737 1672138150
19938 \begin_layout Plain Layout
19940 \change_inserted 564990737 1672138150
19943 \change_deleted 274215730 1672889016
19947 \change_inserted 274215730 1672889016
19951 \change_inserted 564990737 1672138150
19967 \begin_inset Separator latexpar
19974 \begin_layout Enumerate
19976 \change_inserted 564990737 1672138150
19977 \begin_inset Argument 1
19980 \begin_layout Plain Layout
19982 \change_inserted 564990737 1672138150
19986 \begin_layout Plain Layout
19988 \change_inserted 564990737 1672138150
20012 \begin_layout Standard
20014 \change_inserted 564990737 1672138150
20015 For this list these commands were used:
20018 \begin_layout Standard
20021 \change_inserted 564990737 1672138150
20031 \begin_inset Newline newline
20039 \begin_inset Newline newline
20043 \change_deleted 274215730 1672889037
20047 \change_inserted 274215730 1672889037
20051 \change_inserted 564990737 1672138150
20055 \begin_inset Newline newline
20065 \begin_layout Standard
20067 \change_inserted 564990737 1672138150
20074 makes the label emphasized and
20075 \change_deleted 274215730 1672889045
20081 \change_inserted 274215730 1672889046
20085 \change_inserted 564990737 1672138150
20091 \begin_layout Standard
20093 \change_inserted 564990737 1672138150
20094 \begin_inset Note Greyedout
20097 \begin_layout Plain Layout
20099 \change_inserted 564990737 1672138150
20105 When you change the label of a list level,
20106 it will be used for all following lists until you change the definition.
20114 \begin_layout Standard
20116 \change_inserted 564990737 1672138150
20120 \begin_layout Plain Layout
20122 \change_inserted 564990737 1672138150
20140 \begin_layout Subsubsection
20142 \change_inserted 564990737 1672138150
20143 Numbered Paragraphs in Reports
20146 \begin_layout Enumerate
20148 \change_inserted 564990737 1672138213
20149 Official reports often include numbered paragraphs;
20150 you can achieve this with a variation on the approach outlined in
20151 \change_deleted -712698321 1674916429
20153 \change_inserted 564990737 1672138213
20155 \change_deleted -712698321 1674916431
20157 \change_inserted -712698321 1674916432
20159 \change_inserted 564990737 1672138213
20161 \begin_inset space ~
20165 \change_inserted -712698321 1674916425
20167 \begin_inset CommandInset ref
20169 reference "sec:How-to-use"
20174 \change_deleted -712698321 1674916426
20176 \begin_inset CommandInset ref
20178 reference "fn:If-you-really"
20187 \change_inserted 564990737 1672138213
20193 in each command with
20200 \begin_layout Enumerate
20202 \change_inserted 564990737 1672138150
20203 These numbered paragraphs were generated by inserting the \SpecialChar TeX
20205 \begin_inset Separator latexpar
20212 \begin_layout Standard
20214 \change_inserted 564990737 1672138150
20228 \begin_layout Standard
20230 \change_inserted 564990737 1672138150
20231 before the start of the section;
20238 uses the \SpecialChar LaTeX
20239 section counter to generate the first part of the number.
20243 \begin_layout Enumerate
20245 \change_inserted 564990737 1672138150
20246 I have ignored the subsection heading in this example because,
20247 with paragraphs numbered in this way,
20248 subsections are less likely to be used.
20251 \begin_layout Subsubsection
20253 \change_inserted 564990737 1672138150
20254 Resumed Enumeration
20257 \begin_layout Standard
20259 \change_inserted 564990737 1672138150
20263 \begin_layout Plain Layout
20265 \change_inserted 564990737 1672138150
20281 \begin_layout Standard
20283 \change_inserted 564990737 1672138150
20284 Enumerations can be resumed after intermediate paragraphs:
20287 \begin_layout Enumerate
20289 \change_inserted 564990737 1672138150
20290 \begin_inset Argument 1
20293 \begin_layout Plain Layout
20295 \change_inserted 564990737 1672138150
20299 \begin_layout Plain Layout
20301 \change_inserted 564990737 1672138150
20318 \begin_inset Note Note
20321 \begin_layout Plain Layout
20323 \change_inserted 564990737 1672138150
20324 goes back to default numbering
20332 \begin_layout Enumerate
20334 \change_inserted 564990737 1672138150
20338 \begin_layout Standard
20340 \change_inserted 564990737 1672138150
20344 \begin_layout Enumerate-Resume
20346 \change_inserted 564990737 1672138150
20350 \begin_layout Standard
20352 \change_inserted 564990737 1672138150
20353 To resume an enumeration,
20360 \change_deleted -712698321 1673882803
20361 Its numbering appears in blue within \SpecialChar LyX
20362 to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
20365 \change_inserted 564990737 1672138150
20369 \begin_layout Standard
20371 \change_inserted 564990737 1672138150
20372 \begin_inset Note Greyedout
20375 \begin_layout Plain Layout
20377 \change_inserted 564990737 1672138150
20383 If there is no previous enumeration to resume,
20384 you will get a \SpecialChar LaTeX
20393 \begin_layout Standard
20395 \change_inserted 564990737 1672138150
20396 Perhaps you might want to resume the list with a different number from the next one.
20397 Or you want to start a new enumeration with a defined number.
20398 This is possible by adding an optional argument to the first list item of a normal enumeration.
20403 \begin_layout Standard
20405 \change_inserted 564990737 1672138150
20411 \begin_layout Standard
20413 \change_inserted 564990737 1672138150
20418 is the number with which you want to resume the list.
20422 \begin_layout Enumerate
20424 \change_inserted 564990737 1672138150
20428 \begin_layout Enumerate
20430 \change_inserted 564990737 1672138150
20434 \begin_layout Standard
20436 \change_inserted 564990737 1672138150
20437 Enumeration starting at a given value:
20440 \begin_layout Enumerate
20442 \change_inserted 564990737 1672138150
20443 \begin_inset Argument 1
20446 \begin_layout Plain Layout
20448 \change_inserted 564990737 1672138150
20452 \begin_layout Plain Layout
20454 \change_inserted 564990737 1672138150
20468 This enumeration starts at 4
20471 \begin_layout Subsubsection
20473 \change_inserted 564990737 1672138150
20475 \begin_inset Index idx
20480 \begin_layout Plain Layout
20482 \change_inserted 564990737 1672138150
20494 \begin_layout Standard
20496 \change_inserted 564990737 1672138150
20497 In some cases you might want less or more vertical space between the items of a list.
20498 For example if the default space is too much in your opinion in this case:
20501 \begin_layout Itemize
20503 \change_inserted 564990737 1672138150
20507 \begin_layout Itemize
20509 \change_inserted 564990737 1672138150
20510 with standard spacing
20513 \begin_layout Standard
20515 \change_inserted 564990737 1672138150
20516 You can decrease the space by adding an optional argument to the first item of the list.
20517 Add there the command
20521 to get no additional list space like in this example:
20524 \begin_layout Itemize
20526 \change_inserted 564990737 1672138150
20527 \begin_inset Argument 1
20530 \begin_layout Plain Layout
20532 \change_inserted 564990737 1672138150
20536 \begin_layout Plain Layout
20538 \change_inserted 564990737 1672138150
20555 \begin_layout Itemize
20557 \change_inserted 564990737 1672138150
20561 \begin_layout Itemize
20563 \change_inserted 564990737 1672138150
20567 \begin_layout Standard
20569 \change_inserted 564990737 1672138150
20570 To add space you can use several other commands provided by the
20575 \begin_inset Index idx
20580 \begin_layout Plain Layout
20582 \change_inserted 564990737 1672138150
20593 For more information see the
20594 \begin_inset CommandInset href
20596 name "enumitem documentation"
20597 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
20605 \begin_layout Standard
20607 \change_inserted 564990737 1672138150
20608 There are also many commands available to change the horizontal spacing and indentation.
20609 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
20610 \begin_inset space \thinspace{}
20613 cm so that the number is in the page margin:
20616 \begin_layout Enumerate
20618 \change_inserted 564990737 1672138150
20619 \begin_inset Argument 1
20622 \begin_layout Plain Layout
20624 \change_inserted 564990737 1672138150
20628 \begin_layout Plain Layout
20630 \change_inserted 564990737 1672138150
20650 \begin_layout Enumerate
20652 \change_inserted 564990737 1672138150
20653 with negative indentation
20656 \begin_layout Subsubsection
20658 \change_inserted 564990737 1672138150
20659 Further Customization
20660 \begin_inset Index idx
20665 \begin_layout Plain Layout
20667 \change_inserted 564990737 1672138150
20679 \begin_layout Standard
20681 \change_inserted 564990737 1672138150
20682 You can also change the style of description lists.
20686 \begin_layout Standard
20688 \change_inserted 564990737 1672138150
20694 \begin_layout Standard
20696 \change_inserted 564990737 1672138150
20697 changes the description label font,
20701 \begin_layout Standard
20703 \change_inserted 564990737 1672138150
20712 \begin_layout Standard
20714 \change_inserted 564990737 1672138150
20715 sets the list style.
20718 \begin_layout Standard
20720 \change_inserted 564990737 1672138150
20721 An example where the command
20724 \begin_layout Standard
20726 \change_inserted 564990737 1672138150
20735 \begin_layout Standard
20737 \change_inserted 564990737 1672138150
20741 \begin_layout Description
20743 \change_inserted 564990737 1672138150
20745 \begin_inset space ~
20750 \begin_inset Argument 1
20753 \begin_layout Plain Layout
20755 \change_inserted 564990737 1672138150
20759 \begin_layout Plain Layout
20761 \change_inserted 564990737 1672138150
20780 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
20781 therefore ionizing them.
20784 \begin_layout Description
20786 \change_inserted 564990737 1672138150
20788 \begin_inset space ~
20792 In computer science,
20793 reference counting is a technique of storing the number of references,
20795 or handles to a resource such as an object,
20797 disk space or other resource.
20800 \begin_layout Standard
20802 \change_inserted 564990737 1672138150
20803 There are many more commands and features provided by the
20808 \begin_inset Index idx
20813 \begin_layout Plain Layout
20815 \change_inserted 564990737 1672138150
20826 For more information see the
20827 \begin_inset CommandInset href
20829 name "enumitem documentation"
20830 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
20838 \begin_layout Subsection
20840 \change_inserted 564990737 1672138150
20846 \begin_layout Standard
20848 \change_inserted 564990737 1672138150
20849 This module uses the package
20853 to provide nine new list environments.
20854 Itemized and enumerated lists can be typeset within paragraphs,
20855 as paragraphs and in a compact version.
20856 Most environments have optional arguments to format the labels.
20858 the \SpecialChar LaTeX
20859 list environments itemize and enumerate are extended to use a similar optional argument.
20860 For further details see
20862 File\SpecialChar menuseparator
20863 Open Example\SpecialChar menuseparator
20864 Modules\SpecialChar menuseparator
20865 Paragraph Lists (paralist)
20870 Help\SpecialChar menuseparator
20871 Specific Manuals\SpecialChar menuseparator
20875 \begin_inset CommandInset href
20877 name "paralist documentation"
20878 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
20886 \begin_layout Section
20888 \change_inserted 564990737 1672161542
20889 Literate Programming
20890 \change_deleted -712698321 1673885680
20892 \change_inserted 564990737 1672161542
20896 \begin_layout Subsection
20898 \change_inserted 564990737 1672161542
20902 \begin_layout Standard
20904 \change_inserted 564990737 1672161542
20905 This module allows the use of Noweb as a literate programming tool.
20906 The files and the documentation for Noweb can be obtained from
20907 \begin_inset CommandInset href
20910 target "https://www.ctan.org/pkg/noweb"
20916 Literate programming is described in section
20917 \begin_inset space ~
20921 \begin_inset CommandInset ref
20923 reference "sec:Literate-Programming"
20928 and there are three example files:
20931 File\SpecialChar menuseparator
20932 Open Example\SpecialChar menuseparator
20933 Modules\SpecialChar menuseparator
20939 File\SpecialChar menuseparator
20940 Open Example\SpecialChar menuseparator
20941 Modules\SpecialChar menuseparator
20946 File\SpecialChar menuseparator
20947 Open Example\SpecialChar menuseparator
20948 Modules\SpecialChar menuseparator
20949 Noweb2\SpecialChar LyX
20955 \begin_layout Subsection
20957 \change_inserted 564990737 1672161542
20961 \begin_layout Standard
20963 \change_inserted 564990737 1672161542
20964 This module uses the
20974 \begin_inset Flex Code
20977 \begin_layout Plain Layout
20979 \change_inserted 564990737 1672161542
20987 package in R for dynamic report generation has to be installed for this module to work:
20989 \begin_inset Flex Code
20992 \begin_layout Plain Layout
20994 \change_inserted 564990737 1672161542
20995 install.packages(“knitr”)
21006 \begin_layout Paragraph
21008 \change_inserted 564990737 1672161542
21012 \begin_layout Itemize
21014 \change_inserted 564990737 1672161542
21015 it depends on R >= 2.14.1.
21017 \begin_inset Flex URL
21020 \begin_layout Plain Layout
21022 \change_inserted 564990737 1672161542
21024 http://yihui.name/knitr
21033 \change_deleted -712698321 1673886383
21035 \change_inserted 564990737 1672161542
21039 \begin_layout Itemize
21041 \change_inserted 564990737 1672161542
21046 also has to be installed.
21048 \change_inserted -712698321 1673886396
21052 \begin_layout Itemize
21054 \change_inserted 564990737 1672161542
21055 It cannot be used if the modules
21058 \begin_inset space ~
21069 \change_deleted -712698321 1673886383
21071 \change_inserted -712698321 1673886376
21075 \begin_layout Standard
21077 \change_inserted 564990737 1672161542
21080 Help\SpecialChar menuseparator
21081 Specific Manuals\SpecialChar menuseparator
21087 File\SpecialChar menuseparator
21088 Open Example\SpecialChar menuseparator
21089 Modules\SpecialChar menuseparator
21093 \begin_inset space ~
21097 \begin_inset CommandInset ref
21099 reference "sec:Literate-Programming"
21104 for information about literate programming.
21107 \begin_layout Subsection
21109 \change_inserted 564990737 1672161542
21113 \begin_layout Standard
21115 \change_inserted 564990737 1672161542
21116 This module allows the use of the statistical language S/R as a literate programming tool.
21127 \begin_inset CommandInset href
21130 target "https://www.ctan.org/pkg/includernw"
21136 \begin_inset CommandInset href
21139 target "https://www.ctan.org/pkg/fancyvrb"
21144 are available from CTAN.
21145 It cannot be used if the module
21148 \begin_inset space ~
21156 Help\SpecialChar menuseparator
21157 Specific Manuals\SpecialChar menuseparator
21163 File\SpecialChar menuseparator
21164 Open Example\SpecialChar menuseparator
21165 Modules\SpecialChar menuseparator
21169 \begin_inset space ~
21173 \begin_inset CommandInset ref
21175 reference "sec:Literate-Programming"
21180 for information about literate programming.
21183 \begin_layout Section
21185 \change_inserted 564990737 1672224959
21189 \begin_layout Subsection
21191 \change_inserted 564990737 1672224959
21195 \begin_layout Standard
21197 \change_inserted 564990737 1672224959
21198 This modules defines theorem environments and the proof environment using the extended AMS machinery.
21199 Both numbered and unnumbered types are provided.
21201 the theorems are numbered consecutively throughout the document.
21202 This can be changed by loading one of the
21204 AMS Theorems (Numbered by \SpecialChar ldots
21208 It cannot be used if the modules
21214 Standard Theorems (Unnumbered)
21219 \begin_layout Subsection
21221 \change_inserted 564990737 1672224959
21222 AMS Theorems (Extended)
21225 \begin_layout Standard
21227 \change_inserted 564990737 1672224959
21228 This module defines some additional theorem environments for use with the
21232 package (which must be loaded).
21269 \change_deleted -712698321 1675594790
21276 \change_inserted 564990737 1672224959
21300 in both numbered and unnumbered forms.
21303 \begin_layout Subsection
21305 \change_inserted 564990737 1672224959
21306 AMS Theorems (Extended,
21307 Numbered by Type within Chapters)
21310 \begin_layout Standard
21312 \change_inserted 564990737 1672224959
21313 This module defines some additional theorem environments for use with the
21315 AMS Theorems (Numbered by Type within Chapters)
21318 \change_deleted -712698321 1674898102
21320 \change_inserted -712698321 1674898103
21322 \change_inserted 564990737 1672224959
21323 (which must be loaded).
21360 \change_deleted -712698321 1675594800
21367 \change_inserted 564990737 1672224959
21381 in both numbered and unnumbered forms.
21383 \change_inserted -712698321 1674898226
21387 \begin_layout Standard
21389 \change_inserted 564990737 1672224959
21392 AMS Theorems (Extended)
21395 the different theorem types provided here each have a separate counter,
21396 restarted with each new chapter (e.g.,
21398 \change_deleted -712698321 1674898319
21402 \change_inserted -712698321 1674898319
21404 \change_inserted 564990737 1672224959
21409 \change_deleted -712698321 1674898320
21413 \change_inserted -712698321 1674898321
21415 \change_inserted 564990737 1672224959
21420 \change_deleted -712698321 1674898322
21424 \change_inserted -712698321 1674898322
21426 \change_inserted 564990737 1672224959
21431 \change_deleted -712698321 1674898325
21435 \change_inserted -712698321 1674898325
21437 \change_inserted 564990737 1672224959
21442 \change_deleted -712698321 1674898327
21446 \change_inserted -712698321 1674898327
21448 \change_inserted 564990737 1672224959
21453 \change_deleted -712698321 1674898329
21457 \change_inserted -712698321 1674898329
21459 \change_inserted 564990737 1672224959
21466 \change_deleted -712698321 1674898339
21468 \change_inserted -712698321 1674898339
21470 \change_inserted 564990737 1672224959
21472 \change_inserted -712698321 1674898336
21477 \change_inserted 564990737 1672224959
21481 \change_deleted -712698321 1674898342
21483 \change_inserted -712698321 1674898342
21487 \change_inserted 564990737 1672224959
21492 \change_deleted -712698321 1674898344
21494 \change_inserted -712698321 1674898344
21498 \change_inserted 564990737 1672224959
21503 \change_deleted -712698321 1674898346
21505 \change_inserted -712698321 1674898347
21509 \change_inserted 564990737 1672224959
21514 \change_deleted -712698321 1674898348
21516 \change_inserted -712698321 1674898348
21520 \change_inserted 564990737 1672224959
21522 \change_inserted -712698321 1674898350
21527 \change_deleted -712698321 1674898352
21529 \change_inserted -712698321 1674898353
21532 \change_inserted 564990737 1672224959
21536 \begin_layout Subsection
21538 \change_inserted 564990737 1672224959
21539 AMS Theorems (Extended,
21543 \begin_layout Standard
21545 \change_inserted 564990737 1672224959
21546 This module defines some additional theorem environments for use with the
21548 AMS Theorems (Numbered by Type)
21550 package (which must be loaded).
21587 \change_deleted -712698321 1675594806
21594 \change_inserted 564990737 1672224959
21608 in both numbered and unnumbered forms.
21610 \change_inserted -712698321 1674898455
21614 \begin_layout Standard
21616 \change_inserted 564990737 1672224959
21619 AMS Theorems (Extended)
21622 the different theorem types provided here each have a separate counter (e.g.,
21624 \change_deleted -712698321 1674898821
21626 \change_inserted -712698321 1674898821
21630 \change_inserted 564990737 1672224959
21635 \change_deleted -712698321 1674898823
21637 \change_inserted -712698321 1674898823
21641 \change_inserted 564990737 1672224959
21646 \change_deleted -712698321 1674898825
21648 \change_inserted -712698321 1674898825
21652 \change_inserted 564990737 1672224959
21657 \change_deleted -712698321 1674898827
21659 \change_inserted -712698321 1674898827
21663 \change_inserted 564990737 1672224959
21668 \change_deleted -712698321 1674898830
21670 \change_inserted -712698321 1674898830
21674 \change_inserted 564990737 1672224959
21681 \change_deleted -712698321 1674898832
21683 \change_inserted -712698321 1674898832
21687 \change_inserted 564990737 1672224959
21692 \change_deleted -712698321 1674898834
21694 \change_inserted -712698321 1674898834
21698 \change_inserted 564990737 1672224959
21703 \change_deleted -712698321 1674898836
21705 \change_inserted -712698321 1674898836
21709 \change_inserted 564990737 1672224959
21714 \change_deleted -712698321 1674898838
21716 \change_inserted -712698321 1674898838
21720 \change_inserted 564990737 1672224959
21728 \begin_layout Subsection
21730 \change_inserted 564990737 1672224959
21731 AMS Theorems (Numbered by Type within Chapters)
21734 \begin_layout Standard
21736 \change_inserted 564990737 1672224959
21737 This module defines theorem environments and the proof environment using the extended AMS machinery.
21738 Both numbered and unnumbered types are provided.
21740 \change_inserted -712698321 1674901718
21744 \begin_layout Standard
21746 \change_inserted 564990737 1672224959
21752 the different theorem types provided here each have a separate counter (e.g.,
21754 \change_deleted -712698321 1674901843
21756 \change_inserted -712698321 1674901843
21760 \change_inserted 564990737 1672224959
21765 \change_deleted -712698321 1674901845
21767 \change_inserted -712698321 1674901845
21771 \change_inserted 564990737 1672224959
21776 \change_deleted -712698321 1674901847
21780 \change_inserted -712698321 1674901847
21782 \change_inserted 564990737 1672224959
21787 \change_inserted -712698321 1674901849
21791 \change_deleted -712698321 1674901849
21793 \change_inserted 564990737 1672224959
21798 \change_inserted -712698321 1674901852
21802 \change_deleted -712698321 1674901852
21804 \change_inserted 564990737 1672224959
21809 \change_inserted -712698321 1674901854
21813 \change_deleted -712698321 1674901854
21815 \change_inserted 564990737 1672224959
21822 \change_deleted -712698321 1674901859
21824 \change_inserted -712698321 1674901859
21828 \change_inserted 564990737 1672224959
21833 \change_deleted -712698321 1674901861
21835 \change_inserted -712698321 1674901861
21839 \change_inserted 564990737 1672224959
21844 \change_deleted -712698321 1674901863
21846 \change_inserted -712698321 1674901863
21850 \change_inserted 564990737 1672224959
21855 \change_deleted -712698321 1674901868
21857 \change_inserted -712698321 1674901868
21861 \change_inserted 564990737 1672224959
21867 The numbering restarts for each chapter:
21869 \change_deleted -712698321 1674901871
21871 \change_inserted -712698321 1674901871
21875 \change_inserted 564990737 1672224959
21880 \change_deleted -712698321 1674901873
21882 \change_inserted -712698321 1674901873
21886 \change_inserted 564990737 1672224959
21892 \change_inserted -712698321 1674901725
21896 \begin_layout Standard
21898 \change_inserted 564990737 1672224959
21899 It cannot be used if the modules
21911 Standard Theorems (Numbered by Type)
21915 Standard Theorems (Unnumbered)
21920 \begin_layout Subsection
21922 \change_inserted 564990737 1672224959
21923 AMS Theorems (Numbered by Type)
21926 \begin_layout Standard
21928 \change_inserted 564990737 1672224959
21929 This module defines theorem environments and the proof environment using the extended AMS machinery.
21930 Both numbered and unnumbered types are provided.
21936 the different theorem types provided here each have a separate counter (e.g.,
21938 \change_deleted -712698321 1674902051
21940 \change_inserted -712698321 1674902051
21944 \change_inserted 564990737 1672224959
21949 \change_deleted -712698321 1674902053
21951 \change_inserted -712698321 1674902053
21955 \change_inserted 564990737 1672224959
21960 \change_deleted -712698321 1674902055
21962 \change_inserted -712698321 1674902055
21966 \change_inserted 564990737 1672224959
21971 \change_inserted -712698321 1674902058
21975 \change_deleted -712698321 1674902058
21977 \change_inserted 564990737 1672224959
21982 \change_inserted -712698321 1674902061
21986 \change_deleted -712698321 1674902060
21988 \change_inserted 564990737 1672224959
21993 \change_deleted -712698321 1674902063
21995 \change_inserted -712698321 1674902063
21999 \change_inserted 564990737 1672224959
22006 \change_deleted -712698321 1674902066
22008 \change_inserted -712698321 1674902067
22012 \change_inserted 564990737 1672224959
22017 \change_deleted -712698321 1674902069
22019 \change_inserted -712698321 1674902069
22023 \change_inserted 564990737 1672224959
22028 \change_deleted -712698321 1674902071
22030 \change_inserted -712698321 1674902071
22034 \change_inserted 564990737 1672224959
22039 \change_deleted -712698321 1674902075
22041 \change_inserted -712698321 1674902075
22045 \change_inserted 564990737 1672224959
22051 The numbering’s scope is the whole document.
22052 For chapter- and section-wide numbering,
22053 use one of the ‘within Sections’/‘within Chapters’ modules,
22056 \change_inserted -712698321 1674902047
22060 \begin_layout Standard
22062 \change_inserted 564990737 1672224959
22063 It cannot be used if the modules
22075 Standard Theorems (Numbered by Type)
22079 Standard Theorems (Unnumbered)
22084 \begin_layout Subsection
22086 \change_inserted 564990737 1672224959
22087 Number Equations by Section
22090 \begin_layout Standard
22092 \change_inserted 564990737 1672224959
22093 This module resets the equation number at section start and prepends the section number to the equation number,
22095 \change_deleted -712698321 1674902160
22097 \change_inserted 564990737 1672224959
22103 \change_deleted -712698321 1674902162
22105 \change_inserted 564990737 1672224959
22109 \begin_layout Subsection
22111 \change_inserted 564990737 1672224959
22115 \begin_layout Standard
22117 \change_inserted 564990737 1672224959
22118 This module defines some theorem environments for use with non-AMS classes.
22120 the theorems are numbered consecutively throughout the document.
22121 This can be changed by loading one of the
22123 Standard Theorems (Numbered by \SpecialChar ldots
22128 \change_inserted -712698321 1674902414
22132 \begin_layout Standard
22134 \change_inserted 564990737 1672224959
22135 It cannot be used if the modules
22141 Standard Theorems (Unnumbered)
22147 \begin_layout Subsection
22149 \change_inserted 564990737 1672224959
22150 Standard Theorems (Nameable)
22153 \begin_layout Standard
22155 \change_inserted 564990737 1672224959
22156 This module facilitates the use of named theorems.
22157 The name of the theorem
22158 \change_deleted -712698321 1674902805
22160 \change_inserted -712698321 1674902825
22161 can be inserted via
22163 Insert\SpecialChar menuseparator
22165 \change_deleted -712698321 1674902827
22167 \change_inserted 564990737 1672224959
22168 Additional Theorem Text
22169 \change_deleted -712698321 1674902831
22173 \change_inserted 564990737 1672224959
22178 \begin_layout Subsection
22180 \change_inserted 564990737 1672224959
22181 Standard Theorems (Numbered by Chapter)
22184 \begin_layout Standard
22186 \change_inserted 564990737 1672224959
22187 This module numbers theorems and the like by chapter (i.e.,
22188 the counter is reset at each chapter start).
22189 Use this module only with document classes that provide a chapter environment.
22191 \change_inserted -712698321 1674903079
22195 \begin_layout Standard
22197 \change_inserted 564990737 1672224959
22208 \change_inserted -712698321 1674903082
22212 \begin_layout Standard
22214 \change_inserted 564990737 1672224959
22215 It cannot be used if the module
22217 Standard Theorems (Numbered by Section)
22222 \begin_layout Subsection
22224 \change_inserted 564990737 1672224959
22225 Standard Theorems (Numbered by Section)
22228 \begin_layout Standard
22230 \change_inserted 564990737 1672224959
22231 This module numbers theorems and the like by section (i.e.,
22232 the counter is reset at each section start).
22242 It cannot be used if the module
22244 Standard Theorems (Numbered by Chapter)
22249 \begin_layout Subsection
22251 \change_inserted 564990737 1672224959
22252 Standard Theorems (Numbered by Type within Chapters)
22255 \begin_layout Standard
22257 \change_inserted 564990737 1672224959
22258 This module defines some theorem environments for use with non-AMS classes.
22268 the different theorem types provided here each have a separate counter (e.g.,
22270 \change_deleted -712698321 1674903338
22272 \change_inserted -712698321 1674903338
22276 \change_inserted 564990737 1672224959
22281 \change_deleted -712698321 1674903340
22283 \change_inserted -712698321 1674903340
22287 \change_inserted 564990737 1672224959
22292 \change_deleted -712698321 1674903343
22294 \change_inserted -712698321 1674903343
22298 \change_inserted 564990737 1672224959
22303 \change_deleted -712698321 1674903346
22305 \change_inserted -712698321 1674903346
22309 \change_inserted 564990737 1672224959
22314 \change_deleted -712698321 1674903348
22316 \change_inserted -712698321 1674903348
22320 \change_inserted 564990737 1672224959
22325 \change_deleted -712698321 1674903351
22327 \change_inserted -712698321 1674903351
22331 \change_inserted 564990737 1672224959
22338 \change_deleted -712698321 1674903354
22340 \change_inserted -712698321 1674903354
22344 \change_inserted 564990737 1672224959
22349 \change_deleted -712698321 1674903356
22351 \change_inserted -712698321 1674903356
22355 \change_inserted 564990737 1672224959
22360 \change_deleted -712698321 1674903359
22362 \change_inserted -712698321 1674903359
22366 \change_inserted 564990737 1672224959
22371 \change_deleted -712698321 1674903361
22373 \change_inserted -712698321 1674903361
22377 \change_inserted 564990737 1672224959
22383 The numbering is reset at each chapter start.
22385 \change_inserted -712698321 1674902715
22389 \begin_layout Standard
22391 \change_inserted 564990737 1672224959
22394 AMS Theorems (Numbered by Type)
22398 Standard Theorems (Numbered by Type)
22402 \change_inserted -712698321 1674902717
22406 \begin_layout Standard
22408 \change_inserted 564990737 1672224959
22409 It cannot be used if any of the modules
22421 Standard Theorems (Unnumbered)
22426 Standard Theorems (Numbered by Sections)
22430 Standard Theorems (Numbered by Type within Sections)
22435 \begin_layout Subsection
22437 \change_inserted 564990737 1672224959
22438 Standard Theorems (Numbered by Type within Sections)
22441 \begin_layout Standard
22443 \change_inserted 564990737 1672224959
22444 This module defines some theorem environments for use with non-AMS classes.
22454 the different theorem types provided here each have a separate counter (e.g.,
22456 \change_deleted -712698321 1674902520
22458 \change_inserted -712698321 1674902520
22462 \change_inserted 564990737 1672224959
22467 \change_deleted -712698321 1674902522
22469 \change_inserted -712698321 1674902522
22473 \change_inserted 564990737 1672224959
22478 \change_deleted -712698321 1674902527
22480 \change_inserted -712698321 1674902527
22484 \change_inserted 564990737 1672224959
22489 \change_inserted -712698321 1674902529
22493 \change_deleted -712698321 1674902529
22495 \change_inserted 564990737 1672224959
22500 \change_deleted -712698321 1674902532
22502 \change_inserted -712698321 1674902532
22506 \change_inserted 564990737 1672224959
22511 \change_inserted -712698321 1674902535
22515 \change_deleted -712698321 1674902534
22517 \change_inserted 564990737 1672224959
22524 \change_deleted -712698321 1674902538
22526 \change_inserted -712698321 1674902538
22530 \change_inserted 564990737 1672224959
22535 \change_deleted -712698321 1674902540
22537 \change_inserted -712698321 1674902540
22541 \change_inserted 564990737 1672224959
22546 \change_deleted -712698321 1674902543
22548 \change_inserted -712698321 1674902543
22552 \change_inserted 564990737 1672224959
22557 \change_inserted -712698321 1674902545
22561 \change_deleted -712698321 1674902545
22563 \change_inserted 564990737 1672224959
22569 The numbering is reset at each section start.
22571 \change_inserted -712698321 1674902574
22575 \begin_layout Standard
22577 \change_inserted 564990737 1672224959
22580 AMS Theorems (Numbered by Type)
22584 Standard Theorems (Numbered by Type)
22588 \change_inserted -712698321 1674902609
22592 \begin_layout Standard
22594 \change_inserted 564990737 1672224959
22595 It cannot be used if any of the modules
22607 Standard Theorems (Unnumbered)
22612 Standard Theorems (Numbered by Chapters)
22616 Standard Theorems (Numbered by Type within Chapters)
22621 \begin_layout Subsection
22623 \change_inserted 564990737 1672224959
22624 Standard Theorems (Numbered by Type)
22627 \begin_layout Standard
22629 \change_inserted 564990737 1672224959
22630 This module defines some theorem environments for use with non-AMS classes.
22640 the different theorem types provided here each have a separate counter (e.g.,
22642 \change_deleted -712698321 1674903220
22644 \change_inserted -712698321 1674903220
22648 \change_inserted 564990737 1672224959
22653 \change_deleted -712698321 1674903221
22655 \change_inserted -712698321 1674903221
22659 \change_inserted 564990737 1672224959
22664 \change_deleted -712698321 1674903225
22666 \change_inserted -712698321 1674903226
22670 \change_inserted 564990737 1672224959
22675 \change_inserted -712698321 1674903228
22679 \change_deleted -712698321 1674903228
22681 \change_inserted 564990737 1672224959
22686 \change_deleted -712698321 1674903231
22688 \change_inserted -712698321 1674903232
22692 \change_inserted 564990737 1672224959
22697 \change_inserted -712698321 1674903261
22701 \change_deleted -712698321 1674903233
22703 \change_inserted 564990737 1672224959
22710 \change_deleted -712698321 1674903237
22712 \change_inserted -712698321 1674903237
22716 \change_inserted 564990737 1672224959
22721 \change_deleted -712698321 1674903240
22723 \change_inserted -712698321 1674903240
22727 \change_inserted 564990737 1672224959
22732 \change_deleted -712698321 1674903242
22734 \change_inserted -712698321 1674903242
22738 \change_inserted 564990737 1672224959
22743 \change_deleted -712698321 1674903246
22745 \change_inserted -712698321 1674903246
22749 \change_inserted 564990737 1672224959
22755 The numbering’s scope is the whole document.
22756 For chapter- and section-wide numbering,
22757 use one of the “within Chapters”/“within Sections” modules,
22760 \change_inserted -712698321 1674903280
22764 \begin_layout Standard
22766 \change_inserted 564990737 1672224959
22767 It cannot be used if any of the modules
22779 Standard Theorems (Unnumbered)
22783 AMS Theorems (Numbered by Type)
22788 \begin_layout Subsection
22790 \change_inserted 564990737 1672224959
22791 Standard Theorems (Unnumbered)
22794 \begin_layout Standard
22796 \change_inserted 564990737 1672224959
22797 This module defines only unnumbered theorem environments and the proof environment,
22798 using the extended AMS machinery.
22799 It cannot be used if either of the modules
22810 \begin_layout Subsection
22812 \change_inserted 564990737 1672224959
22816 \begin_layout Standard
22818 \change_inserted 564990737 1672224959
22819 This module provides a straightforward way to segregate subequations in LyX.
22822 Help\SpecialChar menuseparator
22823 Math\SpecialChar menuseparator
22830 \begin_layout Section
22832 \change_inserted 564990737 1672236008
22836 \begin_layout Subsection
22838 \change_inserted 564990737 1672236008
22839 Custom Header/Footer Text
22842 \begin_layout Standard
22844 \change_inserted 564990737 1672236008
22845 This module requires the
22848 \begin_inset space ~
22862 ocument\SpecialChar menuseparator
22867 ettings\SpecialChar menuseparator
22869 \begin_inset space ~
22874 dialog to be set to
22879 It adds six environments to document classes which support the
22886 \begin_layout Itemize
22888 \change_inserted 564990737 1672236008
22894 \begin_layout Itemize
22896 \change_inserted 564990737 1672236008
22902 \begin_layout Itemize
22904 \change_inserted 564990737 1672236008
22910 \begin_layout Itemize
22912 \change_inserted 564990737 1672236008
22918 \begin_layout Itemize
22920 \change_inserted 564990737 1672236008
22926 \begin_layout Itemize
22928 \change_inserted 564990737 1672236008
22934 \begin_layout Subsubsection
22936 \change_inserted 564990737 1672236008
22937 Fancy Headers and Footers
22940 \begin_layout Standard
22942 \change_inserted 564990737 1672236008
22943 The default page layout is rather plain;
22945 \change_deleted -712698321 1674910295
22947 \begin_inset Flex Code
22950 \begin_layout Plain Layout
22952 \change_inserted 564990737 1672236008
22961 \change_inserted 564990737 1672236008
22963 \change_inserted -712698321 1674910328
22966 Article (Standard Class)
22969 \change_inserted 564990737 1672236008
22971 all you get is a centered page number at the bottom of the page.
22973 \change_inserted -712698321 1674910381
22975 \change_inserted 564990737 1672236008
22977 \change_deleted -712698321 1674910376
22979 \change_inserted -712698321 1674910376
22983 \change_inserted 564990737 1672236008
22987 so it appears to be a bit fancier.
22989 \change_inserted -712698321 1674910455
22993 \begin_layout Standard
22995 \change_inserted 564990737 1672236008
22999 \begin_inset space ~
23013 ocument\SpecialChar menuseparator
23018 ettings\SpecialChar menuseparator
23022 \begin_inset Quotes eld
23026 \begin_inset Quotes erd
23030 you will find that the page header is divided into three fields,
23031 not surprisingly labeled
23032 \begin_inset Quotes eld
23036 \begin_inset Quotes erd
23041 \begin_inset Quotes eld
23045 \begin_inset Quotes erd
23050 \begin_inset Quotes eld
23054 \begin_inset Quotes erd
23058 The footer is also divided into these three fields.
23059 The \SpecialChar LaTeX
23060 commands to set these fields in the simplest manner are
23089 Suppose you wish to put your name in the upper left hand corner of each page.
23090 Simply insert the following command in the preamble:
23094 \begin_layout LyX-Code
23096 \change_inserted 564990737 1672236008
23103 \begin_layout Standard
23105 \change_inserted 564990737 1672236008
23106 You will now see your name in the upper left.
23107 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,
23109 \begin_inset space \thinspace{}
23115 \begin_layout LyX-Code
23117 \change_inserted 564990737 1672236008
23123 \begin_layout Standard
23125 \change_inserted 564990737 1672236008
23128 an easier way to make simple changes.
23134 ocument\SpecialChar menuseparator
23139 ettings\SpecialChar menuseparator
23140 Modules\SpecialChar menuseparator
23141 Page Layout\SpecialChar menuseparator
23142 Custom Header/Footer Text
23145 you will find you have six new environments corresponding to the six fields described above.
23148 \begin_layout Standard
23150 \change_inserted 564990737 1672236008
23151 Let's get really fancy:
23152 lets put the section number with the word
23153 \begin_inset Quotes eld
23157 \begin_inset Quotes erd
23161 \begin_inset space \thinspace{}
23165 \begin_inset space \space{}
23168 Section 3) in the upper left,
23169 the page number (e.
23170 \begin_inset space \thinspace{}
23174 \begin_inset space \space{}
23177 Page 4) in the upper right,
23178 your name in the lower left,
23179 and the date in the lower right.
23180 Use your newly enabled environments to add these entries:
23183 \begin_layout Standard
23185 \change_deleted -712698321 1674910975
23186 \begin_inset VSpace defskip
23190 \change_inserted 564990737 1672236008
23194 \begin_layout LyX-Code
23196 \change_inserted 564990737 1672236008
23200 \begin_inset space ~
23219 \begin_layout LyX-Code
23221 \change_inserted 564990737 1672236008
23227 \begin_layout LyX-Code
23229 \change_inserted 564990737 1672236008
23246 \begin_layout LyX-Code
23248 \change_inserted 564990737 1672236008
23260 \begin_layout LyX-Code
23262 \change_inserted 564990737 1672236008
23268 \begin_layout LyX-Code
23270 \change_inserted 564990737 1672236008
23284 \begin_layout Standard
23286 \change_deleted -712698321 1674910976
23287 \begin_inset VSpace defskip
23291 \change_inserted 564990737 1672236008
23295 \begin_layout Standard
23297 \change_inserted 564990737 1672236008
23298 Make sure you enter the commands
23317 as \SpecialChar TeX
23335 access \SpecialChar LaTeX
23336 ’s section and page counters,
23337 and so print out the current section and page numbers.
23344 simply prints out today’s date.
23347 \begin_layout Standard
23349 \change_inserted 564990737 1672236008
23350 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
23351 If you don't want one of the rules,
23352 set its thickness to 0.
23353 The header rule has a default thickness of 0.4pt,
23354 the footer rule is 0pt.
23355 For this you will need to use \SpecialChar TeX
23359 \begin_layout Standard
23361 \change_inserted 564990737 1672236008
23368 headrulewidth}{0.4pt}
23373 \begin_layout Standard
23375 \change_inserted 564990737 1672236008
23382 footrulewidth}{0.4pt}
23384 to set the thicknesses.
23387 \begin_layout Standard
23389 \change_inserted 564990737 1672236008
23390 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
23395 thispagestyle{empty}
23402 thispagestyle{plain}
23409 thispagestyle{fancy}
23412 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
23415 title pages are marked as plain by default,
23416 while following pages are marked fancy when using the global fancy setting.
23420 \begin_layout Standard
23422 \change_inserted 564990737 1672236008
23423 If you want a header or footer to be on the outer side of a two sided document,
23424 you need to use something like:
23427 \begin_layout LyX-Code
23429 \change_deleted -712698321 1674911361
23432 \begin_inset Flex Strong
23435 \begin_layout Plain Layout
23437 \change_inserted 564990737 1672236008
23451 \change_inserted -712698321 1674911361
23461 \begin_layout LyX-Code
23463 \change_deleted -712698321 1674911364
23466 \begin_inset Flex Strong
23469 \begin_layout Plain Layout
23471 \change_inserted 564990737 1672236008
23487 \change_inserted -712698321 1674911364
23499 \begin_layout Standard
23501 \change_inserted 564990737 1672236008
23502 The first command clears all existing footers avoiding any conflicts with your new command.
23505 \begin_layout Standard
23507 \change_inserted 564990737 1672236008
23508 You can enter any of these commands,
23509 the simpler ones in any of your new environments,
23510 the more complex ones as \SpecialChar TeX
23512 at any point in your document and they will take effect on the next page.
23515 \begin_layout Standard
23517 \change_inserted 564990737 1672236008
23518 As a final example,
23519 it is possible to include an image in the header or footer.
23520 Suppose you want to put a company logo in the upper left hand corner.
23521 You might try something like
23522 \change_inserted -712698321 1674911745
23525 Document\SpecialChar menuseparator
23526 Settings\SpecialChar menuseparator
23530 \change_inserted 564990737 1672236008
23534 \begin_layout LyX-Code
23536 \change_inserted 564990737 1672236008
23543 includegraphics{logo.
23544 \change_deleted -712698321 1674911807
23546 \change_inserted -712698321 1674911807
23548 \change_inserted 564990737 1672236008
23552 \begin_layout Standard
23555 \change_deleted -712698321 1674911836
23557 \change_inserted -712698321 1674911837
23559 \change_inserted 564990737 1672236008
23560 ou may need to preface this with
23564 usepackage{graphics}
23566 if you don't include graphics elsewhere in your document
23567 \change_deleted -712698321 1674911839
23569 \change_inserted 564990737 1672236008
23573 \begin_layout Standard
23575 \change_inserted 564990737 1672236008
23576 For more information on fancy headers,
23578 \begin_inset Flex Code
23581 \begin_layout Plain Layout
23583 \change_inserted 564990737 1672236008
23592 \begin_inset CommandInset href
23595 target "http://www.ctan.org/pkg/fancyhdr"
23604 \begin_layout Subsection
23606 \change_inserted 564990737 1672236008
23607 Landscape Document Parts
23610 \begin_layout Standard
23612 \change_inserted 564990737 1672236008
23613 This module outputs parts of the document in landscape mode using
23615 Insert\SpecialChar menuseparator
23616 Custom Insets\SpecialChar menuseparator
23621 Insert\SpecialChar menuseparator
23622 Custom Insets\SpecialChar menuseparator
23623 Landscape (Floating)
23628 \begin_layout Subsection
23630 \change_inserted 564990737 1672236008
23631 \begin_inset CommandInset label
23633 name "sec:Multiple-Columns"
23640 \begin_layout Standard
23642 \change_inserted 564990737 1672236008
23643 This module uses the
23648 \begin_inset Index idx
23653 \begin_layout Plain Layout
23655 \change_inserted 564990737 1672236008
23665 package and is independent of the option
23678 ocument\SpecialChar menuseparator
23683 ettings\SpecialChar menuseparator
23685 \begin_inset space ~
23691 If you want to have two columns for the whole document,
23692 you are recommended to use the
23701 For all other cases use this module.
23702 \change_deleted 564990737 1672236008
23703 Multiple Text Columns
23706 \begin_layout Standard
23708 \change_deleted 564990737 1672236008
23709 This feature is independent of the option
23711 Two-column document
23713 in the document settings under
23718 If you want to have 2
23719 \begin_inset space ~
23722 columns for the whole document,
23723 it is recommended to use the
23725 Two-column document
23728 For all other cases use this feature.
23731 \begin_layout Standard
23733 \change_deleted 564990737 1672236008
23734 To use multiple text columns in your document,
23735 you have to load the module
23741 Document\SpecialChar menuseparator
23742 Settings\SpecialChar menuseparator
23745 ) and must have the \SpecialChar LaTeX
23747 \begin_inset Flex Code
23750 \begin_layout Plain Layout
23761 \begin_layout Standard
23762 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
23763 Within the different columns you can use everything,
23764 with the limitation that for floats you need to
23765 \change_deleted 564990737 1672236179
23766 use the float option
23769 \change_inserted 564990737 1672236179
23778 \begin_inset space ~
23788 dit\SpecialChar menuseparator
23794 \begin_inset space ~
23804 \begin_layout Subsubsection
23808 \begin_layout Standard
23809 If you want to have
23810 \change_deleted -712698321 1674912320
23812 \change_inserted -712698321 1674912321
23814 \change_deleted -712698321 1674912322
23816 \begin_inset space ~
23820 \change_inserted -712698321 1674912322
23823 columns in your text,
23824 insert a multicolumn inset via the menu
23826 Insert\SpecialChar menuseparator
23828 \begin_inset space ~
23831 Insets\SpecialChar menuseparator
23833 \begin_inset space ~
23838 where the columns should start.
23839 Write all text that should be printed in 2
23840 \begin_inset space ~
23843 columns into this inset.
23846 \begin_layout Standard
23847 Here is an example:
23850 \begin_layout Standard
23852 \begin_inset Flex Multiple Columns
23855 \begin_layout Plain Layout
23860 The Adventure of the Empty House
23863 \begin_inset Newline newline
23868 Sir Arthur Conan Doyle
23871 \begin_layout Plain Layout
23874 It was in the spring of the year 1894 that all London was interested,
23875 and the fashionable world dismayed,
23876 by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
23877 The public has already learned those particulars of the crime which came out in the police investigation,
23878 but a good deal was suppressed upon that occasion,
23879 since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
23881 at the end of nearly ten years,
23882 am I allowed to supply those missing links which make up the whole of that remarkable chain.
23883 The crime was of interest in itself,
23884 but that interest was as nothing to me compared to the inconceivable sequel,
23885 which afforded me the greatest shock and surprise of any event in my adventurous life.
23887 after this long interval,
23888 I find myself thrilling as I think of it,
23889 and feeling once more that sudden flood of joy,
23891 and incredulity which utterly submerged my mind.
23892 Let me say to that public,
23893 which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
23894 that they are not to blame me if I have not shared my knowledge with them,
23895 for I should have considered it my first duty to do so,
23896 had I not been barred by a positive prohibition from his own lips,
23897 which was only withdrawn upon the third of last month.
23905 \begin_layout Standard
23906 To get 3 or more columns,
23907 set the cursor into the multicolumn inset and use the menu
23909 Insert\SpecialChar menuseparator
23911 \begin_inset space ~
23915 \begin_inset space ~
23921 The number of the desired columns is written into that inset (for 3
23922 \begin_inset space ~
23926 \begin_inset Quotes eld
23930 \begin_inset Quotes erd
23934 \begin_inset Newline newline
23937 Here is an example with 3
23938 \begin_inset space ~
23944 \begin_layout Standard
23945 \begin_inset Flex Multiple Columns
23948 \begin_layout Plain Layout
23951 \begin_inset Argument 1
23954 \begin_layout Plain Layout
23961 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
23962 and that after his disappearance I never failed to read with care the various problems which came before the public.
23963 And I even attempted,
23965 for my own private satisfaction,
23966 to employ his methods in their solution,
23967 though with indifferent success.
23970 which appealed to me like this tragedy of Ronald Adair.
23971 As I read the evidence at the inquest,
23972 which led up to a verdict of willful murder against some person or persons unknown,
23973 I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
23974 There were points about this strange business which would,
23976 have specially appealed to him,
23977 and the efforts of the police would have been supplemented,
23978 or more probably anticipated,
23979 by the trained observation and the alert mind of the first criminal agent in Europe.
23981 as I drove upon my round,
23982 I turned over the case in my mind and found no explanation which appeared to me to be adequate.
23983 At the risk of telling a twice-told tale,
23984 I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
23992 \begin_layout Standard
23993 You can have up to 10
23994 \begin_inset space ~
23997 columns if you want to,
23998 but that might not be very pleasant for the readers of your document.
24001 \begin_layout Standard
24003 \change_deleted 564990737 1672236245
24004 \begin_inset Newpage newpage
24012 \begin_layout Subsubsection
24013 Columns inside Columns
24016 \begin_layout Standard
24017 You can also have columns inside columns:
24020 \begin_layout Standard
24021 \begin_inset Flex Multiple Columns
24024 \begin_layout Plain Layout
24027 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24028 at that time governor of one of the Australian colonies.
24029 Adair's mother had returned from Australia to undergo the operation for cataract,
24032 and her daughter Hilda were living together at 427 Park Lane.
24035 \begin_layout Plain Layout
24036 \begin_inset Flex Multiple Columns
24039 \begin_layout Plain Layout
24042 The youth moved in the best society
24043 \begin_inset space ~
24047 so far as was known,
24048 no enemies and no particular vices.
24049 He had been engaged to Miss Edith Woodley,
24051 but the engagement had been broken off by mutual consent some months before,
24052 and there was no sign that it had left any very profound feeling behind it.
24053 For the rest {sic} the man's life moved in a narrow and conventional circle,
24054 for his habits were quiet and his nature unemotional.
24055 Yet it was upon this easy-going young aristocrat that death came,
24056 in most strange and unexpected form,
24057 between the hours of ten and eleven-twenty on the night of March 30,
24066 \begin_layout Plain Layout
24069 Ronald Adair was fond of cards
24070 \begin_inset space ~
24073 – playing continually,
24074 but never for such stakes as would hurt him.
24075 He was a member of the Baldwin,
24077 and the Bagatelle card clubs.
24079 after dinner on the day of his death,
24080 he had played a rubber of whist at the latter club.
24081 He had also played there in the afternoon.
24086 The evidence of those who had played with him
24087 \begin_inset space ~
24094 \begin_inset space ~
24097 – showed that the game was whist,
24098 and that there was a fairly equal fall of the cards.
24099 Adair might have lost five pounds,
24101 His fortune was a considerable one,
24102 and such a loss could not in any way affect him.
24103 He had played nearly every day at one club or other,
24104 but he was a cautious player,
24105 and usually rose a winner.
24106 It came out in evidence that,
24107 in partnership with Colonel Moran,
24108 he had actually won as much as four hundred and twenty pounds in a sitting,
24110 from Godfrey Milner and Lord Balmoral.
24111 So much for his recent history as it came out at the inquest.
24119 \begin_layout Subsubsection
24123 \begin_layout Standard
24124 The examples in this section show some more special features of multiple columns.
24127 \begin_layout Standard
24128 For more features of multiple columns,
24130 \begin_inset CommandInset href
24132 name "documentation"
24133 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24138 of the \SpecialChar LaTeX
24140 \begin_inset Flex Code
24143 \begin_layout Plain Layout
24152 \begin_layout Paragraph
24156 \begin_layout Standard
24157 To add a preface text for multiple columns,
24158 set the cursor into the multicolumn inset and use the menu
24160 Insert\SpecialChar menuseparator
24164 Write your preface text into that inset.
24165 \begin_inset Newline newline
24168 This is an example with some preface text:
24171 \begin_layout Standard
24172 \begin_inset VSpace bigskip
24178 \begin_layout Standard
24179 \begin_inset Flex Multiple Columns
24182 \begin_layout Plain Layout
24183 \begin_inset Argument 2
24186 \begin_layout Plain Layout
24187 And the story continues and continues and continues and continues\SpecialChar ldots
24195 On the evening of the crime,
24196 he returned from the club exactly at ten.
24197 His mother and sister were out spending the evening with a relation.
24198 The servant deposed that she heard him enter the front room on the second floor,
24199 generally used as his sitting-room.
24200 She had lit a fire there,
24201 and as it smoked she had opened the window.
24202 No sound was heard from the room until eleven-twenty,
24203 the hour of the return of Lady Maynooth and her daughter.
24204 Desiring to say good-night,
24205 she attempted to enter her son's room.
24206 The door was locked on the inside,
24207 and no answer could be got to their cries and knocking.
24209 and the door forced.
24210 The unfortunate young man was found lying near the table.
24211 His head had been horribly mutilated by an expanding revolver bullet,
24212 but no weapon of any sort was to be found in the room.
24220 \begin_layout Standard
24221 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
24223 For example the command
24226 \begin_layout LyX-Code
24229 subsection{subsection title}
24232 \begin_layout Standard
24233 creates a subsection.
24234 In this example the preface is a subsubsection:
24237 \begin_layout Standard
24238 \begin_inset Flex Multiple Columns
24241 \begin_layout Plain Layout
24242 \begin_inset Argument 2
24245 \begin_layout Plain Layout
24249 \begin_layout Plain Layout
24258 This is a subsubsection heading as a preface
24262 \begin_layout Plain Layout
24276 A minute examination of the circumstances served only to make the case more complex.
24277 In the first place,
24278 no reason could be given why the young man should have fastened the door upon the inside.
24279 There was the possibility that the murderer had done this,
24280 and had afterwards escaped by the window.
24281 The drop was at least twenty feet,
24283 and a bed of crocuses in full bloom lay beneath.
24284 Neither the flowers nor the earth showed any sign of having been disturbed,
24285 nor were there any marks upon the narrow strip of grass which separated the house from the road.
24288 it was the young man himself who had fastened the door.
24289 But how did he come by his death?
24290 No one could have climbed up to the window without leaving traces.
24291 Suppose a man had fired through the window,
24292 he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
24294 Park Lane is a frequented thoroughfare;
24295 there is a cab stand within a hundred yards of the house.
24296 No one had heard a shot.
24304 \begin_layout Standard
24305 If there is less vertical space than
24306 \change_deleted -712698321 1674913194
24308 \begin_inset space ~
24312 \change_inserted -712698321 1674913195
24315 text lines is left on the page at the beginning of the multiple columns,
24316 a page break will be inserted before the multiple columns.
24317 Depending on the number of lines of the preface text,
24318 you might want to change this space.
24319 This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
24321 Insert\SpecialChar menuseparator
24323 \begin_inset space ~
24327 \begin_inset space ~
24331 \begin_inset space ~
24337 Insert into that inset the amount of space like e.
24338 \begin_inset space \thinspace{}
24342 \begin_inset space \space{}
24346 \begin_inset Quotes eld
24350 \begin_inset Quotes erd
24354 \begin_inset Newline newline
24357 In this example the space is set to 7
24358 \begin_inset space ~
24361 text lines by using
24362 \begin_inset Flex Code
24365 \begin_layout Plain Layout
24374 \begin_inset Flex Code
24377 \begin_layout Plain Layout
24385 needs to be inserted as \SpecialChar TeX
24389 \begin_layout Standard
24390 \begin_inset Flex Multiple Columns
24393 \begin_layout Plain Layout
24394 \begin_inset Argument 3
24397 \begin_layout Plain Layout
24402 \begin_layout Plain Layout
24418 On the evening of the crime,
24419 he returned from the club exactly at ten.
24420 His mother and sister were out spending the evening with a relation.
24421 The servant deposed that she heard him enter the front room on the second floor,
24422 generally used as his sitting-room.
24423 She had lit a fire there,
24424 and as it smoked she had opened the window.
24425 No sound was heard from the room until eleven-twenty,
24426 the hour of the return of Lady Maynooth and her daughter.
24427 Desiring to say good-night,
24428 she attempted to enter her son's room.
24429 The door was locked on the inside,
24430 and no answer could be got to their cries and knocking.
24432 and the door forced.
24433 The unfortunate young man was found lying near the table.
24434 His head had been horribly mutilated by an expanding revolver bullet,
24435 but no weapon of any sort was to be found in the room.
24443 \begin_layout Paragraph
24447 \begin_layout Standard
24448 The amount of space before and after multiple columns can be changed by changing the length
24449 \begin_inset Flex Code
24452 \begin_layout Plain Layout
24461 For example the command
24464 \begin_layout LyX-Code
24472 \begin_layout Standard
24473 in \SpecialChar TeX
24474 Code changes its value to 3
24475 \begin_inset space \thinspace{}
24479 The change must be made before the multiple columns' start.
24480 The predefined value is 13
24481 \begin_inset space \thinspace{}
24487 \begin_layout Standard
24489 \begin_inset Flex Code
24492 \begin_layout Plain Layout
24501 \begin_inset space \thinspace{}
24507 \begin_layout Standard
24511 \begin_layout Plain Layout
24517 multicolsep}{2.5cm}
24525 \begin_layout Standard
24526 \begin_inset Flex Multiple Columns
24529 \begin_layout Plain Layout
24532 All day I turned these facts over in my mind,
24533 endeavouring to hit upon some theory which could reconcile them all,
24534 and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
24535 I confess that I made little progress.
24536 In the evening I strolled across the Park,
24537 and found myself about six o'clock at the Oxford Street end of Park Lane.
24538 A group of loafers upon the pavements,
24539 all staring up at a particular window,
24540 directed me to the house which I had come to see.
24542 thin man with coloured glasses,
24543 whom I strongly suspected of being a plain-clothes detective,
24544 was pointing out some theory of his own,
24545 while the others crowded round to listen to what he said.
24546 I got as near him as I could,
24547 but his observations seemed to me to be absurd,
24548 so I withdrew again in some disgust.
24549 As I did so I struck against an elderly,
24551 who had been behind me,
24552 and I knocked down several books which he was carrying.
24560 \begin_layout Standard
24561 \begin_inset Note Greyedout
24564 \begin_layout Plain Layout
24570 The values you set with
24571 \begin_inset Flex Code
24574 \begin_layout Plain Layout
24582 will be used for all following multiple columns until you change them again.
24590 \begin_layout Standard
24594 \begin_layout Plain Layout
24606 \begin_inset Note Note
24609 \begin_layout Plain Layout
24610 go back to the default
24618 \begin_layout Standard
24620 \change_deleted 564990737 1672236355
24621 \begin_inset Newpage newpage
24629 \begin_layout Paragraph
24633 \begin_layout Standard
24634 A column break can be forced by inserting the command
24635 \begin_inset Flex Code
24638 \begin_layout Plain Layout
24646 as \SpecialChar TeX
24647 Code to that position in the text where the column should be broken.
24648 Note that this leads in most cases to whitespace in the text.
24649 \begin_inset Newline newline
24652 Here is an example:
24655 \begin_layout Standard
24656 \begin_inset Flex Multiple Columns
24659 \begin_layout Plain Layout
24662 \begin_inset Quotes eld
24665 You're surprised to see me,
24667 \begin_inset Quotes erd
24675 \begin_layout Plain Layout
24678 I acknowledged that I was.
24681 \begin_layout Plain Layout
24684 \begin_inset Quotes eld
24690 and when I chanced to see you go into this house,
24691 as I came hobbling after you,
24692 I thought to myself,
24693 I'll just step in and see that kind gentleman,
24694 and tell him that if I was a bit gruff in my manner there was not any harm meant,
24695 and that I am much obliged to him for picking up my books.
24696 \begin_inset Quotes erd
24702 \begin_layout Plain Layout
24705 \begin_inset Quotes eld
24708 You make too much of a trifle,
24709 \begin_inset Quotes erd
24714 \begin_inset Quotes eld
24717 May I ask how you knew who I was?
24718 \begin_inset Quotes erd
24721 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
24725 \begin_layout Plain Layout
24737 \begin_layout Plain Layout
24740 \begin_inset Quotes eld
24745 if it isn't too great a liberty,
24746 I am a neighbour of yours,
24747 for you'll find my little bookshop at the corner of Church Street,
24748 and very happy to see you,
24750 Maybe you collect yourself,
24755 \begin_inset space ~
24771 \begin_inset space ~
24776 With five volumes you could just fill that gap on that second shelf.
24780 \begin_inset Quotes erd
24791 \begin_layout Paragraph
24795 \begin_layout Standard
24796 The width of the columns is automatically calculated,
24797 but you can modify the space between the columns.
24798 This is done by changing the length
24799 \begin_inset Flex Code
24802 \begin_layout Plain Layout
24811 Its predefined value is 10
24812 \begin_inset space \thinspace{}
24816 Here is an example where
24817 \begin_inset Flex Code
24820 \begin_layout Plain Layout
24829 \begin_inset space \thinspace{}
24835 \begin_layout Standard
24839 \begin_layout Plain Layout
24853 \begin_layout Standard
24854 \begin_inset Flex Multiple Columns
24857 \begin_layout Plain Layout
24860 My observations of No.
24861 \begin_inset space \space{}
24864 427 Park Lane did little to clear up the problem in which I was interested.
24865 The house was separated from the street by a low wall and railing,
24866 the whole not more than five feet high.
24867 It was perfectly easy,
24869 for anyone to get into the garden,
24870 but the window was entirely inaccessible,
24871 since there was no water pipe or anything which could help the most active man to climb it.
24872 More puzzled than ever,
24873 I retraced my steps to Kensington.
24874 I had not been in my study five minutes when the maid entered to say that a person desired to see me.
24875 To my astonishment it was none other than my strange old book collector,
24877 wizened face peering out from a frame of white hair,
24878 and his precious volumes,
24879 a dozen of them at least,
24880 wedged under his right arm.
24888 \begin_layout Standard
24892 \begin_layout Plain Layout
24904 \begin_inset Note Note
24907 \begin_layout Plain Layout
24908 go back to the default
24916 \begin_layout Paragraph
24920 \begin_layout Standard
24921 Between the columns a rule with a width of the length
24922 \begin_inset Flex Code
24925 \begin_layout Plain Layout
24934 If this rule width is set to 0
24935 \begin_inset space \thinspace{}
24938 pt (this is the default),
24939 the rule is suppressed.
24940 In the following example the rule is 2
24941 \begin_inset space \thinspace{}
24947 \begin_layout Standard
24951 \begin_layout Plain Layout
24957 columnseprule}{2pt}
24965 \begin_layout Standard
24966 \begin_inset Flex Multiple Columns
24969 \begin_layout Plain Layout
24972 \begin_inset Quotes eld
24975 You're surprised to see me,
24977 \begin_inset Quotes erd
24985 \begin_layout Plain Layout
24988 I acknowledged that I was.
24991 \begin_layout Plain Layout
24994 \begin_inset Quotes eld
25000 and when I chanced to see you go into this house,
25001 as I came hobbling after you,
25002 I thought to myself,
25003 I'll just step in and see that kind gentleman,
25004 and tell him that if I was a bit gruff in my manner there was not any harm meant,
25005 and that I am much obliged to him for picking up my books.
25006 \begin_inset Quotes erd
25012 \begin_layout Plain Layout
25015 \begin_inset Quotes eld
25018 You make too much of a trifle,
25019 \begin_inset Quotes erd
25024 \begin_inset Quotes eld
25027 May I ask how you knew who I was?
25028 \begin_inset Quotes erd
25034 \begin_layout Plain Layout
25037 \begin_inset Quotes eld
25042 if it isn't too great a liberty,
25043 I am a neighbour of yours,
25044 for you'll find my little bookshop at the corner of Church Street,
25045 and very happy to see you,
25047 Maybe you collect yourself,
25052 \begin_inset space ~
25068 \begin_inset space ~
25073 With five volumes you could just fill that gap on that second shelf.
25077 \begin_inset Quotes erd
25088 \begin_layout Standard
25089 \begin_inset VSpace defskip
25095 \begin_layout Standard
25096 The rule can be colored by redefining the command
25097 \begin_inset Flex Code
25100 \begin_layout Plain Layout
25109 This is done by inserting the command
25112 \begin_layout LyX-Code
25117 columnseprulecolor}{
25122 \begin_layout Standard
25123 as \SpecialChar TeX
25124 Code before the multicolumn inset.
25126 \begin_inset Flex Code
25129 \begin_layout Plain Layout
25135 in this command by a color of your choice.
25136 You can use all pre- and self-defined colors.
25145 \begin_inset space ~
25150 for more information about pre- and self-defined colors.
25151 To go back to the default color insert the command
25154 \begin_layout LyX-Code
25159 columnseprulecolor}{
25164 \begin_layout Standard
25165 Here is the example with a cyan rule and 1
25166 \begin_inset space \thinspace{}
25169 cm column separation:
25172 \begin_layout Standard
25176 \begin_layout Plain Layout
25185 \begin_layout Plain Layout
25191 columnseprulecolor}{
25201 \begin_layout Standard
25202 \begin_inset Flex Multiple Columns
25205 \begin_layout Plain Layout
25208 \begin_inset Quotes eld
25211 You're surprised to see me,
25213 \begin_inset Quotes erd
25221 \begin_layout Plain Layout
25224 I acknowledged that I was.
25227 \begin_layout Plain Layout
25230 \begin_inset Quotes eld
25236 and when I chanced to see you go into this house,
25237 as I came hobbling after you,
25238 I thought to myself,
25239 I'll just step in and see that kind gentleman,
25240 and tell him that if I was a bit gruff in my manner there was not any harm meant,
25241 and that I am much obliged to him for picking up my books.
25242 \begin_inset Quotes erd
25248 \begin_layout Plain Layout
25251 \begin_inset Quotes eld
25254 You make too much of a trifle,
25255 \begin_inset Quotes erd
25260 \begin_inset Quotes eld
25263 May I ask how you knew who I was?
25264 \begin_inset Quotes erd
25270 \begin_layout Plain Layout
25273 \begin_inset Quotes eld
25278 if it isn't too great a liberty,
25279 I am a neighbour of yours,
25280 for you'll find my little bookshop at the corner of Church Street,
25281 and very happy to see you,
25283 Maybe you collect yourself,
25288 \begin_inset space ~
25304 \begin_inset space ~
25309 With five volumes you could just fill that gap on that second shelf.
25313 \begin_inset Quotes erd
25324 \begin_layout Standard
25328 \begin_layout Plain Layout
25334 columnseprule}{0pt}
25337 \begin_layout Plain Layout
25343 columnseprulecolor}{
25351 \begin_inset Note Note
25354 \begin_layout Plain Layout
25355 go back to the default
25363 \begin_layout Section
25365 \change_inserted 564990737 1671270380
25369 \begin_layout Subsection
25371 \change_inserted 564990737 1671270398
25373 \change_deleted 564990737 1671270396
25379 \begin_layout Standard
25382 as well as any other text processor uses by default rectangular paragraphs.
25383 For special cases like for example posters,
25384 invitation cards or poems you can modify the paragraph shape to one of your choice.
25386 \change_deleted 564990737 1672311802
25387 This can be done by using the \SpecialChar LaTeX
25389 \begin_inset Flex Code
25392 \begin_layout Plain Layout
25398 which is loaded by using in the document settings the module
25400 Custom paragraph shapes
25403 \change_inserted 564990737 1672311802
25404 This module uses the
25408 package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
25414 \begin_layout Subsubsection
25418 \begin_layout Standard
25420 \change_inserted -712698321 1674913874
25431 \change_inserted -712698321 1674913877
25434 provides the following shapes:
25437 \begin_layout Standard
25438 \begin_inset Tabular
25439 <lyxtabular version="3" rows="13" columns="3">
25440 <features booktabs="true" islongtable="true" longtabularalignment="center">
25441 <column alignment="left" valignment="middle" width="16col%">
25442 <column alignment="left" valignment="middle" width="40col%">
25443 <column alignment="left" valignment="middle" width="35col%">
25444 <row endhead="true">
25445 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25448 \begin_layout Plain Layout
25457 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25460 \begin_layout Plain Layout
25469 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25472 \begin_layout Plain Layout
25482 <row interlinespace="default">
25483 <cell alignment="left" valignment="top" usebox="none">
25486 \begin_layout Plain Layout
25494 <cell alignment="left" valignment="top" usebox="none">
25497 \begin_layout Plain Layout
25500 Circle with circular hole (in the size of a CD/DVD)
25505 <cell alignment="left" valignment="top" usebox="none">
25508 \begin_layout Plain Layout
25512 take care there is not too much text
25518 <row interlinespace="default">
25519 <cell alignment="left" valignment="top" usebox="none">
25522 \begin_layout Plain Layout
25530 <cell alignment="left" valignment="top" usebox="none">
25533 \begin_layout Plain Layout
25541 <cell alignment="left" valignment="top" usebox="none">
25544 \begin_layout Plain Layout
25548 calculation might fail
25554 <row interlinespace="default">
25555 <cell alignment="left" valignment="top" usebox="none">
25558 \begin_layout Plain Layout
25566 <cell alignment="left" valignment="top" usebox="none">
25569 \begin_layout Plain Layout
25572 Rhomboid (symbolizing a
25573 \begin_inset Quotes eld
25577 \begin_inset Quotes erd
25585 <cell alignment="left" valignment="top" usebox="none">
25588 \begin_layout Plain Layout
25597 <row interlinespace="default">
25598 <cell alignment="left" valignment="top" usebox="none">
25601 \begin_layout Plain Layout
25609 <cell alignment="left" valignment="top" usebox="none">
25612 \begin_layout Plain Layout
25620 <cell alignment="left" valignment="top" usebox="none">
25623 \begin_layout Plain Layout
25632 <row interlinespace="default">
25633 <cell alignment="left" valignment="top" usebox="none">
25636 \begin_layout Plain Layout
25644 <cell alignment="left" valignment="top" usebox="none">
25647 \begin_layout Plain Layout
25655 <cell alignment="left" valignment="top" usebox="none">
25658 \begin_layout Plain Layout
25667 <row interlinespace="default">
25668 <cell alignment="left" valignment="top" usebox="none">
25671 \begin_layout Plain Layout
25679 <cell alignment="left" valignment="top" usebox="none">
25682 \begin_layout Plain Layout
25685 Nut for bolt (hexagon with circular hole)
25690 <cell alignment="left" valignment="top" usebox="none">
25693 \begin_layout Plain Layout
25702 <row interlinespace="default">
25703 <cell alignment="left" valignment="top" usebox="none">
25706 \begin_layout Plain Layout
25714 <cell alignment="left" valignment="top" usebox="none">
25717 \begin_layout Plain Layout
25725 <cell alignment="left" valignment="top" usebox="none">
25728 \begin_layout Plain Layout
25737 <row interlinespace="default">
25738 <cell alignment="left" valignment="top" usebox="none">
25741 \begin_layout Plain Layout
25749 <cell alignment="left" valignment="top" usebox="none">
25752 \begin_layout Plain Layout
25760 <cell alignment="left" valignment="top" usebox="none">
25763 \begin_layout Plain Layout
25772 <row interlinespace="default">
25773 <cell alignment="left" valignment="top" usebox="none">
25776 \begin_layout Plain Layout
25784 <cell alignment="left" valignment="top" usebox="none">
25787 \begin_layout Plain Layout
25795 <cell alignment="left" valignment="top" usebox="none">
25798 \begin_layout Plain Layout
25807 <row interlinespace="default">
25808 <cell alignment="left" valignment="top" usebox="none">
25811 \begin_layout Plain Layout
25819 <cell alignment="left" valignment="top" usebox="none">
25822 \begin_layout Plain Layout
25825 Normal/reversed rain drop
25830 <cell alignment="left" valignment="top" usebox="none">
25833 \begin_layout Plain Layout
25837 calculation might fail
25843 <row interlinespace="default">
25844 <cell alignment="left" valignment="top" usebox="none">
25847 \begin_layout Plain Layout
25856 <cell alignment="left" valignment="top" usebox="none">
25859 \begin_layout Plain Layout
25862 The \SpecialChar TeX
25868 <cell alignment="left" valignment="top" usebox="none">
25871 \begin_layout Plain Layout
25880 <row interlinespace="default">
25881 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25884 \begin_layout Plain Layout
25888 \begin_inset Newline newline
25896 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25899 \begin_layout Plain Layout
25902 Triangles in different orientations
25907 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25910 \begin_layout Plain Layout
25926 \begin_layout Standard
25927 To use a shape for your paragraph,
25928 simply select it in \SpecialChar LyX
25929 's pull-down box for environments in the toolbar.
25932 \begin_layout Standard
25933 \begin_inset Newpage newpage
25939 \begin_layout Standard
25940 Here is an example paragraph in the shape of a nut:
25943 \begin_layout Standard
25944 \begin_inset VSpace bigskip
25953 Lorem ipsum dolor sit amet,
25954 consetetur sadipscing elitr,
25955 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25957 At vero eos et accusam et justo duo dolores et ea rebum.
25958 Stet clita kasd gubergren,
25959 no sea takimata sanctus est Lorem ipsum dolor sit amet.
25960 Lorem ipsum dolor sit amet,
25961 consetetur sadipscing elitr,
25962 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25966 \begin_layout Standard
25967 \begin_inset VSpace bigskip
25973 \begin_layout Standard
25974 \begin_inset Note Greyedout
25977 \begin_layout Plain Layout
25987 paragraphs cannot run over a page break.
25995 \begin_layout Standard
25996 \begin_inset VSpace bigskip
26002 \begin_layout Standard
26004 \begin_inset Flex Code
26007 \begin_layout Plain Layout
26013 takes care that the shape will always be preserved,
26014 no matter how much text is in the paragraph.
26015 Therefore the paragraph size changes with the amount of contained text.
26016 This can lead to paragraph sizes exceeding the page margins.
26017 To demonstrate the size scaling,
26018 here is the same example paragraph but with twice as much text:
26021 \begin_layout Standard
26022 \begin_inset Newpage newpage
26031 Lorem ipsum dolor sit amet,
26032 consetetur sadipscing elitr,
26033 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26035 At vero eos et accusam et justo duo dolores et ea rebum.
26036 Stet clita kasd gubergren,
26037 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26038 Lorem ipsum dolor sit amet,
26039 consetetur sadipscing elitr,
26040 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26042 Lorem ipsum dolor sit amet,
26043 consetetur sadipscing elitr,
26044 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26046 At vero eos et accusam et justo duo dolores et ea rebum.
26047 Stet clita kasd gubergren,
26048 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26049 Lorem ipsum dolor sit amet,
26050 consetetur sadipscing elitr,
26051 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26055 \begin_layout Standard
26056 \begin_inset VSpace bigskip
26062 \begin_layout Standard
26063 An exception is the shape
26068 It cannot be scaled because it must fit the size of a CD/DVD.
26069 Therefore the amount of text that fits into the shape is limited.
26070 \change_deleted -712698321 1674914001
26072 \begin_inset Newline newline
26076 \change_inserted -712698321 1674914001
26080 \begin_layout Standard
26090 meaning that the calculation of their size can fail,
26091 depending on the amount of text.
26092 You will then get the \SpecialChar LaTeX
26094 \begin_inset Quotes eld
26097 Arithmetic overflow
26098 \begin_inset Quotes erd
26102 In this case one can try to remove or add some text;
26103 if nothing works one has to use another shape.
26106 \begin_layout Standard
26108 \change_deleted -712698321 1674914021
26109 \begin_inset VSpace bigskip
26117 \begin_layout Standard
26118 For shapes with tips you will maybe see that \SpecialChar LaTeX
26119 's hyphenation routine fails for text in the tips.
26120 Therefore it is often necessary to add hyphenation points
26125 arg "specialchar-insert hyphenation"
26130 ) to the corresponding text parts.
26133 \begin_layout Standard
26135 \change_deleted -712698321 1674914022
26136 \begin_inset VSpace bigskip
26144 \begin_layout Standard
26145 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
26146 You can therefore not use the paragraph dialog to align such paragraphs.
26147 A solution is to put the paragraph into a minipage or parbox and align the box.
26148 The problem is hereby to find the right width for the box.
26149 Because if it is too wide and you center the box,
26150 the paragraph is not centered too because it sticks at the left side of the box.
26151 So you might have to play a bit with the width until it fits.
26152 Here are two heart-shaped paragraphs,
26153 the first one is not aligned,
26154 the second one is right-aligned:
26157 \begin_layout Standard
26158 \begin_inset Newpage newpage
26164 \begin_layout Heart
26168 Lo\SpecialChar softhyphen
26169 rem ipsum dolor sit amet,
26170 consetetur sadipscing elitr,
26171 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26173 At vero eos et accusam et justo duo dolores et ea rebum.
26174 Stet clita kasd gubergren,
26175 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26178 \begin_layout Standard
26179 \begin_inset VSpace bigskip
26185 \begin_layout Standard
26188 \begin_inset Box Frameless
26198 height_special "totalheight"
26203 backgroundcolor "none"
26206 \begin_layout Heart
26210 Lo\SpecialChar softhyphen
26211 rem ipsum dolor sit amet,
26212 consetetur sadipscing elitr,
26213 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26215 At vero eos et accusam et justo duo dolores et ea rebum.
26216 Stet clita kasd gubergren,
26217 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26225 \begin_layout Subsubsection
26229 \begin_layout Standard
26230 You can define any shape you want.
26231 Doing this manually is a lot of work because every coordinate must be specified.
26232 But there is a way to let the computer calculate the coordinates:
26235 \begin_layout Enumerate
26236 Install the program
26237 \begin_inset CommandInset href
26240 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26248 \begin_layout Enumerate
26255 TeX/LaTeX\SpecialChar menuseparator
26256 Settings\SpecialChar menuseparator
26259 and select the font size you are using in your document.
26260 For example this document uses the size 12
26261 \begin_inset space \thinspace{}
26267 \begin_layout Enumerate
26271 \begin_layout Enumerate
26274 TeX/LaTeX\SpecialChar menuseparator
26277 to export the shape to coordinates.
26278 In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
26282 \begin_layout Plain Layout
26283 For more information see
26284 \begin_inset CommandInset href
26286 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26299 \begin_layout Standard
26300 The coordinates are written into a \SpecialChar TeX
26302 To use it for your \SpecialChar LyX
26306 \begin_layout Enumerate
26307 Place the cursor before the first character of your paragraph (or into a new empty one).
26310 \begin_layout Enumerate
26311 Open in \SpecialChar LyX
26314 Insert\SpecialChar menuseparator
26315 File\SpecialChar menuseparator
26317 \begin_inset space ~
26323 select the file and use
26332 \begin_layout Standard
26333 \begin_inset VSpace defskip
26339 \begin_layout Standard
26340 \begin_inset Note Greyedout
26343 \begin_layout Plain Layout
26349 The changed shape only applies to the current paragraph;
26350 everything is reset to normal for the next paragraph.
26351 Therefore the shape definition file must be input into every paragraph with the desired shape.
26359 \begin_layout Standard
26360 \begin_inset VSpace bigskip
26366 \begin_layout Standard
26367 Here is an example:
26370 \begin_layout Standard
26371 \begin_inset VSpace bigskip
26377 \begin_layout Standard
26378 \begin_inset CommandInset include
26380 filename "SpecialParagraphShape.tex"
26387 Lorem ipsum dolor sit amet,
26388 consetetur sadipscing elitr,
26389 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26391 At vero eos et accusam et justo duo dolores et ea rebum.
26392 Stet clita kasd gubergren,
26393 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26394 Lorem ipsum dolor sit amet,
26395 consetetur sadipscing elitr,
26396 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26400 \begin_layout Standard
26401 \begin_inset VSpace bigskip
26407 \begin_layout Standard
26413 to draw complexer shapes in
26417 you can draw the shape in a program of your choice and import the resulting image to
26422 Then you only need to draw a line or spline along the outline of the image.
26425 \begin_layout Standard
26427 \change_deleted -712698321 1674914114
26428 \begin_inset VSpace bigskip
26436 \begin_layout Standard
26439 Custom paragraph shapes
26441 also provides the two commands
26449 which can be used to define custom shapes coordinate by coordinate.
26453 \begin_layout Plain Layout
26454 These commands are internally used for all shapes described here.
26459 For information how these styles are used and about further customization possibilities,
26461 \begin_inset CommandInset href
26463 name "documentation"
26464 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26470 \begin_inset Flex Code
26473 \begin_layout Plain Layout
26482 \begin_layout Subsection
26484 \change_inserted 564990737 1672311925
26488 \begin_layout Hanging
26490 \change_inserted 564990737 1672311925
26491 This module adds the
26497 one where all but the first line of the paragraph is indented.
26498 This may not appear in your \SpecialChar LyX
26499 document but will appear in the final output.
26502 \begin_layout Subsection
26504 \change_inserted 564990737 1672311925
26505 \begin_inset CommandInset label
26507 name "subsec:Initials"
26511 Initials (Drop Caps)
26514 \begin_layout Initial
26516 \change_inserted 564990737 1672311925
26517 \begin_inset Argument 2
26520 \begin_layout Plain Layout
26522 \change_inserted 564990737 1672311925
26531 \begin_inset Argument 3
26534 \begin_layout Plain Layout
26536 \change_inserted 564990737 1672311925
26544 module adds a drop capitals paragraph style
26548 for paragraph environments which you can use wherever you want to have drop capitals.
26549 You then have three more items in the
26556 \begin_layout Itemize
26558 \change_inserted 564990737 1672311925
26563 which creates an inset for the drop capital
26566 \begin_layout Itemize
26568 \change_inserted 564990737 1672311925
26573 which creates an inset for the rest of the word
26576 \begin_layout Itemize
26578 \change_inserted 564990737 1672311925
26583 which allow you configure the formatting of the drop capital.
26586 \begin_layout Standard
26588 \change_inserted 564990737 1672311925
26589 To customize the appearance of the style,
26592 Help\SpecialChar menuseparator
26593 Embedded Objects\SpecialChar menuseparator
26594 Objects Surrounded by Text\SpecialChar menuseparator
26600 \begin_layout Section
26602 \change_inserted 564990737 1672312011
26606 \begin_layout Subsection
26608 \change_inserted 564990737 1672312011
26609 Hyphenatable Text Markup
26610 \change_inserted -712698321 1674915075
26612 \change_inserted 564990737 1672312011
26616 \begin_layout Standard
26618 \change_inserted 564990737 1672312011
26620 \change_deleted -712698321 1674915086
26622 \change_inserted -712698321 1674915087
26624 \change_inserted 564990737 1672312011
26625 defines text styles to highlight,
26628 underline and capitalize/small-cap text by means of the
26634 \change_inserted -712698321 1674915141
26638 \begin_layout Standard
26640 \change_inserted 564990737 1672312011
26641 As opposed to the markup provided by the Text Properties dialog,
26642 words marked-up with
26648 \begin_inset CommandInset href
26650 name "soul documentation"
26651 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
26659 \begin_layout Subsection
26661 \change_inserted 564990737 1672312011
26665 \begin_layout Standard
26667 \change_inserted 564990737 1672312011
26668 This module defines some character styles for logical markup:
26672 \begin_inset Flex Noun
26675 \begin_layout Plain Layout
26677 \change_inserted 564990737 1672312011
26693 \begin_inset Flex Emph
26696 \begin_layout Plain Layout
26698 \change_inserted 564990737 1672312011
26712 \begin_inset Flex Strong
26715 \begin_layout Plain Layout
26717 \change_inserted 564990737 1672312011
26727 \begin_inset Flex Code
26730 \begin_layout Plain Layout
26732 \change_inserted 564990737 1672312011
26740 which are accessed via the
26745 dit\SpecialChar menuseparator
26747 \begin_inset space ~
26751 \begin_inset space ~
26763 \begin_layout Chapter
26765 \change_deleted 564990737 1671304317
26769 \change_inserted 564990737 1671304322
26771 \change_deleted 564990737 1671304331
26772 ies with Bib\SpecialChar TeX
26778 \begin_layout Standard
26779 The most basic information about how to use Bib\SpecialChar TeX
26784 with \SpecialChar LyX
26785 is contained in the section
26787 Bibliography databases
26794 The following subsections explain special bibliography features supported by \SpecialChar LyX
26798 \begin_layout Section
26799 Alternative Citation Styles
26802 \begin_layout Standard
26803 Standard Bib\SpecialChar TeX
26805 \begin_inset space \thinspace{}
26809 \begin_inset space \space{}
26813 \begin_inset Quotes eld
26817 \begin_inset Quotes erd
26820 ) to refer to a cited work.
26822 in many scientific disciplines,
26823 other citation styles are in use.
26824 The most common one is the author-year style (e.
26825 \begin_inset space \thinspace{}
26829 \begin_inset space \space{}
26833 \begin_inset Quotes eld
26837 \begin_inset Quotes erd
26842 supports three packages that provide this style,
26844 \begin_inset Flex Code
26847 \begin_layout Plain Layout
26855 \begin_inset Flex Code
26858 \begin_layout Plain Layout
26866 \begin_inset Flex Code
26869 \begin_layout Plain Layout
26876 Each of these packages has their pros and cons,
26877 which cannot be listed in detail.
26878 If you only want to have simple author-year (or author-numerical) style,
26879 or if you want to use one of the countless style files for
26880 \begin_inset Flex Code
26883 \begin_layout Plain Layout
26890 then the established
26891 \begin_inset Flex Code
26894 \begin_layout Plain Layout
26900 package is probably your choice.
26901 If you look for specific citation styles common in law studies,
26902 you might consider the
26903 \begin_inset Flex Code
26906 \begin_layout Plain Layout
26913 If you want to have full control over the formatting or look for advanced features such as ibidem,
26914 footnote citations,
26915 full title citations,
26916 advanced date formats (such as 400 BC) or full localization to other languages than English,
26917 you should definitely consider
26918 \begin_inset Flex Code
26921 \begin_layout Plain Layout
26928 which exceeds all other packages in terms of features,
26929 but is also quite heavy and more resource-hungry.
26932 \begin_layout Standard
26933 The handling of these packages in \SpecialChar LyX
26934 is basically the same.
26936 \change_deleted -712698321 1674917685
26938 \begin_inset Flex Noun
26941 \begin_layout Plain Layout
26942 Document\SpecialChar menuseparator
26949 \change_inserted -712698321 1674917685
26952 Document\SpecialChar menuseparator
26958 \change_deleted -712698321 1674917692
26960 \begin_inset Flex Noun
26963 \begin_layout Plain Layout
26970 \change_inserted -712698321 1674917692
26978 \change_deleted -712698321 1674917696
26980 \begin_inset Flex Noun
26983 \begin_layout Plain Layout
26990 \change_inserted -712698321 1674917696
26998 \change_deleted -712698321 1674917703
27000 \begin_inset Flex Noun
27003 \begin_layout Plain Layout
27010 \change_inserted -712698321 1674917703
27019 \change_deleted -712698321 1674917708
27021 \begin_inset Flex Noun
27024 \begin_layout Plain Layout
27031 \change_inserted -712698321 1674917708
27040 \change_deleted -712698321 1674917712
27042 \begin_inset Flex Noun
27045 \begin_layout Plain Layout
27046 Biblatex (Natbib mode)
27052 \change_inserted -712698321 1674917712
27055 Biblatex (Natbib mode)
27061 \change_deleted -712698321 1674917718
27063 \begin_inset Flex Noun
27066 \begin_layout Plain Layout
27073 \change_inserted -712698321 1674917718
27081 \change_deleted -712698321 1674917724
27083 \begin_inset Flex Noun
27086 \begin_layout Plain Layout
27093 \change_inserted -712698321 1674917724
27101 \begin_inset space ~
27104 6.5.3 in the User's Guide for more information on these choices).
27105 With all these packages,
27106 you will get some extra features in the citation dialog and you can select the style of the reference (
27107 \begin_inset Quotes eld
27111 \begin_inset Quotes erd
27116 \begin_inset Quotes eld
27120 \begin_inset Quotes erd
27125 \begin_inset Quotes eld
27130 \begin_inset Quotes erd
27135 \begin_inset Quotes eld
27139 \begin_inset Quotes erd
27143 Note that either package needs specifically designed style files.
27144 They all ship their own,
27145 but there are lots of additional style files,
27146 and there is even an interactive style file builder
27150 \begin_layout Plain Layout
27152 \begin_inset Flex URL
27155 \begin_layout Plain Layout
27157 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
27168 \begin_inset Flex Code
27171 \begin_layout Plain Layout
27180 \begin_layout Section
27181 Subdivided Bibliographies
27184 \begin_layout Standard
27185 Sometimes you might need to divide your bibliography into several sections.
27186 If you are for instance a historian,
27187 the possibility to separate sources and scientific works is most likely a
27188 \begin_inset Quotes eld
27192 \begin_inset Quotes erd
27197 Bib\SpecialChar TeX
27198 itself does not allow you to do this.
27199 But with the help of some \SpecialChar LaTeX
27201 Bib\SpecialChar TeX
27202 can be extended to fit your needs.
27205 \begin_layout Standard
27207 provides native support for one of these packages,
27216 \begin_layout Plain Layout
27218 \begin_inset Flex URL
27221 \begin_layout Plain Layout
27223 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
27233 The advantage of this package (compared to other packages such as
27237 ) is that you don't need to define new citation commands.
27239 you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
27241 If you want to divide your bibliography into the sections
27242 \begin_inset Quotes eld
27246 \begin_inset Quotes erd
27250 \begin_inset Quotes eld
27254 \begin_inset Quotes erd
27258 you first need to create two bibliographic databases,
27260 \begin_inset space \thinspace{}
27264 \begin_inset space \space{}
27268 \begin_inset Flex Code
27271 \begin_layout Plain Layout
27278 \begin_inset Flex Code
27281 \begin_layout Plain Layout
27291 \begin_layout Standard
27293 \change_deleted -712698321 1674917736
27295 \begin_inset Flex Noun
27298 \begin_layout Plain Layout
27299 Document\SpecialChar menuseparator
27306 \change_inserted -712698321 1674917736
27309 Document\SpecialChar menuseparator
27315 \change_deleted -712698321 1674917752
27317 \begin_inset Flex Noun
27320 \begin_layout Plain Layout
27327 \change_inserted -712698321 1674917752
27335 \change_deleted -712698321 1674917741
27339 \begin_inset Flex Noun
27342 \begin_layout Plain Layout
27345 Subdivided bibliography
27351 \change_inserted -712698321 1674917741
27352 Subdivided bibliography
27357 Now you can insert multiple Bib\SpecialChar TeX
27359 one for each section of your bibliography.
27360 Returning to our example:
27361 Insert the Bib\SpecialChar TeX
27363 \begin_inset Flex Code
27366 \begin_layout Plain Layout
27372 and a second one for the database
27373 \begin_inset Flex Code
27376 \begin_layout Plain Layout
27383 You are free to use the same or different styles for each section.
27385 you can choose if the bibliography section should contain
27386 \begin_inset Quotes eld
27389 all cited references
27390 \begin_inset Quotes erd
27393 of the specified database(s) (which is the default),
27395 \begin_inset Quotes eld
27398 all uncited references
27399 \begin_inset Quotes erd
27403 \begin_inset Quotes eld
27407 \begin_inset Quotes erd
27411 This might be useful if you would like to separate your bibliography into three sections:
27413 \begin_inset Quotes eld
27417 \begin_inset Quotes erd
27422 \begin_inset Quotes eld
27426 \begin_inset Quotes erd
27431 \begin_inset Quotes eld
27435 \begin_inset Quotes erd
27439 The titles for the sections can be added as ordinary sections or subsections.
27441 \begin_inset Flex Code
27444 \begin_layout Plain Layout
27450 removes the bibliography title,
27451 you have to manually re-add that,
27452 too (as a chapter* or section*,
27456 \begin_layout Standard
27462 the procedure is a bit different.
27473 \begin_inset Flex Noun
27476 \begin_layout Plain Layout
27477 Subdivided bibliography
27482 option is disabled if you use
27492 provides its own means to generate subdivided bibliographies.
27493 You can either add keywords to bibliography entries via the
27494 \begin_inset Flex Code
27497 \begin_layout Plain Layout
27503 entry option and then filter bibliography sections by keyword (by adding
27504 \begin_inset Flex Code
27507 \begin_layout Plain Layout
27514 \begin_inset Flex Noun
27517 \begin_layout Plain Layout
27523 field of the dialog that opens if you left-click on the
27524 \begin_inset Flex Noun
27527 \begin_layout Plain Layout
27528 Biblatex Generated Bibliography
27534 or you can filter by entry types (such as
27543 \begin_inset space \thinspace{}
27548 \begin_inset Flex Code
27551 \begin_layout Plain Layout
27558 \begin_inset Flex Code
27561 \begin_layout Plain Layout
27568 \begin_inset Flex Noun
27571 \begin_layout Plain Layout
27578 or you can create so-called
27579 \begin_inset Quotes eld
27582 Bibliography Categories
27583 \begin_inset Quotes erd
27586 to which you can assign individual entries.
27587 Please refer to the Biblatex manual,
27590 Subdivided Bibliographies
27596 \begin_layout Section
27597 Multiple Bibliographies
27598 \begin_inset CommandInset label
27600 name "subsec:Multiple-Bibliographies"
27607 \begin_layout Standard
27608 Multiple bibliographies,
27610 \begin_inset space \thinspace{}
27614 \begin_inset space \space{}
27617 a bibliography for each part,
27620 subsection or child (sub-document) of the document,
27621 are also supported by \SpecialChar LyX
27623 In order to enable it,
27625 \change_deleted -712698321 1674917759
27627 \begin_inset Flex Noun
27630 \begin_layout Plain Layout
27631 Document\SpecialChar menuseparator
27632 Settings\SpecialChar menuseparator
27639 \change_inserted -712698321 1674917759
27642 Document\SpecialChar menuseparator
27643 Settings\SpecialChar menuseparator
27648 and select the relevant unit (e.
27649 \begin_inset space \thinspace{}
27654 \begin_inset Quotes eld
27658 \begin_inset Quotes erd
27662 \begin_inset Flex Noun
27665 \begin_layout Plain Layout
27666 Multiple Bibliographies
27672 Then add a Bib(la)\SpecialChar TeX
27673 bibliography to each unit (e.
27674 \begin_inset space \thinspace{}
27678 section) of your document.
27680 a separate bibliography,
27681 containing only the references done in the current unit is generated.
27684 \begin_layout Standard
27685 If you use Bib\SpecialChar TeX
27688 \begin_inset Flex Code
27691 \begin_layout Plain Layout
27698 \begin_inset Flex Code
27701 \begin_layout Plain Layout
27707 package is used to create multiple bibliographies.
27708 The former package is used if you select
27709 \begin_inset Quotes eld
27713 \begin_inset Quotes erd
27721 \begin_inset Flex Noun
27724 \begin_layout Plain Layout
27725 Sectioned Bibliography
27731 In all other cases,
27733 \begin_inset Flex Code
27736 \begin_layout Plain Layout
27746 \begin_layout Plain Layout
27747 An alternative approach,
27748 if you are willing to use some
27749 \begin_inset Flex Noun
27752 \begin_layout Plain Layout
27760 \begin_inset space ~
27764 \begin_inset CommandInset ref
27766 reference "sec:Inserting-TeX-Code"
27773 \begin_inset Flex Code
27776 \begin_layout Plain Layout
27788 \begin_inset Flex Code
27791 \begin_layout Plain Layout
27799 encloses the specified units in
27800 \begin_inset Flex Code
27803 \begin_layout Plain Layout
27810 \begin_inset Flex Code
27813 \begin_layout Plain Layout
27822 \begin_inset Flex Code
27825 \begin_layout Plain Layout
27833 in order to create the units.
27834 Note that this approach has some limitations.
27836 every citation reference has to be inside some
27837 \begin_inset Flex Code
27840 \begin_layout Plain Layout
27847 So citations outside a defined unit (e.
27848 \begin_inset space \thinspace{}
27852 before the first section if you use
27853 \begin_inset Quotes eld
27857 \begin_inset Quotes erd
27861 \begin_inset Quotes eld
27865 \begin_inset Quotes erd
27869 You can also create your own units by entering
27870 \begin_inset Flex Code
27873 \begin_layout Plain Layout
27882 \begin_inset Flex Code
27885 \begin_layout Plain Layout
27893 as \SpecialChar TeX
27894 code (for instance to work around the mentioned limitation).
27898 \begin_inset Flex Code
27901 \begin_layout Plain Layout
27907 s cannot be nested.
27908 A second limitation is that
27909 \begin_inset Flex Code
27912 \begin_layout Plain Layout
27918 always processes all references of a bibliography database,
27919 even if they are not cited.
27920 This can result in odd labels (e.
27921 \begin_inset space \thinspace{}
27926 \begin_inset Quotes eld
27930 \begin_inset Quotes erd
27933 if two works of this author from 2014 are in the database,
27934 even if only one is cited).
27937 \begin_layout Standard
27944 \begin_inset Flex Code
27947 \begin_layout Plain Layout
27953 option is used instead.
27954 If you need specific units,
27955 you can start them with the \SpecialChar TeX
27957 \begin_inset Flex Code
27960 \begin_layout Plain Layout
27969 \begin_inset Flex Code
27972 \begin_layout Plain Layout
27982 If you also want to control the end of the unit,
27983 use the environment
27984 \begin_inset Flex Code
27987 \begin_layout Plain Layout
27997 \begin_inset Flex Code
28000 \begin_layout Plain Layout
28012 \begin_inset Flex Code
28015 \begin_layout Plain Layout
28021 s cannot be nested.
28022 In addition to the individual bibliography of the current unit,
28027 also provides an easy way to output all bibliographies,
28030 \begin_inset space \thinspace{}
28034 at the end of the document).
28036 \begin_inset Quotes eld
28039 all reference units
28040 \begin_inset Quotes erd
28043 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
28044 Please refer to the
28048 manual for more information on this topic.
28051 \begin_layout Chapter
28053 \change_deleted 564990737 1671355654
28057 \change_inserted 564990737 1671355667
28059 \change_deleted 564990737 1671355661
28061 \change_inserted 564990737 1671355684
28063 \begin_inset CommandInset label
28065 name "chap:bullets"
28070 \change_deleted 564990737 1671355684
28072 \begin_inset CommandInset label
28083 \begin_layout Standard
28089 \begin_layout Section
28093 \begin_layout Standard
28095 provides 216 bullet shapes that can be accessed from a simple dialog.
28096 Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
28097 These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
28101 \begin_layout Plain Layout
28103 actually you can but you'll have to do it by hand.
28111 \begin_layout Section
28115 \begin_layout Standard
28116 Open the dialog by selecting the
28117 \change_deleted -712698321 1674916009
28119 \begin_inset Flex Noun
28122 \begin_layout Plain Layout
28123 Document\SpecialChar menuseparator
28130 \change_inserted -712698321 1674916009
28133 Document\SpecialChar menuseparator
28138 menu item and then select the
28139 \begin_inset Flex Noun
28142 \begin_layout Plain Layout
28151 \begin_layout Standard
28152 The dialog provides you with a table of bullet shapes.
28153 A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
28154 The row of buttons across the top is used to select which bullet depth you are changing.
28155 \change_inserted -712698321 1674916033
28159 \begin_layout Standard
28161 \change_inserted -712698321 1674916177
28168 \change_deleted -712698321 1674916065
28170 \change_inserted -712698321 1674916067
28173 text entry under the table
28174 \change_inserted -712698321 1674916074
28176 \change_deleted -712698321 1674916096
28177 shows the currently selected
28178 \change_inserted -712698321 1674916101
28179 in which you can enter a
28181 bullet shape's \SpecialChar LaTeX
28183 \change_deleted -712698321 1674916109
28184 and this can be edited if desired
28187 If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
28191 \begin_layout Standard
28192 The six panels are divided up by the packages they require.
28193 The following table shows the mappings from button name to \SpecialChar LaTeX
28197 \begin_layout Standard
28199 \begin_inset Tabular
28200 <lyxtabular version="3" rows="7" columns="2">
28201 <features tabularvalignment="middle">
28202 <column alignment="center" valignment="top" width="0pt">
28203 <column alignment="center" valignment="top" width="0pt">
28205 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28208 \begin_layout Plain Layout
28223 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28226 \begin_layout Plain Layout
28243 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28246 \begin_layout Plain Layout
28261 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28264 \begin_layout Plain Layout
28273 base \SpecialChar LaTeX
28281 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28284 \begin_layout Plain Layout
28299 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28302 \begin_layout Plain Layout
28319 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28322 \begin_layout Plain Layout
28337 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28340 \begin_layout Plain Layout
28357 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28360 \begin_layout Plain Layout
28375 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28378 \begin_layout Plain Layout
28395 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28398 \begin_layout Plain Layout
28413 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28416 \begin_layout Plain Layout
28433 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28436 \begin_layout Plain Layout
28451 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28454 \begin_layout Plain Layout
28477 \begin_layout Standard
28479 doesn't stop you using bullets from packages you don't have.
28480 If you get errors from \SpecialChar LaTeX
28481 when you try to view or print the file,
28482 then it is likely you are missing a package.
28486 \begin_layout Plain Layout
28488 doesn't restrict your use since you may be editing locally and exporting elsewhere.
28496 \begin_layout Section
28498 \change_inserted -712698321 1674916414
28499 \begin_inset CommandInset label
28501 name "sec:How-to-use"
28510 \begin_layout Standard
28511 Select which bullet depth you want to change then select the bullet shape and size.
28512 Any changes will not be visible in \SpecialChar LyX
28514 but are visible when viewing the document.
28517 \begin_layout Standard
28518 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
28519 \change_deleted -712698321 1674916288
28524 \begin_layout Plain Layout
28526 \change_deleted -712698321 1674916287
28527 \begin_inset CommandInset label
28529 name "fn:If-you-really"
28539 want to have multiple sets of paragraphs with different sets of bullets in each,
28540 then you're going to have to get your hands dirty with \SpecialChar TeX
28542 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
28543 code for a wide range of bullet shapes.
28544 To make your own custom paragraphs you have the following options:
28547 \begin_layout Plain Layout
28551 \begin_layout Plain Layout
28567 \begin_layout Plain Layout
28571 \begin_layout Plain Layout
28593 \begin_layout Itemize
28594 Use the \SpecialChar LaTeX
28596 \begin_inset Flex Code
28599 \begin_layout Plain Layout
28607 to specify a new bullet shape for a given depth.
28608 You'll also need to save the current bullet shape so you can restore it again afterwards.
28609 In this itemized list the following \SpecialChar LaTeX
28610 code was used to change the bullet used for the first depth.
28614 \begin_layout LyX-Code
28624 \begin_layout LyX-Code
28641 \begin_layout Itemize
28642 Note that the itemize depth is specified in Roman numerals as part of the
28651 \begin_layout Itemize
28652 \begin_inset Argument item:1
28655 \begin_layout Plain Layout
28659 \begin_layout Plain Layout
28677 Specify each individual entry by starting each item with the bullet shape enclosed in a
28678 \begin_inset Quotes eld
28682 \begin_inset Quotes erd
28685 inset (available at
28687 Insert\SpecialChar menuseparator
28691 \begin_inset Flex Noun
28694 \begin_layout Plain Layout
28703 this item was started with
28704 \begin_inset Flex Code
28707 \begin_layout Plain Layout
28722 \begin_layout Plain Layout
28726 \begin_layout Plain Layout
28742 \begin_layout Plain Layout
28743 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
28744 The way used here was:
28747 \begin_layout LyX-Code
28760 \change_inserted -712698321 1674916331
28762 \begin_inset CommandInset label
28764 name "fn:If-you-really"
28771 \begin_layout Standard
28773 \change_inserted -712698321 1674916288
28778 want to have multiple sets of paragraphs with different sets of bullets in each,
28779 then you're going to have to get your hands dirty with \SpecialChar TeX
28781 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
28782 code for a wide range of bullet shapes.
28783 To make your own custom paragraphs you have the following options:
28786 \begin_layout Standard
28788 \change_inserted -712698321 1674916288
28792 \begin_layout Plain Layout
28794 \change_inserted -712698321 1674916288
28810 \begin_layout Standard
28812 \change_inserted -712698321 1674916288
28816 \begin_layout Plain Layout
28818 \change_inserted -712698321 1674916288
28840 \begin_layout Itemize
28842 \change_inserted -712698321 1674916288
28843 Use the \SpecialChar LaTeX
28845 \begin_inset Flex Code
28848 \begin_layout Plain Layout
28850 \change_inserted -712698321 1674916288
28860 to specify a new bullet shape for a given depth.
28861 You'll also need to save the current bullet shape so you can restore it again afterwards.
28862 In this itemized list the following \SpecialChar LaTeX
28863 code was used to change the bullet used for the first depth.
28867 \begin_layout LyX-Code
28869 \change_inserted -712698321 1674916288
28879 \begin_layout LyX-Code
28881 \change_inserted -712698321 1674916288
28898 \begin_layout Itemize
28900 \change_inserted -712698321 1674916288
28901 Note that the itemize depth is specified in Roman numerals as part of the
28910 \begin_layout Itemize
28912 \change_inserted -712698321 1674916288
28913 \begin_inset Argument item:1
28916 \begin_layout Plain Layout
28918 \change_inserted -712698321 1674916288
28922 \begin_layout Plain Layout
28924 \change_inserted -712698321 1674916288
28944 Specify each individual entry by starting each item with the bullet shape enclosed in a
28945 \begin_inset Quotes eld
28949 \begin_inset Quotes erd
28952 inset (available at
28954 Insert\SpecialChar menuseparator
28958 \begin_inset Flex Noun
28961 \begin_layout Plain Layout
28963 \change_inserted -712698321 1674916288
28974 this item was started with
28975 \begin_inset Flex Code
28978 \begin_layout Plain Layout
28980 \change_inserted -712698321 1674916288
28997 \begin_layout Standard
28999 \change_inserted -712698321 1674916288
29003 \begin_layout Plain Layout
29005 \change_inserted -712698321 1674916288
29021 \begin_layout Standard
29023 \change_inserted -712698321 1674916288
29024 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
29025 The way used here was:
29028 \begin_layout LyX-Code
29030 \change_inserted -712698321 1674916288
29042 \begin_layout Chapter
29046 \begin_layout Section
29047 Multipart Documents
29050 \begin_layout Subsection
29054 \begin_layout Standard
29055 When you are working on a large file with many sections,
29056 it is often convenient to break up the document into several files,
29057 or perhaps you have something where a table may change from time to time,
29058 but the preceding text does not.
29060 you should seriously consider using multipart documents.
29062 scientific papers often have five major sections:
29068 Each of these could be its own separate \SpecialChar LyX
29071 \begin_inset Quotes eld
29075 \begin_inset Quotes erd
29078 file which contains the title,
29083 plus the five included files.
29084 It is important to note that each of these files is a full \SpecialChar LyX
29085 file which can be formatted and printed on its own,
29086 as well as included in a master file.
29087 Each of these files must have the same document class,
29089 don't attempt to mix book classes with article classes.
29090 You may also include \SpecialChar LaTeX
29093 these files must not have their own preamble (i.
29094 \begin_inset space \thinspace{}
29098 \begin_inset space \space{}
29101 everything up to and including the
29102 \begin_inset Flex Code
29105 \begin_layout Plain Layout
29113 line as well as the
29114 \begin_inset Flex Code
29117 \begin_layout Plain Layout
29125 line must be deleted) or else errors will be generated when you try to make a DVI file.
29128 \begin_layout Standard
29130 allows you to include files quite easily with
29131 \change_deleted -712698321 1674917774
29133 \begin_inset Flex Noun
29136 \begin_layout Plain Layout
29137 Insert\SpecialChar menuseparator
29139 \begin_inset space ~
29148 \change_inserted -712698321 1674917774
29151 Insert\SpecialChar menuseparator
29153 \begin_inset space ~
29161 When you click on this selection a small box is inserted into the file at the current cursor location.
29162 Clicking on the box raises a dialog which allows you to select the file to be included,
29163 and the method of its inclusion.
29167 \begin_layout Standard
29168 The file selection box should by now be obvious.
29169 The three inclusion methods are
29170 \begin_inset Quotes eld
29174 \begin_inset Quotes erd
29179 \begin_inset Quotes eld
29183 \begin_inset Quotes erd
29188 \begin_inset Quotes eld
29192 \begin_inset Quotes erd
29197 \begin_inset Quotes eld
29201 \begin_inset Quotes erd
29205 \begin_inset Quotes eld
29209 \begin_inset Quotes erd
29212 are similar in many ways,
29213 but there are also some notable differences:
29216 \begin_layout Enumerate
29218 \begin_inset Quotes eld
29222 \begin_inset Quotes erd
29225 are typeset beginning on a new page,
29226 while files that are
29227 \begin_inset Quotes eld
29231 \begin_inset Quotes erd
29234 are typeset starting on the current page.
29237 \begin_layout Enumerate
29238 \begin_inset Quotes eld
29242 \begin_inset Quotes erd
29245 files cannot themselves
29246 \begin_inset Quotes eld
29250 \begin_inset Quotes erd
29254 \begin_inset Quotes eld
29258 \begin_inset Quotes erd
29263 \begin_inset Quotes eld
29267 \begin_inset Quotes erd
29272 infinite sub-inputting is possible.
29275 \begin_layout Enumerate
29276 \begin_inset Quotes eld
29280 \begin_inset Quotes erd
29283 allow for the output of only selected
29284 \begin_inset Quotes eld
29288 \begin_inset Quotes erd
29292 while maintaining the actual counters (pagination etc.) and references (please refer to the section
29295 \begin_inset space ~
29303 \begin_inset space ~
29308 manual for details).
29311 \begin_layout Standard
29314 \begin_inset Quotes eld
29318 \begin_inset Quotes erd
29321 is the preferred method for chapters that are outsourced to child documents,
29323 \begin_inset Quotes eld
29327 \begin_inset Quotes erd
29330 is more suitable for arbitrary file inheritance.
29333 \begin_layout Standard
29335 \begin_inset Quotes eld
29339 \begin_inset Quotes erd
29342 included file allows you to include a file typeset exactly as it appears in the file,
29344 \begin_inset space \thinspace{}
29348 \begin_inset space \space{}
29352 \begin_inset Flex Code
29355 \begin_layout Plain Layout
29362 with the characters set in a fixed-width typewriter font.
29364 spaces in this file are invisible,
29365 though two consecutive spaces are conserved,
29366 unlike \SpecialChar LyX
29367 's normal treatment of spaces.
29370 \begin_inset Flex Noun
29373 \begin_layout Plain Layout
29375 \begin_inset space ~
29379 \begin_inset space ~
29383 \begin_inset space ~
29391 checkbox typesets a mark to unambiguously define the presence of a space.
29395 \begin_layout Standard
29397 the master file is converted into a full \SpecialChar LaTeX
29398 file before typesetting,
29399 while the included files are converted to \SpecialChar LaTeX
29400 files that do not have all the preamble information.
29403 \begin_layout Subsection
29404 Cross-References Between Files
29407 \begin_layout Standard
29408 \begin_inset Box Shadowbox
29418 height_special "totalheight"
29423 backgroundcolor "none"
29426 \begin_layout Plain Layout
29427 This section is somewhat out of date.
29428 Need to describe default master documents and how children are opened when the master is.
29437 \begin_layout Standard
29438 It is possible to set up cross-references between the different files.
29440 open all the files in question:
29441 let's call them A and B in a two file example,
29442 where B is included in A.
29443 Let's say you insert a label in A,
29444 then want to reference it in B.
29445 Open the cross-reference dialog whilst in document B,
29446 and you can select the
29447 \begin_inset Quotes eld
29451 \begin_inset Quotes erd
29457 \begin_layout Subsection
29458 Bibliography Lists in all Subdocuments
29461 \begin_layout Standard
29462 If you work with child documents,
29463 you might want to have only one main bibliography at the end,
29464 but still be able to have a selected bibliography for the child if you output it on its own.
29465 Here is how to achieve this.
29468 \begin_layout Standard
29469 For the main document,
29470 you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
29471 If the bibliography inset is in the master file,
29472 the references will be inherited by all children,
29473 so they are available in the citation dialog within each child.
29476 \begin_layout Standard
29477 For child-specific bibliographies,
29478 insert bibliography insets within the child documents,
29479 at the place where the bibliography should appear when the child is compiled separately.
29481 the trick is to insert them into a branch (
29483 Insert\SpecialChar menuseparator
29484 Branch\SpecialChar menuseparator
29485 Insert New Branch...
29489 \begin_inset space \thinspace{}
29494 \begin_inset Quotes eld
29498 \begin_inset Quotes erd
29502 Within the children,
29503 activate the branch (
29505 Document\SpecialChar menuseparator
29506 Settings...\SpecialChar menuseparator
29511 deactivate the branch (
29513 Document\SpecialChar menuseparator
29514 Settings...\SpecialChar menuseparator
29518 Now the child's bibliography will be ignored by the master,
29519 but considered by the child.
29522 \begin_layout Standard
29523 If you need multiple bibliographies (e.
29524 \begin_inset space \thinspace{}
29528 one per child in the
29533 please refer to sec.
29534 \begin_inset space ~
29538 \begin_inset CommandInset ref
29540 reference "subsec:Multiple-Bibliographies"
29548 \begin_layout Section
29553 \begin_layout Standard
29554 Users sometimes need to be able to
29555 \begin_inset Quotes eld
29559 \begin_inset Quotes erd
29563 file together with all the images (and other files) on which it depends,
29564 either for sending to a publisher or for sharing with a co-author.
29566 includes a Python script (
29567 \begin_inset Flex Code
29570 \begin_layout Plain Layout
29576 ) that automates this process.
29578 you must have either the
29579 \begin_inset Flex Code
29582 \begin_layout Plain Layout
29589 \begin_inset Flex Code
29592 \begin_layout Plain Layout
29598 python modules installed on your system.
29600 the script prefers the
29601 \begin_inset Flex Code
29604 \begin_layout Plain Layout
29611 \begin_inset Flex Code
29614 \begin_layout Plain Layout
29620 format on Unix-like systems and the
29621 \begin_inset Flex Code
29624 \begin_layout Plain Layout
29633 \begin_layout Standard
29635 's configuration process will set the script up to export a `\SpecialChar LyX
29637 and this format will then be available under
29638 \change_deleted -712698321 1674917789
29640 \begin_inset Flex Code
29643 \begin_layout Plain Layout
29644 File\SpecialChar menuseparator
29651 \change_inserted -712698321 1674917789
29654 File\SpecialChar menuseparator
29662 \begin_layout Standard
29663 Independently of the platform,
29664 the generation of a particular archive format can be forced by adding either the
29665 \begin_inset Flex Code
29668 \begin_layout Plain Layout
29675 \begin_inset Flex Code
29678 \begin_layout Plain Layout
29685 \begin_inset Flex Code
29688 \begin_layout Plain Layout
29695 \begin_inset Flex Code
29698 \begin_layout Plain Layout
29704 format) switch to the
29705 \begin_inset Flex Code
29708 \begin_layout Plain Layout
29711 \change_deleted -712698321 1674918890
29712 \SpecialChar menuseparator
29714 \change_inserted -712698321 1674918890
29724 \change_deleted -712698321 1674917814
29726 \begin_inset Flex Code
29729 \begin_layout Plain Layout
29730 Tools\SpecialChar menuseparator
29731 Preferences\SpecialChar menuseparator
29732 File Handling\SpecialChar menuseparator
29739 \change_inserted -712698321 1674917814
29742 Tools\SpecialChar menuseparator
29743 Preferences\SpecialChar menuseparator
29744 File Handling\SpecialChar menuseparator
29750 (Make sure you add the switch after the script name,
29754 \begin_layout Section
29756 \change_deleted -712698321 1674910251
29757 Fancy Headers and Footers
29760 \begin_layout Standard
29762 \change_deleted -712698321 1674910251
29763 The default page layout is rather plain;
29765 \begin_inset Flex Code
29768 \begin_layout Plain Layout
29775 all you get is a centered page number at the bottom of the page.
29776 This document uses KOMA-script's book class,
29777 so it appears to be a bit fancier.
29778 But to really put on a show,
29779 you need to set the document page style to
29780 \begin_inset Quotes eld
29784 \begin_inset Quotes erd
29788 as mentioned in the
29793 This section describes the \SpecialChar LaTeX
29794 code you need to insert in your \SpecialChar LaTeX
29795 preamble in order to get the desired effects.
29798 \begin_layout Standard
29800 \change_deleted -712698321 1674910251
29801 For more information on fancy headers,
29803 \begin_inset Flex Code
29806 \begin_layout Plain Layout
29812 package documentation.
29814 \begin_inset Flex URL
29817 \begin_layout Plain Layout
29819 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
29827 \begin_layout Standard
29829 \change_deleted -712698321 1674910251
29830 The page header is divided into three fields,
29831 not surprisingly labeled
29832 \begin_inset Quotes eld
29836 \begin_inset Quotes erd
29841 \begin_inset Quotes eld
29845 \begin_inset Quotes erd
29850 \begin_inset Quotes eld
29854 \begin_inset Quotes erd
29858 The footer is also divided into these three fields.
29859 The \SpecialChar LaTeX
29860 commands to set these fields in the simplest manner are
29861 \begin_inset Flex Code
29864 \begin_layout Plain Layout
29874 \begin_inset Flex Code
29877 \begin_layout Plain Layout
29887 \begin_inset Flex Code
29890 \begin_layout Plain Layout
29900 \begin_inset Flex Code
29903 \begin_layout Plain Layout
29913 Suppose you wish to put your name in the upper left hand corner of each page.
29914 Simply insert the following command in the preamble:
29918 \begin_layout Standard
29920 \change_deleted -712698321 1674910251
29929 \begin_layout Standard
29931 \change_deleted -712698321 1674910251
29932 You will now see your name in the upper left.
29933 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,
29935 \begin_inset space \thinspace{}
29941 \begin_layout Standard
29943 \change_deleted -712698321 1674910251
29951 \begin_layout Standard
29953 \change_deleted -712698321 1674910251
29954 Let's get really fancy:
29955 lets put the section number with the word
29956 \begin_inset Quotes eld
29960 \begin_inset Quotes erd
29964 \begin_inset space \thinspace{}
29968 \begin_inset space \space{}
29971 Section 3) in the upper left,
29972 the page number (e.
29973 \begin_inset space \thinspace{}
29977 \begin_inset space \space{}
29980 Page 4) in the upper right,
29981 your name in the lower left,
29982 and the date in the lower right.
29983 The following commands should now appear in the preamble:
29986 \begin_layout Standard
29988 \change_deleted -712698321 1674910251
29998 \begin_layout Standard
30000 \change_deleted -712698321 1674910251
30008 \begin_layout Standard
30010 \change_deleted -712698321 1674910251
30020 \begin_layout Standard
30022 \change_deleted -712698321 1674910251
30031 \begin_layout Standard
30033 \change_deleted -712698321 1674910251
30041 \begin_layout Standard
30043 \change_deleted -712698321 1674910251
30053 \begin_layout Standard
30055 \change_deleted -712698321 1674910251
30057 \begin_inset Flex Code
30060 \begin_layout Plain Layout
30069 \begin_inset Flex Code
30072 \begin_layout Plain Layout
30080 access \SpecialChar LaTeX
30081 's section and page counters,
30082 and so print out the current section and page number.
30084 \begin_inset Flex Code
30087 \begin_layout Plain Layout
30095 simply prints out today's date.
30098 \begin_layout Standard
30100 \change_deleted -712698321 1674910251
30101 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
30102 If you don't want one of the rules,
30103 set its thickness to 0.
30104 The header rule has a default thickness of 0.4pt,
30105 the footer rule is 0pt.
30111 \begin_inset Flex Code
30114 \begin_layout Plain Layout
30119 headrulewidth}{0.4pt}
30125 \begin_inset Flex Code
30128 \begin_layout Plain Layout
30133 footrulewidth}{0.4pt}
30138 to set the thicknesses.
30141 \begin_layout Standard
30143 \change_deleted -712698321 1674910251
30144 You can switch the header/footer settings on and off for individual pages using commands like
30145 \begin_inset Flex Code
30148 \begin_layout Plain Layout
30151 thispagestyle{empty}
30158 \begin_inset Flex Code
30161 \begin_layout Plain Layout
30164 thispagestyle{plain}
30171 \begin_inset Flex Code
30174 \begin_layout Plain Layout
30177 thispagestyle{fancy}
30183 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
30186 title pages are marked as plain by default,
30187 while following pages are marked fancy when using the global fancy setting.
30190 \begin_layout Standard
30192 \change_deleted -712698321 1674910251
30193 As a final example,
30194 it is possible to include an image in the header or footer.
30195 Suppose you want to put a company logo in the upper lefthand corner.
30196 You might try something like
30199 \begin_layout Standard
30201 \change_deleted -712698321 1674910251
30210 includegraphics{logo.eps}}}
30213 \begin_layout Standard
30216 \change_deleted -712698321 1674910251
30217 (you may need to preface this with
30218 \begin_inset Flex Code
30221 \begin_layout Plain Layout
30224 usepackage{graphics}
30229 if you don't include graphics elsewhere in your document).
30234 \begin_layout Chapter
30236 and the World Wide Web
30239 \begin_layout Standard
30241 has long supported the export of documents to various web-friendly formats,
30243 Before version 2.0,
30245 HTML export was always accomplished by the use of external converters.
30249 \begin_layout Plain Layout
30250 For details on the use of external converters with \SpecialChar LyX
30256 section of the Customization manual.
30261 These fall into two large groups:
30262 there are converters that use \SpecialChar LaTeX
30263 as an intermediate format,
30265 \begin_inset Flex Code
30268 \begin_layout Plain Layout
30276 \begin_inset Flex Code
30279 \begin_layout Plain Layout
30287 \begin_inset Flex Code
30290 \begin_layout Plain Layout
30297 relying upon \SpecialChar LyX
30298 to produce the \SpecialChar LaTeX
30300 and there is a converter that works directly on \SpecialChar LyX
30303 \begin_inset Flex Code
30306 \begin_layout Plain Layout
30314 All of these have different advantages and disadvantages.
30318 \begin_layout Standard
30319 The \SpecialChar LaTeX
30320 -based converters have the advantage that,
30322 they know everything about the exported document that \SpecialChar LaTeX
30324 Such converters do not care,
30326 if a certain block of code was produced by \SpecialChar LyX
30327 or was Evil Red Text.
30328 These converters know about
30329 \begin_inset Flex Code
30332 \begin_layout Plain Layout
30341 and can often make use of the
30342 \begin_inset Flex Code
30345 \begin_layout Plain Layout
30351 files generated by Bib\SpecialChar TeX
30355 is a very hard language to parse—
30356 it is sometimes said that only \SpecialChar TeX
30357 itself understands \SpecialChar TeX
30359 and \SpecialChar LaTeX
30360 -based converters will often choke on what seem to be quite simple constructs;
30361 complex ones can throw them completely,
30362 and as of this writing,
30368 manual will not export with
30369 \begin_inset Flex Code
30372 \begin_layout Plain Layout
30379 though the others will.
30380 The other issue concerns how math is handled.
30381 These converters typically convert the formulae into little pictures that are then linked from the HTML document.
30382 Since these are actually generated by \SpecialChar LaTeX
30385 But they do not scale well,
30386 and just getting them to look as if they are actually meant to be in your document—
30387 so that the font sizes seem to be roughly the same—
30388 can be a challenge.
30391 \begin_layout Standard
30393 \begin_inset Flex Code
30396 \begin_layout Plain Layout
30404 \begin_inset CommandInset href
30406 name "http://pinchito.es/elyxer/"
30407 target "http://pinchito.es/elyxer/"
30412 ) solves some of these problems.
30414 the formulae it produces scale perfectly,
30415 since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
30416 But even moderately complex formula are rendered less well than with
30417 \begin_inset Flex Code
30420 \begin_layout Plain Layout
30427 this reflects the limitations of HTML.
30431 \begin_layout Plain Layout
30434 \begin_inset Flex Code
30437 \begin_layout Plain Layout
30444 can also use jsMath and MathJax for equations,
30445 but this setting is only available globally and requires one to have access to a server that runs the backend.
30450 More importantly (as of version 1.1.1,
30453 \begin_inset Flex Code
30456 \begin_layout Plain Layout
30463 has limited support for math macros and no support for user-defined paragraph or character styles.
30464 These limitations make
30465 \begin_inset Flex Code
30468 \begin_layout Plain Layout
30475 unsuitable for many of the documents \SpecialChar LyX
30479 these problems could be solved,
30480 but the \SpecialChar LyX
30481 developers have decided to follow a different path and have made \SpecialChar LyX
30482 itself capable of writing XHTML,
30483 just as it is capable of writing \SpecialChar LaTeX
30489 \begin_layout Standard
30490 As of this writing,
30491 XHTML output remains under development and should probably be regarded as
30492 \begin_inset Quotes eld
30496 \begin_inset Quotes erd
30503 \begin_layout Plain Layout
30505 \begin_inset Flex Code
30508 \begin_layout Plain Layout
30509 development/HTML/HTML.notes
30515 which can be found in the \SpecialChar LyX
30517 \begin_inset CommandInset href
30519 name "accessed online"
30520 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
30526 usually contains up-to-date information about the state of XHTML output.
30527 See also the list of XHTML bugs on
30528 \begin_inset CommandInset href
30530 name "the bug tracker"
30531 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"
30542 the developers have chosen this approach because it has several potential advantages over the other two.
30545 \begin_layout Standard
30546 These advantages are primarily due to the fact that the XHTML output routines,
30547 since they are part of \SpecialChar LyX
30549 know everything \SpecialChar LyX
30550 knows about the document being exported.
30554 \begin_layout Plain Layout
30555 Another advantage is that,
30556 since these routines are internal to \SpecialChar LyX
30558 they are immune to changes in \SpecialChar LyX
30560 or to changes in the semantics of existing insets.
30565 So they know about the table of contents (as displayed in the outline),
30566 about the counters associated with different paragraph styles,
30567 and about user-defined styles.
30568 The XHTML output routines know what \SpecialChar LyX
30569 knows about internationalization,
30571 so they will output
30572 \begin_inset Quotes eld
30576 \begin_inset Quotes erd
30580 \begin_inset Quotes eld
30588 \begin_inset Quotes erd
30592 depending upon the language in effect at the time.
30596 \begin_layout Standard
30598 the output routines know what \SpecialChar LyX
30599 knows about document layout,
30601 about how the document is to be rendered on screen.
30602 We use this information when we output the document as XHTML.
30609 generates CSS style information corresponding to the layout information it uses to render the document on screen:
30610 if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
30612 then (by default) they will be sans-serif and bold when viewed in a web browser,
30614 And this is true not just for pre-defined styles,
30617 including user-defined styles.
30619 the XHTML output routines make no distinction between user-defined paragraph and
30620 \change_deleted 244031559 1603876931
30622 \change_inserted 244031559 1603876940
30625 styles and \SpecialChar LyX
30626 's own pre-defined styles:
30628 everything \SpecialChar LyX
30629 knows about the styles is contained in the layout files.
30630 And much the same is true as regards pre-defined textual insets,
30632 and various custom insets.
30636 \begin_layout Standard
30637 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
30638 output can be customized and extended:
30639 through layout files and modules.
30640 See chapter five of the
30644 manual for the details.
30647 \begin_layout Standard
30648 The remainder of this chapter contains more detailed information on XHTML output,
30650 and ways to work around those limitations.
30653 \begin_layout Section
30654 Math Output in XHTML
30657 \begin_layout Standard
30659 offers four choices for how math is rendered.
30660 These have various advantages and disadvantages:
30663 \begin_layout Itemize
30665 \begin_inset Newline newline
30668 MathML is a dialect of XML designed specifically for mathematics on the web,
30669 and it typically renders very well in browsers that support it.
30670 The disadvantage is that not all browsers support MathML,
30671 and support is not complete even in the Gecko-based browsers,
30673 \begin_inset Newline newline
30676 If \SpecialChar LyX
30677 is unable to render a formula as MathML—
30679 if the formula uses the
30680 \begin_inset Flex Code
30683 \begin_layout Plain Layout
30690 then it will instead output the formula as an image.
30694 \begin_layout Itemize
30696 \begin_inset Newline newline
30699 As mentioned above,
30701 \begin_inset Flex Code
30704 \begin_layout Plain Layout
30710 outputs math as HTML,
30715 \begin_layout Plain Layout
30717 has borrowed some of the CSS for its HTML output from
30718 \begin_inset Flex Code
30721 \begin_layout Plain Layout
30732 For simple formulae,
30733 this can work quite well,
30734 though with more complicated formulae it tends to break down.
30736 this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
30737 fairly simple math.
30738 \begin_inset Newline newline
30741 If Lyx is unable to render a formula as HTML—
30743 if the formula uses the
30744 \begin_inset Flex Code
30747 \begin_layout Plain Layout
30754 then it will instead output the formula as an image.
30758 \begin_layout Itemize
30760 \begin_inset Newline newline
30764 \begin_inset Flex Code
30767 \begin_layout Plain Layout
30775 will output formulae as images,
30776 the very same images,
30778 that are used for instant preview.
30782 \begin_layout Plain Layout
30783 Instant preview does
30787 have to be on for images to be output,
30793 The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
30795 so they are very accurate.
30797 as mentioned earlier,
30798 is that these are bitmapped images,
30799 so they do not scale terribly well,
30800 and one cannot copy them,
30802 \begin_inset Newline newline
30805 The size of the images can be controlled by setting the
30806 \begin_inset Quotes eld
30809 Math Images Scaling
30810 \begin_inset Quotes erd
30814 \change_deleted -712698321 1674917822
30816 \begin_inset Flex Noun
30819 \begin_layout Plain Layout
30820 Document\SpecialChar menuseparator
30821 Settings\SpecialChar menuseparator
30828 \change_inserted -712698321 1674917822
30831 Document\SpecialChar menuseparator
30832 Settings\SpecialChar menuseparator
30841 \begin_layout Plain Layout
30842 For those who want to know,
30843 this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
30849 \begin_inset Newline newline
30852 If \SpecialChar LyX
30853 for some reason fails to create an image for a formula (e.g.,
30854 if a required \SpecialChar LaTeX
30855 package is not installed),
30856 then it will fall back to outputing the raw \SpecialChar LaTeX
30860 \begin_layout Itemize
30863 \begin_inset Newline newline
30868 will happily output math as \SpecialChar LaTeX
30870 As well as being the output of last resort,
30871 this method can be used with such tools as
30872 \begin_inset CommandInset href
30875 target "http://www.math.union.edu/~dpvc/jsMath/"
30881 which uses JavaScript to render \SpecialChar LaTeX
30882 embedded in HTML documents.
30884 wraps the \SpecialChar LaTeX
30886 \begin_inset Flex Code
30889 \begin_layout Plain Layout
30895 (for inline formulas) or
30896 \begin_inset Flex Code
30899 \begin_layout Plain Layout
30905 (for displayed formulas) with
30906 \begin_inset Flex Code
30909 \begin_layout Plain Layout
30916 as is required for jsMath.
30919 \begin_layout Standard
30920 One of these output methods must be selected under
30921 \change_deleted -712698321 1674917830
30923 \begin_inset Flex Noun
30926 \begin_layout Plain Layout
30927 Document\SpecialChar menuseparator
30928 Settings\SpecialChar menuseparator
30935 \change_inserted -712698321 1674917830
30938 Document\SpecialChar menuseparator
30939 Settings\SpecialChar menuseparator
30948 This is a document-wide setting,
30952 \begin_layout Standard
30955 will offer the user the option to select an alternate output method for a particular inset,
30957 one that isn't being rendered very well by MathML.
30961 \begin_layout Plain Layout
30963 since \SpecialChar LyX
30964 falls back to images if the inset contains ERT,
30965 then one can force output as an image by putting some harmless ERT into the math,
30968 \begin_inset Formula $a=b\relax$
30979 \begin_layout Section
30980 Bibliography and Citations
30983 \begin_layout Standard
30984 XHTML output fully supports bibliographies and citations.
30988 \begin_layout Standard
30989 Citation labels are generated by the same machinery that generates \SpecialChar LyX
30990 's on-screen labels,
30991 so the labels will look in the output much as they do in \SpecialChar LyX
30994 If you are using numerical citations,
30995 then \SpecialChar LyX
30996 will output numerical labels,
30997 such as [1] or [17],
30998 rather than simply showing the citation key in square brackets,
30999 as it does on-screen.
31000 If you are using author-year citations,
31001 then \SpecialChar LyX
31002 will add lowercase letters to the years,
31003 just as Bib\SpecialChar TeX
31005 if it finds more than one citation for a given author-year combination.
31006 The labels will be printed with the bibliography entries.
31007 Note that there is,
31009 no way to customize the appearance of the labels,
31011 to choose between square brackets and parentheses.
31014 \begin_layout Standard
31015 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
31016 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.
31017 The formatting can be customized in your layout file or,
31024 manual for the details.
31027 \begin_layout Standard
31028 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
31029 So you can see things like this:
31032 \begin_layout Quote
31035 \begin_inset Quotes eld
31038 Context and Logical Form
31039 \begin_inset Quotes erd
31045 Language in Context:
31049 Oxford University Press,
31055 \begin_layout Quote
31058 \begin_inset Quotes eld
31061 Semantics in Context
31062 \begin_inset Quotes erd
31068 Language in Context:
31072 Oxford University Press,
31078 \begin_layout Standard
31079 This should be fixed before long.
31082 \begin_layout Standard
31083 There is no support at present for sectioned bibliographies.
31084 If you have multiple bibliographies,
31085 then \SpecialChar LyX
31086 will print the same bibliography over and over.
31089 \begin_layout Section
31093 \begin_layout Standard
31095 will happily export indexes as XHTML,
31096 but with certain limitations at the moment.
31099 \begin_layout Standard
31100 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
31108 \begin_layout Plain Layout
31109 The main issue here is that \SpecialChar LyX
31110 itself does not really handle these.
31111 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
31117 We'll describe how they are handled using the subsection headings from that section.
31120 \begin_layout Itemize
31121 Grouping Index Entries (aka,
31124 makes an effort to support these,
31125 but the entries must be separated by
31126 \begin_inset Quotes eld
31131 \begin_inset Quotes erd
31136 there must be spaces around the exclamation point.
31137 This is because it is otherwise too difficult to check for escaped exclamation points,
31142 \begin_layout Itemize
31144 There is no support at all for page ranges,
31145 since these make no sense with XHMTL.
31147 you will just get two index entries,
31151 \begin_layout Itemize
31153 There is no support for cross-referencing.
31154 If \SpecialChar LyX
31155 finds an entry containing the
31156 \begin_inset Quotes eld
31159 |see\SpecialChar ldots
31161 \begin_inset Quotes erd
31165 it is just dropped,
31166 and the rest is treated as an ordinary index entry.
31169 \begin_layout Itemize
31172 does support attempts to fix the sorting order.
31173 It will take what is before the first `@' it finds and use that for sorting,
31174 taking what follows the first `@' to be the actual entry.
31177 does not check for escaped `@',
31178 so do not try to index email addresses.
31181 \begin_layout Itemize
31182 Index Entry Layout:
31183 You can format entries by using the text style dialog,
31184 or by using any other method available within \SpecialChar LyX
31186 There is no support for constructs like:
31188 \begin_inset Quotes eld
31192 \begin_inset Quotes erd
31197 if \SpecialChar LyX
31198 finds a pipe symbol,
31201 it will delete it and everything that follows it.
31204 \begin_layout Itemize
31206 There is no support for multiple indexes.
31208 all index entries will be printed as one large index.
31209 To avoid our printing several versions of the index,
31210 we print only the main index,
31211 so make sure you have one.
31214 \begin_layout Section
31215 Nomenclature and Glossary
31218 \begin_layout Standard
31219 There is at present no support for glossaries.
31220 Adding it would be fairly trivial,
31224 \begin_layout Chapter
31226 \change_inserted 1075283030 1616534180
31230 \begin_layout Standard
31232 \change_inserted 1075283030 1616534386
31235 can generate documents in the DocBook XML vocabulary.
31236 With versions 2.3 and before,
31237 only select templates could be used to generate DocBook documents (only version 4).
31238 Starting with \SpecialChar LyX
31240 most \SpecialChar LyX
31241 layouts can generate valid DocBook documents (only version 5).
31242 This feature is built into \SpecialChar LyX
31243 and does not require the use of external tools.
31246 \begin_layout Standard
31248 \change_inserted 1075283030 1616534437
31249 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
31250 output can be customized and extended:
31251 through layout files and modules.
31252 See chapter five of the
31256 manual for the details.
31259 \begin_layout Standard
31261 \change_inserted 1075283030 1616534475
31262 Most \SpecialChar LyX
31263 features are supported with DocBook,
31267 \begin_layout Itemize
31269 \change_inserted 1075283030 1616534741
31270 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
31274 All formulae are also available in raw \SpecialChar TeX
31275 in the DocBook output for further processing.
31278 \begin_layout Itemize
31280 \change_inserted 1075283030 1616534852
31281 Bibliographies and citations are implemented,
31282 including with an external BibTeX file.
31283 Bibliography entries are not prerendered when the detailed information are available,
31284 but rather output with the standard DocBook constructs.
31285 The external DocBook processor is expected to handle the rendering of entries.
31288 \begin_layout Itemize
31290 \change_inserted 1075283030 1616534863
31291 Indexes are supported,
31292 including multiple indices.
31299 and cross-references (
31304 with the exception of the same symbols escaped.
31313 ) are not supported.
31314 There is no support for escaping of index entries.
31317 \begin_layout Itemize
31319 \change_inserted 1075283030 1616534884
31320 Glossaries are implemented.
31323 \begin_layout Standard
31325 \change_inserted 1075283030 1616534894
31326 Two major parameters can be set at the document level.
31329 \begin_layout Itemize
31331 \change_inserted 1075283030 1616534948
31334 can generate tables either as HTML (default value) or CALS,
31335 depending on the user's requirements.
31336 Most DocBook processors accept both formats.
31339 \begin_layout Itemize
31341 \change_inserted 1075283030 1616535006
31344 MathML is included within its own name space,
31346 The implication is that there must be an indication of the tags belonging to the MathML standard.
31347 Three choices are offered:
31352 \begin_layout Itemize
31354 \change_inserted 1075283030 1616535044
31356 the MathML name space is defined for each formula (using the
31360 attribute on each formula)
31363 \begin_layout Itemize
31365 \change_inserted 1075283030 1616535090
31371 the MathML name space is defined at the document level (using the
31375 attribute on the root element).
31376 Each MathML is prefixed with
31387 \begin_layout Itemize
31389 \change_inserted 1075283030 1616620405
31405 \begin_layout Standard
31407 \change_inserted 1075283030 1616620470
31408 This option is especially useful if you want \SpecialChar LyX
31409 to match your personal style or to work with buggy software that only accepts one prefix for MathML.
31415 \begin_layout Chapter
31416 The \SpecialChar LyX
31420 \begin_layout Section
31424 \begin_layout Standard
31425 The `\SpecialChar LyX
31426 server' allows other programs to talk to \SpecialChar LyX
31428 invoke \SpecialChar LyX
31430 and retrieve information about the \SpecialChar LyX
31432 This is only intended for advanced users,
31433 but they should find it useful.
31434 It is by writing to the \SpecialChar LyX
31437 that bibliography managers,
31440 \begin_inset Quotes eld
31444 \begin_inset Quotes erd
31447 citations to \SpecialChar LyX
31451 \begin_layout Section
31452 Starting the \SpecialChar LyX
31454 \begin_inset CommandInset label
31456 name "sec:Starting-the-Server"
31463 \begin_layout Standard
31464 The \SpecialChar LyX
31465 server works through the use of a pair of named pipes.
31466 These are usually located in
31467 \begin_inset Flex Code
31470 \begin_layout Plain Layout
31477 (except on Windows,
31482 named pipes are special objects located in
31483 \begin_inset Flex Code
31486 \begin_layout Plain Layout
31498 ) and have the names
31499 \begin_inset Quotes eld
31503 \begin_inset Flex Code
31506 \begin_layout Plain Layout
31513 \begin_inset Quotes erd
31517 \begin_inset Quotes eld
31521 \begin_inset Flex Code
31524 \begin_layout Plain Layout
31531 \begin_inset Quotes erd
31535 External programs write into
31536 \begin_inset Flex Code
31539 \begin_layout Plain Layout
31545 and read back data from
31546 \begin_inset Flex Code
31549 \begin_layout Plain Layout
31556 The stem of the pipe names can be defined in the
31557 \change_deleted -712698321 1674917840
31559 \begin_inset Flex Noun
31562 \begin_layout Plain Layout
31563 Tools\SpecialChar menuseparator
31570 \change_inserted -712698321 1674917840
31573 Tools\SpecialChar menuseparator
31580 \begin_inset Flex Code
31583 \begin_layout Plain Layout
31584 "/home/myhome/lyxpipe"
31591 \begin_inset Flex Code
31594 \begin_layout Plain Layout
31608 on Windows (where any working path instead of lyxpipe can be used,
31610 \begin_inset Flex Code
31613 \begin_layout Plain Layout
31636 configure this manually in order for the server to start.
31639 \begin_layout Standard
31642 \begin_inset Flex Code
31645 \begin_layout Plain Layout
31652 \begin_inset Flex Code
31655 \begin_layout Plain Layout
31661 ' to create the pipes.
31662 If one of the pipes already exists,
31664 will assume that another \SpecialChar LyX
31665 process is already running and will not start the server.
31666 On POSIX (Unix like) systems,
31667 if for some other reason,
31669 \begin_inset Quotes eld
31673 \begin_inset Quotes erd
31676 pipe is left in existence when \SpecialChar LyX
31678 then \SpecialChar LyX
31679 will try to delete it.
31680 If this fails for some reason,
31681 you will need to delete the pipes manually and then restart \SpecialChar LyX
31684 pipes are deleted by the OS on program termination or crash,
31686 \begin_inset Quotes eld
31690 \begin_inset Quotes erd
31693 pipes should not be possible.
31696 \begin_layout Standard
31697 To have several \SpecialChar LyX
31698 processes with servers at the same time,
31699 you have to use different configurations,
31700 perhaps by using separate user directories,
31702 \begin_inset Flex Code
31705 \begin_layout Plain Layout
31715 \begin_layout Standard
31716 If you are developing a client program,
31717 you might find it useful to enable debugging information from the \SpecialChar LyX
31719 Do this by starting \SpecialChar LyX
31721 \begin_inset Flex Code
31724 \begin_layout Plain Layout
31733 \begin_layout Standard
31734 You can find a complete example client written in C++ in the source distribution as
31735 \begin_inset Flex Code
31738 \begin_layout Plain Layout
31739 development/lyxserver/server_monitor.cpp
31747 \begin_layout Standard
31748 Another useful tool is the command-line based client found in
31749 \begin_inset Flex Code
31752 \begin_layout Plain Layout
31753 src/client/lyxclient
31761 \begin_layout Section
31762 Normal communication
31765 \begin_layout Standard
31766 To issue a \SpecialChar LyX
31768 the client writes a line of ASCII text into the input pipe.
31769 This line has the following format:
31772 \begin_layout Quote
31786 \begin_layout Description
31787 clientname is a name that the client can choose arbitrarily.
31788 Its only use is that \SpecialChar LyX
31789 will echo it if it sends an answer—
31790 so a client can dispatch results from different requesters.
31793 \begin_layout Description
31794 function is the function you want \SpecialChar LyX
31796 It is the same as the commands you'd use in the minibuffer.
31799 \begin_layout Description
31800 argument is an optional argument which is meaningful only to some functions (for instance,
31802 \begin_inset Quotes eld
31806 \begin_inset Quotes erd
31809 LFUN will insert the argument as text at the cursor position).
31812 \begin_layout Standard
31813 The answer from \SpecialChar LyX
31814 will arrive in the output pipe and be of the form
31817 \begin_layout Quote
31831 \begin_layout Standard
31840 are just echoed from the command request,
31845 is more or less useful information filled according to how the command execution worked out.
31848 \begin_inset Quotes eld
31852 \begin_inset Quotes erd
31856 will return information about the internal state of \SpecialChar LyX
31858 while other will return an empty data-response.
31859 This means that the command execution went fine.
31862 \begin_layout Standard
31864 the response from \SpecialChar LyX
31865 will have this form
31868 \begin_layout Quote
31882 \begin_layout Standard
31887 should contain an explanation of why the command failed.
31890 \begin_layout Standard
31894 \begin_layout LyX-Code
31895 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
31896 \begin_inset Newline newline
31899 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
31900 \begin_inset Newline newline
31903 read a <~/.lyxpipe.out
31904 \begin_inset Newline newline
31910 \begin_layout Subsection
31911 AppleScript (Mac OS X)
31914 \begin_layout Standard
31915 Since \SpecialChar LyX
31918 supports basic interactions with AppleScript for normal communication through the command run.
31919 This command takes a direct argument (the
31923 to perform) and an optional argument.
31924 It either returns the output of the function or triggers an error with the error message and code.
31927 \begin_layout Standard
31931 \begin_layout LyX-Code
31932 tell application "\SpecialChar LyX
31936 \begin_layout LyX-Code
31940 \begin_layout LyX-Code
31941 -- Stores the current file name into f
31944 \begin_layout LyX-Code
31945 set f to (run "server-get-filename" with argument "")
31948 \begin_layout LyX-Code
31949 on error the error_message number the error_number
31952 \begin_layout LyX-Code
31953 display dialog "Error:
31954 " & the error_number & ".
31958 \begin_layout LyX-Code
31959 & the error_message buttons {"OK"} default button 1
31962 \begin_layout LyX-Code
31966 \begin_layout LyX-Code
31970 \begin_layout Section
31974 \begin_layout Standard
31976 can notify clients of events going on asynchronously.
31977 Currently it will only do this if the user binds a key sequence with the function
31978 \begin_inset Quotes eld
31982 \begin_inset Quotes erd
31986 The format of the string \SpecialChar LyX
31987 sends is as follows:
31990 \begin_layout Quote
31991 \begin_inset Flex Code
31994 \begin_layout Plain Layout
32005 \begin_layout Standard
32010 is the printed representation of the key sequence that was actually typed by the user.
32013 \begin_layout Standard
32014 This mechanism can be used to extend \SpecialChar LyX
32015 's command set and implement macros.
32016 Bind some key sequence to
32017 \begin_inset Quotes eld
32021 \begin_inset Quotes erd
32025 Then start a client that listens on the output pipe,
32026 dispatches the command according to the sequence,
32027 and starts a function that may use \SpecialChar LyX
32028 calls and \SpecialChar LyX
32029 requests to issue a command or a series of commands to \SpecialChar LyX
32033 \begin_layout Section
32034 The simple \SpecialChar LyX
32038 \begin_layout Standard
32040 implements a simple protocol that can be used for session management.
32041 All messages are of the form
32044 \begin_layout Quote
32054 \begin_layout Standard
32060 \begin_inset Quotes eld
32064 \begin_inset Quotes erd
32068 \begin_inset Quotes eld
32072 \begin_inset Quotes erd
32077 \begin_inset Quotes eld
32081 \begin_inset Quotes erd
32084 is received from a client,
32086 will report back to inform the client that it's listening to it's messages,
32088 \begin_inset Quotes eld
32092 \begin_inset Quotes erd
32095 sent from \SpecialChar LyX
32096 will inform clients that \SpecialChar LyX
32100 \begin_layout Section
32101 Reverse DVI/PDF search
32104 \begin_layout Standard
32105 Some DVI/PDF viewers
32109 \begin_layout Plain Layout
32110 The following viewers offer the reverse PDF search feature:
32111 Okular on KDE/Linux,
32113 Skim on Mac OSX and SumatraPDF on Windows.
32122 facility (also called
32127 This means that you can tell \SpecialChar LyX
32128 to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
32130 the viewer must be able to communicate with \SpecialChar LyX
32132 This is done via the \SpecialChar LyX
32133 server either by using the named pipe (
32138 or the UNIX domain socket (
32142 ) that \SpecialChar LyX
32143 creates in its temporary directory (this is the way the
32144 \begin_inset Flex Code
32147 \begin_layout Plain Layout
32153 program communicates with \SpecialChar LyX
32156 you need a helper script that mediates between the viewer and \SpecialChar LyX
32159 the viewer can communicate with \SpecialChar LyX
32161 This depends on the selected viewer and on your operating system.
32162 The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
32164 we will thus describe how to setup reverse search for specific viewers.
32165 Before we turn to this,
32167 we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
32170 \begin_layout Subsection
32172 \begin_inset CommandInset label
32174 name "subsec:rev-search"
32181 \begin_layout Standard
32182 In most cases \SpecialChar LyX
32183 will do the work for you by pressing the following button in the toolbar:
32187 arg "buffer-toggle-output-sync"
32192 you can also enable the feature by checking
32194 Synchronize with Output
32197 \change_deleted -712698321 1674917848
32199 \begin_inset Flex Noun
32202 \begin_layout Plain Layout
32203 Document\SpecialChar menuseparator
32204 Settings\SpecialChar menuseparator
32211 \change_inserted -712698321 1674917848
32214 Document\SpecialChar menuseparator
32215 Settings\SpecialChar menuseparator
32221 In such a case \SpecialChar LyX
32222 will automatically insert the necessary Sync\SpecialChar TeX
32223 macro (for PDF) or load the srcltx package (for DVI) respectively.
32224 This option can be easily reached also on
32225 \begin_inset Flex Code
32228 \begin_layout Plain Layout
32237 \begin_layout Standard
32238 If you need a different setting,
32239 you can select or input a custom macro from the drop down box just below
32240 \change_deleted -712698321 1674917855
32242 \begin_inset Flex Noun
32245 \begin_layout Plain Layout
32246 Document\SpecialChar menuseparator
32247 Settings\SpecialChar menuseparator
32248 Output\SpecialChar menuseparator
32249 Synchronize with Output
32255 \change_inserted -712698321 1674917855
32258 Document\SpecialChar menuseparator
32259 Settings\SpecialChar menuseparator
32260 Output\SpecialChar menuseparator
32261 Synchronize with Output
32268 \begin_layout Standard
32269 Note that the method
32270 \begin_inset Flex Code
32273 \begin_layout Plain Layout
32281 enables gzip compression.
32282 If your viewer does not support it,
32283 you should instead use
32284 \begin_inset Flex Code
32287 \begin_layout Plain Layout
32298 \begin_layout Standard
32299 Please also note that including the
32300 \begin_inset Flex Code
32303 \begin_layout Plain Layout
32310 \begin_inset Flex Code
32313 \begin_layout Plain Layout
32319 sometimes has an undesired impact on the typesetting.
32321 you should switch output synchronization off for the final typesetting if you use the
32322 \begin_inset Flex Code
32325 \begin_layout Plain Layout
32332 \begin_inset Flex Code
32335 \begin_layout Plain Layout
32345 \begin_layout Standard
32346 In case you need some more special settings that are not covered by the automatic settings,
32347 read the next section about how to set up output synchronization manually.
32348 If the automatic setup suits your needs,
32349 you can readily jump to section
32350 \begin_inset space ~
32354 \begin_inset CommandInset ref
32356 reference "subsec:configuring-viewers"
32362 where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
32365 \begin_layout Subsection
32369 \begin_layout Standard
32371 provides several different methods for reverse search.
32372 Some are built-in in the
32373 \begin_inset Flex Code
32376 \begin_layout Plain Layout
32383 some are provided by external packages.
32384 Your choice depends on whether your \SpecialChar LaTeX
32385 distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
32386 The available methods are described in the following.
32389 \begin_layout Subsubsection*
32390 Built-in DVI-search via src-specials (DVI only)
32393 \begin_layout Standard
32394 This method provides the DVI file with the necessary information for reverse search.
32395 It is available in \SpecialChar LaTeX
32396 since quite some time (any somewhat recent \SpecialChar LaTeX
32397 distribution should include it),
32398 and it works reliably.
32401 \begin_inset Flex Noun
32404 \begin_layout Plain Layout
32415 \begin_inset Flex Noun
32418 \begin_layout Plain Layout
32429 \change_deleted -712698321 1674917875
32431 \begin_inset Flex Noun
32434 \begin_layout Plain Layout
32435 Preferences\SpecialChar menuseparator
32436 File Handling\SpecialChar menuseparator
32443 \change_inserted -712698321 1674917875
32446 Preferences\SpecialChar menuseparator
32447 File Handling\SpecialChar menuseparator
32453 \begin_inset Flex Code
32456 \begin_layout Plain Layout
32457 latex -src-specials $$i
32463 If this doesn't work,
32464 check if your \SpecialChar TeX
32465 engine needs different options (the syntax might differ in some distributions).
32468 \begin_layout Subsubsection*
32469 External Packages (PDFSync and scrltx)
32472 \begin_layout Standard
32481 provide reverse search facility for PDF output (via pdflatex) and DVI output,
32483 In order to enable it,
32484 load the packages in the \SpecialChar LyX
32489 \begin_layout Itemize
32490 \begin_inset Flex Code
32493 \begin_layout Plain Layout
32496 usepackage{pdfsync}
32501 for reverse PDF search,
32504 \begin_layout Itemize
32505 \begin_inset Flex Code
32508 \begin_layout Plain Layout
32511 usepackage[active]{srcltx}
32516 for reverse DVI search.
32519 \begin_layout Standard
32520 If you want to be able to perform both DVI and PDF reverse searches,
32521 you can also insert in the preamble the following lines
32524 \begin_layout LyX-Code
32528 \begin_inset Newline newline
32534 \begin_inset Newline newline
32539 usepackage{pdfsync}
32540 \begin_inset Newline newline
32546 \begin_inset Newline newline
32551 usepackage[active]{srcltx}
32552 \begin_inset Newline newline
32560 \begin_layout Standard
32562 you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
32565 \begin_layout Standard
32566 Note that PDFSync might affect the output layout of your document.
32567 It is therefore advised to disable PDFsync for final documents.
32570 \begin_layout Subsubsection*
32571 Built-in reverse search via Sync\SpecialChar TeX
32575 \begin_layout Standard
32577 \begin_inset Flex Code
32580 \begin_layout Plain Layout
32586 have built-in support for both PDF and DVI reverse search.
32589 Sync\SpecialChar TeX
32592 facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
32597 You need at least \SpecialChar TeX
32598 Live 2008 or a recent Mik\SpecialChar TeX
32599 distribution in order to use it.
32603 \begin_layout Plain Layout
32605 Mik\SpecialChar TeX
32606 does not understand/obey the command \SpecialChar LyX
32607 inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
32610 \begin_layout Plain Layout
32611 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
32612 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
32613 by adding the -synctex=1 switch).
32618 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
32620 SumatraPDF on Windows;
32621 see the next section for details) already provide Sync\SpecialChar TeX
32625 \begin_layout Standard
32626 To enable Sync\SpecialChar TeX
32629 \begin_inset Flex Noun
32632 \begin_layout Plain Layout
32643 \begin_inset Flex Noun
32646 \begin_layout Plain Layout
32651 (plain) -> DraftDVI
32657 \change_deleted -712698321 1674917887
32659 \begin_inset Flex Noun
32662 \begin_layout Plain Layout
32663 Preferences\SpecialChar menuseparator
32664 File Handling\SpecialChar menuseparator
32671 \change_inserted -712698321 1674917887
32674 Preferences\SpecialChar menuseparator
32675 File Handling\SpecialChar menuseparator
32681 \begin_inset Flex Code
32684 \begin_layout Plain Layout
32685 latex -synctex=1 $$i
32691 and for PDF output,
32693 \begin_inset Flex Noun
32696 \begin_layout Plain Layout
32701 (pdflatex) -> PDF (pdflatex)
32707 \begin_inset Flex Code
32710 \begin_layout Plain Layout
32711 pdflatex -synctex=1 $$i
32717 Should your viewer not be considered in the following description,
32718 or in case of missing success,
32719 please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
32724 \begin_layout Plain Layout
32725 Note that the option
32726 \begin_inset Flex Code
32729 \begin_layout Plain Layout
32735 option enables gzip compression.
32736 If your viewer does not support it,
32737 you should instead use
32738 \begin_inset Flex Code
32741 \begin_layout Plain Layout
32755 \begin_layout Subsection
32756 Configuring and using specific viewers
32757 \begin_inset CommandInset label
32759 name "subsec:configuring-viewers"
32766 \begin_layout Subsubsection*
32767 Xdvi (all platforms)
32770 \begin_layout Standard
32772 \begin_inset Flex Code
32775 \begin_layout Plain Layout
32782 you don't need to do anything else for performing a reverse DVI search,
32783 as \SpecialChar LyX
32784 already provides the necessary hooks for automatically using the
32785 \begin_inset Flex Code
32788 \begin_layout Plain Layout
32795 Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
32799 \begin_layout Standard
32801 if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
32803 simply change the DVI viewer in
32804 \change_deleted -712698321 1674917897
32806 \begin_inset Flex Noun
32809 \begin_layout Plain Layout
32810 Preferences\SpecialChar menuseparator
32811 File Handling\SpecialChar menuseparator
32818 \change_inserted -712698321 1674917897
32821 Preferences\SpecialChar menuseparator
32822 File Handling\SpecialChar menuseparator
32831 \begin_layout Plain Layout
32832 On Mac OSX you have to use
32833 \begin_inset Flex Code
32836 \begin_layout Plain Layout
32837 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
32848 \begin_inset Flex Code
32851 \begin_layout Plain Layout
32852 xdvi -editor "lyxeditor.sh %f %l"
32859 \begin_inset Flex Code
32862 \begin_layout Plain Layout
32868 is a suitable script.
32870 a minimal shell script is the following one:
32873 \begin_layout LyX-Code
32875 \begin_inset Newline newline
32878 LYXPIPE="/path/to/lyxpipe"
32879 \begin_inset Newline newline
32882 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
32883 \begin_inset Newline newline
32886 echo "$COMMAND" > "${LYXPIPE}".in || exit
32887 \begin_inset Newline newline
32890 read TMP < "${LYXPIPE}".out || exit
32893 \begin_layout Standard
32895 \begin_inset Flex Code
32898 \begin_layout Plain Layout
32904 is the LyXServer pipe path specified in
32905 \change_deleted -712698321 1674917907
32907 \begin_inset Flex Noun
32910 \begin_layout Plain Layout
32911 Preferences\SpecialChar menuseparator
32918 \change_inserted -712698321 1674917907
32921 Preferences\SpecialChar menuseparator
32930 \begin_layout Plain Layout
32932 \begin_inset Flex Code
32935 \begin_layout Plain Layout
32941 folder of a source distribution you can find a
32942 \begin_inset Flex Code
32945 \begin_layout Plain Layout
32951 script which is able to locate the
32955 based on your preferences.
32963 \begin_layout Subsubsection*
32967 \begin_layout Standard
32969 \begin_inset Flex Code
32972 \begin_layout Plain Layout
32973 /Applications/MacDviX_Folder/calleditor.script
32979 add the following lines:
32982 \begin_layout LyX-Code
32983 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
32984 \begin_inset Newline newline
32990 \begin_layout Standard
32991 Modify the lines accordingly if you install \SpecialChar LyX
32992 somewhere else than in the Applications folder.
32995 \begin_layout Standard
32996 Reverse search is triggered by Alt-click (OPTION-click).
32999 \begin_layout Subsubsection*
33003 \begin_layout Standard
33005 \begin_inset Flex Code
33008 \begin_layout Plain Layout
33009 open -a Skim.app $$i
33014 to the viewer setting in
33015 \change_deleted -712698321 1674917916
33017 \begin_inset Flex Noun
33020 \begin_layout Plain Layout
33021 Preferences\SpecialChar menuseparator
33022 File Handling\SpecialChar menuseparator
33023 File formats\SpecialChar menuseparator
33030 \change_inserted -712698321 1674917916
33033 Preferences\SpecialChar menuseparator
33034 File Handling\SpecialChar menuseparator
33035 File formats\SpecialChar menuseparator
33042 \change_deleted -712698321 1674917924
33044 \begin_inset Flex Noun
33047 \begin_layout Plain Layout
33048 Skim\SpecialChar menuseparator
33049 Preferences\SpecialChar menuseparator
33056 \change_inserted -712698321 1674917924
33059 Skim\SpecialChar menuseparator
33060 Preferences\SpecialChar menuseparator
33066 \change_deleted -712698321 1674917931
33068 \begin_inset Flex Noun
33071 \begin_layout Plain Layout
33078 \change_inserted -712698321 1674917931
33085 preset and enter command
33086 \begin_inset Flex Noun
33089 \begin_layout Plain Layout
33090 /Applications/\SpecialChar LyX
33091 .app/Contents/MacOS/lyxeditor
33099 \begin_layout Standard
33100 Reverse search is triggered by COMMAND-SHIFT-click
33103 \begin_layout Subsubsection*
33107 \begin_layout Standard
33108 Reverse search with evince does not work out of the box,
33109 but it can be achieved by means of some third party helper scripts.
33111 \begin_inset CommandInset href
33113 target "https://wiki.lyx.org/LyX/SyncTeX"
33121 \begin_layout Subsubsection*
33125 \begin_layout Standard
33127 \change_deleted -712698321 1674917941
33129 \begin_inset Flex Noun
33132 \begin_layout Plain Layout
33133 Settings\SpecialChar menuseparator
33134 Configure Okular\SpecialChar menuseparator
33141 \change_inserted -712698321 1674917941
33144 Settings\SpecialChar menuseparator
33145 Configure Okular\SpecialChar menuseparator
33151 \begin_inset Quotes erd
33155 This inserts the appropriate command (
33156 \begin_inset Flex Code
33159 \begin_layout Plain Layout
33168 \begin_layout Standard
33169 Reverse search is triggered by SHIFT-click.
33171 \change_inserted -712698321 1578211026
33172 Note that this only works if Okular is in
33173 \begin_inset Quotes eld
33177 \begin_inset Quotes erd
33181 \begin_inset space \thinspace{}
33185 the hand symbol is clicked).
33190 \begin_layout Subsubsection*
33194 \begin_layout Standard
33195 Qpdfview supports Sync\SpecialChar TeX
33196 since version 0.3.5.
33198 \change_deleted -712698321 1674917949
33200 \begin_inset Flex Noun
33203 \begin_layout Plain Layout
33204 Edit\SpecialChar menuseparator
33205 Settings\SpecialChar menuseparator
33212 \change_inserted -712698321 1674917949
33215 Edit\SpecialChar menuseparator
33216 Settings\SpecialChar menuseparator
33222 click on the input field of the
33223 \begin_inset Quotes eld
33227 \begin_inset Quotes erd
33230 item and add the command
33231 \begin_inset Flex Code
33234 \begin_layout Plain Layout
33243 \begin_layout Standard
33244 Reverse search is triggered by double-click or,
33245 in more recent versions,
33249 \begin_layout Subsubsection*
33253 \begin_layout Standard
33256 \change_deleted -712698321 1674917958
33258 \begin_inset Flex Noun
33261 \begin_layout Plain Layout
33262 View\SpecialChar menuseparator
33269 \change_inserted -712698321 1674917958
33272 View\SpecialChar menuseparator
33277 menu and select the
33278 \begin_inset Quotes eld
33282 \begin_inset Quotes erd
33287 \begin_inset Quotes eld
33290 New\SpecialChar ldots
33292 \begin_inset Quotes erd
33296 in the window that opens,
33298 \begin_inset Quotes eld
33303 \begin_inset Quotes erd
33306 (or any other name you like) in the
33307 \begin_inset Quotes eld
33311 \begin_inset Quotes erd
33315 Now click on the button labeled
33316 \begin_inset Quotes eld
33321 \begin_inset Quotes erd
33324 to open a file dialog and navigate to the directory containing the batch file
33325 \begin_inset Flex Code
33328 \begin_layout Plain Layout
33336 \begin_inset Flex Code
33339 \begin_layout Plain Layout
33345 and then specify the program arguments as
33346 \begin_inset Flex Code
33349 \begin_layout Plain Layout
33357 \begin_inset Flex Code
33360 \begin_layout Plain Layout
33366 wrapper is used for communicating with \SpecialChar LyX
33374 \begin_layout LyX-Code
33376 \begin_inset Newline newline
33379 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
33388 \begin_inset Newline newline
33402 \begin_layout Standard
33403 Make sure that the \SpecialChar LyX
33404 Server pipe path you specified in \SpecialChar LyX
33406 \begin_inset Flex Code
33409 \begin_layout Plain Layout
33424 otherwise change the
33425 \begin_inset Flex Code
33428 \begin_layout Plain Layout
33434 wrapper accordingly.
33437 \begin_layout Standard
33439 reverse search is triggered by double-click.
33442 \begin_layout Subsubsection*
33443 SumatraPDF (Windows)
33446 \begin_layout Standard
33447 In order to use SumatraPDF for inverse search,
33449 \begin_inset Flex Code
33452 \begin_layout Plain Layout
33453 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
33458 in the viewer setting in
33459 \change_deleted -712698321 1674917965
33461 \begin_inset Flex Noun
33464 \begin_layout Plain Layout
33465 Preferences\SpecialChar menuseparator
33466 File Handling\SpecialChar menuseparator
33467 File formats\SpecialChar menuseparator
33474 \change_inserted -712698321 1674917965
33477 Preferences\SpecialChar menuseparator
33478 File Handling\SpecialChar menuseparator
33479 File formats\SpecialChar menuseparator
33486 \begin_inset Flex Code
33489 \begin_layout Plain Layout
33495 is the previous wrapper.
33496 If SumatraPDF.exe is not in your command PATH,
33497 use its full file name.
33500 \begin_layout Standard
33501 Reverse search is triggered by double-click.
33504 \begin_layout Subsubsection*
33508 \begin_layout Standard
33510 make sure that yap is your default DVI viewer in the Windows environment,
33513 \change_deleted -712698321 1674917973
33515 \begin_inset Flex Noun
33518 \begin_layout Plain Layout
33519 View\SpecialChar menuseparator
33526 \change_inserted -712698321 1674917973
33529 View\SpecialChar menuseparator
33534 menu and select the
33535 \begin_inset Quotes eld
33539 \begin_inset Quotes erd
33544 \begin_inset Quotes eld
33547 New\SpecialChar ldots
33549 \begin_inset Quotes erd
33553 in the window that opens,
33555 \begin_inset Quotes eld
33560 \begin_inset Quotes erd
33563 (or any other name you like) in the
33564 \begin_inset Quotes eld
33568 \begin_inset Quotes erd
33572 Now click on the button labeled
33573 \begin_inset Quotes eld
33578 \begin_inset Quotes erd
33581 to open a file dialog and navigate to the directory containing the
33582 \begin_inset Flex Code
33585 \begin_layout Plain Layout
33591 program (which is installed by default on Cygwin along with the \SpecialChar LyX
33594 \begin_inset Flex Code
33597 \begin_layout Plain Layout
33603 and then specify the program arguments as
33604 \begin_inset Flex Code
33607 \begin_layout Plain Layout
33615 you will be using the
33619 for communicating with \SpecialChar LyX
33622 for whatever reason,
33623 you want to use the
33629 \begin_inset Flex Code
33632 \begin_layout Plain Layout
33638 option and be sure to specify the \SpecialChar LyX
33639 Server pipe path in the \SpecialChar LyX
33643 \begin_layout Standard
33645 reverse search is triggered by double-click.
33648 \begin_layout Subsubsection*
33649 SumatraPDF (Cygwin)
33652 \begin_layout Standard
33653 In order to use SumatraPDF for inverse search,
33655 \begin_inset Flex Code
33658 \begin_layout Plain Layout
33659 SumatraPDF -inverse-search "lyxeditor -g %f %l"
33664 in the viewer setting in
33665 \change_deleted -712698321 1674917986
33667 \begin_inset Flex Noun
33670 \begin_layout Plain Layout
33671 Preferences\SpecialChar menuseparator
33672 File Handling\SpecialChar menuseparator
33673 File formats\SpecialChar menuseparator
33680 \change_inserted -712698321 1674917986
33683 Preferences\SpecialChar menuseparator
33684 File Handling\SpecialChar menuseparator
33685 File formats\SpecialChar menuseparator
33691 If SumatraPDF.exe is not in your command PATH,
33692 use its full posix path.
33694 \begin_inset Flex Code
33697 \begin_layout Plain Layout
33703 enables communication via the
33710 \begin_inset Flex Code
33713 \begin_layout Plain Layout
33719 option if you want to use the
33724 and be sure to specify the \SpecialChar LyX
33725 Server pipe path in the \SpecialChar LyX
33729 \begin_layout Standard
33730 Reverse search is triggered by double-click.
33733 \begin_layout Section
33737 \begin_layout Standard
33739 as the name implies,
33741 \begin_inset Quotes eld
33745 \begin_inset Quotes erd
33749 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
33751 If forward search is set up (as described in what follows),
33752 you can put the cursor anywhere in your \SpecialChar LyX
33755 \change_deleted -712698321 1674917994
33757 \begin_inset Flex Noun
33760 \begin_layout Plain Layout
33761 Navigate\SpecialChar menuseparator
33768 \change_inserted -712698321 1674917994
33771 Navigate\SpecialChar menuseparator
33777 \change_deleted -712698321 1674918002
33781 \begin_inset Flex Noun
33784 \begin_layout Plain Layout
33793 \change_inserted -712698321 1674918002
33798 in the context menu via right mouse click),
33799 and then the viewer will jump to that position as well.
33802 that your viewer supports this function.
33805 \begin_layout Standard
33806 To make forward search possible,
33807 you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
33809 This can be done via the methods described in the section
33810 \begin_inset CommandInset ref
33812 reference "subsec:rev-search"
33820 \begin_layout Standard
33822 you need to configure \SpecialChar LyX
33823 for using your viewers in
33824 \change_deleted -712698321 1674918011
33826 \begin_inset Flex Noun
33829 \begin_layout Plain Layout
33830 Tools\SpecialChar menuseparator
33831 Preferences\SpecialChar menuseparator
33832 Output\SpecialChar menuseparator
33839 \change_inserted -712698321 1674918011
33842 Tools\SpecialChar menuseparator
33843 Preferences\SpecialChar menuseparator
33844 Output\SpecialChar menuseparator
33850 We provide a range of tested configurations for some viewers,
33851 which you can select from the drop down list.
33852 If none of these configurations suits you,
33853 you have to find out and enter a suitable configuration yourself.
33854 The definition syntax uses the following placeholders:
33857 \begin_layout Itemize
33859 \begin_inset Flex Code
33862 \begin_layout Plain Layout
33872 \begin_layout Itemize
33874 \begin_inset Flex Code
33877 \begin_layout Plain Layout
33884 name of the (temporary) exported .tex file (without path)
33887 \begin_layout Itemize
33889 \begin_inset Flex Code
33892 \begin_layout Plain Layout
33899 name of the (temporary) exported .tex file (including path)
33902 \begin_layout Itemize
33904 \begin_inset Flex Code
33907 \begin_layout Plain Layout
33914 name of the exported output file (either dvi or pdf,
33915 depending on which one exists in the temporary directory)
33918 \begin_layout Standard
33919 Note that only some of the viewers provide full and usable forward search functionality out of the box,
33926 \begin_layout Plain Layout
33927 You might want to set
33928 \begin_inset Flex Code
33931 \begin_layout Plain Layout
33938 \change_deleted -712698321 1674918020
33940 \begin_inset Flex Noun
33943 \begin_layout Plain Layout
33944 Tools\SpecialChar menuseparator
33945 Preferences\SpecialChar menuseparator
33946 File Handling\SpecialChar menuseparator
33948 \begin_inset space ~
33957 \change_inserted -712698321 1674918020
33960 Tools\SpecialChar menuseparator
33961 Preferences\SpecialChar menuseparator
33962 File Handling\SpecialChar menuseparator
33964 \begin_inset space ~
33980 \begin_layout Plain Layout
33981 SumatraPDF can also use DDE commands through the external program CMCDDE —
33983 \begin_inset CommandInset href
33985 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
34001 \begin_layout Plain Layout
34002 Forward search with evince can be achieved by means of third party helper scripts.
34004 \begin_inset CommandInset href
34006 target "https://wiki.lyx.org/LyX/SyncTeX"
34017 require some extra tools in order to use forward search.
34018 While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
34019 some other viewers – e.
34020 \begin_inset space \thinspace{}
34024 xpdf – allow at least to reload the document and jump to a specific page of the file,
34025 so you can at least navigate
34026 \begin_inset Quotes eld
34030 \begin_inset Quotes erd
34034 This latter functionality is provided by an external call of synctex (see the predefined example configurations).
34038 \begin_layout Standard
34039 Forward search works both with DVI and PDF output.
34041 simply checks which preview format you have used before (i.
34042 \begin_inset space \thinspace{}
34046 which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
34047 \change_deleted 564990737 1672743015
34051 \begin_layout Standard
34053 \change_deleted 564990737 1672743015
34054 Special Document Classes
34057 \begin_layout Standard
34059 \change_deleted 564990737 1669742044
34063 \begin_layout Standard
34065 \change_deleted 564990737 1669742044
34071 \begin_layout Standard
34073 \change_deleted 564990737 1669742044
34077 \begin_layout Standard
34079 \change_deleted 564990737 1669742044
34080 This section describes how \SpecialChar LyX
34081 can be used to write articles for submission to the scientific journal
34083 Astronomy and Astrophysics
34086 \begin_inset Flex URL
34089 \begin_layout Plain Layout
34091 https://www.aanda.org/
34096 ) using Version 5.01 of the document class
34101 This package can be downloaded from the ftp site
34104 \begin_layout Standard
34106 \change_deleted 564990737 1669742044
34107 \begin_inset VSpace medskip
34113 \begin_layout Standard
34116 \change_deleted 564990737 1669742044
34117 \begin_inset Flex URL
34120 \begin_layout Plain Layout
34122 ftp://ftp.edpsciences.org/pub/aa/readme.html
34130 \begin_layout Standard
34132 \change_deleted 564990737 1669742044
34133 \begin_inset VSpace medskip
34139 \begin_layout Standard
34141 \change_deleted 564990737 1669742044
34142 A manual comes together with that package,
34143 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.
34147 \begin_layout Standard
34149 \change_deleted 564990737 1669742044
34150 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
34152 That change involved also some slight changes to the style files,
34153 namely the removal of the thesaurus command.
34154 The \SpecialChar LyX
34155 class aa supports the newest version of these style files,
34157 If you have an older version installed,
34160 the old (version 4) layout has been kept as
34165 Please refer to the comments in
34168 Dir/layouts/aapaper.layout
34173 \begin_layout Standard
34175 \change_deleted 564990737 1669742044
34179 \begin_layout Standard
34181 \change_deleted 564990737 1669742044
34182 It is recommended you start from the example template distributed with \SpecialChar LyX
34184 If you are not using a template,
34185 note the following settings:
34188 \begin_layout Itemize
34190 \change_deleted 564990737 1669742044
34197 Document\SpecialChar menuseparator
34201 that one was obvious).
34204 \begin_layout Itemize
34206 \change_deleted 564990737 1669742044
34207 Don't change the option
34210 \begin_inset space ~
34221 The whole layout is done by the macros,
34222 you shouldn't change anything.
34225 \begin_layout Standard
34227 \change_deleted 564990737 1669742044
34231 \begin_layout Standard
34233 \change_deleted 564990737 1669742044
34234 First thing to enter is the header information.
34235 It consists of seven entries,
34236 of which some are optional.
34240 \begin_layout Itemize
34242 \change_deleted 564990737 1669742044
34251 \begin_layout Itemize
34253 \change_deleted 564990737 1669742044
34262 \begin_layout Itemize
34264 \change_deleted 564990737 1669742044
34273 \begin_layout Itemize
34275 \change_deleted 564990737 1669742044
34284 \begin_layout Itemize
34286 \change_deleted 564990737 1669742044
34292 [optional] if more than one author:
34293 whom to contact for offprint requests.
34296 \begin_layout Itemize
34298 \change_deleted 564990737 1669742044
34304 [optional] mail address for contacts.
34307 \begin_layout Itemize
34309 \change_deleted 564990737 1669742044
34316 Suggested format is
34323 \begin_layout Standard
34325 \change_deleted 564990737 1669742044
34326 There is no need to issue the
34333 this is done automatically by \SpecialChar LyX
34334 when the header is finished.
34335 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
34336 just to get the best optics and meets the layout of the real document.
34339 \begin_layout Standard
34341 \change_deleted 564990737 1669742044
34342 If you want to place footnotes in the header block,
34344 \begin_inset space \thinspace{}
34348 \begin_inset space \space{}
34351 to state your present address,
34352 just use the standard footnote via the menu
34354 Insert\SpecialChar menuseparator
34359 will automagically use the term
34368 \begin_layout Standard
34370 \change_deleted 564990737 1669742044
34373 Edit\SpecialChar menuseparator
34377 you'll find two insets which are relevant for the titling:
34380 \begin_layout Itemize
34382 \change_deleted 564990737 1669742044
34389 to mark corresponding author\SpecialChar breakableslash
34391 The institutes are numbered sequentially as they appear in the
34396 so you have to put a marker to each author.
34399 \begin_layout Itemize
34401 \change_deleted 564990737 1669742044
34406 to supply an email address for fast contact.
34409 \begin_layout Standard
34411 \change_deleted 564990737 1669742044
34412 In addition to these topics,
34413 the macros use one additional \SpecialChar LaTeX
34414 command that has no counterpart in \SpecialChar LyX
34418 \begin_layout Itemize
34420 \change_deleted 564990737 1669742044
34427 to separate different names for more than one author and institute,
34431 \begin_layout Standard
34433 \change_deleted 564990737 1669742044
34434 The appropriate command has to be entered in \SpecialChar LyX
34435 and marked as \SpecialChar LaTeX
34441 \begin_layout Standard
34443 \change_deleted 564990737 1669742044
34447 \begin_layout Standard
34449 \change_deleted 564990737 1669742044
34450 The abstract should immediately follow the header block.
34451 With version 5 the abstract environment was changed to a command,
34452 and there is now a restriction to only one paragraph.
34454 it should contain an entry with the keywords.
34455 This is done via the paragraph style
34460 Refer to the example paper.
34463 \begin_layout Standard
34465 \change_deleted 564990737 1669742044
34466 Supported environments
34469 \begin_layout Standard
34471 \change_deleted 564990737 1669742044
34472 The A&A paper layout supports the following environments for structuring your text:
34475 \begin_layout Itemize
34477 \change_deleted 564990737 1669742044
34483 \begin_layout Itemize
34485 \change_deleted 564990737 1669742044
34491 \begin_layout Itemize
34493 \change_deleted 564990737 1669742044
34499 \begin_layout Itemize
34501 \change_deleted 564990737 1669742044
34507 \begin_layout Itemize
34509 \change_deleted 564990737 1669742044
34515 \begin_layout Itemize
34517 \change_deleted 564990737 1669742044
34523 \begin_layout Itemize
34525 \change_deleted 564990737 1669742044
34531 \begin_layout Itemize
34533 \change_deleted 564990737 1669742044
34539 \begin_layout Itemize
34541 \change_deleted 564990737 1669742044
34547 \begin_layout Itemize
34549 \change_deleted 564990737 1669742044
34555 \begin_layout Itemize
34557 \change_deleted 564990737 1669742044
34563 \begin_layout Itemize
34565 \change_deleted 564990737 1669742044
34572 \begin_layout Standard
34574 \change_deleted 564990737 1669742044
34575 Commands not supported by \SpecialChar LyX
34579 \begin_layout Standard
34581 \change_deleted 564990737 1669742044
34582 Some commands are not yet supported by the
34586 layout for \SpecialChar LyX
34588 Some have already been mentioned.
34589 For the sake of completeness,
34590 they are listed all together here:
34593 \begin_layout Itemize
34595 \change_deleted 564990737 1669742044
34603 \begin_layout Itemize
34605 \change_deleted 564990737 1669742044
34613 \begin_layout Itemize
34615 \change_deleted 564990737 1669742044
34623 \begin_layout Itemize
34625 \change_deleted 564990737 1669742044
34633 \begin_layout Standard
34635 \change_deleted 564990737 1669742044
34636 If you want to use any of these commands,
34637 you have to enter them yourself.
34640 Do not forget to mark them as \SpecialChar LaTeX
34644 \begin_layout Standard
34646 \change_deleted 564990737 1669742044
34647 Figure and Table Floats
34650 \begin_layout Standard
34652 \change_deleted 564990737 1669742044
34654 provides support for the necessary float environments
34665 therefore we won't tell much about it here.
34669 \begin_inset space ~
34675 Just remember that tables should be left-aligned.
34677 select the table and change the alignment in
34679 Edit\SpecialChar menuseparator
34681 \begin_inset space ~
34687 \begin_layout Standard
34689 \change_deleted 564990737 1669742044
34690 There is only one special thing:
34691 the figures with caption besides the figure.
34692 To create such a figure,
34693 you have to do the following:
34696 \begin_layout Enumerate
34698 \change_deleted 564990737 1669742044
34699 Create a wide figure float:
34702 Insert\SpecialChar menuseparator
34703 Float\SpecialChar menuseparator
34707 then right click in the figure and select
34710 \begin_inset space ~
34718 \begin_layout Enumerate
34720 \change_deleted 564990737 1669742044
34721 Enter your caption text.
34724 \begin_layout Enumerate
34726 \change_deleted 564990737 1669742044
34731 to move the cursor above the caption.
34734 \begin_layout Enumerate
34736 \change_deleted 564990737 1669742044
34740 \begin_layout Enumerate
34742 \change_deleted 564990737 1669742044
34743 Position the cursor behind the figure and insert a horizontal fill:
34746 Insert\SpecialChar menuseparator
34748 \begin_inset space ~
34751 Character\SpecialChar menuseparator
34753 \begin_inset space ~
34761 \begin_layout Enumerate
34763 \change_deleted 564990737 1669742044
34764 Switch to \SpecialChar LaTeX
34769 \begin_inset space ~
34777 \begin_layout Enumerate
34779 \change_deleted 564990737 1669742044
34789 Do not close the brace!
34792 \begin_layout Enumerate
34794 \change_deleted 564990737 1669742044
34795 Position the cursor behind the caption text,
34796 switch to \SpecialChar LaTeX
34797 mode and insert the closing brace:
34801 \begin_inset space ~
34813 \begin_layout Standard
34815 \change_deleted 564990737 1669742044
34817 refer to the figures in the example paper.
34820 \begin_layout Standard
34822 \change_deleted 564990737 1669742044
34826 \begin_layout Standard
34828 \change_deleted 564990737 1669742044
34830 the paper has to be formated in a special double-spacing layout.
34832 you have to give the option
34836 to the document class.
34837 This must be done using the custom class options field in the
34839 Document\SpecialChar menuseparator
34843 Just enter the string
34850 \begin_layout Standard
34852 \change_deleted 564990737 1669742044
34856 \begin_layout Standard
34858 \change_deleted 564990737 1669742044
34863 directory contains an example paper written with \SpecialChar LyX
34865 It is the example paper from the original macro package,
34866 translated to \SpecialChar LyX
34868 Use it for inspiration,
34869 and compare the original \SpecialChar LaTeX
34870 code with \SpecialChar LyX
34874 \begin_layout Standard
34876 \change_deleted 564990737 1671097429
34880 \begin_layout Standard
34882 \change_deleted 564990737 1671097429
34887 can be used to type letters according to German conventions.
34888 A template file is included in
34890 .../lyx/share/templates
34892 for you to use as a starting point.
34895 \begin_layout Standard
34897 \change_deleted 564990737 1671097429
34901 \begin_layout Standard
34903 \change_deleted 564990737 1671097429
34904 See the \SpecialChar LyX
34910 It contains all infos you need.
34913 \begin_layout Standard
34915 \change_deleted 564990737 1669755802
34919 \begin_layout Standard
34921 \change_deleted 564990737 1669755802
34924 Panayotis Papasotiriou
34927 \begin_layout Standard
34929 \change_deleted 564990737 1669755802
34933 \begin_layout Standard
34935 \change_deleted 564990737 1669755802
34936 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
34938 International Journal of Modern Physics C
34942 the ijmpd package is for creating manuscripts to be submitted to the
34944 International Journal of Modern Physics D
34947 Both journals are published by World Scientific.
34948 The corresponding document classes are named
34959 together with instructions for the authors,
34960 can be downloaded from the sites
34961 \begin_inset Flex URL
34964 \begin_layout Plain Layout
34966 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
34972 \begin_inset Flex URL
34975 \begin_layout Plain Layout
34977 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
34983 Both packages are modified versions of the standard
34984 \begin_inset Quotes eld
34988 \begin_inset Quotes erd
34992 and they are almost (but not exactly) identical.
34993 Most of their features are supported by \SpecialChar LyX
34995 I have used \SpecialChar LyX
34996 successfully to write articles submitted to both journals without any problem.
34999 \begin_layout Standard
35001 \change_deleted 564990737 1669755802
35005 \begin_layout Standard
35007 \change_deleted 564990737 1669755802
35009 the easiest way to write a paper is to start with a template.
35012 File\SpecialChar menuseparator
35029 This will give an (almost) empty document that includes the most common fields found in a manuscript.
35030 Simply overwrite the existing text (including the brackets,
35036 You should keep in mind the following remarks.
35039 \begin_layout Enumerate
35041 \change_deleted 564990737 1669755802
35043 won't let you change the font size and the page style of the document,
35044 because such modifications are not allowed by both packages.
35047 \begin_layout Enumerate
35049 \change_deleted 564990737 1669755802
35050 The language of the document should not be changed.
35051 Before previewing your paper,
35052 be sure that the babel package is not used.
35057 arg "dialog-show document"
35062 \SpecialChar menuseparator
35067 \begin_inset Quotes eld
35071 \begin_inset Quotes erd
35081 \begin_layout Enumerate
35083 \change_deleted 564990737 1669755802
35085 \begin_inset Quotes eld
35089 \begin_inset Quotes erd
35092 style must be used to define keywords.
35095 \begin_layout Enumerate
35097 \change_deleted 564990737 1669755802
35098 The ijmpc package provides a style named
35099 \begin_inset Quotes eld
35102 Classification Codes
35103 \begin_inset Quotes erd
35107 which can be used to define classification codes,
35108 such as PACS numbers.
35109 Note that this facility is not supported by the ijmpd package.
35112 \begin_layout Enumerate
35114 \change_deleted 564990737 1669755802
35115 Several new environments are available:
35117 \begin_inset Quotes eld
35121 \begin_inset Quotes erd
35126 \begin_inset Quotes eld
35130 \begin_inset Quotes erd
35135 \begin_inset Quotes eld
35139 \begin_inset Quotes erd
35144 \begin_inset Quotes eld
35148 \begin_inset Quotes erd
35153 \begin_inset Quotes eld
35157 \begin_inset Quotes erd
35162 \begin_inset Quotes eld
35166 \begin_inset Quotes erd
35171 \begin_inset Quotes eld
35175 \begin_inset Quotes erd
35180 \begin_inset Quotes eld
35184 \begin_inset Quotes erd
35189 \begin_inset Quotes eld
35193 \begin_inset Quotes erd
35198 \begin_inset Quotes eld
35202 \begin_inset Quotes erd
35207 \begin_inset Quotes eld
35211 \begin_inset Quotes erd
35216 \begin_inset Quotes eld
35220 \begin_inset Quotes erd
35225 \begin_inset Quotes eld
35229 \begin_inset Quotes erd
35234 \begin_inset Quotes eld
35238 \begin_inset Quotes erd
35242 Their use is more or less obvious.
35244 supports all these environments;
35245 it will use the proper label,
35247 and numbering scheme for each of them.
35250 \begin_layout Enumerate
35252 \change_deleted 564990737 1669755802
35253 Both packages use basic citations;
35254 the natbib package should not be used.
35255 In \SpecialChar LyX
35257 citation references are shown as usual;
35259 citations are shown as superscripts.
35260 If you want to use a citation as normal text,
35267 \begin_inset space \thinspace{}
35271 \begin_inset space \space{}
35275 \begin_inset Quotes eld
35279 \begin_inset space \space{}
35289 \begin_inset Quotes erd
35295 \begin_layout Enumerate
35297 \change_deleted 564990737 1669755802
35299 \begin_inset Quotes eld
35303 \begin_inset Quotes erd
35306 section in both packages.
35307 To put acknowledgments,
35309 \begin_inset Quotes eld
35313 \begin_inset Quotes erd
35319 \begin_layout Enumerate
35321 \change_deleted 564990737 1669755802
35322 Appendices may be added to the paper,
35327 the Acknowledgments and
35333 provides a special environment,
35335 \begin_inset Quotes eld
35339 \begin_inset Quotes erd
35342 which marks the beginning of the appendices.
35343 This environment should be left blank;
35344 it just sends a \SpecialChar LaTeX
35346 but nothing is really printed.
35347 In \SpecialChar LyX
35350 \begin_inset Quotes eld
35354 \begin_inset Quotes erd
35357 is printed with blue letters,
35358 as a signal that all sections after that point are appendices.
35359 To write an appendix,
35361 \begin_inset Quotes eld
35365 \begin_inset Quotes erd
35370 will number each appendix with capital letters,
35371 as required by both journals.
35373 \begin_inset Quotes eld
35377 \begin_inset Quotes erd
35384 be present before the first appendix;
35386 all appendices will be numbered as normal sections in the output.
35389 \begin_layout Enumerate
35391 \change_deleted 564990737 1669755802
35392 The ijmpc and the ijmpd packages use the
35396 command to implement table captions.
35398 a table created by \SpecialChar LyX
35399 is printed correctly,
35400 but its caption is ignored.
35402 you can use some \SpecialChar TeX
35403 code to overcome this problem,
35404 so that captions are printed as expected.
35406 create a float table as usual,
35407 remove the caption,
35408 and replace it with the \SpecialChar TeX
35420 you must also the \SpecialChar TeX
35425 immediately after the tabular material.
35426 Study the example table included in the template files to see how this trick is implemented.
35428 If you need table captions,
35429 you should implement the whole table float in a
35434 then include this file to the \SpecialChar LyX
35437 Insert\SpecialChar menuseparator
35438 File\SpecialChar menuseparator
35440 \begin_inset space ~
35446 Details on how to create a table float can be found in the files
35455 included in the corresponding packages.
35458 \begin_layout Standard
35460 \change_deleted 564990737 1669755802
35461 Preparing a paper for submission
35464 \begin_layout Standard
35466 \change_deleted 564990737 1669755802
35467 Before you submit your paper you must export the \SpecialChar LyX
35468 document as a \SpecialChar LaTeX
35471 File\SpecialChar menuseparator
35472 Export\SpecialChar menuseparator
35480 \begin_layout Plain Layout
35481 Actually you have the choice between \SpecialChar LaTeX
35482 (plain) and pdflatex.
35483 If you intend to use pdflatex to prepare the paper,
35484 you should use the pdflatex option so that included graphics are converted to PDF format,
35485 ready for use by pdflatex.
35491 then make the following changes to the resulting
35498 \begin_layout Enumerate
35500 \change_deleted 564990737 1669755802
35501 Remove the comment lines before the
35510 \begin_layout Enumerate
35512 \change_deleted 564990737 1669755802
35513 Remove everything between (and including) the
35526 except for any commands you specifically put into the \SpecialChar LaTeX
35530 \begin_layout Standard
35532 \change_deleted 564990737 1672743015
35537 file should be saved and processed through \SpecialChar LaTeX
35538 as many times as necessary.
35539 You may also want to check the resulting
35546 \begin_layout Standard
35548 \change_deleted 564990737 1669801478
35552 \begin_layout Standard
35554 \change_deleted 564990737 1669801478
35560 \begin_layout Standard
35562 \change_deleted 564990737 1669801478
35566 \begin_layout Standard
35568 \change_deleted 564990737 1669801478
35569 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
35570 Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
35571 \begin_inset Flex URL
35574 \begin_layout Plain Layout
35576 ftp://ftp.iop.org/pub/journals/latex2e
35584 \begin_layout Standard
35586 \change_deleted 564990737 1669801478
35590 \begin_layout Standard
35592 \change_deleted 564990737 1669801478
35593 The easiest way to write a paper is to start with the template
35597 that is available via
35599 File\SpecialChar menuseparator
35602 The template explains how to use the special text environments.
35603 Here are the most important advices:
35606 \begin_layout Itemize
35608 \change_deleted 564990737 1669801478
35609 To be able to compile your document to a PDF,
35612 ensure that the no AMS packages are loaded in
35614 Document\SpecialChar menuseparator
35615 Settings\SpecialChar menuseparator
35621 \begin_layout Itemize
35623 \change_deleted 564990737 1669801478
35626 The title environment defines the kind of your paper.
35627 So use one of the following environments for the title:
35631 \begin_layout Itemize
35633 \change_deleted 564990737 1669801478
35642 \begin_layout Itemize
35644 \change_deleted 564990737 1669801478
35653 \begin_layout Itemize
35655 \change_deleted 564990737 1669801478
35661 for a Topical review
35664 \begin_layout Itemize
35666 \change_deleted 564990737 1669801478
35675 \begin_layout Itemize
35677 \change_deleted 564990737 1669801478
35686 \begin_layout Itemize
35688 \change_deleted 564990737 1669801478
35694 for a Paper (same as Title)
35697 \begin_layout Itemize
35699 \change_deleted 564990737 1669801478
35705 for a Preliminary communication
35708 \begin_layout Itemize
35710 \change_deleted 564990737 1669801478
35716 for a Rapid communication
35719 \begin_layout Itemize
35721 \change_deleted 564990737 1669801478
35727 for a Letter to the editor
35731 \begin_layout Itemize
35733 \change_deleted 564990737 1669801478
35736 All title environments except of
35740 can have an optional short title.
35743 \begin_layout Itemize
35745 \change_deleted 564990737 1669801478
35746 There is a general title environment
35750 which is not directly supported by \SpecialChar LyX
35752 This can be used as \SpecialChar TeX
35753 code when your document doesn't fit into one of the other title types.
35756 \begin_layout Standard
35758 \change_deleted 564990737 1672743015
35759 For more informations like hints for special table and formula formatting,
35760 look at the IOP author guidelines.
35763 \begin_layout Standard
35765 \change_deleted 564990737 1670317155
35769 \begin_layout Standard
35771 \change_deleted 564990737 1670317155
35774 Panayotis Papasotiriou
35777 \begin_layout Standard
35779 \change_deleted 564990737 1670317155
35783 \begin_layout Standard
35785 \change_deleted 564990737 1670317155
35786 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
35787 Most known of them (at least in my domain of interest) are
35789 Astrophysics and Space Science
35796 but there are many others (see a complete list at
35797 \begin_inset Flex URL
35800 \begin_layout Plain Layout
35802 http://www.wkap.nl/jrnllist.htm/JRNLHOME
35808 The Kluwer package may be downloaded from the site
35809 \begin_inset Flex URL
35812 \begin_layout Plain Layout
35814 http://www.wkap.nl/kaphtml.htm/STYLEFILES
35820 A complete user guide is contained in that package (but it can also be downloaded separately).
35823 \begin_layout Standard
35825 \change_deleted 564990737 1670317155
35827 supports many features of the package but not everything.
35829 the \SpecialChar TeX
35830 code needed is reduced to some
35831 \begin_inset Quotes eld
35835 \begin_inset Quotes erd
35838 commands of the package (see
35839 \begin_inset space ~
35843 \begin_inset CommandInset ref
35845 reference "subsec:kluwer_peculiarities"
35851 I have recently used \SpecialChar LyX
35852 to write an article submitted to the
35854 Astrophysics and Space Science
35856 without any problem.
35859 \begin_layout Standard
35861 \change_deleted 564990737 1670317155
35865 \begin_layout Standard
35867 \change_deleted 564990737 1670317155
35868 The easiest way to write a paper is to start with the Kluwer template file.
35871 File\SpecialChar menuseparator
35884 This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
35885 As in most templates,
35886 simply overwrite the existing text (including the brackets,
35891 ) with the correct information.
35894 \begin_layout Standard
35896 \change_deleted 564990737 1670317155
35897 Preparing a paper for submission
35900 \begin_layout Standard
35902 \change_deleted 564990737 1670317155
35903 As in the AAS\SpecialChar TeX
35905 before you submit your paper to a journal you must
35906 \begin_inset Quotes eld
35910 \begin_inset Quotes erd
35916 \begin_layout Enumerate
35918 \change_deleted 564990737 1670317155
35919 Export your paper as a \SpecialChar LaTeX
35924 File\SpecialChar menuseparator
35925 Export\SpecialChar menuseparator
35933 \begin_layout Enumerate
35935 \change_deleted 564990737 1670317155
35940 file with a text editor and make the following changes
35944 \begin_layout Enumerate
35946 \change_deleted 564990737 1670317155
35947 remove the comment lines before the
35956 \begin_layout Enumerate
35958 \change_deleted 564990737 1670317155
35959 remove everything between (and including) the
35972 except for any commands you specifically put into the \SpecialChar LaTeX
35976 \begin_layout Standard
35978 \change_deleted 564990737 1670317155
35987 \begin_layout Enumerate
35989 \change_deleted 564990737 1670317155
35994 file through \SpecialChar LaTeX
35995 as many times as necessary (usually up to three).
35998 \begin_layout Enumerate
36000 \change_deleted 564990737 1670317155
36007 \begin_inset space \thinspace{}
36011 \begin_inset space \space{}
36019 and check if everything is OK (it should,
36020 if you didn't make any mistake).
36023 \begin_layout Standard
36025 \change_deleted 564990737 1670317155
36026 \begin_inset Quotes eld
36030 \begin_inset Quotes erd
36033 of the Kluwer package
36034 \begin_inset CommandInset label
36036 name "subsec:kluwer_peculiarities"
36043 \begin_layout Standard
36045 \change_deleted 564990737 1670317155
36046 The Kluwer package has the following
36047 \begin_inset Quotes eld
36051 \begin_inset Quotes erd
36057 \begin_layout Enumerate
36059 \change_deleted 564990737 1670317155
36060 It is possible to write multiple articles in the same \SpecialChar LaTeX
36065 \begin_layout Plain Layout
36066 I can't imagine any good reason to do this.
36072 Each article must be included in the environment
36073 \begin_inset Quotes eld
36077 \begin_inset Quotes erd
36082 this environment cannot be omitted,
36083 even if you write just one article.
36085 each article starts with the command
36093 ends with the command
36100 Although this can be implemented in \SpecialChar LyX
36102 I didn't included it,
36103 since it looks ugly and can confuse the novice user.
36105 you need to enter them directly and mark them as \SpecialChar LaTeX
36106 code (the well-known
36107 \begin_inset Quotes eld
36112 \begin_inset Quotes erd
36118 \begin_layout Enumerate
36120 \change_deleted 564990737 1670317155
36121 Information given at the beginning of the article (i.
36122 \begin_inset space \thinspace{}
36126 \begin_inset space \space{}
36135 abstract and keywords) must be included in an environment called
36136 \begin_inset Quotes eld
36140 \begin_inset Quotes erd
36144 This is not implemented in \SpecialChar LyX
36146 so you must enter title,
36148 \begin_inset space ~
36151 between two \SpecialChar TeX
36167 \begin_layout Enumerate
36169 \change_deleted 564990737 1670317155
36170 According to the user manual,
36171 the label of each bibliography item must be written as
36194 \begin_layout Standard
36196 \change_deleted 564990737 1670317155
36201 template takes care of all these
36202 \begin_inset Quotes eld
36206 \begin_inset Quotes erd
36210 If you start a new paper using this template you don't need to do anything special.
36214 \begin_layout Enumerate
36216 \change_deleted 564990737 1670317155
36217 don't delete the \SpecialChar TeX
36218 code included in the template,
36222 \begin_layout Enumerate
36224 \change_deleted 564990737 1670317155
36225 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
36228 \begin_layout Standard
36230 \change_deleted 564990737 1671097446
36234 \begin_layout Standard
36236 \change_deleted 564990737 1671097446
36241 provides an alternative to the standard
36246 It provides similar functionality,
36247 but you might prefer this layout with sans serif sections,
36252 \begin_layout Standard
36254 \change_deleted 564990737 1671097446
36255 Springer Journals (
36262 \begin_layout Standard
36264 \change_deleted 564990737 1671097446
36270 \begin_layout Standard
36272 \change_deleted 564990737 1671097446
36276 \begin_layout Standard
36278 \change_deleted 564990737 1671097446
36279 These are the layout files for some of the journal formats used by Springer Verlag and listed on
36280 \begin_inset Flex URL
36283 \begin_layout Plain Layout
36285 http://www.springer.de/author/tex/help-journals.html
36291 where you should also go to fetch the class files (yes,
36292 these are \SpecialChar LaTeX2e
36294 It is a modular system:
36295 the things common to all journals are implemented in
36300 which journal-specific layout files (such as,
36302 \begin_inset space \thinspace{}
36306 \begin_inset space \space{}
36313 for Journal of Geodesy) can include.
36316 \begin_layout Standard
36318 \change_deleted 564990737 1671097446
36319 This means that implementing support for any other Springer journal on this list is as simple as writing your own
36327 file following the outline given in
36335 \begin_layout Standard
36337 \change_deleted 564990737 1671097446
36338 It is reasonably well tested only for the Journal of Geodesy.
36347 come with the standard \SpecialChar LyX
36349 Install the relevant class file (downloaded from Springer) in a proper directory,
36350 reconfigure \SpecialChar LaTeX
36351 (in the te\SpecialChar TeX
36357 as root if necessary —
36358 doesn't \SpecialChar LyX
36359 take care of this?),
36360 reconfigure \SpecialChar LyX
36361 and it should work.
36364 \begin_layout Standard
36366 \change_deleted 564990737 1671097446
36370 \begin_layout Standard
36372 \change_deleted 564990737 1671097446
36373 A large number of theorem-like styles —
36388 \begin_layout Standard
36390 \change_deleted 564990737 1671097446
36396 Running_\SpecialChar LaTeX
36407 See the Springer class file documentation for details.
36410 \begin_layout Standard
36412 \change_deleted 564990737 1671097446
36416 \begin_layout Itemize
36418 \change_deleted 564990737 1671097446
36432 \begin_layout Itemize
36434 \change_deleted 564990737 1671097446
36437 Probability Theory and Related Fields
36445 Jean-Marc Lasgouttes
36448 \begin_layout Standard
36450 \change_deleted 564990737 1671097446
36455 \begin_layout Standard
36457 \change_deleted 564990737 1671097446
36461 \begin_layout Standard
36463 \change_deleted 564990737 1671097446
36464 These files are partly based on the older
36469 which was again based on a tinkered-with version of an old \SpecialChar LaTeX
36470 2.09 style file from Springer.
36478 Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
36479 layout file mechanism.
36482 \begin_layout Standard
36484 \change_deleted 564990737 1671097446
36488 \begin_layout Standard
36490 \change_deleted 564990737 1671097446
36492 But probably less than in the old hacked-\SpecialChar LaTeX
36500 \begin_layout Chapter
36502 Features needing Extra Software
36505 \begin_layout Section
36506 Checking \SpecialChar TeX
36510 \begin_layout Standard
36516 \begin_layout Subsection
36520 \begin_layout Standard
36529 \begin_layout Plain Layout
36534 is not yet available when you are using the \SpecialChar LaTeX
36535 distribution MiK\SpecialChar TeX
36550 \begin_inset space ~
36561 \begin_inset Newline newline
36565 \begin_inset CommandInset href
36567 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
36575 \begin_layout Standard
36578 Chk\SpecialChar TeX
36581 package is a program that was written by
36582 \begin_inset Flex Noun
36585 \begin_layout Plain Layout
36587 \begin_inset space ~
36595 in frustration because some constructs in \SpecialChar LaTeX
36596 are sometimes non-intuitive,
36597 and easy to forget.
36598 The program runs over your \SpecialChar LaTeX
36600 checks the integrity of the file,
36601 and flags some common errors.
36602 In other technical words,
36607 for \SpecialChar LaTeX
36611 \begin_layout Standard
36613 what is a syntax checker doing in \SpecialChar LyX
36614 which is supposed to produce correct \SpecialChar LaTeX
36616 The answer is simple:
36621 not only checks the
36630 checks for type-errors,
36633 Chk\SpecialChar TeX
36636 catches some common
36641 in addition to the syntactical ones.
36645 Chk\SpecialChar TeX
36648 is capable of detecting several common errors,
36652 \begin_layout Itemize
36653 Ellipsis detection:
36654 \begin_inset Newline newline
36657 Use \SpecialChar ldots
36661 \begin_layout Itemize
36662 No space in front of/after parenthesis:
36663 \begin_inset Newline newline
36669 \begin_layout Itemize
36670 Enforcement of normal space after common abbreviations:
36671 \begin_inset Newline newline
36675 \begin_inset space \thinspace{}
36679 \begin_inset space \space{}
36682 is too wide spacing.
36685 \begin_layout Itemize
36686 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
36687 \begin_inset Newline newline
36691 And this is wrong spacing.
36694 \begin_layout Itemize
36695 Space in front of labels and similar commands:
36696 \begin_inset Newline newline
36699 The label should stick right up to the text to avoid falling to a wrong page.
36701 \begin_inset CommandInset label
36711 \begin_layout Plain Layout
36712 This footnote is in danger of falling off to a wrong page
36717 The label is separated too much.
36720 \begin_layout Itemize
36721 Space in front of references,
36722 instead of hard spaces:
36723 \begin_inset Newline newline
36726 If you have bad luck,
36727 the text will break right between the referenced text and reference number,
36730 \begin_inset CommandInset ref
36732 reference "sec:chktex"
36740 \begin_layout Itemize
36742 \begin_inset Quotes eld
36746 \begin_inset Quotes erd
36750 \begin_inset Formula $\times$
36754 \begin_inset Newline newline
36757 2x2 looks cheap compared to
36758 \begin_inset Formula $2\times2$
36764 \begin_layout Standard
36765 and more \SpecialChar ldots
36766 It is an invaluable tool when you are
36767 \begin_inset Quotes eld
36771 \begin_inset Quotes erd
36774 your document before printing,
36775 and you should run it right after the obligatory spelling check,
36776 and before you go fine tuning the typesetting.
36779 \begin_layout Subsection
36783 \begin_layout Standard
36784 If you have the program installed,
36785 usage is as simple as choosing
36787 Tools\SpecialChar menuseparator
36789 \begin_inset space ~
36795 This will make \SpecialChar LyX
36796 generate a \SpecialChar LaTeX
36797 file of your document,
36800 Chk\SpecialChar TeX
36804 and then make \SpecialChar LyX
36806 \begin_inset Quotes eld
36810 \begin_inset Quotes erd
36813 with the warnings from
36815 Chk\SpecialChar TeX
36820 The warnings will be placed close to the point of the mistake,
36821 and you can quickly find them by using the
36823 Navigate\SpecialChar menuseparator
36827 or the shortcut key
36836 Open the error boxes by clicking on them with the mouse,
36837 or use the shortcut key
36846 or the corresponding
36855 Read the warning and correct the mistake,
36856 if it is a mistake.
36857 If you have trouble understanding what the warning is about,
36858 you can safely ignore it.
36859 Remember that there is a hidden layer between the document on screen and the technical details in invoking
36861 Chk\SpecialChar TeX
36865 and this gap can make some warnings seem arcane or just plain silly.
36868 \begin_layout Standard
36869 This document is an excellent testing bed for the feature,
36870 and it should provide quite a few warnings for you to fiddle with.
36871 Since computers are only so smart,
36872 expect most of the warnings to be false alarms,
36876 \begin_layout Subsection
36877 How to fine tune it
36880 \begin_layout Standard
36884 Chk\SpecialChar TeX
36887 makes more noise than suits your mood.
36888 Then you can choose not to use it,
36889 wait until your mood changes,
36890 or try to customize
36892 Chk\SpecialChar TeX
36895 to get better along with you.
36898 \begin_layout Standard
36901 Chk\SpecialChar TeX
36908 very configurable and extensible,
36909 you should not expect to solve all problems with
36911 Chk\SpecialChar TeX
36914 in \SpecialChar LyX
36916 Since \SpecialChar LyX
36917 has to generate a somewhat special \SpecialChar LaTeX
36918 file to be able to match the line numbers from the
36920 Chk\SpecialChar TeX
36927 \begin_layout Plain Layout
36928 You can inspect the specific output from
36934 Document\SpecialChar menuseparator
36937 \begin_inset space ~
36951 to the internal document structure,
36952 some of the warnings will not appear correctly.
36953 There are two things you can do about this:
36956 \begin_layout Itemize
36959 Chk\SpecialChar TeX
36962 invocation command line in
36963 \change_deleted -712698321 1674918035
36965 \begin_inset Flex Noun
36968 \begin_layout Plain Layout
36969 Tools\SpecialChar menuseparator
36970 Preferences\SpecialChar menuseparator
36971 Output\SpecialChar menuseparator
36972 LaTeX\SpecialChar menuseparator
36979 \change_inserted -712698321 1674918035
36982 Tools\SpecialChar menuseparator
36983 Preferences\SpecialChar menuseparator
36984 Output\SpecialChar menuseparator
36985 LaTeX\SpecialChar menuseparator
36993 Chk\SpecialChar TeX
36996 installation configuration file (usually with the file
37001 See below to learn what warnings can be enabled and disabled on the command line.
37004 \begin_layout Itemize
37005 Export your document as a raw \SpecialChar LaTeX
37008 File\SpecialChar menuseparator
37009 Export\SpecialChar menuseparator
37018 Invoked in this way,
37019 it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
37021 but with a little patience,
37022 you should be able to do it.
37025 \begin_layout Standard
37026 Here follows the warning messages that can be enabled and disabled in
37035 to disable a warning,
37040 to enable a warning.
37041 The emphasized entries are disabled by default,
37042 because the default is "
37044 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
37049 \begin_layout Standard
37050 Notice that you should only use the options that enable and disable warnings,
37051 because \SpecialChar LyX
37052 relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
37059 \begin_layout Enumerate
37063 Command terminated with space.
37066 \begin_layout Enumerate
37069 Non-breaking space (
37070 \begin_inset Quotes eld
37078 \begin_inset Quotes erd
37081 ) should have been used.
37084 \begin_layout Enumerate
37088 You should enclose the previous parenthesis with
37089 \begin_inset Quotes eld
37097 \begin_inset Quotes erd
37103 \begin_layout Enumerate
37106 Italic correction (
37107 \begin_inset Quotes eld
37117 \begin_inset Quotes erd
37120 ) found in non-italic buffer.
37123 \begin_layout Enumerate
37126 Italic correction (
37127 \begin_inset Quotes eld
37137 \begin_inset Quotes erd
37140 ) found more than once.
37143 \begin_layout Enumerate
37147 No italic correction (
37148 \begin_inset Quotes eld
37158 \begin_inset Quotes erd
37164 \begin_layout Enumerate
37168 \begin_inset Quotes eld
37176 \begin_inset Quotes erd
37180 \begin_inset Quotes eld
37188 \begin_inset Quotes erd
37194 \begin_layout Enumerate
37197 Wrong length of dash may have been used.
37200 \begin_layout Enumerate
37204 \begin_inset Quotes eld
37212 \begin_inset Quotes erd
37217 \begin_inset Quotes eld
37225 \begin_inset Quotes erd
37231 \begin_layout Enumerate
37235 \begin_inset Quotes eld
37243 \begin_inset Quotes erd
37249 \begin_layout Enumerate
37253 \begin_inset Quotes eld
37261 \begin_inset Quotes erd
37264 to achieve an ellipsis.
37267 \begin_layout Enumerate
37270 Inter-word spacing (
37271 \begin_inset Quotes eld
37281 \begin_inset Quotes eld
37284 ) should perhaps be used.
37287 \begin_layout Enumerate
37290 Inter-sentence spacing (
37291 \begin_inset Quotes eld
37301 \begin_inset Quotes erd
37304 ) should perhaps be used.
37307 \begin_layout Enumerate
37310 Could not find argument for command.
37313 \begin_layout Enumerate
37317 \begin_inset Quotes eld
37325 \begin_inset Quotes erd
37331 \begin_layout Enumerate
37334 Math mode still on at end of \SpecialChar LaTeX
37338 \begin_layout Enumerate
37342 \begin_inset Quotes eld
37350 \begin_inset Quotes erd
37353 doesn't match the number of
37354 \begin_inset Quotes eld
37362 \begin_inset Quotes erd
37368 \begin_layout Enumerate
37371 You should use either
37374 \begin_inset Quotes eld
37382 \begin_inset Quotes erd
37387 as an alternative to
37388 \begin_inset Quotes eld
37396 \begin_inset Quotes erd
37402 \begin_layout Enumerate
37409 " (ASCII 39) instead of "
37416 \begin_layout Enumerate
37419 User-specified pattern found.
37422 \begin_layout Enumerate
37425 This command might not be intended.
37428 \begin_layout Enumerate
37435 \begin_layout Enumerate
37453 \begin_layout Enumerate
37456 Delete this space to maintain correct page references.
37459 \begin_layout Enumerate
37463 You might wish to put this between a pair of
37464 \begin_inset Quotes eld
37472 \begin_inset Quotes erd
37478 \begin_layout Enumerate
37481 You ought to remove spaces in front of punctuation.
37484 \begin_layout Enumerate
37487 Could not execute \SpecialChar LaTeX
37491 \begin_layout Enumerate
37500 in front of small punctuation.
37503 \begin_layout Enumerate
37511 may look prettier here.
37514 \begin_layout Enumerate
37518 Multiple spaces detected in output.
37521 \begin_layout Enumerate
37524 This text may be ignored.
37527 \begin_layout Enumerate
37533 \begin_inset Quotes eld
37538 to begin quotation,
37546 \begin_layout Enumerate
37557 \begin_inset Quotes eld
37565 \begin_layout Enumerate
37571 \begin_layout Enumerate
37574 You should perhaps use
37575 \begin_inset Quotes eld
37583 \begin_inset Quotes erd
37589 \begin_layout Enumerate
37592 You should put a space in front of/after parenthesis.
37595 \begin_layout Enumerate
37598 You should avoid spaces in front of/after parenthesis.
37601 \begin_layout Enumerate
37605 You should not use punctuation in front of/after quotes.
37608 \begin_layout Enumerate
37611 Double space found.
37614 \begin_layout Enumerate
37617 You should put punctuation outside inner/inside display math mode.
37620 \begin_layout Enumerate
37623 You ought to not use primitive \SpecialChar TeX
37624 in \SpecialChar LaTeX
37628 \begin_layout Enumerate
37631 You should remove spaces in front of
37632 \begin_inset Quotes eld
37640 \begin_inset Quotes erd
37646 \begin_layout Enumerate
37649 \begin_inset Quotes eld
37657 \begin_inset Quotes erd
37660 is normally not followed by
37661 \begin_inset Quotes eld
37669 \begin_inset Quotes erd
37675 \begin_layout Standard
37676 In later versions of \SpecialChar LyX
37678 we hope to provide a more complete interface to this tool (and it's smaller cousin
37682 ) to exploit the full power of it.
37683 But it's not exactly useless as it is now:
37684 go try it on one of your existing documents of a certain length and be surprised.
37687 \begin_layout Section
37688 Version Control in \SpecialChar LyX
37692 \begin_layout Standard
37695 Lars Gullik Bjønnes
37702 \begin_layout Subsection
37706 \begin_layout Standard
37708 supports some of the most basic RCS/CVS/SVN/GIT commands.
37709 If you need something a bit more sophisticated you will have to do that manually in a terminal
37710 \change_inserted 5863208 1685691238
37711 or your favourite client
37716 \begin_layout Standard
37717 Also note that CVS support is not as good as subversion support,
37718 so we advise using SVN instead.
37719 A good place to start learning Subversion is the SVN Book
37723 \begin_layout Plain Layout
37724 \begin_inset CommandInset href
37726 target "http://svnbook.red-bean.com/"
37737 In the case of RCS you should read
37738 \begin_inset Quotes eld
37742 \begin_inset Quotes erd
37751 This file describes all the basic features of RCS.
37752 You should especially notice the comment about a RCS directory,
37753 and the notion of a master RCS file (the file ending in
37760 \begin_layout Standard
37761 Before you begin to use the version control features in \SpecialChar LyX
37763 you should be familiar with RCS/CVS/SVN/GIT usage.
37764 The implementation in \SpecialChar LyX
37765 assumes a recent version of the GNU RCS or CVS/SVN package —
37766 no guarantees are made for older versions.
37767 Most of the log messages are not currently displayed after operations —
37768 you can check them in the Messages pane if you are unsure.
37769 Regular users of version control will appreciate the VC toolbar,
37770 which can be enabled via
37772 View\SpecialChar menuseparator
37773 Toolbars\SpecialChar menuseparator
37775 \begin_inset space ~
37783 \begin_layout Standard
37784 For introducing your own external commands consult
37785 \begin_inset Flex Code
37788 \begin_layout Plain Layout
37802 \begin_layout Standard
37803 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
37805 Document\SpecialChar menuseparator
37809 Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
37810 Compressed LyX documents are binary files,
37811 which cannot be merged by version control systems.
37813 \change_inserted 5863208 1685692758
37816 Also to avoid unnecessary merge conflicts we advise to disable document Document\SpecialChar menuseparator
37817 Settings\SpecialChar menuseparator
37818 Output\SpecialChar menuseparator
37819 Save transient properties when more users work on the same document.
37824 \begin_layout Subsection
37825 RCS commands in \SpecialChar LyX
37829 \begin_layout Standard
37830 The following sections describe the RCS commands supported by \SpecialChar LyX
37832 You can find them in the
37834 File\SpecialChar menuseparator
37836 \begin_inset space ~
37843 was tested against RCS 5.7/5.8
37844 \change_inserted 5863208 1685694069
37850 \begin_layout Subsubsection
37856 \begin_layout Standard
37857 If your document is not under revision control,
37858 this is the only item shown in the menu.
37859 And if it is under revision control,
37864 item is not visible.
37868 \begin_layout Standard
37869 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
37870 You are asked interactively to supply an initial description of the document.
37871 The document is now set in Read-Only mode and you have to
37874 \begin_inset space ~
37878 \begin_inset space ~
37882 \begin_inset space ~
37888 before making any changes to it.
37889 A document under revision control has a
37890 \begin_inset Quotes eld
37893 [RCS:<version> <locker>]
37894 \begin_inset Quotes erd
37897 item tagged to the filename in the minibuffer.
37900 \begin_layout Standard
37901 RCS command that is run:
37904 \begin_layout LyX-Code
37907 ci -q -u -i -t-"<initial description>" <file-name>
37910 \begin_layout Standard
37915 to understand the switches.
37919 \begin_layout Subsubsection
37925 \begin_layout Standard
37926 When you are finished editing a file,
37927 you check in your changes.
37929 you are asked for a description of the changes.
37930 This is stored in the history log.
37931 The version number is bumped,
37932 your changes are applied to the master RCS file,
37933 the document is unlocked and set to Read-Only mode.
37936 \begin_layout Itemize
37940 ci -q -u -m"<description>" <file-name>
37943 \begin_layout Subsubsection
37949 \begin_layout Standard
37950 By doing this you lock the document so that only you can edit it.
37951 This will also make the document Read-Write only for you.
37952 You will usually continue editing for a while and when you are finished you check in your changes.
37953 The status line is changed to reflect that you have locked the file.
37956 \begin_layout Itemize
37960 co -q -l <file-name>
37963 \begin_layout Subsubsection
37966 Revert To Repository Version
37969 \begin_layout Standard
37970 This will discard all changes made to the document since the last check in.
37971 You get a warning before changes are discarded.
37974 \begin_layout Itemize
37978 co -f -u<version> <file-name>
37981 \begin_layout Subsubsection
37987 \begin_layout Standard
37988 This will create a copy of the current document.
37989 Since RCS does not support copy operations natively,
37990 the version history is not preserved,
37991 and the copy is added as a new file.
37992 It requires a clean document without any changes since the last checkin.
37993 You are asked for a file name and a description of the copy operation.
37994 After that the copy is created,
37995 both locally and in the repository.
37996 If the parent directories of the copied and original document differ,
37997 all relative paths of included files of the copy are adjusted (like in
37999 File\SpecialChar menuseparator
38005 the copy is loaded instead of the original document.
38008 \begin_layout Labeling
38009 \labelwidthstring 00.00.0000
38011 \begin_inset space ~
38016 \begin_inset space ~
38020 \begin_inset Newline newline
38024 \begin_inset Flex Code
38027 \begin_layout Plain Layout
38030 \begin_inset Quotes qld
38034 \begin_inset Quotes qld
38043 \begin_inset Flex Code
38046 \begin_layout Plain Layout
38049 \begin_inset Quotes qld
38053 \begin_inset Quotes qld
38062 \begin_inset Newline newline
38066 \begin_inset Flex Code
38069 \begin_layout Plain Layout
38073 \begin_inset Quotes qld
38077 \begin_inset Quotes qld
38088 \begin_layout Subsubsection
38094 \begin_layout Standard
38095 This makes as if the last check in never happened.
38096 No changes are made to the document loaded into \SpecialChar LyX
38098 but the last version is removed from the master RCS file.
38101 \begin_layout Itemize
38105 rcs -o<version> <file-name>
38108 \begin_layout Subsubsection
38114 \begin_layout Standard
38115 This shows the complete history of the RCS document.
38120 is shown in a browser.
38128 \begin_layout Subsubsection
38132 \begin_layout Standard
38134 supports RCS version number,
38136 date and time of last commit.
38137 All those are extracted from
38139 rlog -r <file-name>
38143 \begin_inset CommandInset ref
38145 reference "subsec:VCS-Revision-Information"
38153 \begin_layout Subsection
38154 CVS commands in \SpecialChar LyX
38158 \begin_layout Standard
38159 A subset of CVS operations is supported by \SpecialChar LyX
38161 You can find the commands in the
38163 File\SpecialChar menuseparator
38165 \begin_inset space ~
38171 The version control system SVN is more powerful,
38172 so please use it instead of CVS if possible.
38175 \begin_layout Subsubsection
38181 \begin_layout Standard
38182 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
38183 If you're using a client-server setup you may need to login before doing the first repository checkout.
38186 \begin_layout Standard
38187 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.
38188 Standard CVS repositories don't operate with a file locking mechanism.
38189 This may be surprising,
38190 but conflicts only occur if people disagree on the proper content of the same part of a document.
38192 if co-workers are used to communicate regularly,
38193 these conflicts occur rarely.
38194 If they don't communicate they have a fundamental problem anyway.
38195 Nevertheless some people like to work with so called
38196 \begin_inset Quotes eld
38200 \begin_inset Quotes erd
38204 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.
38205 When the changes are checked in the working copy returns to readonly state.
38206 With \SpecialChar LyX
38207 one has to edit the
38208 \begin_inset Flex Code
38211 \begin_layout Plain Layout
38217 file and add the line
38218 \begin_inset Flex Code
38221 \begin_layout Plain Layout
38227 to work with reserved checkouts.
38228 The benefit is the possibility to see who is using a writable copy of some document.
38229 It's not guaranteed only one user makes a copy writable.
38232 \begin_layout Standard
38234 tries to guess if you're using reserved or non-reserved checkouts.
38235 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.
38236 When a reserved checkout is detected you have to use
38237 \begin_inset Flex Noun
38240 \begin_layout Plain Layout
38246 to make your working copy writable if it's readonly.
38248 \begin_inset Flex Noun
38251 \begin_layout Plain Layout
38257 operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
38260 \begin_layout Standard
38261 More information about CVS can be found here
38262 \begin_inset Flex URL
38265 \begin_layout Plain Layout
38267 http://www.nongnu.org/cvs
38273 \begin_inset Flex URL
38276 \begin_layout Plain Layout
38278 http://ximbiot.com/cvs
38286 \begin_layout Standard
38291 to understand the sub-commands and the switches mentioned below.
38294 \begin_layout Subsubsection
38300 \begin_layout Standard
38301 If your document is not under revision control,
38302 this is the only item shown in the menu.
38303 And if it is under revision control,
38308 item is not visible.
38312 \begin_layout Standard
38313 This command registers in CVS your document
38314 \begin_inset Flex Strong
38317 \begin_layout Plain Layout
38325 in the case you have already the documents directory under CVS control (in particular
38330 This means you have to create or checkout the archive by yourself using external tools.
38331 (In case you forget that step \SpecialChar LyX
38332 registers the document with RCS.)
38335 \begin_layout Standard
38336 Then you are asked interactively to supply an initial description of the document.
38337 Don't forget that registered file is not yet checked in.
38340 \begin_layout Standard
38341 CVS command that is run:
38344 cvs -q add -m"<entered message>" "<file-name>"
38347 \begin_layout Standard
38352 above and for all other CVS commands is an abbreviation for
38353 \begin_inset Quotes eld
38356 change the current working directory to file location and use the file name without path component as argument
38357 \begin_inset Quotes erd
38363 \begin_layout Subsubsection
38369 \begin_layout Standard
38370 When you are finished editing a file,
38371 you commit your changes.
38372 When you do this and you had changed the document,
38373 you are asked for a description of the changes.
38374 After that changes are written to the repository.
38375 In case you didn't change the document and a reserved checkout is detected the reservation made on
38376 \begin_inset Flex Noun
38379 \begin_layout Plain Layout
38388 \begin_layout Labeling
38389 \labelwidthstring 00.00.0000
38391 \begin_inset space ~
38396 \begin_inset space ~
38400 \begin_inset Newline newline
38404 \begin_inset Flex Code
38407 \begin_layout Plain Layout
38410 -q commit -m"<description>" "<file-name>"
38416 \begin_inset Newline newline
38420 \begin_inset Flex Code
38423 \begin_layout Plain Layout
38434 \begin_layout Subsubsection
38440 \begin_layout Standard
38441 When you are sharing a repository with others,
38442 you may have to incorporate their changes into your working copy.
38445 \begin_layout Standard
38449 cvs -q update "<file-name>"
38452 \begin_layout Standard
38453 If a readonly checkout is detected the working copy is made writable and reserved.
38456 \begin_layout Standard
38460 cvs -q edit "<file-name>"
38463 \begin_layout Subsubsection
38466 Revert To Repository Version
38469 \begin_layout Standard
38470 This will discard all changes made to the document since the last check in.
38471 You get a warning before changes are discarded.
38472 Firstly the file is deleted,
38473 secondly CVS update command is run.
38476 \begin_layout Standard
38480 cvs -q update "<file-name>"
38483 \begin_layout Standard
38484 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
38487 \begin_layout Standard
38491 cvs -q unedit "<file-name>"
38494 \begin_layout Subsubsection
38500 \begin_layout Standard
38501 This will create a copy of the current document.
38502 Since CVS does not support copy operations natively,
38503 the version history is not preserved,
38504 and the copy is added as a new file.
38505 It requires a clean document without any changes since the last checkin.
38506 You are asked for a file name and a description of the copy operation.
38507 After that the copy is created,
38508 both locally and in the repository.
38509 If the parent directories of the copied and original document differ,
38510 all relative paths of included files of the copy are adjusted (like in
38512 File\SpecialChar menuseparator
38518 the copy is loaded instead of the original document.
38521 \begin_layout Labeling
38522 \labelwidthstring 00.00.0000
38524 \begin_inset space ~
38529 \begin_inset space ~
38533 \begin_inset Newline newline
38537 \begin_inset Flex Code
38540 \begin_layout Plain Layout
38547 \begin_inset Flex Code
38550 \begin_layout Plain Layout
38557 \begin_inset Newline newline
38561 \begin_inset Flex Code
38564 \begin_layout Plain Layout
38565 cvs -q add "<new-file-name>"
38573 \begin_layout Subsubsection
38579 \begin_layout Standard
38580 This will rename the current document.
38581 Since CVS does not support rename operations natively,
38582 the version history is not preserved,
38583 the renamed document is added as a new file,
38584 and the original document is deleted.
38585 It requires a clean document without any changes since the last checkin.
38586 You are asked for a file name and a description of the rename operation.
38587 After that the document is renamed,
38588 both locally and in the repository.
38589 If the parent directories of the new and old file names differ,
38590 all relative paths of included files are adjusted (like in
38592 File\SpecialChar menuseparator
38598 the document is reloaded using the new name.
38601 \begin_layout Labeling
38602 \labelwidthstring 00.00.0000
38604 \begin_inset space ~
38609 \begin_inset space ~
38613 \begin_inset Newline newline
38617 \begin_inset Flex Code
38620 \begin_layout Plain Layout
38627 \begin_inset Flex Code
38630 \begin_layout Plain Layout
38637 \begin_inset Newline newline
38641 \begin_inset Flex Code
38644 \begin_layout Plain Layout
38645 cvs -q add "<new-file-name>"
38651 \begin_inset Newline newline
38655 \begin_inset Flex Code
38658 \begin_layout Plain Layout
38659 cvs -q remove "<file-name>"
38667 \begin_layout Subsubsection
38668 Update of the local directory checkout from repository
38671 \begin_layout Standard
38672 Once your documents gets more complex,
38673 containing sub-documents and pictures,
38675 \begin_inset Flex Code
38678 \begin_layout Plain Layout
38684 files and so on using version control becomes more complicated.
38686 supports updating the whole tree in which resides the document.
38687 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.
38688 You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
38689 It's good practice anyway to store multipart documents in an extra directory.
38692 \begin_layout Standard
38694 \begin_inset Flex Code
38697 \begin_layout Plain Layout
38698 Update local directory from repository
38703 command updates the whole directory.
38704 If local changes are detected user is warned before update starts.
38705 In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
38706 You have to review and correct the result of the merge.
38707 You'll find the conflicts enclosed in pairs of
38708 \begin_inset Flex Code
38711 \begin_layout Plain Layout
38718 \begin_inset Flex Code
38721 \begin_layout Plain Layout
38728 \begin_inset Flex Code
38731 \begin_layout Plain Layout
38738 The first part is your version as before the update operation with the document name prepended.
38739 The second one is the repository version with the version number after the sequence of
38740 \begin_inset Flex Code
38743 \begin_layout Plain Layout
38752 \begin_layout Labeling
38753 \labelwidthstring 00.00.0000
38755 \begin_inset space ~
38760 \begin_inset space ~
38764 \begin_inset Newline newline
38768 \begin_inset Flex Code
38771 \begin_layout Plain Layout
38780 (Ask if changes are detected.)
38781 \begin_inset Newline newline
38785 \begin_inset Flex Code
38788 \begin_layout Plain Layout
38800 \begin_layout Standard
38802 \begin_inset Flex Code
38805 \begin_layout Plain Layout
38811 stands for the path to the document.
38814 \begin_layout Subsubsection
38820 \begin_layout Standard
38821 This shows the complete history of the CVS document.
38824 cvs log "<file-name>"
38826 is shown in a browser.
38829 \begin_layout Subsubsection
38833 \begin_layout Standard
38835 supports CVS version number,
38837 date and time of last commit.
38838 All those are extracted from
38840 cvs log -r <file-name>
38844 \begin_inset CommandInset ref
38846 reference "subsec:VCS-Revision-Information"
38854 \begin_layout Subsection
38855 SVN commands in \SpecialChar LyX
38859 \begin_layout Standard
38860 SVN is now partially supported by \SpecialChar LyX
38862 You can find the commands in the
38864 File\SpecialChar menuseparator
38866 \begin_inset space ~
38872 Please note that if you use password protected access to repository via ssh,
38873 you will be asked in terminal window.
38875 was tested against SVN 1.5,
38881 \begin_layout Plain Layout
38882 Most of the commands will work with 1.4 too,
38884 \begin_inset CommandInset ref
38886 reference "subsec:SVN-Repo-Update"
38892 There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
38900 \begin_layout Subsubsection
38906 \begin_layout Standard
38907 If your document is not under revision control,
38908 this is the only item shown in the menu.
38909 And if it is under revision control,
38914 item is not visible.
38917 \begin_layout Standard
38918 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
38923 This means you have to checkout the archive by yourself.
38926 \begin_layout Standard
38927 Then you are asked interactively to supply an initial description of the document.
38928 Don't forget that registered file is not yet commited.
38931 \begin_layout Standard
38932 SVN command that is run:
38936 \begin_inset Quotes qld
38940 \begin_inset Quotes qld
38946 \begin_layout Standard
38951 to understand the switches.
38954 \begin_layout Subsubsection
38960 \begin_layout Standard
38961 When you are finished editing a file,
38962 you commit your changes.
38964 you are asked for a description of the changes.
38965 After that changes are commited.
38968 \begin_layout Standard
38973 \begin_layout Plain Layout
38974 In case locking is not enabled.
38976 \begin_inset CommandInset ref
38978 reference "subsec:SVN-File-Locking"
38990 svn commit -q -m"<description>" <file-name>
38993 \begin_layout Subsubsection
38999 \begin_layout Standard
39000 Updates the changes of this file from the repository.
39001 Be sure you understand SVN merging and conflicts resolving before using this function,
39002 because all conflicts has to be resolved manually by you!
39005 \begin_layout Standard
39010 \begin_layout Plain Layout
39018 svn update --non-interactive
39019 \begin_inset Quotes qld
39023 \begin_inset Quotes qld
39029 \begin_layout Subsubsection
39032 Revert To Repository Version
39035 \begin_layout Standard
39036 This will discard all changes made to the document since the last check in.
39037 You get a warning before changes are discarded.
39040 \begin_layout Standard
39045 \begin_inset Quotes qld
39049 \begin_inset Quotes qld
39055 \begin_layout Subsubsection
39061 \begin_layout Standard
39062 This will create a copy of the current document including the version history.
39063 It requires a clean document without any changes since the last checkin.
39064 You are asked for a file name and a description of the copy operation.
39065 After that the copy is created,
39066 both locally and in the repository.
39067 If the parent directories of the copied and original document differ,
39068 all relative paths of included files of the copy are adjusted (like in
39070 File\SpecialChar menuseparator
39076 the copy is loaded instead of the original document.
39079 \begin_layout Labeling
39080 \labelwidthstring 00.00.0000
39082 \begin_inset space ~
39087 \begin_inset space ~
39091 \begin_inset Newline newline
39095 \begin_inset Flex Code
39098 \begin_layout Plain Layout
39102 \begin_inset Quotes qld
39106 \begin_inset Quotes qld
39110 \begin_inset Quotes qld
39114 \begin_inset Quotes qld
39123 \begin_inset Newline newline
39127 \begin_inset Flex Code
39130 \begin_layout Plain Layout
39139 \begin_layout Subsubsection
39145 \begin_layout Standard
39146 This will rename the current document including the version history.
39147 It requires a clean document without any changes since the last checkin.
39148 You are asked for a file name and a description of the rename operation.
39149 After that the document is renamed,
39150 both locally and in the repository.
39151 If the parent directories of the new and old file names differ,
39152 all relative paths of included files are adjusted (like in
39154 File\SpecialChar menuseparator
39160 the document is reloaded using the new name.
39163 \begin_layout Labeling
39164 \labelwidthstring 00.00.0000
39166 \begin_inset space ~
39171 \begin_inset space ~
39175 \begin_inset Newline newline
39179 \begin_inset Flex Code
39182 \begin_layout Plain Layout
39186 \begin_inset Quotes qld
39190 \begin_inset Quotes qld
39194 \begin_inset Quotes qld
39198 \begin_inset Quotes qld
39207 \begin_inset Newline newline
39211 \begin_inset Flex Code
39214 \begin_layout Plain Layout
39223 \begin_layout Subsubsection
39224 \begin_inset CommandInset label
39226 name "subsec:SVN-Repo-Update"
39230 Update of the local directory checkout from repository
39234 \begin_layout Plain Layout
39235 Note that this command will work only with subversion
39236 \begin_inset Formula $\geqq1.5$
39247 \begin_layout Standard
39248 All the commands above have one shortcoming – they deal with the current document only.
39249 Once your document contains pictures,
39251 \begin_inset Flex Code
39254 \begin_layout Plain Layout
39260 files and so on administration becomes more complicated.
39262 now supports updating the whole tree in which resides the document
39266 \begin_layout Plain Layout
39267 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
39274 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.
39278 \begin_layout Standard
39279 \begin_inset Flex Code
39282 \begin_layout Plain Layout
39283 Update local directory from repository
39288 command updates the whole directory and in case of merge conflicts local version of the files are left,
39289 so no unintended data loss occurs.
39290 If local changes are detected user is warned before update starts.
39293 \begin_layout Labeling
39294 \labelwidthstring 00.00.0000
39296 \begin_inset space ~
39301 \begin_inset space ~
39305 \begin_inset Newline newline
39309 \begin_inset Flex Code
39312 \begin_layout Plain Layout
39318 (Ask if changes are detected.)
39319 \begin_inset Newline newline
39323 \begin_inset Flex Code
39326 \begin_layout Plain Layout
39327 svn update --accept mine-full $path
39335 \begin_layout Standard
39337 \begin_inset Flex Code
39340 \begin_layout Plain Layout
39346 stands for the path to the document.
39349 \begin_layout Subsubsection
39355 \begin_layout Standard
39356 This shows the complete history of the SVN document.
39360 \begin_inset Quotes qld
39364 \begin_inset Quotes qld
39369 is shown in a browser.
39372 \begin_layout Subsubsection
39374 \begin_inset CommandInset label
39376 name "subsec:SVN-File-Locking"
39383 \begin_layout Standard
39384 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.
39385 When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
39386 which guarantees that only one user is allowed to edit file at the given time.
39389 \begin_layout Standard
39390 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
39392 \begin_inset CommandInset ref
39394 reference "subsec:Automatical-Locking-Property"
39400 \begin_inset Flex Code
39403 \begin_layout Plain Layout
39413 \begin_layout Plain Layout
39414 \begin_inset Flex URL
39417 \begin_layout Plain Layout
39419 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
39430 If this property is detected for a given document \SpecialChar LyX
39431 starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
39432 This in particular means there are two different modes of file use in \SpecialChar LyX
39436 \begin_layout Itemize
39438 The loaded file is in the read-only mode.
39439 For editing on needs to check-out.
39444 consists of updating from the repository and gaining write lock.
39445 If the lock is not possible to obtain,
39446 we remain in unlocked state.
39449 \begin_layout Itemize
39451 The loaded file is in the
39452 \begin_inset Quotes els
39456 \begin_inset Quotes ers
39460 No other user is allowed to edit the file.
39465 consists of commiting changes and releasing write-lock.
39466 If no changes have been made to the document,
39467 no commit will be produced
39471 \begin_layout Plain Layout
39472 Don't be puzzled by the fact that you will be asked for commit message anyway.
39477 and only the write-lock will be released.
39480 \begin_layout Standard
39484 \begin_layout Labeling
39485 \labelwidthstring 00.00.0000
39489 svn commit -q -m"<description>" "<file-name>"
39490 \begin_inset Newline newline
39493 svn unlock "<file-name>"
39496 \begin_layout Labeling
39497 \labelwidthstring 00.00.0000
39501 svn update "<file-name>"
39502 \begin_inset Newline newline
39505 svn lock "<file-name>"
39508 \begin_layout Subsubsection
39511 \begin_inset CommandInset label
39513 name "subsec:Automatical-Locking-Property"
39519 Automatic Locking Property
39522 \begin_layout Standard
39523 The above mentioned automatic setting of write permissions of the .lyx file can be set through
39525 File\SpecialChar menuseparator
39527 \begin_inset space ~
39530 Control\SpecialChar menuseparator
39531 Use Locking Property
39534 This command is active only when the file is not locked on the svn server (i.e.
39535 you need to check-out before proceeding).
39538 \begin_layout Labeling
39539 \labelwidthstring 00.00.0000
39541 \begin_inset space ~
39547 \begin_layout Labeling
39548 \labelwidthstring 00.00.0000
39552 svn propset svn:needs-lock ON "<file-name>"
39555 \begin_layout Labeling
39556 \labelwidthstring 00.00.0000
39560 svn propdel svn:needs-lock "<file-name>"
39563 \begin_layout Subsubsection
39564 \begin_inset CommandInset label
39566 name "subsec:VCS-Revision-Information"
39570 Revision Information in Documents
39573 \begin_layout Standard
39574 There are more possibilities how to activate revision information in our document.
39577 \begin_layout Itemize
39583 \begin_layout Itemize
39584 tree revision information (
39585 \begin_inset Flex Code
39588 \begin_layout Plain Layout
39595 The result is the output of the
39596 \begin_inset Flex Code
39599 \begin_layout Plain Layout
39606 the following table gives you an idea,
39607 how to read the results.
39610 \begin_layout Standard
39612 \begin_inset Tabular
39613 <lyxtabular version="3" rows="6" columns="2">
39614 <features tabularvalignment="middle">
39615 <column alignment="left" valignment="top">
39616 <column alignment="left" valignment="top">
39618 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
39621 \begin_layout Plain Layout
39629 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
39632 \begin_layout Plain Layout
39642 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39645 \begin_layout Plain Layout
39651 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39654 \begin_layout Plain Layout
39655 mixed revision working copy
39662 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39665 \begin_layout Plain Layout
39671 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39674 \begin_layout Plain Layout
39675 modified working copy
39682 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39685 \begin_layout Plain Layout
39691 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39694 \begin_layout Plain Layout
39695 switched working copy
39702 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39705 \begin_layout Plain Layout
39711 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39714 \begin_layout Plain Layout
39715 partial working copy,
39716 from a sparse checkout
39723 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
39726 \begin_layout Plain Layout
39732 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
39735 \begin_layout Plain Layout
39738 switched working copy
39751 \begin_layout Itemize
39752 file revision information.
39753 The result comes from parsing the output of
39754 \begin_inset Flex Code
39757 \begin_layout Plain Layout
39759 \begin_inset space ~
39763 \begin_inset space ~
39767 \begin_inset space ~
39776 Supported flags are:
39780 \begin_layout Itemize
39781 version number of the last commit (
39782 \begin_inset Flex Code
39785 \begin_layout Plain Layout
39794 \begin_layout Itemize
39795 author of the last commit (
39796 \begin_inset Flex Code
39799 \begin_layout Plain Layout
39808 \begin_layout Itemize
39809 date of the last commit (
39810 \begin_inset Flex Code
39813 \begin_layout Plain Layout
39822 \begin_layout Itemize
39823 time of the last commit (
39824 \begin_inset Flex Code
39827 \begin_layout Plain Layout
39837 \begin_layout Standard
39838 You can obtain this info via InsetInfo (
39839 \change_inserted 5863208 1564400022
39842 Insert\SpecialChar menuseparator
39843 Field\SpecialChar menuseparator
39844 Version Control Revision
39845 \change_deleted 5863208 1564399852
39850 \begin_inset Flex Code
39853 \begin_layout Plain Layout
39854 info-insert buffer vcs-date
39862 The information will be available only when you have the file stored under svn managment (i.e.
39864 \begin_inset Flex Code
39867 \begin_layout Plain Layout
39873 directory is available with your document).
39877 \begin_layout Itemize
39880 possibility is to use svn keywords
39884 \begin_layout Plain Layout
39885 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
39891 In short – you set file keywords property (e.g.
39894 svn propset svn:keywords 'Rev' file.lyx
39896 ) and then paste keyword \SpecialChar TeX
39901 \begin_layout Plain Layout
39902 This is an easy way how to ensure that \SpecialChar LyX
39903 won't break the line in the middle of keyword tag.
39908 tag in your document (e.g.
39910 \begin_inset Flex Code
39913 \begin_layout Plain Layout
39920 This way svn client will automatically substitute revision number (e.g.
39922 \begin_inset Flex Code
39925 \begin_layout Plain Layout
39932 ) after each update and commit.
39933 There are more problems with this approach.
39935 the '$' character is used in \SpecialChar TeX
39936 world for math equations,
39937 so any occurence of math formula
39938 \begin_inset Formula $Rev$
39942 \begin_inset Formula $Rev:59$
39945 in your \SpecialChar LyX
39947 Similarly for other keywords like Id,
39951 Secondly svn output is dependent on your locales,
39952 so its very easy that svn would produce some problematic strings once Date is used.
39953 Thirdly you get the whole 'Rev:
39954 59' string in your document instead of the plain number.
39955 Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
39956 to support it directly.
39959 \begin_layout Subsection
39960 SVN and Windows Environment
39963 \begin_layout Quote
39964 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
39965 they would be well advised to use TortoiseSVN.
39972 \begin_layout Subsubsection
39976 \begin_layout Standard
39977 In addition to installing \SpecialChar LyX
39979 and having access to a Subversion repository,
39980 the user will need to install the Subversion client program.
39981 A Windows installer for the client program is available from
39982 \begin_inset CommandInset href
39985 target "http://www.collab.net/nonav/downloads/subversion/"
39991 The user may also want to install
39992 \begin_inset CommandInset href
39995 target "http://tortoisesvn.tigris.org/"
40001 which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
40002 Operations done outside \SpecialChar LyX
40003 will typically be more convenient using the Explorer context menu.
40004 Note that TortoiseSVN is not a replacement for the client program,
40005 which is what \SpecialChar LyX
40009 \begin_layout Subsubsection
40010 Bringing a document under Subversion control
40013 \begin_layout Standard
40014 Before a \SpecialChar LyX
40015 document can be brought under version control in Subversion,
40016 its parent directory needs to be under version control.
40017 If the document is being added to a project already in the repository,
40018 this is accomplished by checking the project out to the directory where the new document will be placed.
40019 If the project itself is not yet under version control (for instance,
40020 if this document starts a new project),
40021 the directory must be imported into the repository.
40022 This is done outside \SpecialChar LyX
40024 Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
40025 or alternatively can be done using the command line client at a DOS prompt.
40026 The procedure for importing the project using TortoiseSVN is described below,
40027 assuming an existing repository and a new project being started in
40034 For information on using the Subversion client program,
40042 \begin_layout Enumerate
40049 in Windows Explorer,
40053 TortoiseSVN\SpecialChar menuseparator
40058 adjust the URL for the repository,
40062 \begin_layout Enumerate
40063 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
40067 Supply a name for the project folder and click OK.
40068 Add a message for the log file if desired,
40069 then click OK again.
40070 The new project folder should appear in the repository.
40072 click OK again to exit the repository browser.
40075 \begin_layout Enumerate
40076 Once again right click
40083 this time selecting SVN Checkout\SpecialChar ldots
40084 Select the URL of the project folder you just created in the repository,
40085 and set the checkout directory to
40093 You will be warned about a non-empty folder;
40094 click OK to proceed.
40095 You should now have a
40106 \begin_layout Enumerate
40107 Create or open your document in \SpecialChar LyX
40110 File\SpecialChar menuseparator
40112 \begin_inset space ~
40115 Control\SpecialChar menuseparator
40119 Add a log message and click OK to commit the document to version control.
40122 \begin_layout Standard
40123 From this point onward,
40124 you should have full functionality in the
40126 File\SpecialChar menuseparator
40128 \begin_inset space ~
40134 You also have the option of checking the document in and out,
40135 viewing its history,
40137 using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
40140 \begin_layout Subsubsection
40141 SSH tunnel used with SVN under Windows
40144 \begin_layout Standard
40145 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
40146 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,
40147 also be prepared for a great deal of frustration\SpecialChar ldots
40151 \begin_layout Enumerate
40152 Get an svn client for windows,
40153 as described in the previous sections.
40154 When it is a fresh install run some svn command (e.g.
40156 \begin_inset Flex Code
40159 \begin_layout Plain Layout
40165 ) to create config files,
40166 which you will need to change later on.
40169 \begin_layout Enumerate
40170 Choose an ssh client for Windows.
40171 There are several possibilities,
40172 we will use the one from Putty tools
40176 \begin_layout Plain Layout
40177 \begin_inset Flex URL
40180 \begin_layout Plain Layout
40182 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
40193 You will need to set the connection up so that the client doesn't ask for any password from you.
40194 To keep things easy we will use only keys without any additional password protection etc.
40198 \begin_layout Enumerate
40200 \begin_inset Flex Code
40203 \begin_layout Plain Layout
40210 Save your private .ppk key file and put the public one on the server side.
40211 If the SVN server runs on Linux,
40212 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
40213 \begin_inset Quotes eld
40218 Public key for pasting into OpenSSH authorized_keys file
40221 \begin_inset Quotes erd
40224 edit field into the server's
40225 \begin_inset Flex Code
40228 \begin_layout Plain Layout
40229 ~/.ssh/authorized_keys
40235 \begin_inset Flex Code
40238 \begin_layout Plain Layout
40247 \begin_layout Enumerate
40249 \begin_inset Flex Code
40252 \begin_layout Plain Layout
40259 In the SVN config file
40263 \begin_layout Plain Layout
40264 Exact path depends on Windows version,
40265 usually somewhere around
40266 \begin_inset Flex Code
40269 \begin_layout Plain Layout
40272 Documents and Settings
40286 \begin_inset Flex Code
40289 \begin_layout Plain Layout
40309 \begin_inset Flex Code
40312 \begin_layout Plain Layout
40313 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
40322 \begin_layout Plain Layout
40323 It will usually take a lot of time to get exact command right and it depends on many things.
40324 For example do not have some remote server saved as a default session in Putty etc.
40326 try to connect via plink without SVN first.
40335 \begin_layout Enumerate
40336 Checkout the SVN archive,
40338 \begin_inset space \thinspace{}
40342 \begin_inset Newline newline
40346 \begin_inset Flex Code
40349 \begin_layout Plain Layout
40350 svn co svn+ssh://user@server/repository_path
40358 \begin_layout Subsubsection
40359 End-of-Line Conversions
40362 \begin_layout Standard
40363 When the collaborators are mixing Linux and Windows environments,
40365 will use different line endings inside the .lyx files.
40366 This is not a problem as far as \SpecialChar LyX
40367 functionality is concerned,
40368 but the commit diffs will be huge and merge-conflicts prone.
40369 Fortunately SVN itself knows
40373 \begin_layout Plain Layout
40374 \begin_inset Flex URL
40377 \begin_layout Plain Layout
40379 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
40389 how to deal with CR/LF problems when switching .lyx files to the
40390 \begin_inset Flex Code
40393 \begin_layout Plain Layout
40403 \begin_layout Plain Layout
40406 \begin_inset Flex Code
40409 \begin_layout Plain Layout
40410 svn propset svn:eol-style native FILE_NAME
40423 \begin_layout Subsection
40424 GIT commands in \SpecialChar LyX
40428 \begin_layout Standard
40429 A minimal subset of GIT commands is now supported by \SpecialChar LyX
40431 You can find the commands in the
40433 File\SpecialChar menuseparator
40435 \begin_inset space ~
40441 Please note that if you use password protected access to repository via ssh,
40442 you will be asked in terminal window.
40444 was tested against GIT 1.7
40445 \change_inserted 5863208 1685694088
40452 \begin_layout Plain Layout
40453 Windows users please note that you need to ensure that git is on the path.
40454 This can be set from within \SpecialChar LyX
40457 Tools\SpecialChar menuseparator
40458 Preferences\SpecialChar menuseparator
40459 Paths\SpecialChar menuseparator
40470 \begin_layout Standard
40471 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
40472 With traditional version control systems there is one central server which hosts the repository.
40473 Users commit their changes to the server,
40474 and get updates made by other users from it.
40476 users commit to a local repository.
40477 The local repository can be synchronized with one or more remote repositories using the
40478 \begin_inset Flex Code
40481 \begin_layout Plain Layout
40488 \begin_inset Flex Code
40491 \begin_layout Plain Layout
40499 does not interact in any way with remote GIT repositories.
40500 It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
40501 If you use remote GIT repositories you need to do the
40502 \begin_inset Flex Code
40505 \begin_layout Plain Layout
40512 \begin_inset Flex Code
40515 \begin_layout Plain Layout
40521 operations with your favourite GIT client.
40524 \begin_layout Subsubsection
40530 \begin_layout Standard
40531 If your document is not under revision control,
40532 this is the only item shown in the menu.
40533 And if it is under revision control,
40538 item is not visible.
40541 \begin_layout Standard
40542 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
40547 \change_inserted 5863208 1685693727
40552 \begin_layout Plain Layout
40554 \change_inserted 5863208 1685693727
40559 *and* initial repository commit (or at least
40563 ) needs to be manually done.
40573 This means you have to checkout the archive by yourself.
40576 \begin_layout Standard
40577 Then you are asked interactively to supply an initial description of the document.
40578 Don't forget that registered file is not yet committed.
40581 \begin_layout Standard
40582 GIT command that is run:
40586 \begin_inset Quotes qld
40590 \begin_inset Quotes qld
40596 \begin_layout Standard
40601 to understand the switches.
40604 \begin_layout Subsubsection
40610 \begin_layout Standard
40611 When you are finished editing a file,
40612 you commit your changes.
40614 you are asked for a description of the changes.
40615 After that changes are committed.
40618 \begin_layout Standard
40622 git commit -q -m"<description>" <file-name>
40625 \begin_layout Subsubsection
40628 Revert To Repository Version
40631 \begin_layout Standard
40632 This will discard all changes made to the document since the last check in.
40633 You get a warning before changes are discarded.
40636 \begin_layout Standard
40641 \begin_inset Quotes qld
40645 \begin_inset Quotes qld
40651 \begin_layout Subsubsection
40657 \begin_layout Standard
40658 This will rename the current document including the version history.
40659 It requires a clean document without any changes since the last checkin.
40660 You are asked for a file name and a description of the rename operation.
40661 After that the document is renamed,
40662 both locally and in the repository.
40663 If the parent directories of the new and old file names differ,
40664 all relative paths of included files are adjusted (like in
40666 File\SpecialChar menuseparator
40672 the document is reloaded using the new name.
40675 \begin_layout Labeling
40676 \labelwidthstring 00.00.0000
40678 \begin_inset space ~
40683 \begin_inset space ~
40687 \begin_inset Newline newline
40691 \begin_inset Flex Code
40694 \begin_layout Plain Layout
40698 \begin_inset Quotes qld
40702 \begin_inset Quotes qld
40706 \begin_inset Quotes qld
40710 \begin_inset Quotes qld
40719 \begin_inset Newline newline
40723 \begin_inset Flex Code
40726 \begin_layout Plain Layout
40735 \begin_layout Subsubsection
40741 \begin_layout Standard
40742 This shows the complete history of the GIT document.
40746 \begin_inset Quotes qld
40750 \begin_inset Quotes qld
40755 is shown in a browser.
40758 \begin_layout Subsubsection
40762 \begin_layout Standard
40764 supports GIT hash number of the last commit to the file,
40766 \change_inserted 1119979965 1564297456
40767 its abbreviated form,
40771 date and time of last commit.
40772 All those are extracted from
40774 git log -n 1 --pretty=format:%H%n
40775 \change_inserted 1119979965 1564297427
40781 Tree version information is obtained via
40783 git describe --abbrev --dirty --long
40787 \begin_inset CommandInset ref
40789 reference "subsec:VCS-Revision-Information"
40797 \begin_layout Subsection
40801 \begin_layout Standard
40802 With the recent addition of the
40803 \begin_inset Flex Code
40806 \begin_layout Plain Layout
40812 function \SpecialChar LyX
40813 power users are allowed to create their own commands for revision control.
40816 \begin_layout Standard
40817 As an example you can see how two TortoiseSVN commands could be integrated directly:
40820 \begin_layout Description
40823 \begin_inset Flex Code
40826 \begin_layout Plain Layout
40827 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
40835 \begin_layout Description
40838 \begin_inset Flex Code
40841 \begin_layout Plain Layout
40842 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
40850 \begin_layout Subsection
40851 Version control and Document comparison
40854 \begin_layout Standard
40855 One of the typical uses of version control is to inspect the changes between revisions,
40856 usually by creating
40857 \begin_inset Flex Code
40860 \begin_layout Plain Layout
40867 While this is useful for plain text files,
40868 it is much less useful in the case of \SpecialChar LyX
40870 which have more a complicated structure.
40871 Hence we provide binding to the Document comparison feature.
40872 There are two ways of calling this feature – either by direct call of
40873 \begin_inset Flex Code
40876 \begin_layout Plain Layout
40883 function (for details see \SpecialChar LyX
40884 functions manual) or by the toolbar icon
40898 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 '
40899 \begin_inset Flex Noun
40902 \begin_layout Plain Layout
40908 ' revisions back means comparison of the edited file with last commited revision).
40912 \begin_layout Standard
40913 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,
40914 numbers always point to the last number in RCS revision number,
40917 We don't currently support GIT addressing of revisions,
40918 one can just compare edited document with its revision X steps backs,
40919 where X is addressed as
40920 \begin_inset Flex Code
40923 \begin_layout Plain Layout
40932 \begin_layout Section
40934 \change_inserted 564990737 1672161575
40935 \begin_inset CommandInset label
40937 name "sec:Literate-Programming"
40943 Literate Programming
40946 \begin_layout Standard
40951 (kayvan@sylvan.com)
40956 original documentation written by
40958 Edmar Wienskoski Jr.
40961 (edmar-w-jr@technologist.com)
40964 \begin_layout Subsection
40968 \begin_layout Standard
40969 The main purpose of this documentation is to show you how to use \SpecialChar LyX
40970 for literate programming,
40971 where it is assumed that you are familiar with this programming technique,
40973 \begin_inset Quotes eld
40977 \begin_inset Quotes erd
40981 \begin_inset Quotes eld
40985 \begin_inset Quotes erd
40989 If that is not the case,
40990 please follow the web links provided in the following sections.
40991 There is a lot of good documentation out there covering old development history to the latest tools tips.
40994 \begin_layout Standard
40995 It is also assumed that you are familiar with \SpecialChar LyX
40996 itself to a point that you are comfortable changing your \SpecialChar LyX
40998 and X resources file.
40999 If that is not the case please refer to other \SpecialChar LyX
41000 documentation to cover your specific needs.
41003 \begin_layout Subsection
41004 Literate Programming
41007 \begin_layout Standard
41008 From the Literate Programming FAQ:
41012 \begin_layout Quotation
41013 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
41015 literate programs should be enjoyable reading,
41018 I couldn't resist!) In general,
41019 literate programs combine source and documentation in a single file.
41020 Literate programming tools then parse the file to produce either readable documentation or compilable source.
41021 The WEB style of literate programming was created by D.
41022 \begin_inset space \thinspace{}
41026 Knuth during the development of his \SpecialChar TeX
41027 typesetting software.
41031 \begin_layout Standard
41032 Another excerpt says:
41035 \begin_layout Quotation
41038 How is literate programming different from verbose commenting?
41041 \begin_layout Quotation
41042 There are three distinguishing characteristics.
41043 In order of importance,
41049 \begin_layout Itemize
41050 flexible order of elaboration
41053 \begin_layout Itemize
41054 automatic support for browsing
41057 \begin_layout Itemize
41058 typeset documentation,
41059 especially diagrams and mathematics
41063 \begin_layout Standard
41064 Now that I sparked your curiosity,
41065 take a look in the references.
41068 \begin_layout Subsubsection
41072 \begin_layout Standard
41073 The complete Literate Programming FAQ can be found at:
41076 \begin_layout Quote
41077 Literate Programming FAQ
41078 \begin_inset Flex URL
41081 \begin_layout Plain Layout
41083 http://www.literateprogramming.com/lpfaq.pdf
41091 \begin_layout Standard
41092 The FAQ lists 23 (twenty three!) different literate programming tools.
41093 Where some are specialized or
41094 \begin_inset Quotes eld
41098 \begin_inset Quotes erd
41101 for particular programming languages,
41102 while other have general scope.
41107 for my own use for several reasons:
41110 \begin_layout Itemize
41111 It can generate the documentation either in \SpecialChar LaTeX
41115 \begin_layout Itemize
41116 It has a open architecture,
41118 \begin_inset space \thinspace{}
41122 \begin_inset space \space{}
41125 it is easy to plug in new filters
41129 \begin_layout Plain Layout
41134 are programs that read a given data stream and output a manipulated data stream.
41136 a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
41142 and to perform special processing that you may need.
41146 \begin_layout Itemize
41147 There is a good selection of filters available already (the HTML is one of them).
41150 \begin_layout Itemize
41154 \begin_layout Standard
41155 The Noweb web page can be found at:
41159 \begin_layout Quote
41161 \begin_inset Flex URL
41164 \begin_layout Plain Layout
41166 https://www.cs.tufts.edu/~nr/noweb/
41174 \begin_layout Standard
41175 Starting from there you can reach many other interesting links and even some literate program examples.
41178 \begin_layout Subsection
41180 and Literate Programming with Noweb
41183 \begin_layout Standard
41184 The \SpecialChar LyX
41185 support for Literate Programming is provided by using the generic \SpecialChar LyX
41186 converters mechanism.
41187 This support is provided in a
41188 \begin_inset Quotes eld
41192 \begin_inset Quotes erd
41197 \begin_inset space \thinspace{}
41201 \begin_inset space \space{}
41204 you will be able to use this new \SpecialChar LyX
41205 feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
41209 \begin_layout Subsubsection
41210 Generating documents and code (weaving and tangling)
41213 \begin_layout Paragraph
41214 Using the noweb module
41217 \begin_layout Standard
41218 If you have installed Noweb and \SpecialChar LyX
41220 whenever you open a new document,
41221 after you have chosen its document class,
41224 Document\SpecialChar menuseparator
41228 \begin_inset Quotes eld
41232 \begin_inset Quotes erd
41236 If Noweb is correctly installed,
41237 when you click on the
41238 \begin_inset Quotes eld
41242 \begin_inset Quotes erd
41247 \begin_inset Quotes eld
41251 \begin_inset Quotes erd
41254 module in the available list and you can add it to your document.
41257 \begin_layout Paragraph
41261 \begin_layout Standard
41263 enables you to write code with a custom inset named
41264 \begin_inset Flex Noun
41267 \begin_layout Plain Layout
41274 Noweb delimits chunks like this:
41277 \begin_layout LyX-Code
41281 \begin_layout LyX-Code
41285 \begin_layout LyX-Code
41289 \begin_layout LyX-Code
41293 \begin_layout LyX-Code
41297 \begin_layout Standard
41298 The problem is that whatever is written in between the << and the
41302 must be taken literally,
41304 \begin_inset space \thinspace{}
41308 \begin_inset space \space{}
41312 should be prevented from making any special interpretation of what has been written.
41313 This is also handled by
41314 \begin_inset Flex Noun
41317 \begin_layout Plain Layout
41324 that works like a normal text inset but has a free spacing capability.
41327 \begin_layout Standard
41329 you can also use the
41330 \begin_inset Quotes eld
41334 \begin_inset Quotes erd
41337 construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
41340 \begin_layout LyX-Code
41344 \begin_layout LyX-Code
41345 def some_function(args):
41348 \begin_layout LyX-Code
41349 "This is the doc string for this function."
41352 \begin_layout LyX-Code
41358 \begin_layout LyX-Code
41359 @ %def some_function
41362 \begin_layout Standard
41363 For an example of this usage and the resulting cross-reference output,
41364 look at the Literate python program in
41366 LIBDIR/examples/listerrors.lyx
41368 which should make this all clear.
41371 \begin_layout Paragraph
41372 Generating the documentation
41375 \begin_layout Standard
41376 At this point you already have a new document file with a proper document class,
41377 and with some code and text on it.
41379 The answer is simple,
41382 View\SpecialChar menuseparator
41387 Just like you would do for a plain document.
41388 No special procedure is required.
41391 \begin_layout Standard
41392 To help orientate you,
41393 I will now explain what happens inside \SpecialChar LyX
41397 \begin_layout Enumerate
41400 Update\SpecialChar menuseparator
41403 menu option is chosen,
41404 a \SpecialChar LaTeX
41410 \begin_layout Standard
41411 If the document is of any literate class the generated file will be named with an extension name defined by the
41412 \begin_inset Quotes eld
41416 \begin_inset Quotes erd
41419 format (defined in the Preferences panel),
41420 otherwise the file will have the usual
41428 \begin_layout Enumerate
41429 Note that the only difference so far is in the name of the file,
41430 no special processing is required by \SpecialChar LyX
41432 Given that you formatted the code using the
41433 \begin_inset Flex Noun
41436 \begin_layout Plain Layout
41444 takes care of the business.
41447 \begin_layout Enumerate
41448 If the document is of any literate class \SpecialChar LyX
41449 will then use the internal \SpecialChar LyX
41450 to Noweb converter,
41451 followed by the Noweb to \SpecialChar LaTeX
41456 \begin_layout Plain Layout
41457 The converters are defined in the
41459 Tools\SpecialChar menuseparator
41464 \begin_inset Quotes eld
41468 \begin_inset Quotes erd
41480 manual for general information about converters.
41485 to generate the \SpecialChar LaTeX
41490 \begin_layout Standard
41491 Otherwise it will just skip this step.
41495 \begin_layout Enumerate
41498 is invoked and the regular post processing continues as in a plain document.
41501 \begin_layout Standard
41502 Independence from a particular
41503 \begin_inset Quotes eld
41507 \begin_inset Quotes erd
41510 is easily achieved by changing the commands that are run by the various converters.
41513 \begin_layout Paragraph
41514 Generating the code
41517 \begin_layout Standard
41518 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
41519 a \SpecialChar LaTeX
41520 file is generated just like step 1 above.
41528 This converter needs to be defined by the user and is not installed by default,
41529 though the Program format is.
41530 This converter (like any other converter) will have two parts:
41533 \begin_layout Enumerate
41534 The converter program itself.
41535 This program performs the conversion from the one format to the other (in this case,
41536 from the Noweb format to the Program pseudo-format).
41539 \begin_layout Enumerate
41540 The error log parser.
41541 This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
41543 This makes it possible for \SpecialChar LyX
41544 to place error boxes in the right places in the file buffer.
41547 \begin_layout Standard
41550 \begin_inset Quotes eld
41554 \begin_inset Quotes erd
41561 \begin_layout LyX-Code
41569 \begin_layout Standard
41570 This basically means that \SpecialChar LyX
41572 \begin_inset Quotes eld
41576 \begin_inset Quotes erd
41579 (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
41580 temp directory) and the directory path of the original \SpecialChar LyX
41585 \begin_layout Standard
41586 This is an implementation of
41587 \begin_inset Quotes eld
41591 \begin_inset Quotes erd
41594 that you can place in a directory on your path:
41597 \begin_layout LyX-Code
41603 \begin_layout LyX-Code
41609 \begin_layout LyX-Code
41612 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
41615 \begin_layout Standard
41616 The next part of the converter setting is the
41617 \begin_inset Quotes eld
41621 \begin_inset Quotes erd
41624 which is to be set to
41627 \begin_layout LyX-Code
41630 parselog=$$s/scripts/listerrors
41633 \begin_layout Standard
41634 This will run any errors that are generated by the
41635 \begin_inset Quotes eld
41639 \begin_inset Quotes erd
41642 process through the
41643 \begin_inset Quotes eld
41647 \begin_inset Quotes erd
41653 \begin_layout Standard
41654 The build will normally take place in \SpecialChar LyX
41655 's temporary directory,
41656 so the files produced by the conversion will be in that directory.
41658 will copy out what it regards as the `main' file,
41663 conversion may produce several files,
41664 and so most of these would then be deleted when \SpecialChar LyX
41666 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.
41669 \begin_layout Paragraph
41670 Build instructions in the document
41673 \begin_layout Standard
41674 The last piece of the integration between \SpecialChar LyX
41676 \begin_inset Quotes eld
41680 \begin_inset Quotes erd
41685 the instructions for building your program should be embedded in a chunk of its own.
41687 \begin_inset Quotes eld
41691 \begin_inset Quotes erd
41694 above uses the notangle command to look for this chunk (called
41695 \begin_inset Quotes eld
41699 \begin_inset Quotes erd
41702 ) and runs its contents through
41703 \begin_inset Quotes eld
41707 \begin_inset Quotes erd
41713 \begin_layout Standard
41715 such a chunk would look something like this:
41718 \begin_layout LyX-Code
41722 \begin_layout LyX-Code
41724 \begin_inset Newline newline
41727 if [ -z "${NOWEB_SOURCE}" ]
41728 \begin_inset Newline newline
41734 \begin_layout LyX-Code
41735 NOWEB_SOURCE=myfile.nw
41736 \begin_inset Newline newline
41740 \begin_inset Newline newline
41744 code to extract files ...
41745 use NOWEB_OUTPUT_DIR here ...]
41746 \begin_inset Newline newline
41750 code to compile files ...]
41751 \begin_inset Newline newline
41757 \begin_layout Standard
41759 \change_deleted 564990737 1672161716
41762 LIBDIR/examples/listerrors.lyx
41766 LIBDIR/examples/Literate.lyx
41767 \change_inserted 564990737 1672161716
41771 File\SpecialChar menuseparator
41772 Open Example\SpecialChar menuseparator
41773 Modules\SpecialChar menuseparator
41779 \change_inserted -712698321 1674917096
41782 File\SpecialChar menuseparator
41783 Open Example\SpecialChar menuseparator
41784 Modules\SpecialChar menuseparator
41790 \change_deleted 564990737 1672161729
41794 \begin_inset Quotes eld
41798 \begin_inset Quotes erd
41801 program for some illustrations of how all of these pieces go together
41802 \change_deleted -712698321 1674917093
41804 \change_deleted 564990737 1672161756
41807 LIBDIR/examples/noweb2lyx.lyx
41808 \change_deleted -712698321 1674917093
41812 File\SpecialChar menuseparator
41813 Open Example\SpecialChar menuseparator
41814 Modules\SpecialChar menuseparator
41815 Noweb2\SpecialChar LyX
41826 \change_deleted 564990737 1672161767
41829 files show off the language-indepence of the \SpecialChar LyX
41830 literate programming support since they are written in Python
41831 \change_deleted 564990737 1672161782
41835 and Perl respectively.
41838 \begin_layout Subsubsection
41839 Configuring \SpecialChar LyX
41843 \begin_layout Standard
41844 All the Literate Programming support is configured by the
41846 Tools\SpecialChar menuseparator
41850 \begin_inset Quotes eld
41854 \begin_inset Quotes erd
41858 The important parts are:
41861 \begin_layout Description
41863 \begin_inset space ~
41867 \begin_inset Quotes eld
41871 \begin_inset Quotes erd
41875 \begin_inset space ~
41878 format Set up via the File Formats tab,
41879 this is where the Noweb-specific pieces are set up.
41889 the file extension is set to
41894 This tells \SpecialChar LyX
41895 to create a file with a
41899 extension in the first step of the conversion process.
41902 \begin_layout Description
41904 \begin_inset space ~
41912 \begin_inset space ~
41915 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).
41918 \begin_layout Description
41928 This converter performs the
41929 \begin_inset Quotes eld
41933 \begin_inset Quotes erd
41936 of the literate document.
41939 \begin_inset Quotes eld
41944 noweave -delay -index $$i > $$o
41947 \begin_inset Quotes erd
41953 \begin_layout Description
41963 \begin_inset Quotes eld
41967 \begin_inset Quotes erd
41972 the Converter is set to
41973 \begin_inset Quotes eld
41981 \begin_inset Quotes erd
41986 \begin_inset Newline newline
41990 \begin_inset Quotes eld
41995 parselog=$$s/scripts/listerrors
41998 \begin_inset Quotes erd
42004 \begin_layout Subsubsection
42008 \begin_layout Standard
42009 There is also a new function implemented in the \SpecialChar LyX
42012 \begin_inset Quotes eld
42015 server-goto-file-row" function,
42016 to be used with ddd/gdb or other debugger.
42020 \begin_layout Standard
42021 When debugging code with ddd/gdb,
42022 it is possible to invoke a text editor at the current execution position with a single key stroke.
42023 The default ddd configuration for that is shift-ctrl-V.
42024 It happens that you can define the editor command line invocation in ddd by accessing the
42026 Edit\SpecialChar menuseparator
42027 Preferences\SpecialChar menuseparator
42030 dialog and changing the "Edit Sources" entry.
42033 \begin_layout Standard
42034 I take advantage of the newly created \SpecialChar LyX
42035 server function and this ddd feature,
42037 \begin_inset Quotes eld
42041 \begin_inset Quotes erd
42047 \begin_layout LyX-Code
42048 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
42051 \begin_layout Standard
42053 whenever you are using ddd and find a point in the program that you want to edit,
42054 you just press shift-ctrl-V (in the ddd window),
42055 and ddd will forward this information to \SpecialChar LyX
42056 through the \SpecialChar LyX
42057 server and then the \SpecialChar LyX
42058 window will show the same file with the cursor at the same position ddd was pointing to.
42059 No more guessing or long scrolling to locate a point in the program back from debugging !
42062 \begin_layout Standard
42063 Note however that you must enable the \SpecialChar LyX
42064 server to get this feature working (it is disabled by default).
42066 \begin_inset space ~
42070 \begin_inset CommandInset ref
42072 reference "sec:Starting-the-Server"
42077 explains how to do that.
42080 \begin_layout Subsubsection
42084 \begin_layout Standard
42085 There are six new buttons that can be added to your \SpecialChar LyX
42087 Four of these buttons are short cuts to layout styles:
42110 one for the custom inset
42115 The last one is a short cut to the
42116 \begin_inset Quotes eld
42120 \begin_inset Quotes erd
42127 \begin_layout Standard
42129 has a range of buttons that are available for tool bar customization.
42130 In my toolbar I like to combine the six short cuts above with two more:
42135 \SpecialChar menuseparator
42140 \SpecialChar menuseparator
42147 Document\SpecialChar menuseparator
42148 View\SpecialChar menuseparator
42152 Here is how it looks like:
42155 \begin_layout LyX-Code
42159 \begin_layout LyX-Code
42163 \begin_layout LyX-Code
42164 Icon "layout Standard"
42167 \begin_layout LyX-Code
42168 Icon "layout Section"
42171 \begin_layout LyX-Code
42172 Icon "layout \SpecialChar LaTeX
42176 \begin_layout LyX-Code
42177 Icon "layout \SpecialChar LyX
42181 \begin_layout LyX-Code
42182 Icon "flex.insert Chunk"
42185 \begin_layout LyX-Code
42189 \begin_layout LyX-Code
42193 \begin_layout LyX-Code
42194 Icon "buffer-typeset"
42197 \begin_layout LyX-Code
42198 Icon "build-program"
42201 \begin_layout LyX-Code
42205 \begin_layout LyX-Code
42209 \begin_layout LyX-Code
42213 \begin_layout LyX-Code
42217 \begin_layout LyX-Code
42221 \begin_layout Subsubsection
42222 Colors customization
42225 \begin_layout Standard
42226 There are a number of colors in \SpecialChar LyX
42227 that can be customized in
42232 One of the things that bothers people is the \SpecialChar LaTeX
42234 The default color is red,
42235 since the chunks uses \SpecialChar LaTeX
42237 and there is a lot of chunks in literate documents,
42238 you may get tired of seeing everything in red.
42239 You can change it by going to the tabs
42249 \begin_layout Standard
42250 The next thing is the visible presence of the newline character in the screen.
42251 You can choose the color of this particular character and make it blend in the background.
42252 I recommend you choosing a color that is close to the background but not equal,
42253 that way you still can see it is there,
42254 but it is not bothering you anymore.
42257 \begin_layout Subsection
42262 \begin_layout Standard
42272 \change_inserted 564990737 1672161863
42275 Help\SpecialChar menuseparator
42276 Specific Manuals\SpecialChar menuseparator
42282 \change_deleted 564990737 1671643409
42288 \change_inserted 564990737 1672161856
42291 File\SpecialChar menuseparator
42292 Open Example\SpecialChar menuseparator
42293 Modules\SpecialChar menuseparator
42299 \change_deleted 564990737 1671643461
42300 the Sweave manual (menu
42302 Help\SpecialChar menuseparator
42306 \change_inserted 564990737 1672161856
42309 Help\SpecialChar menuseparator
42310 Specific Manuals\SpecialChar menuseparator
42312 \change_deleted 564990737 1672161921
42317 \change_inserted 564990737 1672161917
42320 File\SpecialChar menuseparator
42321 Open Example\SpecialChar menuseparator
42322 Modules\SpecialChar menuseparator
42326 \change_deleted 564990737 1672742969
42330 \begin_layout Standard
42332 \change_deleted 564990737 1671355343
42336 \begin_layout Standard
42338 \change_deleted 564990737 1671355343
42339 You can do everything with \SpecialChar LyX
42340 that you can do with \SpecialChar LaTeX
42344 cannot support every \SpecialChar LaTeX
42346 But you can always use \SpecialChar TeX
42348 This chapter shows you some more special things you might want to use.
42349 For other special things you can do with figures,
42356 \begin_inset space ~
42362 \change_inserted -712698321 1674917293
42366 \begin_layout Standard
42368 \change_inserted -712698321 1674917303
42369 \begin_inset CommandInset index_print
42370 LatexCommand printindex