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 564990737 "John Lyx"
142 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
143 \author 1075283030 "Thibaut"
144 \author 1119979965 "Joel A. Kulesza"
150 Additional \SpecialChar LyX
154 \begin_layout Subtitle
156 \change_deleted 630872221 1622909155
158 \change_inserted 630872221 1622909155
165 by the \SpecialChar LyX
170 \begin_layout Plain Layout
172 Principal maintainer of this file is
174 Richard Kimberly Heck
177 If you have comments or error corrections,
178 please send them to the \SpecialChar LyX
179 Documentation mailing list,
181 \begin_inset Flex Code
184 \begin_layout Plain Layout
185 <lyx-docs@lists.lyx.org>
198 \begin_layout Standard
199 \begin_inset CommandInset toc
200 LatexCommand tableofcontents
207 \begin_layout Standard
209 \change_inserted 5863208 1672865652
210 \begin_inset Note Note
213 \begin_layout Plain Layout
215 \change_inserted 5863208 1672865674
216 Note to all translators:
219 \begin_layout Plain Layout
221 \change_inserted 5863208 1672865817
222 This manual was restructured for LyX 2.4.
223 Attached are notes for translators to help them to find their way round the new structure of Additional.lyx.
224 This note itself will be deleted in the final 2.4 release.
225 \begin_inset Newline newline
231 \begin_layout Plain Layout
233 \change_inserted 5863208 1672865801
236 Additional.lyx 2.4 Changes
239 \begin_layout Itemize
241 \change_inserted 5863208 1672865801
246 \begin_layout Itemize
248 \change_inserted 5863208 1672865801
253 \begin_layout Itemize
255 \change_inserted 5863208 1672865801
262 \begin_layout Itemize
264 \change_inserted 5863208 1672865801
266 moved and minor edits
269 \begin_layout Itemize
271 \change_inserted 5863208 1672865801
276 \begin_layout Itemize
278 \change_inserted 5863208 1672865801
283 \begin_layout Itemize
285 \change_inserted 5863208 1672865801
290 \begin_layout Itemize
292 \change_inserted 5863208 1672865801
294 moved and significant edits
297 \begin_layout Itemize
299 \change_inserted 5863208 1672865801
304 \begin_layout Itemize
306 \change_inserted 5863208 1672865801
311 \begin_layout Itemize
313 \change_inserted 5863208 1672865801
315 moved and minor edits
318 \begin_layout Itemize
320 \change_inserted 5863208 1672865801
325 \begin_layout Itemize
327 \change_inserted 5863208 1672865801
332 \begin_layout Itemize
334 \change_inserted 5863208 1672865801
339 \begin_layout Itemize
341 \change_inserted 5863208 1672865801
346 \begin_layout Itemize
348 \change_inserted 5863208 1672865824
353 \begin_layout Itemize
355 \change_inserted 5863208 1672865831
360 \begin_layout Itemize
362 \change_inserted 5863208 1672865831
367 \begin_layout Itemize
369 \change_inserted 5863208 1672865831
374 \begin_layout Itemize
376 \change_inserted 5863208 1672865831
381 \begin_layout Itemize
383 \change_inserted 5863208 1672865831
388 \begin_layout Itemize
390 \change_inserted 5863208 1672865831
395 \begin_layout Itemize
397 \change_inserted 5863208 1672865831
399 moved with minor edits
402 \begin_layout Itemize
404 \change_inserted 5863208 1672865831
409 \begin_layout Itemize
411 \change_inserted 5863208 1672865831
416 \begin_layout Itemize
418 \change_inserted 5863208 1672865831
420 moved with minor edits
423 \begin_layout Itemize
425 \change_inserted 5863208 1672865831
430 \begin_layout Itemize
432 \change_inserted 5863208 1672865831
437 \begin_layout Itemize
439 \change_inserted 5863208 1672865831
444 \begin_layout Itemize
446 \change_inserted 5863208 1672865831
447 (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.)
451 \begin_layout Itemize
453 \change_inserted 5863208 1672865831
460 \begin_layout Itemize
462 \change_inserted 5863208 1672865831
463 All module descriptions new except:
466 \begin_layout Itemize
468 \change_inserted 5863208 1672865831
470 moved with minor edits
473 \begin_layout Itemize
475 \change_inserted 5863208 1672865831
476 Custom header/footer text:
477 moved with minor edits
480 \begin_layout Itemize
482 \change_inserted 5863208 1672865831
484 moved with minor edits
487 \begin_layout Itemize
489 \change_inserted 5863208 1672865831
490 Custom paragraph shapes:
491 moved with minor edits
494 \begin_layout Itemize
496 \change_inserted 5863208 1672865831
498 moved with minor edits
502 \begin_layout Itemize
504 \change_inserted 5863208 1672865831
511 \begin_layout Itemize
513 \change_inserted 5863208 1672865831
514 Content moved but unchanged
518 \begin_layout Itemize
520 \change_inserted 5863208 1672865831
527 \begin_layout Itemize
529 \change_inserted 5863208 1672865845
530 Content moved but unchanged
534 \begin_layout Itemize
536 \change_inserted 5863208 1672865845
539 new chapter and content
542 \begin_layout Itemize
544 \change_inserted 5863208 1672865845
545 All other chapters unchanged but renumbered except:
548 \begin_layout Itemize
550 \change_inserted 5863208 1672865845
551 section 11.3 Literate programming:
562 \begin_layout Chapter
566 \begin_layout Standard
567 This manual is essentially Part II of the
569 User's Guide\SpecialChar endofsentence
572 The reason for separating the two documents is simple:
577 is already quite lengthy,
578 and it contains information on all of the basic features one needs to know in order to prepare most documents.
581 Team has worked to make \SpecialChar LyX
582 extensible through various configuration files and external packages.
583 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
585 you can create a layout file (or module) for it without having to alter \SpecialChar LyX
587 We've already had contributions of several new features this way,
588 and some of them are documented here.
589 There are also some more `advanced' features,
590 such as how to control the presentation of bibliographies and how to work with multi-part documents,
591 that are not covered in the
595 and are discussed here.
598 \begin_layout Standard
599 This manual also documents some special features,
601 \change_deleted 244031559 1603802929
604 \change_inserted 244031559 1603802931
608 \change_deleted 244031559 1603802954
613 which require additional software to work properly.
614 There is also a chapter on \SpecialChar LyX
617 there's a chapter of \SpecialChar LaTeX
619 things you can use to spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
627 only WYSIWYM and will only ever interface to some,
633 \begin_layout Standard
634 If you haven't read the
639 you are definitely in the wrong manual.
644 is the first place to go,
645 since it describes the notation and format of all of the manuals.
646 You should also be thoroughly familiar with the
650 and all of the basic features of \SpecialChar LyX
651 before attempting to read this one.
654 \begin_layout Standard
655 Since many of the topics in this manual depend heavily on \SpecialChar LyX
656 's interaction with \SpecialChar LaTeX
658 this first chapter covers the inner workings of \SpecialChar LyX
659 and how to direct \SpecialChar LyX
660 to generate exactly the \SpecialChar LaTeX
662 It is obviously for more seasoned \SpecialChar LyX
666 \begin_layout Chapter
668 and \SpecialChar LaTeX
672 \begin_layout Section
674 Uses \SpecialChar LaTeX
678 \begin_layout Standard
679 This chapter is for both \SpecialChar TeX
680 -nicians and the \SpecialChar LaTeX
683 we'll explain how \SpecialChar LyX
684 and \SpecialChar LaTeX
685 work together to produce printable output.
686 This is the only place in any of the manuals where we assume you know something about \SpecialChar LaTeX
690 \begin_layout Standard
694 \begin_inset Quotes eld
697 WYSIWYM frontend to \SpecialChar LaTeX
699 \begin_inset Quotes erd
702 but that's no longer true.
703 There are frontends to \SpecialChar LaTeX
708 \begin_layout Plain Layout
709 Some familar ones are \SpecialChar TeX
715 There are also the \SpecialChar LaTeX
716 modes for vi and emacs,
722 These are basically text editors with the ability to run \SpecialChar LaTeX
723 and mark any errors in the file you're editing.
724 Although \SpecialChar LyX
734 run \SpecialChar LaTeX
736 and it also indicates errors in the file,
740 you don't need to know \SpecialChar LaTeX
741 to use \SpecialChar LyX
744 has added its own extensions to \SpecialChar LaTeX
746 Try the following sometime:
748 \begin_inset Flex Noun
751 \begin_layout Plain Layout
752 Export\SpecialChar menuseparator
759 \begin_inset Flex Noun
762 \begin_layout Plain Layout
769 \begin_inset Flex Noun
772 \begin_layout Plain Layout
773 View\SpecialChar menuseparator
784 then look at the preamble of the resulting
785 \begin_inset Flex Code
788 \begin_layout Plain Layout
795 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
797 These macros are defined automatically,
798 according to the features you use in the document.
801 \begin_layout Standard
802 There are several commands that automatically invoke \SpecialChar LaTeX
807 \begin_layout Itemize
808 \begin_inset Flex Noun
811 \begin_layout Plain Layout
812 Document\SpecialChar menuseparator
821 \begin_layout Itemize
822 \begin_inset Flex Noun
825 \begin_layout Plain Layout
826 Document\SpecialChar menuseparator
835 \begin_layout Standard
836 They will only invoke \SpecialChar LaTeX
837 if the file has changed since the last time \SpecialChar LaTeX
842 \begin_layout Standard
843 When \SpecialChar LyX
844 runs \SpecialChar LaTeX
845 on the file you're editing,
846 it performs these steps:
849 \begin_layout Enumerate
850 Convert the document to \SpecialChar LaTeX
851 and save to a file with the extension
852 \begin_inset Flex Code
855 \begin_layout Plain Layout
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
874 \begin_layout Enumerate
875 Run \SpecialChar LaTeX
877 \begin_inset Flex Code
880 \begin_layout Plain Layout
886 file (maybe several times),
887 and run any other commands (such as
888 \begin_inset Flex Code
891 \begin_layout Plain Layout
898 \begin_inset Flex Code
901 \begin_layout Plain Layout
907 ) needed to compile the \SpecialChar LaTeX
911 \begin_layout Enumerate
912 If there are any errors,
916 \begin_layout Standard
917 If you have run \SpecialChar LaTeX
919 \begin_inset Flex Noun
922 \begin_layout Plain Layout
923 View\SpecialChar menuseparator
931 then runs a DVI viewer to display the DVI-file.
933 \begin_inset Flex Noun
936 \begin_layout Plain Layout
937 View\SpecialChar menuseparator
945 performs further steps:
948 \begin_layout Enumerate
950 \begin_inset Flex Code
953 \begin_layout Plain Layout
959 to convert the DVI file to PostScript.
962 \begin_layout Enumerate
963 Run a PostScript viewer,
965 \begin_inset Flex Code
968 \begin_layout Plain Layout
975 to display the PostScript file.
978 \begin_layout Standard
980 does similar things when viewing,
985 \begin_layout Section
986 Translating \SpecialChar LaTeX
987 files into \SpecialChar LyX
991 \begin_layout Standard
992 You can import a \SpecialChar LaTeX
993 file into \SpecialChar LyX
995 \begin_inset Flex Noun
998 \begin_layout Plain Layout
999 File\SpecialChar menuseparator
1000 Import\SpecialChar menuseparator
1006 command in \SpecialChar LyX
1008 This will call a program named
1009 \begin_inset Flex Code
1012 \begin_layout Plain Layout
1018 which will create a file
1019 \begin_inset Flex Code
1022 \begin_layout Plain Layout
1029 \begin_inset Flex Code
1032 \begin_layout Plain Layout
1040 will then open that file.
1044 \begin_layout Plain Layout
1045 \begin_inset Flex Code
1048 \begin_layout Plain Layout
1054 can also be run from the command line,
1063 \begin_layout Standard
1064 \begin_inset Flex Code
1067 \begin_layout Plain Layout
1073 will translate most legal \SpecialChar LaTeX
1076 It will put things it doesn't understand into \SpecialChar TeX
1078 so after translating a file with
1079 \begin_inset Flex Code
1082 \begin_layout Plain Layout
1089 you can look for \SpecialChar TeX
1090 code and hand-edit it until it looks right.
1093 \begin_layout Standard
1094 If you don't know what \SpecialChar TeX
1096 read the next section.
1099 \begin_layout Section
1100 \begin_inset CommandInset label
1102 name "sec:Inserting-TeX-Code"
1106 Inserting \SpecialChar TeX
1107 Code into \SpecialChar LyX
1111 \begin_layout Standard
1112 Anything you can do in \SpecialChar LaTeX
1113 you can do in \SpecialChar LyX
1115 for a very simple reason:
1116 You can always insert \SpecialChar TeX
1117 code into any \SpecialChar LyX
1121 and will never be able to,
1122 display every possible \SpecialChar LaTeX
1124 If ever you need to insert \SpecialChar LaTeX
1125 commands into your \SpecialChar LyX
1128 \begin_inset Flex Code
1131 \begin_layout Plain Layout
1139 which you can insert into your document with
1140 \begin_inset Flex Noun
1143 \begin_layout Plain Layout
1144 Insert\SpecialChar menuseparator
1154 or the keyboard shortcut
1163 \begin_layout Standard
1164 Here's an example of inserting \SpecialChar LaTeX
1165 commands in a \SpecialChar LyX
1167 The code looks like this:
1170 \begin_layout LyX-Code
1174 \begin_inset Newline newline
1179 begin{minipage}{5cm}
1180 \begin_inset Newline newline
1183 This is an example of a minipage environment.
1185 \begin_inset Newline newline
1188 can put nearly everything in it,
1190 \begin_inset Newline newline
1195 \begin_inset Newline newline
1201 \begin_inset Newline newline
1205 \begin_inset Newline newline
1210 begin{minipage}{5cm}
1211 \begin_inset Newline newline
1217 \begin_inset Newline newline
1222 begin{minipage}{5cm}
1223 \begin_inset Newline newline
1228 \begin_inset Newline newline
1234 \begin_inset Newline newline
1240 \begin_inset Newline newline
1246 \begin_inset Newline newline
1254 \begin_layout LyX-Code
1258 \begin_layout Standard
1260 \begin_inset Flex Code
1263 \begin_layout Plain Layout
1270 box containing this text is directly after this paragraph.
1271 Those of you reading the manual in \SpecialChar LyX
1272 will only see the \SpecialChar TeX
1274 Those reading a printed version of the manuals will see the actual results:
1275 \begin_inset VSpace bigskip
1281 \begin_layout Standard
1285 \begin_layout Plain Layout
1292 \begin_layout Plain Layout
1296 begin{minipage}{5cm}
1299 \begin_layout Plain Layout
1301 This is an example of a minipage environment.
1302 You can put nearly everything in it,
1303 even (non-floating) figures and tables.
1307 \begin_layout Plain Layout
1314 \begin_layout Plain Layout
1319 \begin_layout Plain Layout
1323 begin{minipage}{5cm}
1326 \begin_layout Plain Layout
1333 \begin_layout Plain Layout
1337 begin{minipage}{5cm}
1340 \begin_layout Plain Layout
1346 \begin_layout Plain Layout
1353 \begin_layout Plain Layout
1360 \begin_layout Plain Layout
1367 \begin_layout Plain Layout
1377 \begin_inset VSpace bigskip
1383 \begin_layout Standard
1384 In addition to using \SpecialChar TeX
1386 you can also create a separate file containing some complex \SpecialChar LaTeX
1387 structure and then use
1388 \begin_inset Flex Noun
1391 \begin_layout Plain Layout
1392 Insert\SpecialChar menuseparator
1394 \begin_inset space ~
1402 to include your file (you should select the type
1403 \begin_inset Flex Code
1406 \begin_layout Plain Layout
1413 We recommend that you only do this if you have a
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1429 you'll have a big job tracking down \SpecialChar LaTeX
1433 \begin_layout Standard
1434 There are a few last points to emphasize:
1437 \begin_layout Itemize
1443 check if your \SpecialChar LaTeX
1447 \begin_layout Itemize
1448 Beware of reinventing the wheel.
1451 \begin_layout Standard
1454 does have quite a few features tucked into it,
1455 and more are coming.
1456 Be sure to check the manuals to make sure that \SpecialChar LyX
1457 doesn't have such-and-such feature before you decide you have to do it by hand.
1459 there are numerous \SpecialChar LaTeX
1460 packages out there to do all sorts of things,
1461 from labels to envelopes to fancy multipage tables.
1463 \change_inserted 244031559 1603815732
1465 \begin_inset CommandInset href
1468 target "https://www.ctan.org/"
1474 \change_deleted 244031559 1603815732
1476 \begin_inset CommandInset href
1479 target "http://www.ctan.org/"
1489 \begin_layout Standard
1490 If you do need to do some wild and fancy things within your document,
1491 be sure to check out a good \SpecialChar LaTeX
1492 book for assistance.
1493 There are a number of them listed in the bibliography of the
1500 \begin_layout Section
1502 and the \SpecialChar LaTeX
1506 \begin_layout Subsection
1507 About the \SpecialChar LaTeX
1511 \begin_layout Standard
1512 If you already know \SpecialChar LaTeX
1514 there is no need to explain here what the preamble is good for.
1516 the following will give you some ideas—
1517 we recommend again that you consult a \SpecialChar LaTeX
1518 book for further information.
1520 you should read the points below,
1521 because they explain what you can do and what you don't need to do in the \SpecialChar LaTeX
1522 preamble of a \SpecialChar LyX
1526 \begin_layout Standard
1527 The \SpecialChar LaTeX
1528 preamble comes at the very beginning of a document,
1537 \begin_layout Itemize
1538 Declare the document class.
1540 \begin_inset Newline newline
1544 already does this for you.
1545 If you're a seasoned \SpecialChar LaTeX
1547 and you have a custom document class you want to use,
1550 Customization Manual
1552 for information on how to make \SpecialChar LyX
1556 \begin_layout Itemize
1557 Declare the usage of packages.
1559 \begin_inset Newline newline
1563 packages provide special commands,
1564 which are only available within a document when the package has been declared in the preamble.
1565 In addition to providing special commands,
1566 the inclusion of a package can change the document.
1569 \begin_inset Flex Code
1572 \begin_layout Plain Layout
1578 forces all paragraphs to be indented.
1579 There are other packages for labels,
1586 \begin_layout Itemize
1591 \begin_inset Newline newline
1594 There are several \SpecialChar LaTeX
1595 counters and variables that
1599 be set globally from within the preamble in order to have the desired effect.
1600 (There are variables that you can set and reset inside the document,
1601 too.) Margins are a good example of something that must be set in the preamble.
1602 Another example is the label format for lists.
1603 You can actually set these just about anywhere,
1604 but it's best to do it just once,
1605 inside the preamble.
1608 \begin_layout Itemize
1609 Declare user defined commands (with
1610 \begin_inset Flex Code
1613 \begin_layout Plain Layout
1622 \begin_inset Flex Code
1625 \begin_layout Plain Layout
1634 \begin_inset Newline newline
1637 These are abbreviations for \SpecialChar LaTeX
1638 commands which appear very often inside a document.
1639 Although the preamble is a good place to declare such commands,
1644 be declared anywhere (before they are used for the first time,
1646 This can be useful if there is a lot of raw \SpecialChar LaTeX
1647 code in your document,
1648 which normally should not be the case.
1651 \begin_layout Standard
1653 adds its own set of definitions to the preamble of the
1654 \begin_inset Flex Code
1657 \begin_layout Plain Layout
1664 This makes \SpecialChar LaTeX
1665 files generated by \SpecialChar LyX
1669 \begin_layout Subsection
1670 Changing the Preamble
1673 \begin_layout Standard
1674 The commands which \SpecialChar LyX
1675 adds to the preamble of a \SpecialChar LaTeX
1677 you can't change them without patching \SpecialChar LyX
1681 add your own stuff to the preamble by selecting
1682 \begin_inset Flex Noun
1685 \begin_layout Plain Layout
1688 \begin_inset space ~
1697 \begin_inset Flex Noun
1700 \begin_layout Plain Layout
1701 Document\SpecialChar menuseparator
1709 adds anything in the
1710 \begin_inset Flex Noun
1713 \begin_layout Plain Layout
1719 dialog to its own built-in preamble.
1720 Before adding your own declarations in the preamble,
1721 you should make sure that \SpecialChar LyX
1722 doesn't already support what you want to do.
1723 (Remember what we said about reinventing the wheel?) Also,
1726 make sure your preamble code is correct
1730 doesn't check it for you.
1731 If there is an error,
1732 you're likely to get an error like
1733 \begin_inset Quotes eld
1737 \begin_inset Flex Code
1740 \begin_layout Plain Layout
1749 \begin_inset Quotes erd
1753 If you see this error,
1754 check your preamble.
1757 \begin_layout Subsection
1761 \begin_layout Standard
1762 Here are some examples of what you can add to a preamble,
1766 \begin_layout Subsubsection
1771 \begin_layout Standard
1772 There are two variables under \SpecialChar LaTeX
1773 that control page position:
1775 \begin_inset Flex Code
1778 \begin_layout Plain Layout
1787 \begin_inset Flex Code
1790 \begin_layout Plain Layout
1799 Their names should be self-explanatory.
1800 These variables are useful if you think for a moment about computer labels.
1802 the size of a print medium and the area of the medium that you can actually print on aren't the same.
1804 \begin_inset Flex Code
1807 \begin_layout Plain Layout
1816 \begin_inset Flex Code
1819 \begin_layout Plain Layout
1830 \begin_layout Standard
1831 The default values for
1832 \begin_inset Flex Code
1835 \begin_layout Plain Layout
1844 \begin_inset Flex Code
1847 \begin_layout Plain Layout
1856 \begin_inset space \thinspace{}
1861 \begin_inset space \thinspace{}
1865 \begin_inset space \space{}
1868 the page isn't shifted.
1870 some DVI drivers always seem to shift the page.
1871 We have no idea why,
1872 or why the sysadmin hasn't fixed such behavior.
1873 If you're using \SpecialChar LyX
1874 on a system that you don't personally maintain,
1875 and your sysadmin is a doofus,
1877 \begin_inset Flex Code
1880 \begin_layout Plain Layout
1889 \begin_inset Flex Code
1892 \begin_layout Plain Layout
1901 Suppose your left and top margins are always 0.5
1902 \begin_inset space \thinspace{}
1906 You can add this to the preamble:
1909 \begin_layout LyX-Code
1917 \begin_layout LyX-Code
1925 \begin_layout Standard
1926 and your margins should now be correct.
1929 \begin_layout Subsubsection
1934 \begin_layout Standard
1936 suppose you wanted to print out a bunch of address labels.
1937 There's a rather nice package,
1938 available at your nearest CTAN archive,
1939 for printing sheets of labels:
1941 \begin_inset Flex Code
1944 \begin_layout Plain Layout
1952 your system may not have this package installed by default.
1953 We leave that up to you to check.
1954 You'll also want to read the documentation for it;
1955 we're not going to do that for you.
1956 Since this is an example,
1958 we'll give you an example of how you use this package.
1961 \begin_layout Standard
1963 make sure you're using the
1964 \begin_inset Flex Code
1967 \begin_layout Plain Layout
1975 you need to put the following in your preamble:
1978 \begin_layout LyX-Code
1984 \begin_layout LyX-Code
1990 \begin_layout LyX-Code
1996 \begin_layout LyX-Code
2002 \begin_layout LyX-Code
2008 \begin_layout LyX-Code
2014 \begin_layout LyX-Code
2020 \begin_layout Standard
2021 This sets things up for Avery label sheets,
2023 You're now ready to print labels,
2024 but you'll need to insert \SpecialChar LaTeX
2026 placing the commands
2027 \begin_inset Flex Code
2030 \begin_layout Plain Layout
2039 \begin_inset Flex Code
2042 \begin_layout Plain Layout
2050 around each label text.
2051 This and other special features of
2052 \begin_inset Flex Code
2055 \begin_layout Plain Layout
2061 are explained in its documentation.
2064 \begin_layout Standard
2066 someone may write a \SpecialChar LyX
2067 layout file to support this package directly.
2068 Maybe that someone is you.
2071 \begin_layout Subsubsection
2073 Paragraph Indentation
2076 \begin_layout Standard
2077 Americans are trained to indent the first line of
2082 As with all of their other weird quirks,
2083 most Americans will whine and moan until they can have their way and indent the first line of all paragraphs.
2094 \begin_layout Standard
2096 this behavior isn't standard typography.
2098 you typically only indent the first line of a paragraph
2102 it follows another one.
2103 The idea behind indenting the first line of a paragraph is to distinguish neighboring paragraphs from one another.
2104 If there is no previous paragraph—
2106 if it follows a figure or is the first paragraph in a section—
2107 then there is no need for indentation.
2111 \begin_layout Standard
2112 If you're a typical American (we're still joking!),
2114 you don't care about such esoteric things;
2115 you want your indentation!
2116 Add this to the preamble:
2119 \begin_layout LyX-Code
2122 usepackage{indentfirst}
2125 \begin_layout Standard
2126 If your \SpecialChar TeX
2127 distribution isn't braindead,
2128 you'll have this package,
2129 and all of your paragraphs will get the indentation the Founding Fathers intended they should have.
2132 \begin_layout Subsubsection
2137 \begin_layout Standard
2138 You can also check out the preamble of this document to get an idea of some of the advanced things you can do.
2141 \begin_layout Section
2143 and \SpecialChar LaTeX
2147 \begin_layout Standard
2148 When \SpecialChar LyX
2149 calls \SpecialChar LaTeX
2151 it tells \SpecialChar LaTeX
2152 to blithely ignore any errors and keep going.
2153 It then uses the logfile from the \SpecialChar LaTeX
2154 run to do a post-mortem.
2155 After analyzing the logfile,
2157 displays a dialog listing the errors.
2158 Clicking on any one of them will take you to the position in your \SpecialChar LyX
2159 file where the error occurred.
2163 \begin_layout Plain Layout
2166 Analyzing the logfile is a tough job,
2167 and \SpecialChar LyX
2168 doesn't always go to the right line.
2169 There are also cases where \SpecialChar LaTeX
2170 reports the error on one line,
2171 but the actual error is earlier.
2172 This is not unlike forgetting a closing brace in a program:
2173 You'll get an error,
2182 \begin_layout Standard
2183 Some folks also like to look at the log file directly:
2184 It is available from
2185 \begin_inset Flex Noun
2188 \begin_layout Plain Layout
2189 Document\SpecialChar menuseparator
2191 \begin_inset space ~
2200 There are some fairly common error messages and warnings.
2201 We'll cover those here.
2202 You should look at a good \SpecialChar LaTeX
2203 book for a complete listing.
2206 \begin_layout Itemize
2207 \begin_inset Flex Code
2210 \begin_layout Plain Layout
2217 \begin_inset Newline newline
2220 Anything beginning with these words is a warning message for the purpose of
2221 \begin_inset Quotes eld
2225 \begin_inset Quotes erd
2228 the \SpecialChar LaTeX
2230 You'll get messages like this if you added or changed cross-references or bibliography entries,
2233 is trying to tell you that you need to make another run.
2234 You can by-and-large ignore these.
2237 \begin_layout Itemize
2238 \begin_inset Flex Code
2241 \begin_layout Plain Layout
2248 \begin_inset Newline newline
2251 Another warning message,
2252 this time about fonts which \SpecialChar LaTeX
2254 The rest of the message will often say something about a replacement font that \SpecialChar LaTeX
2256 You can safely ignore these,
2260 \begin_layout Itemize
2261 \begin_inset Flex Code
2264 \begin_layout Plain Layout
2273 \begin_inset Newline newline
2282 It seems to generate at least one of these messages for just about any document you write.
2283 They are warnings about lines that were too long and run past the right margin.
2284 This happens if \SpecialChar LaTeX
2285 does not find a reasonable way to break the lines (notoriously often with typewriter font,
2286 since this does not allow for automatic break points).
2288 this is unnoticeable in the final output.
2289 (It can be just a point or two.) Sometimes,
2291 the lines run rather visibly into the margin;
2292 something you will not want to have in your final print.
2294 \begin_inset Newline newline
2297 There are several global ways to try to minimize the overfull lines.
2300 Enable micro-typographic extensions
2304 Document\SpecialChar menuseparator
2305 Settings\SpecialChar menuseparator
2308 might already improve things a lot.
2311 code such as the following in
2313 Document\SpecialChar menuseparator
2314 Settings\SpecialChar menuseparator
2317 usually reduces the overfull lines drastically (we use this in the preamble of this document):
2321 \begin_layout LyX-Code
2325 \begin_inset Newline newline
2331 \begin_inset Newline newline
2336 emergencystretch 1.5em
2337 \begin_inset Newline newline
2345 \begin_layout Standard
2348 you eventually have to rewrite the text to get the line breaking right.
2352 \begin_layout Plain Layout
2353 For more information,
2355 \begin_inset Flex URL
2358 \begin_layout Plain Layout
2360 http://www.tex.ac.uk/FAQ-overfull.html
2373 \begin_layout Standard
2375 you should check the respective lines,
2376 at least for the final version of your document.
2377 Your eyes will tell you if there's a problem with something that's too wide.
2381 \begin_layout Plain Layout
2382 You can also enable the `draft' option in
2383 \begin_inset Flex Noun
2386 \begin_layout Plain Layout
2387 Document\SpecialChar menuseparator
2394 and then \SpecialChar LaTeX
2395 will draw a black box in the margin of lines that are overfull.
2404 \begin_layout Itemize
2405 \begin_inset Flex Code
2408 \begin_layout Plain Layout
2417 \begin_inset Newline newline
2420 Not quite as common as its cousin.
2421 This happens again if \SpecialChar LaTeX
2422 does not find a reasonable break point and consequently generates too loose lines.
2423 As with the overfull lines,
2424 you should check if this is a visible problem.
2427 \begin_layout Itemize
2428 \begin_inset Flex Code
2431 \begin_layout Plain Layout
2440 \begin_inset Flex Code
2443 \begin_layout Plain Layout
2452 \begin_inset Newline newline
2455 Warnings about troubles breaking the page.
2457 just look at the output.
2458 Your eyes will tell you where something has gone wrong.
2461 \begin_layout Itemize
2462 \begin_inset Flex Code
2465 \begin_layout Plain Layout
2468 \begin_inset Quotes els
2472 \begin_inset Quotes ers
2481 \begin_inset Newline newline
2485 \begin_inset Quotes eld
2489 \begin_inset Quotes erd
2492 isn't installed on this system.
2493 This usually appears because some package your document needs isn't installed.
2494 If you didn't touch the preamble or didn't use the
2495 \begin_inset Flex Code
2498 \begin_layout Plain Layout
2507 then one of the packages \SpecialChar LyX
2508 tried to load is missing.
2510 \begin_inset Flex Noun
2513 \begin_layout Plain Layout
2514 Help\SpecialChar menuseparator
2521 to get a list of packages that \SpecialChar LyX
2523 This file is updated whenever you reconfigure \SpecialChar LyX
2525 \begin_inset Flex Noun
2528 \begin_layout Plain Layout
2529 Tools\SpecialChar menuseparator
2535 ) and tells you which packages have been detected and what they do.
2536 \begin_inset Newline newline
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2551 command and the package in question isn't installed,
2552 then you'll need to install it yourself.
2555 \begin_layout Itemize
2556 \begin_inset Flex Code
2559 \begin_layout Plain Layout
2567 \begin_inset Newline newline
2570 Error messages beginning with this are trying to tell you that you specified a bad or undefined option to a package.
2571 Check the package's documentation.
2574 \begin_layout Itemize
2575 \begin_inset Flex Code
2578 \begin_layout Plain Layout
2579 Undefined control sequence
2585 \begin_inset Newline newline
2588 If you've inserted \SpecialChar LaTeX
2589 code into your document,
2591 you'll get one of these.
2592 You may have forgotten to load a package.
2594 this error message usually means that you used an undefined command.
2598 \begin_layout Standard
2599 There are other error and warning messages.
2600 Some are self-explanatory.
2601 These are usually \SpecialChar LaTeX
2603 Others are downright cryptic.
2604 These are usually \SpecialChar TeX
2610 what they mean or how to decipher them.
2614 \begin_layout Standard
2615 There's a general sequence you should follow if you get error messages:
2618 \begin_layout Enumerate
2619 Look at the \SpecialChar LaTeX
2620 code you inserted for typos.
2623 \begin_layout Enumerate
2624 If there are no typos,
2625 check that you used the command(s) correctly.
2628 \begin_layout Enumerate
2629 If you get a bunch of error boxes piled up at the very top of the document—
2630 and especially if you see a
2631 \begin_inset Quotes eld
2635 \begin_inset Flex Code
2638 \begin_layout Plain Layout
2647 \begin_inset Quotes erd
2651 it means that there are errors in the preamble.
2652 Start debugging your preamble.
2655 \begin_layout Enumerate
2656 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2657 code to the document,
2658 the first suspect is your \SpecialChar LaTeX
2659 distribution itself.
2660 Check for missing packages and install them.
2663 \begin_layout Enumerate
2665 so there are no missing packages.
2666 Did you use any of the fine-tuning options in \SpecialChar LyX
2674 like trying to manually insert lots of
2675 \begin_inset Flex Code
2678 \begin_layout Plain Layout
2680 \change_deleted 177693 1654669036
2682 \change_inserted 177693 1654669038
2686 \begin_inset space ~
2690 \change_deleted 177693 1654669040
2692 \change_inserted 177693 1654669041
2702 \begin_inset Flex Code
2705 \begin_layout Plain Layout
2713 \begin_inset Flex Code
2716 \begin_layout Plain Layout
2723 Did you try to kludge something together with these instead of using the appropriate paragraph environment?
2726 \begin_layout Enumerate
2728 you didn't use any of the fine-tuning options,
2729 you played by the rules.
2730 Did you try to pull a fancy maneuver?
2731 Did you do something funky inside a table or an equation,
2732 like inserting a graphic into a table cell?
2735 \begin_layout Enumerate
2736 Do you have long sections of text where \SpecialChar LaTeX
2737 cannot find a place to break a line?
2740 is rather strict about how much extra inter-word spacing it will add in order to break a line.
2742 you should rework the paragraph to avoid the problem.
2745 \begin_layout Enumerate
2746 Did you go overboard with the nesting?
2748 (currently) doesn't check to make sure you're in the limits for nesting environments.
2749 If you nested a bunch of environments to the
2750 \begin_inset Formula $17^{\mathrm{th}}$
2755 (The limit in \SpecialChar LaTeX
2759 \begin_layout Enumerate
2761 you didn't get any error messages,
2762 but your output looks awful.
2763 If you have a table or figure that's too wide or long for the page,
2768 \begin_layout Enumerate
2769 rescale the figure so it fits.
2772 \begin_layout Enumerate
2773 trim down the table so it fits.
2777 \begin_layout Enumerate
2778 If something else is wrong with the output,
2779 and you didn't try to pull anything fancy or kludge the fine-tuning options,
2780 we're not sure what's wrong.
2783 \begin_layout Standard
2784 If all this doesn't help—
2790 you might have found a bug in \SpecialChar LyX
2795 \begin_layout Chapter
2797 \change_inserted 564990737 1672345271
2801 \begin_layout Standard
2803 \change_inserted 564990737 1672345272
2810 originally offered four standard document classes,
2814 but individuals and organizations,
2815 most notably the American Mathematical Society in the early days,
2816 have made many contributions to extending the range of document classes.
2817 In this chapter we summarize the main externally maintained classes,
2818 some of which are marked “Unavailable:” in the pull-down
2821 \begin_inset space ~
2835 ocument\SpecialChar menuseparator
2840 ettings\SpecialChar menuseparator
2842 \begin_inset space ~
2847 dialog and which you will need to install as described in the
2849 Installing New Document Classes
2855 manual if you want to use them.
2859 \begin_layout Section
2861 \change_inserted 564990737 1670439533
2862 \begin_inset CommandInset label
2864 name "sec:Collections"
2871 \begin_layout Subsection
2873 \change_inserted 564990737 1672345298
2874 \begin_inset CommandInset label
2876 name "subsec:AMS-LaTeX-(American-Mathematical"
2880 AMS-\SpecialChar LaTeX
2881 (American Mathematical Society)
2884 \begin_layout Standard
2886 \change_inserted 564990737 1672345298
2887 The \SpecialChar LyX
2888 supported document classes
2896 are maintained by the Society;
2897 use of their features is described in the Math manual and on their website
2898 \begin_inset Flex URL
2901 \begin_layout Plain Layout
2903 \change_inserted 564990737 1672345298
2905 http://www.ams.org/publications/authors/tex/amslatex
2913 The following summary was originally provided by
2921 and the \SpecialChar LyX
2925 \change_deleted 564990737 1672345297
2928 AMS \SpecialChar LaTeX
2932 \begin_layout Standard
2934 \change_deleted 564990737 1672345297
2942 Richard Kimberly Heck
2947 \begin_layout Standard
2948 \begin_inset VSpace bigskip
2954 \begin_layout Standard
2956 The AMS \SpecialChar LaTeX
2957 layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
2958 The layouts are not tailored to a specific journal,
2960 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
2962 That documentation is available on the Web at
2963 \begin_inset Flex URL
2966 \begin_layout Plain Layout
2974 \begin_inset Flex URL
2977 \begin_layout Plain Layout
2979 ftp://ftp.ams.org/pub/tex/amslatex/
2985 These layouts are appropriate,
2987 for any mathematical writing.
2991 \begin_layout Standard
2992 There are two basic AMS \SpecialChar LaTeX
2997 \begin_layout Itemize
2999 The standard AMS article format
3000 \change_inserted 564990737 1672345333
3004 File\SpecialChar menuseparator
3005 Open Example\SpecialChar menuseparator
3006 Articles\SpecialChar menuseparator
3007 American Mathematical Society (AMS)
3014 \begin_layout Itemize
3016 the standard AMS book (really,
3018 \change_inserted 564990737 1672345366
3022 File\SpecialChar menuseparator
3023 Open Example\SpecialChar menuseparator
3024 Books\SpecialChar menuseparator
3025 American Mathematical Society (AMS)
3030 \change_inserted 564990737 1672345369
3034 \begin_layout Itemize
3036 \change_inserted 564990737 1672345383
3042 the standard AMS proceedings format.
3045 \begin_layout Standard
3047 \change_inserted 564990737 1672345383
3049 only supports the first two natively;
3052 Installing New Document Classes
3058 manual if you want to use
3065 \begin_layout Standard
3066 The layouts themselves contain only the minimum necessary to use the AMS classes.
3069 contain any of the `theorem' environments used for setting theorems,
3072 These are contained,
3075 \change_deleted 564990737 1672345416
3077 \begin_inset Flex Code
3080 \begin_layout Plain Layout
3087 \change_inserted 564990737 1672345416
3095 which is loaded by default when you select one of the AMS classes.
3096 (It can also be used with other classes and can be removed,
3097 if you would rather use something else.) Less commonly used environments are in the
3098 \change_deleted 564990737 1672345436
3100 \begin_inset Flex Code
3103 \begin_layout Plain Layout
3104 Theorems (AMS-Extended)
3110 \change_inserted 564990737 1672345436
3113 AMS Theorems (Extended)
3118 which must be loaded manually.
3121 \begin_layout Standard
3123 theorems and the like are numbered consecutively throughout the document,
3124 but this may be modified by loading the module
3125 \change_deleted 564990737 1672345461
3127 \begin_inset Flex Code
3130 \begin_layout Plain Layout
3131 Theorems (Order by Section)
3137 \change_inserted 564990737 1672345461
3140 Standard Theorems (Numbered by Section)
3146 \begin_inset Flex Code
3149 \begin_layout Plain Layout
3157 \change_deleted 564990737 1672345479
3159 \begin_inset Flex Code
3162 \begin_layout Plain Layout
3163 Theorems (Order by Chapter)
3169 \change_inserted 564990737 1672345480
3172 Standard Theorems (Numbered by Chapter)
3177 These will number the results as
3178 \begin_inset Formula $n.m$
3182 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).
3183 Many environments are also available unnumbered.
3184 These are indicated by an asterisk at the end.
3185 If you happen to want
3191 \change_deleted 564990737 1672345498
3193 \begin_inset Flex Code
3196 \begin_layout Plain Layout
3203 \change_inserted 564990737 1672345498
3206 Standard Theorems (Unnumbered)
3210 provides that option.
3213 \begin_layout Standard
3214 Note that these modules do not
3218 to be used with the AMS classes.
3219 It is perfectly possible to use the
3220 \change_deleted 564990737 1672345520
3222 \begin_inset Flex Code
3225 \begin_layout Plain Layout
3232 \change_inserted 564990737 1672345520
3240 and the others mentioned,
3243 \begin_inset Flex Code
3246 \begin_layout Plain Layout
3254 \begin_inset Flex Code
3257 \begin_layout Plain Layout
3265 \begin_inset Flex Code
3268 \begin_layout Plain Layout
3278 \begin_layout Subsubsection
3279 What these layouts provide
3282 \begin_layout Standard
3283 There is a long list of included environments provided by these layouts.
3284 In AMS-\SpecialChar LaTeX
3288 an opportunity to define an unlimited variety of `theorem' environments.
3290 the AMS recommends the environments that are available in \SpecialChar LyX
3295 \begin_layout Standard
3296 The following environments—
3297 as well as the standard environments,
3299 \begin_inset Flex Noun
3302 \begin_layout Plain Layout
3310 \begin_inset Flex Noun
3313 \begin_layout Plain Layout
3321 \begin_inset Flex Noun
3324 \begin_layout Plain Layout
3332 \begin_inset Flex Noun
3335 \begin_layout Plain Layout
3343 \begin_inset Flex Noun
3346 \begin_layout Plain Layout
3354 \begin_inset Flex Code
3357 \begin_layout Plain Layout
3364 \begin_inset Flex Code
3367 \begin_layout Plain Layout
3376 \begin_layout Description
3377 Address This should be the author's permanent address.
3380 \begin_layout Description
3382 \begin_inset space ~
3385 Address This should be the author's temporary address at the time of submission,
3386 if different from the Address.
3389 \begin_layout Description
3390 Email Author's e-mail address
3393 \begin_layout Description
3394 URL Author's Web address,
3398 \begin_layout Description
3399 Keywords Key words or phrases used to identify specific topics discussed in the paper.
3402 \begin_layout Description
3403 Subjectclass These refer to the AMS Subject Classifications,
3404 published and described in
3406 Mathematical Reviews
3409 These are also available online at the AMS cites listed above.
3412 \begin_layout Description
3416 \begin_layout Description
3420 \begin_layout Description
3424 \begin_layout Standard
3425 The following environments are provided by both the
3426 \change_deleted 564990737 1672345566
3428 \begin_inset Flex Code
3431 \begin_layout Plain Layout
3438 \change_inserted 564990737 1672345566
3446 \change_deleted 564990737 1672345580
3448 \begin_inset Flex Code
3451 \begin_layout Plain Layout
3458 \change_inserted 564990737 1672345580
3466 in the latter case in both starred (unnumbered) and unstarred (numbered) versions.
3467 These same environments are provided only in the starred versions by the
3468 \change_deleted 564990737 1672345596
3470 \begin_inset Flex Code
3473 \begin_layout Plain Layout
3480 \change_inserted 564990737 1672345596
3490 \begin_layout Theorem
3491 This is typically used for the statements of major results.
3495 \begin_layout Corollary*
3496 This is used for statements which follow fairly directly from previous statements.
3498 these can be major results.
3503 These are smaller results needed to prove other statements.
3506 \begin_layout Proposition
3507 These are less major results which (hopefully) add to the general theory being discussed.
3510 \begin_layout Conjecture
3511 These are statements provided without justification,
3512 which the author does not know how to prove,
3513 but which seem to be true (to the author,
3517 \begin_layout Definition*
3518 Guess what this is for.
3519 The font is different for this environment than for the previous ones.
3523 \begin_layout Example*
3524 Used for examples illustrating proven results.
3527 \begin_layout Problem
3528 It's not really known what this is for.
3529 You should figure it out.
3532 \begin_layout Exercise*
3533 Write a description for this one.
3536 \begin_layout Remark
3537 This environment is also a type of theorem,
3538 usually a lesser sort of observation.
3541 \begin_layout Claim*
3542 Often used in the course of giving a proof of a larger result.
3547 these are used to break up long arguments,
3548 using specific instances of some condition.
3553 The numbering scheme for cases is on its own,
3554 not together with other numbered statements.
3559 At the end of this environment,
3560 a QED symbol (usually a square,
3561 but it can vary with different styles) is placed.
3562 If you want to have other environments within this one—
3565 and have the QED symbol appear only after them,
3566 then the other environments need to be nested within the proof environment.
3569 Nesting Environments
3575 for information on nesting.
3580 \change_inserted 564990737 1672345651
3581 Used in a way similar to Proposition,
3582 though perhaps lower on the scale.
3585 \begin_layout Standard
3586 And these environments are provided by
3587 \change_deleted 564990737 1672345684
3589 \begin_inset Flex Code
3592 \begin_layout Plain Layout
3593 Theorems (AMS-Extended)
3599 \change_inserted 564990737 1672345689
3602 AMS Theorems (Extended
3609 \begin_layout Criterion*
3610 A required condition.
3613 \begin_layout Algorithm*
3614 A general procedure to be used.
3617 \begin_layout Axiom*
3618 This is a property or statement taken as true within the system being discussed.
3621 \begin_layout Condition*
3622 Sometimes used to state a condition assumed within the present context of discussion.
3626 Similar to a Remark.
3629 \begin_layout Notation*
3630 Used for the explanation of,
3635 \begin_layout Summary
3636 Do we really need to tell you?
3640 \begin_layout Acknowledgement*
3644 \begin_layout Conclusion*
3645 Sometimes used at the end of a long train of argument.
3646 \change_deleted 564990737 1672345729
3652 \change_deleted 564990737 1672345638
3653 Used in a way similar to Proposition,
3654 though perhaps lower on the scale.
3655 \change_inserted 564990737 1672345720
3659 \begin_layout Assumption*
3661 \change_inserted 564990737 1672345721
3665 \begin_layout Question*
3667 \change_inserted 564990737 1672345721
3671 \begin_layout Standard
3673 \change_inserted 564990737 1672345721
3674 There are ten more Maths modules available including several offering options ordered on
3676 (Numbered by Type \SpecialChar ldots
3684 \begin_layout Standard
3686 the AMS classes automatically provide the AMS \SpecialChar LaTeX
3687 and AMS fonts packages.
3688 They need to be available on your system in order to use these environments.
3691 \begin_layout Subsection
3693 \change_inserted 564990737 1671383236
3694 \begin_inset CommandInset label
3696 name "subsec:Extra-font-sizes"
3703 \begin_layout Standard
3705 \change_inserted 564990737 1671383236
3706 The “Extra font sizes” collection provides the document classes
3709 \begin_inset space \thinspace{}
3712 (with extra font sizes)
3718 \begin_inset space \thinspace{}
3721 (with extra font sizes)
3727 \begin_inset space \thinspace{}
3730 (with extra font sizes)
3735 \begin_inset space \thinspace{}
3738 (with extra font sizes)
3758 document classes respectively but offer the additional
3764 \begin_inset space ~
3777 ocument\SpecialChar menuseparator
3782 ettings\SpecialChar menuseparator
3788 \begin_layout Subsection
3790 \change_inserted 564990737 1671383236
3794 \begin_layout Standard
3796 \change_inserted 564990737 1671383236
3797 The document classes
3800 \begin_inset space \thinspace{}
3808 \begin_inset space \thinspace{}
3823 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3827 \begin_layout Subsection
3829 \change_inserted 564990737 1671383236
3830 \begin_inset CommandInset label
3832 name "subsec:Japanese"
3839 \begin_layout Standard
3841 \change_inserted 564990737 1671383236
3842 The document classes
3845 \begin_inset space \thinspace{}
3854 \begin_inset space \thinspace{}
3857 (Japanese Standard Class Vertical Writing)
3863 \begin_inset space \thinspace{}
3866 (Japanese Standard Class)
3872 \begin_inset space \thinspace{}
3881 \begin_inset space \thinspace{}
3884 (Japanese Standard Class Vertical Writing)
3890 \begin_inset space \thinspace{}
3893 (Japanese Standard Class)
3899 \begin_inset space \thinspace{}
3902 (Japanese Vertical Writing)
3907 \begin_inset space \thinspace{}
3910 (Japanese Standard Class)
3912 provide document classes for the Japanese language.
3915 \begin_layout Subsection
3917 \change_inserted 564990737 1672429136
3918 \begin_inset CommandInset label
3920 name "subsec:KOMA-Script"
3927 \begin_layout Standard
3929 \change_inserted 564990737 1672429136
3939 and the \SpecialChar LyX
3941 \change_deleted 564990737 1672429136
3945 \begin_layout Standard
3947 \change_deleted 564990737 1672429136
3955 \begin_layout Subsubsection
3957 \change_inserted 564990737 1672429161
3961 \begin_layout Standard
3963 \change_inserted 564990737 1672429162
3964 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
3965 it was formally launched with the addition of a letter class in 1994.
3967 a second letter class has been added.
3968 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.
3974 \begin_layout Standard
3975 The \SpecialChar LyX
3978 article (koma-script)
3983 report (koma-script)
4003 correspond to the \SpecialChar LaTeX
4025 \begin_inset space ~
4028 of the Koma-Script family.
4029 They are replacements for the standard document classes
4049 and fit better to European typography conventions in a number of points.
4052 \begin_layout Itemize
4054 \change_deleted 564990737 1672429262
4055 Standard character size is
4056 \change_inserted 564990737 1672429263
4057 The base character sizes when you select a KOMA-Script class are
4061 article (koma-script)
4066 report (koma-script)
4072 \change_deleted 564990737 1672429267
4080 letter (koma-script)
4085 \begin_layout Itemize
4087 labels of the description environment,
4088 and a number of elements of the
4090 letter (koma-script)
4092 document class are set in a bold sans serif font.
4096 \begin_layout Plain Layout
4097 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
4098 especially in the appearance of headings.
4100 the ec bold sans serif fonts look a bit thin.
4101 Here the \SpecialChar LaTeX
4110 helps to produce the
4111 \begin_inset Quotes eld
4115 \begin_inset Quotes erd
4118 appearance when using the ec fonts.
4123 The numbering of chapter headings is made in the same way as the numbering of section headings,
4124 that is without the extra line
4125 \begin_inset Quotes eld
4128 Chapter\SpecialChar ldots
4130 \begin_inset Quotes erd
4135 the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
4136 to be entered in the field
4139 \begin_inset space ~
4146 Layout\SpecialChar menuseparator
4153 \begin_layout Itemize
4155 \change_deleted 564990737 1672429310
4156 The main means in the Koma-Script document classes to design the type area are the options
4164 (in \SpecialChar LyX
4165 to be entered in the extra class options field in the dialog
4167 Document\SpecialChar menuseparator
4171 They make a clearer modification of page margins possible as do the options of the dialog
4173 Document\SpecialChar menuseparator
4178 \change_inserted 564990737 1672429310
4179 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.
4180 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.
4181 You can change the sizes of the margins by changing the factor by which the page is divided into strips;
4182 the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
4187 \begin_layout Standard
4189 \change_inserted 564990737 1672429310
4190 Whatever the factor,
4191 two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
4192 leaving a text area occupying around half the page.
4193 Since most two-sided documents have a binding,
4194 this can make the inner margins appear too narrow;
4195 so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
4199 \begin_layout Standard
4201 \change_inserted 564990737 1672429310
4202 The main means in the Koma-Script document classes to design the type area are the options
4212 Document\SpecialChar menuseparator
4213 Settings\SpecialChar menuseparator
4214 Document Class\SpecialChar menuseparator
4215 Class Options\SpecialChar menuseparator
4222 \begin_layout Standard
4224 \change_inserted 564990737 1672429310
4226 the binding correction is 7.5mm which is added in the form
4233 \begin_inset space ~
4236 options\SpecialChar menuseparator
4244 To change the factor to 11,
4250 to the comma separated list of entries in the
4261 \begin_inset space ~
4267 If you want the default value of this factor for a page size other than A4,
4275 \begin_layout Standard
4277 \change_inserted 564990737 1672429310
4278 To use the circle method of calculating the page layout,
4289 \begin_layout Itemize
4290 The \SpecialChar LaTeX
4291 document classes of the Koma-Script family define a number of additional commands.
4292 Those part of it which makes sense in \SpecialChar LyX
4293 is implemented in corresponding paragraph types.
4296 \begin_layout Standard
4297 Detailed descriptions of the \SpecialChar LaTeX
4298 document classes of the Koma-Script family can be found in the Koma-Script documentation
4309 \begin_layout Subsubsection
4311 \change_inserted 564990737 1672429358
4314 \begin_inset CommandInset label
4316 name "subsec:article-(KOMA-Script),-report"
4322 article (KOMA-Script),
4323 report (KOMA-Script),
4324 and book (KOMA-Script)
4325 \change_deleted 564990737 1672429367
4326 article (koma-script),
4327 report (koma-script),
4328 and book (koma-script)
4333 \begin_layout Standard
4334 The document classes
4336 article (koma-script)
4341 report (koma-script)
4352 are implemented in the layout files
4368 They contain all the paragraph types of the corresponding standard document classes
4385 with the exception of the \SpecialChar LyX
4391 which is replaced by the new
4395 -type having the same functionality.
4400 -Type there is a number of new paragraph types added.
4407 letter (koma-script)
4412 \begin_layout Itemize
4435 additionally inserting an entry in the table of contents.
4444 are not contained in
4446 article (koma-script)
4451 \begin_layout Itemize
4472 additionally clearing running heads.
4479 article (koma-script)
4485 \begin_layout Plain Layout
4498 report (koma-script)
4501 but since this is identical to
4506 is has not been implemented in \SpecialChar LyX
4515 \begin_layout Itemize
4521 generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
4524 \begin_layout Itemize
4533 are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
4534 you might want to place table captions always above the table).
4535 You can also use the class option
4553 You need at least Koma-Script version 2.8q to use this.
4556 \begin_layout Itemize
4562 can be used to set a bonmot,
4564 \begin_inset space \thinspace{}
4568 \begin_inset space \space{}
4571 at the beginning of a chapter.
4572 If you use the optional argument (
4574 Insert\SpecialChar menuseparator
4576 \begin_inset space ~
4582 you can insert the dictum's author there.
4583 Dictum and author are separated by a line.
4584 You need at least Koma-Script version 2.8q to use this.
4591 article (koma-script)
4596 \begin_layout Standard
4597 The following types,
4598 together with the standard types
4613 form the title area of the document.
4614 They must be entered ahead of the first
4615 \begin_inset Quotes eld
4619 \begin_inset Quotes erd
4626 \begin_layout Plain Layout
4627 The corresponding \SpecialChar LaTeX
4628 commands must appear before the
4639 When such a type is used more than once,
4640 the latter usage overwrites the former one,
4642 for every type only the latest usage is valid.
4643 The order of the different types however has,
4659 no effect on the appearance of the produced document.
4662 \begin_layout Itemize
4668 produces a centered paragraph above the ordinary title (
4682 ) for the subject of the document.
4685 \begin_layout Itemize
4691 produces a centered paragraph below the ordinary title (
4705 ) for the publishers' name.
4708 \begin_layout Itemize
4716 report (koma-script)
4722 produces a centered paragraph on its own page behind the title page,
4725 article (koma-script)
4727 produces a centered paragraph below the ordinary title (
4749 \begin_layout Itemize
4755 produces a left aligned paragraph above the ordinary title (
4774 ) for a document`s head.
4777 \begin_layout Itemize
4783 produces in a double-sided print in
4785 report (koma-script)
4791 a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
4793 article (koma-script)
4798 \begin_layout Itemize
4804 produces in a double-sided print in
4806 report (koma-script)
4812 a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
4814 article (koma-script)
4819 \begin_layout Itemize
4826 \begin_inset Quotes eld
4830 \begin_inset Quotes erd
4833 page ahead of the actual document containing a paragraph without special formatting.
4836 \begin_layout Standard
4838 \change_inserted 564990737 1672429680
4839 KOMA-Script offers a wide range of
4846 \begin_inset space ~
4856 ocument\SpecialChar menuseparator
4861 ettings\SpecialChar menuseparator
4863 \begin_inset space ~
4868 dialog which you can apply to the whole document,
4872 \begin_layout Description
4874 \change_inserted 564990737 1672429680
4881 which produces a PDF with a small black box at the end any line in which a formatting error occurs;
4882 the default setting is
4887 \begin_layout Description
4889 \change_inserted 564990737 1672429680
4896 which may take the values
4910 the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
4913 \begin_layout Description
4915 \change_inserted 564990737 1672429680
4922 which may take the values
4936 the first leaves it up to KOMA-Script to add periods after chapter,
4939 the second forces the addition of periods and third suppresses them
4942 \begin_layout Standard
4944 \change_inserted 564990737 1672429680
4945 and the math options:
4948 \begin_layout Description
4950 \change_inserted 564990737 1672429680
4957 which causes equations to be numbered on the left rather than on the right,
4961 \begin_layout Description
4963 \change_inserted 564990737 1672429680
4970 which causes equations to be left justified rather than centered.
4973 \begin_layout Standard
4975 \change_inserted 564990737 1672429680
4976 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
4977 commands and packages;
4979 if you want your captions in bold add
4982 \begin_layout Standard
4984 \change_inserted 564990737 1672429680
4989 setkomafont{captionlabel}{
4994 \begin_layout Standard
4996 \change_inserted 564990737 1672429680
5002 ocument\SpecialChar menuseparator
5009 \SpecialChar menuseparator
5014 \begin_inset space ~
5019 ) and the problem is solved.
5022 \begin_layout Standard
5024 \change_inserted 564990737 1672429680
5025 If you are writing a book,
5026 it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
5027 If you use the Chapter* environment,
5028 your Foreword and Preface will not appear in the Table of Contents;
5029 to make them to appear in the Table of contents,
5030 you need to use Chapter environments and add the \SpecialChar TeX
5034 \begin_layout Standard
5036 \change_inserted 564990737 1672429680
5044 \begin_layout Standard
5046 \change_inserted 564990737 1672429680
5047 at the very start of the book (not in the \SpecialChar LaTeX
5051 \begin_layout Standard
5053 \change_inserted 564990737 1672429680
5061 \begin_layout Standard
5063 \change_inserted 564990737 1672429680
5064 before the first chapter of the body of the text.
5065 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
5070 \begin_layout Plain Layout
5072 \change_inserted 564990737 1672429680
5073 Appendices are normally “numbered” with letters.
5078 If you use the Chapter* environment,
5079 they will not appear in the Table of Contents;
5080 so add the \SpecialChar TeX
5084 \begin_layout Standard
5086 \change_inserted 564990737 1672429680
5094 \begin_layout Standard
5096 \change_inserted 564990737 1672429682
5097 before the first of these headings and use the Chapter environment.
5098 These commands will have no effect on the numbering in \SpecialChar LyX
5100 only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
5103 \begin_layout Standard
5104 The layout files for the document classes
5106 article (koma-script)
5111 report (koma-script)
5123 This is thought of as a place to define your own types.
5128 in your personal layout directory and edit the file!
5129 \change_deleted 564990737 1672430255
5133 \begin_layout Standard
5135 \change_deleted 564990737 1672430255
5136 letter (koma-script)
5139 \begin_layout Description
5141 \change_deleted 564990737 1672429749
5143 This section discusses the obsolete
5145 KOMA-Script-Letter (v.
5146 \begin_inset space ~
5152 which is not even included anymore in recent KOMA releases.
5153 Please refer to the next section for the current KOMA-Script-Letter class (v.
5154 \begin_inset space ~
5160 \begin_layout Standard
5163 \change_deleted 564990737 1672429749
5166 letter (koma-script)
5168 is implemented in the layout file
5173 It contains all the paragraph types of the corresponding standard document class
5179 with the exception of the \SpecialChar LyX
5194 which is replaced by the new
5201 in contrast to the standard document class,
5224 there are a number of new letter specific types.
5227 \begin_layout Standard
5229 \change_deleted 564990737 1672429749
5230 The appearance of the letter produced by this document class can be controlled by a number of \SpecialChar LaTeX
5232 which you can put in the \SpecialChar LaTeX
5237 \begin_layout Plain Layout
5239 the standard appearance of the letter`s heading,
5240 consisting of name and address,
5241 is quite self-willed.
5243 \begin_inset Quotes eld
5247 \begin_inset Quotes erd
5250 heading is produced by the following \SpecialChar LaTeX
5251 commands in the preamble:
5254 \begin_layout LyX-Code
5264 \begin_layout LyX-Code
5280 \begin_layout LyX-Code
5290 \begin_layout LyX-Code
5310 A detailed German description of such \SpecialChar LaTeX
5311 commands can be found in the Koma-Script documentation
5317 the letter's author can produce his personal letter layout.
5320 \begin_layout Standard
5322 \change_deleted 564990737 1672429749
5331 define the beginning of the letter and must be used in every letter.
5332 To emphasize them in the \SpecialChar LyX
5334 they are marked with the letter
5344 \begin_inset space ~
5348 It is possible to write any number of letters in one file.
5353 type produces a new letter using the same addressee and a
5357 type produces a new addressee.
5377 are ordinary paragraph types and can also be used several times in one and the same letter.
5380 \begin_layout Itemize
5382 \change_deleted 564990737 1672429749
5388 produces a paragraph for the addressee and implicitly defines the beginning of the letter.
5391 \begin_layout Itemize
5393 \change_deleted 564990737 1672429749
5399 produces a paragraph for the form of address and implicitly produces a new letter.
5402 \begin_layout Itemize
5404 \change_deleted 564990737 1672429749
5410 produces a paragraph for a close.
5413 \begin_layout Itemize
5415 \change_deleted 564990737 1672429749
5421 produces a paragraph for a postscript.
5424 \begin_layout Itemize
5426 \change_deleted 564990737 1672429749
5432 produces a paragraph for a distribution list.
5435 \begin_layout Itemize
5437 \change_deleted 564990737 1672429749
5443 produces a paragraph for enclosures.
5446 \begin_layout Standard
5448 \change_deleted 564990737 1672429749
5498 are input types provided with a label to enter information,
5499 which will be processed by the document class.
5503 \begin_layout Plain Layout
5504 It could be seen as a matter of inconsequence,
5513 described above are not such input types as well.
5514 Because of the special meaning of those types,
5516 I have implemented them as ordinary paragraph types with a one letter mark in the left margin.
5518 it would affect my feeling of symmetry,
5527 type had such a serious different appearance.
5532 The types must be used ahead of the corresponding
5539 \begin_layout Standard
5541 \change_deleted 564990737 1672429749
5542 An implementation of these types in a WYSIWYG fashion does not seem to make sense,
5543 because the real appearance of the produced letter does not only depend on the usage of the particular type,
5544 but also on other factors.
5546 a signature entered in the
5550 type will in the standard behavior appear in the produced letter only,
5551 when in the same letter also a
5556 The entered value of the
5560 type will in the standard behavior not appear in the produced letter at all.
5561 The possibility to design the letter`s heading freely is already indicated in a footnote above.
5564 \begin_layout Standard
5566 \change_deleted 564990737 1672429749
5567 The input types can also be used as empty paragraphs.
5569 \begin_inset space \thinspace{}
5573 \begin_inset space \space{}
5585 type is not used at all,
5586 in the standard behavior the value of the
5590 type is used as signature,
5596 no signature value is defined.
5599 \begin_layout Standard
5601 \change_deleted 564990737 1672429749
5602 By using the input types it is possible to write a letter template,
5603 containing filled input types with your personal dates (name,
5605 etc.) and empty input types for other dates you want to enter.
5608 \begin_layout Itemize
5610 \change_deleted 564990737 1672429749
5617 in the standard behavior appears as a centered paragraph in small caps in the letter`s heading.
5620 \begin_layout Itemize
5622 \change_deleted 564990737 1672429749
5629 in the standard behavior appears below the
5643 type appears instead.
5646 \begin_layout Itemize
5648 \change_deleted 564990737 1672429749
5655 in the standard behavior appears in a centered paragraph in the letter`s heading below the sender's name.
5658 \begin_layout Itemize
5660 \change_deleted 564990737 1672429749
5666 sender's telephone number,
5667 in the standard behavior only sets the \SpecialChar LaTeX
5677 \begin_layout Itemize
5679 \change_deleted 564990737 1672429749
5685 place of the letter`s making.
5688 \begin_layout Itemize
5690 \change_deleted 564990737 1672429749
5696 date of the letter`s making.
5706 in the standard behavior,
5707 produce the place and the date in a right-aligned line below the addressee's field.
5713 neither place nor date appear,
5714 independent of the value of the
5724 the date of the letter `s production is used.
5727 \begin_layout Itemize
5729 \change_deleted 564990737 1672429749
5735 sender`s back address,
5736 in the standard behavior appears above the addressee's field in a small sans serif font.
5739 \begin_layout Itemize
5741 \change_deleted 564990737 1672429749
5747 special mail information,
5748 in the standard behavior appears underlined above the addressee's field below the back address.
5751 \begin_layout Itemize
5753 \change_deleted 564990737 1672429749
5759 additional information,
5760 in the standard behavior appears on right side below the addressee`s field.
5763 \begin_layout Itemize
5765 \change_deleted 564990737 1672429749
5772 in the standard behavior appears in a big,
5774 sans serif font above the subject.
5777 \begin_layout Itemize
5779 \change_deleted 564990737 1672429749
5785 the letter's subject,
5786 in the standard behavior appears in a bold font above the
5793 \begin_layout Standard
5795 \change_deleted 564990737 1672429749
5820 produce a business letter like line above the
5824 line containing the fields
5825 \begin_inset Quotes eld
5829 \begin_inset Quotes erd
5834 \begin_inset Quotes eld
5838 \begin_inset Quotes erd
5843 \begin_inset Quotes eld
5847 \begin_inset Quotes erd
5852 \begin_inset Quotes eld
5856 \begin_inset Quotes erd
5861 \begin_inset Quotes eld
5865 \begin_inset Quotes erd
5870 \begin_inset Quotes eld
5874 \begin_inset Quotes erd
5885 \begin_inset Quotes eld
5888 business letter types
5889 \begin_inset Quotes erd
5897 type however does not appear,
5898 but only the \SpecialChar LaTeX
5906 The ordinary output of place and date in a right-aligned line below the addressee`s field is suppressed.
5907 The types are implemented as input types provided with a label and must be used ahead of the corresponding
5914 \begin_layout Itemize
5916 \change_deleted 564990737 1672429749
5925 \begin_layout Itemize
5927 \change_deleted 564990737 1672429749
5936 \begin_layout Itemize
5938 \change_deleted 564990737 1672429749
5947 \begin_layout Itemize
5949 \change_deleted 564990737 1672429749
5958 \begin_layout Itemize
5960 \change_deleted 564990737 1672429749
5971 \begin_layout Subsubsection
5973 \change_deleted 564990737 1672429773
5974 The new letter class:
5975 letter (koma-script v.2)
5976 \change_inserted 564990737 1672429774
5978 \begin_inset CommandInset label
5980 name "subsec:The-new-letter"
5984 The new letter class:
5985 letter (KOMA-Script v.2)
5990 \begin_layout Standard
5996 \begin_layout Standard
5997 \begin_inset VSpace medskip
6003 \begin_layout Standard
6005 Koma-Script version 2.8 has introduced a new letter class
6009 which supersedes the now unsupported
6015 on the \SpecialChar LaTeX
6017 a completely new interface and is not compatible with the old class.
6021 though it is recommended you use the new class.
6024 \begin_layout Standard
6025 This class covers the same functionality as
6027 letter (koma-script),
6035 (receiver's address,
6055 will start a new letter (i.
6056 \begin_inset space \thinspace{}
6060 \begin_inset space \space{}
6063 you can write several letters per document).
6064 New elements are sender's
6083 and the possibility to use a
6089 Insert\SpecialChar menuseparator
6095 \begin_layout Standard
6096 The biggest improvement is,
6098 that the letter's layout is configurable to meet almost any needs.
6099 This can be done via the preamble or with a special style file (Letter Class Option,
6105 that will be read in as a class option.
6109 \begin_layout Plain Layout
6110 The KOMA package comes with some default
6121 file that follows german typesetting rules,
6126 that provides the default layout of the old
6131 The latter can be loaded with the class option
6138 Layout\SpecialChar menuseparator
6139 Document\SpecialChar menuseparator
6148 \change_deleted 564990737 1671617922
6156 \change_deleted 564990737 1671617938
6157 that is included in \SpecialChar LyX
6159 \change_inserted 564990737 1671617997
6165 ile\SpecialChar menuseparator
6167 \begin_inset space ~
6175 \begin_inset space ~
6178 Template\SpecialChar menuseparator
6179 Letters\SpecialChar menuseparator
6180 KOMA-Script Letter (V.2)
6185 A detailed description is to be found in the Koma-Script documentation (
6192 \begin_layout Subsubsection
6196 \begin_layout Standard
6197 Visualizing the Koma-Script document classes in \SpecialChar LyX
6199 the \SpecialChar LyX
6200 internals cause some problems.
6203 \begin_layout Itemize
6204 The chapter number of a
6208 type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
6209 The cause for that is the \SpecialChar LyX
6210 internal behavior for the labeltype
6217 \begin_layout Itemize
6218 The headings of the types
6227 \begin_inset Quotes eld
6231 \begin_inset Quotes erd
6236 but not in the \SpecialChar LyX
6239 Document\SpecialChar menuseparator
6241 \begin_inset space ~
6245 \begin_inset space ~
6253 \begin_layout Itemize
6258 document class appear in a skip separation mode,
6260 This is the standard behavior,
6261 no special \SpecialChar LaTeX
6262 commands are needed for that.
6265 Document\SpecialChar menuseparator
6268 dialog the corresponding radio button indicates
6277 value always has the effect that extra \SpecialChar LaTeX
6278 commands are inserted in the document to produce the gap,
6279 which is not what is wanted in this case.
6282 \begin_layout Subsection
6284 \change_inserted 564990737 1672743555
6285 \begin_inset CommandInset label
6287 name "subsec:Polish-M.W.collection"
6292 \begin_inset space \thinspace{}
6296 \begin_inset space \space{}
6300 \change_deleted 564990737 1670924933
6302 book (mwbk) and report (mwrep)
6303 \begin_inset Argument status
6306 \begin_layout Plain Layout
6321 \begin_layout Standard
6327 \begin_layout Standard
6328 The \SpecialChar LyX
6346 correspond to the \SpecialChar LaTeX
6362 They are replacements for the standard document classes
6377 and fit better to Polish typography conventions in a number of points.
6381 \begin_layout Standard
6385 \begin_layout Itemize
6386 Unnumbered titles (with star,
6388 \begin_inset space \thinspace{}
6392 \begin_inset space \space{}
6399 ) are added into table of contents,
6402 \begin_layout Itemize
6403 Additional page styles:
6407 \begin_layout Description
6408 uheadings header with separated lines,
6411 \begin_layout Description
6412 myheadings custom header,
6413 contents headers via commands:
6429 \begin_layout Description
6430 myuheadings custom header with separated lines,
6433 \begin_layout Description
6434 outer page number is placed on outer side of page
6438 \begin_layout Itemize
6443 \begin_layout Description
6444 rmheadings serif titles —
6448 \begin_layout Description
6449 sfheadings sansserif titles,
6452 \begin_layout Description
6453 authortitle on title page first placed is author next title —
6457 \begin_layout Description
6458 titleauthor on title page first placed is title next author,
6461 \begin_layout Description
6462 withmarginpar reserve place on page for margins.
6466 \begin_layout Subsection
6468 \change_inserted 564990737 1672652245
6472 \begin_layout Standard
6474 \change_inserted 564990737 1672652245
6475 The document classes
6478 \begin_inset space \thinspace{}
6486 \begin_inset space \thinspace{}
6500 Detailed information about these document classes can be found in
6502 File\SpecialChar menuseparator
6503 Open Example\SpecialChar menuseparator
6504 Books\SpecialChar menuseparator
6509 File\SpecialChar menuseparator
6510 Open Example\SpecialChar menuseparator
6511 Handouts\SpecialChar menuseparator
6517 \begin_layout Section
6519 \change_inserted 564990737 1670439534
6523 \begin_layout Standard
6525 \change_inserted 564990737 1670794710
6526 See also the document classes in the Collections (section
6527 \begin_inset space ~
6531 \begin_inset CommandInset ref
6533 reference "sec:Collections"
6541 \begin_layout Subsection
6543 \change_inserted 564990737 1670794716
6547 \begin_layout Standard
6549 \change_inserted 564990737 1670794716
6555 updated by the \SpecialChar LyX
6559 \begin_layout Subsubsection
6561 \change_inserted 564990737 1670794716
6565 \begin_layout Standard
6567 \change_inserted 564990737 1670794716
6568 This section describes how \SpecialChar LyX
6569 can be used to write articles for submission to the scientific journal
6571 Astronomy and Astrophysics
6574 \begin_inset CommandInset href
6577 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6582 ) using Version 9.1 of the document class
6587 information about it is available at
6588 \begin_inset Flex URL
6591 \begin_layout Plain Layout
6593 \change_inserted 564990737 1670794716
6595 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
6605 \begin_layout Standard
6607 \change_inserted 564990737 1670794716
6608 A manual comes together with the package and should be consulted before installing this document class as described in the
6610 Installing New Document Classe
6620 \begin_layout Standard
6622 \change_inserted 564990737 1670794716
6623 \begin_inset Note Greyedout
6626 \begin_layout Plain Layout
6628 \change_inserted 564990737 1670794716
6629 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
6631 That change also involved some slight changes to the style files,
6632 namely the removal of the thesaurus command.
6633 If you have an older version installed,
6635 For information about compatibility with the old (version 4) layout,
6636 please refer to the comments in
6639 Dir/layouts/aapaper.layout
6649 \begin_layout Subsubsection
6651 \change_inserted 564990737 1670794716
6655 \begin_layout Standard
6657 \change_inserted 564990737 1671617129
6658 It is recommended you start from the template in the menu
6663 ile\SpecialChar menuseparator
6665 \begin_inset space ~
6673 \begin_inset space ~
6676 Template\SpecialChar menuseparator
6677 Articles\SpecialChar menuseparator
6678 Astronomy & Astrophysics
6681 If you are not using the template,
6682 note the following settings:
6685 \begin_layout Itemize
6687 \change_inserted 564990737 1670794716
6697 ocument\SpecialChar menuseparator
6702 ettings\SpecialChar menuseparator
6704 \begin_inset space ~
6710 that one was obvious).
6713 \begin_layout Itemize
6715 \change_inserted 564990737 1670794716
6719 \begin_inset space ~
6731 \begin_inset space ~
6742 The whole layout is done by the macros,
6743 you shouldn't change anything.
6746 \begin_layout Subsubsection
6748 \change_inserted 564990737 1670794716
6752 \begin_layout Standard
6754 \change_inserted 564990737 1670794716
6755 First thing to enter is the header information.
6756 It consists of five entries,
6757 of which one is optional.
6761 \begin_layout Itemize
6763 \change_inserted 564990737 1670794716
6772 \begin_layout Itemize
6774 \change_inserted 564990737 1670794716
6783 \begin_layout Itemize
6785 \change_inserted 564990737 1670794716
6794 \begin_layout Itemize
6796 \change_inserted 564990737 1670794716
6805 \begin_layout Itemize
6807 \change_inserted 564990737 1670794716
6821 \begin_layout Standard
6823 \change_inserted 564990737 1670794716
6824 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
6825 just to get the best optics and meets the layout of the real document.
6828 \begin_layout Standard
6830 \change_inserted 564990737 1670794716
6831 If you want to place footnotes in the header block,
6833 \begin_inset space \thinspace{}
6837 \begin_inset space \space{}
6840 to state your present address,
6841 just use the standard footnote via the menu
6846 nsert\SpecialChar menuseparator
6855 will automagically use the term
6864 \begin_layout Standard
6866 \change_inserted 564990737 1670794716
6867 In addition to these topics,
6868 the macros use three additional \SpecialChar LaTeX
6869 commands that have no counterpart in \SpecialChar LyX
6873 \begin_layout Itemize
6875 \change_inserted 564990737 1670794716
6882 to separate different names for more than one author and institute,
6886 \begin_layout Itemize
6888 \change_inserted 564990737 1670794716
6895 to mark corresponding author/institute pairs.
6896 The institutes are numbered sequentially as they appear in the
6901 so you have to put a marker to each author.
6904 \begin_layout Itemize
6906 \change_inserted 564990737 1670794716
6913 to supply an email address for fast contact.
6916 \begin_layout Standard
6918 \change_inserted 564990737 1671642374
6920 the appropriate command has to be entered as \SpecialChar TeX
6921 code in \SpecialChar LyX
6923 See the examples in the template and in
6925 File\SpecialChar menuseparator
6926 Open Example\SpecialChar menuseparator
6927 Articles\SpecialChar menuseparator
6928 Astronomy & Astrophysics
6935 \begin_layout Subsubsection
6937 \change_inserted 564990737 1670794716
6941 \begin_layout Standard
6943 \change_inserted 564990737 1670794716
6944 The abstract should immediately follow the header block and must contain five tokens:
6954 \begin_layout Enumerate
6956 \change_inserted 564990737 1670794716
6961 (optional) {} leave it empty if necessary
6964 \begin_layout Enumerate
6966 \change_inserted 564990737 1670794716
6974 \begin_layout Enumerate
6976 \change_inserted 564990737 1670794716
6984 \begin_layout Enumerate
6986 \change_inserted 564990737 1670794716
6994 \begin_layout Enumerate
6996 \change_inserted 564990737 1670794716
7001 (optional) {} leave it empty if necessary
7004 \begin_layout Standard
7006 \change_inserted 564990737 1670794716
7008 This structure not shown in
7015 \begin_layout Subsubsection
7017 \change_inserted 564990737 1670794716
7018 Supported environments
7021 \begin_layout Standard
7023 \change_inserted 564990737 1670794716
7024 The A&A paper layout supports the following environments for structuring your text:
7027 \begin_layout Itemize
7029 \change_inserted 564990737 1670794716
7035 \begin_layout Itemize
7037 \change_inserted 564990737 1670794716
7043 \begin_layout Itemize
7045 \change_inserted 564990737 1670794716
7051 \begin_layout Itemize
7053 \change_inserted 564990737 1670794716
7059 \begin_layout Itemize
7061 \change_inserted 564990737 1670794716
7067 \begin_layout Itemize
7069 \change_inserted 564990737 1670794716
7075 \begin_layout Itemize
7077 \change_inserted 564990737 1670794716
7083 \begin_layout Itemize
7085 \change_inserted 564990737 1670794716
7091 \begin_layout Itemize
7093 \change_inserted 564990737 1670794716
7099 \begin_layout Itemize
7101 \change_inserted 564990737 1670794716
7107 \begin_layout Itemize
7109 \change_inserted 564990737 1670794716
7115 \begin_layout Itemize
7117 \change_inserted 564990737 1670794716
7124 \begin_layout Subsubsection
7126 \change_inserted 564990737 1670794716
7127 Commands not supported by \SpecialChar LyX
7131 \begin_layout Standard
7133 \change_inserted 564990737 1670794716
7134 Some commands are not yet supported by the
7138 layout for \SpecialChar LyX
7140 Some have already been mentioned.
7141 For the sake of completeness,
7142 they are listed all together here:
7145 \begin_layout Itemize
7147 \change_inserted 564990737 1670794716
7155 \begin_layout Itemize
7157 \change_inserted 564990737 1670794716
7165 \begin_layout Itemize
7167 \change_inserted 564990737 1670794716
7175 \begin_layout Itemize
7177 \change_inserted 564990737 1670794716
7185 \begin_layout Itemize
7187 \change_inserted 564990737 1670794716
7195 \begin_layout Standard
7197 \change_inserted 564990737 1670794716
7198 If you want to use any of these commands,
7199 you have to enter them yourself.
7202 Do not forget to use
7208 nsert\SpecialChar menuseparator
7211 \begin_inset space ~
7220 \begin_layout Subsubsection
7222 \change_inserted 564990737 1670794716
7223 Figure and Table Floats
7226 \begin_layout Standard
7228 \change_inserted 564990737 1670794716
7230 provides support for the necessary float environments
7241 therefore we won't tell much about it here.
7245 \begin_inset space ~
7251 Just remember that tables should be left-aligned.
7253 select the table and change the alignment in
7258 dit\SpecialChar menuseparator
7264 \begin_inset space ~
7270 \begin_layout Standard
7272 \change_inserted 564990737 1670794716
7273 There is only one special thing:
7274 the figures with a caption beside the figure.
7275 To create such a figure,
7276 you have to do the following:
7279 \begin_layout Enumerate
7281 \change_inserted 564990737 1670794716
7282 Create a wide figure float:
7288 nsert\SpecialChar menuseparator
7293 t\SpecialChar menuseparator
7298 from within the float,
7304 dit\SpecialChar menuseparator
7310 \begin_inset space ~
7321 \begin_inset space ~
7333 \begin_layout Enumerate
7335 \change_inserted 564990737 1670794716
7336 Enter your caption text.
7339 \begin_layout Enumerate
7341 \change_inserted 564990737 1670794716
7346 to move the cursor above the caption.
7349 \begin_layout Enumerate
7351 \change_inserted 564990737 1670794716
7355 \begin_layout Enumerate
7357 \change_inserted 564990737 1670794716
7358 Position the cursor after the figure and insert a horizontal fill by using the menu:
7364 nsert\SpecialChar menuseparator
7369 rmatting\SpecialChar menuseparator
7375 \begin_inset space ~
7384 dialog and select the
7398 \begin_layout Enumerate
7400 \change_inserted 564990737 1670794716
7401 Switch to \SpecialChar LaTeX
7406 \begin_inset space ~
7414 \begin_layout Enumerate
7416 \change_inserted 564990737 1670794716
7425 Do not close the brace!
7428 \begin_layout Enumerate
7430 \change_inserted 564990737 1670794716
7431 Position the cursor behind the caption text,
7432 switch to \SpecialChar LaTeX
7433 mode and insert the closing brace:
7437 \begin_inset space ~
7449 \begin_layout Standard
7451 \change_inserted 564990737 1671642458
7453 refer to the figures in the file in
7455 File\SpecialChar menuseparator
7456 Open Example\SpecialChar menuseparator
7457 Articles\SpecialChar menuseparator
7458 Astronomy & Astrophysics
7463 \begin_layout Subsubsection
7465 \change_inserted 564990737 1670794716
7469 \begin_layout Standard
7471 \change_inserted 564990737 1670794716
7473 the paper has to be formatted in a special double-spacing layout.
7475 you have to add the option
7486 \begin_inset space ~
7496 ocument\SpecialChar menuseparator
7501 ettings\SpecialChar menuseparator
7503 \begin_inset space ~
7512 \begin_layout Subsubsection
7514 \change_inserted 564990737 1670794716
7518 \begin_layout Standard
7520 \change_inserted 564990737 1671642520
7523 File\SpecialChar menuseparator
7524 Open Example\SpecialChar menuseparator
7525 Articles\SpecialChar menuseparator
7526 Astronomy & Astrophysics
7528 was written with \SpecialChar LyX
7530 It is the example paper from the original macro package,
7536 \begin_inset CommandInset href
7539 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
7545 but translated to \SpecialChar LyX
7546 using the older unstructured abstract type.
7547 Use it for inspiration,
7548 and compare the \SpecialChar LaTeX
7553 with the \SpecialChar LyX
7557 \begin_layout Subsection
7562 \begin_layout Standard
7568 \begin_layout Subsubsection
7572 \begin_layout Standard
7574 is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
7575 the Astrophysical Journal (including the Letters and Supplement),
7576 the Astronomical Journal,
7577 and the Publications of the Astronomical Society of the Pacific.
7579 has proven to be an excellent tool for generating these documents,
7580 especially given its equation,
7582 and figure handling capabilities.
7584 requires version 5.0 (or higher) of these macros;
7586 which is the version described here,
7588 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
7589 2.09 and are fundamentally incompatible with \SpecialChar LyX
7591 The AAS\SpecialChar TeX
7592 package may be downloaded from the AAS\SpecialChar TeX
7596 \begin_layout Standard
7597 \begin_inset VSpace medskip
7603 \begin_layout Standard
7605 \begin_inset Flex URL
7608 \begin_layout Plain Layout
7610 https://aas.org/aastex/aastex-downloads
7618 \begin_layout Standard
7619 \begin_inset VSpace medskip
7625 \begin_layout Standard
7626 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
7629 will not reduce the need to figure out all the AAS\SpecialChar TeX
7631 it will only reduce the drudgery of typing everything in.
7632 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
7633 document conforms completely to the requirements of the journal to which you are submitting your paper.
7636 \begin_layout Subsubsection
7637 Starting a New Paper
7640 \begin_layout Standard
7641 I strongly suggest that you start with the AAS\SpecialChar TeX
7645 File\SpecialChar menuseparator
7651 \change_inserted 564990737 1671617265
7652 \SpecialChar menuseparator
7653 Articles\SpecialChar menuseparator
7654 American Astronomical Society
7655 \change_deleted 564990737 1671617310
7659 enter the new file name,
7667 This will show the most common fields found in a manuscript.
7668 Simply overwrite the existing text (including the brackets,
7673 ) with the correct information.
7674 Many of the AAS\SpecialChar TeX
7675 commands and environments can be implemented directly in \SpecialChar LyX
7678 For commands such as these,
7679 the \SpecialChar LaTeX
7680 code must be entered directly and marked as such.
7681 Such commands are referred to as \SpecialChar TeX
7684 I tried to minimize the amount of \SpecialChar TeX
7685 code needed in an AAS\SpecialChar TeX
7689 \begin_layout Subsubsection
7690 Finishing Your Paper
7693 \begin_layout Standard
7694 When the paper is finished to your satisfaction and previews/prints correctly,
7696 \begin_inset Quotes eld
7700 \begin_inset Quotes erd
7703 actions which need to be done before you submit it to the journals.
7707 \begin_layout Enumerate
7708 Export your paper as a \SpecialChar LaTeX
7711 File\SpecialChar menuseparator
7712 Export\SpecialChar menuseparator
7720 \begin_layout Enumerate
7725 file with your favorite text editor
7729 \begin_layout Enumerate
7730 remove the comment lines before the
7739 \begin_layout Enumerate
7744 usepackage...{fontenc}
7746 line if it appears (usually just after
7762 \begin_layout Enumerate
7763 remove everything between (and including) the
7776 except for any commands you specifically put into the \SpecialChar LaTeX
7777 preamble (which should appear immediately after the
7778 \begin_inset Quotes eld
7781 User specified \SpecialChar LaTeX
7783 \begin_inset Quotes erd
7794 \begin_layout Enumerate
7795 Run the resulting file through \SpecialChar LaTeX
7796 to make sure it still processes correctly.
7799 \begin_layout Enumerate
7800 Reread the journal requirements to make sure your filenames and formats are correct.
7803 \begin_layout Enumerate
7807 \begin_layout Subsubsection
7808 Comments On Specific Commands
7811 \begin_layout Standard
7812 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
7814 the AAS\SpecialChar TeX
7819 ) gives a good description of each.
7820 Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
7821 So let's begin \SpecialChar ldots
7825 \begin_layout Paragraph
7826 Things that work as expected
7829 \begin_layout Standard
7830 Because they work as you might expect,
7831 I simply list them and the section they are found in:
7948 begin{thebibliography}
7958 all the cite commands and their variations (2.13.2),
7959 the generic graphicx figure commands (2.14.1),
7988 amongst other places),
8019 \begin_layout Standard
8020 The following style options also work correctly:
8046 Simply put them in the
8052 Layout\SpecialChar menuseparator
8058 \begin_layout Paragraph
8060 but require more comment
8063 \begin_layout Standard
8064 The following items work,
8065 but require a little more discussion:
8068 \begin_layout Itemize
8069 These items are reserved for use by the journal editors,
8070 but you can put them into the \SpecialChar LaTeX
8071 preamble if you feel compelled to do so:
8109 \begin_layout Itemize
8110 These items may be placed in the \SpecialChar LaTeX
8112 and are included as blanks in the template file:
8136 \begin_layout Itemize
8143 (2.3) – can only be used
8144 \begin_inset Quotes eld
8148 \begin_inset Quotes erd
8152 not in the middle of a paragraph.
8153 Use \SpecialChar TeX
8154 code if you need to embed it.
8157 \begin_layout Itemize
8164 (2.3) – will have extra {} after it.
8165 This should not cause an error.
8168 \begin_layout Itemize
8175 (2.6) – can only be used
8176 \begin_inset Quotes eld
8180 \begin_inset Quotes erd
8184 not in the middle of a paragraph.
8185 Use \SpecialChar TeX
8186 code if you need to embed it.
8189 \begin_layout Itemize
8196 (2.8) – can't insert a cross-reference tag,
8197 you must type the tag name by hand
8200 \begin_layout Itemize
8214 \begin_layout Itemize
8221 (2.9) – will have extra {} after it.
8222 This should not cause an error.
8225 \begin_layout Itemize
8232 (2.11) – will have extra {} after it.
8233 This should not cause an error.
8236 \begin_layout Itemize
8243 (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
8245 Insert\SpecialChar menuseparator
8250 \begin_inset Quotes eld
8254 \begin_inset Quotes erd
8257 inserts an optional argument of the type needed by
8264 Hopefully it will be renamed someday.
8267 \begin_layout Itemize
8280 for the catalog ID optional parameter
8283 \begin_layout Itemize
8296 for the catalog ID optional parameter
8299 \begin_layout Paragraph
8300 Things not implemented,
8301 use \SpecialChar TeX
8305 \begin_layout Standard
8317 setcounter{equation}
8320 Journal name abbreviations (2.13.4),
8363 insert it as the first element in the lefthand cell after where you want it.
8364 Don't use any of \SpecialChar LyX
8365 's rules in the table),
8440 \begin_layout Paragraph
8441 Things that cannot be implemented
8444 \begin_layout Standard
8446 at least in any meaningful sort of way,
8447 so I suggest ignoring them.
8448 They are the references environment (2.13.3),
8449 and the deluxetable environment (2.15).
8451 really need to use deluxetable,
8452 I suggest editing it in a separate file with a text editor,
8455 Insert\SpecialChar menuseparator
8457 \begin_inset space ~
8462 to include it in your \SpecialChar LyX
8465 \change_deleted 564990737 1671642564
8471 \change_inserted 564990737 1671642618
8474 File\SpecialChar menuseparator
8475 Open Example\SpecialChar menuseparator
8476 Articles\SpecialChar menuseparator
8477 American Astronomical Society
8482 \change_inserted 564990737 1671642621
8488 \begin_layout Subsubsection
8492 and Other Ruminations
8495 \begin_layout Paragraph
8496 Getting \SpecialChar LyX
8497 and AAS\SpecialChar TeX
8501 \begin_layout Standard
8502 It can be a bit tricky to get \SpecialChar LyX
8503 to recognize a new layout and document class.
8504 When all else fails,
8508 \begin_layout Enumerate
8509 Make certain that \SpecialChar LaTeX
8510 can find AAS\SpecialChar TeX
8512 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
8513 distribution into a directory completely unrelated to \SpecialChar LaTeX
8514 or AAS\SpecialChar TeX
8515 and run \SpecialChar LaTeX
8523 \begin_layout Enumerate
8528 appears in \SpecialChar LyX
8536 \begin_layout Enumerate
8539 Tools\SpecialChar menuseparator
8544 then restart \SpecialChar LyX
8548 \begin_layout Enumerate
8549 Open a regular new file,
8550 not from a template.
8551 Does AAS\SpecialChar TeX
8552 appear in the class list in
8554 Document\SpecialChar menuseparator
8560 \begin_layout Standard
8561 If you get a warning from an existing AAS\SpecialChar TeX
8562 document about not being able to find the AAS\SpecialChar TeX
8563 layout or a message about
8564 \begin_inset Quotes eld
8567 You should not mix title layouts with normal ones
8568 \begin_inset Quotes erd
8572 things haven't been installed correctly.
8575 \begin_layout Paragraph
8577 error processing a table
8580 \begin_layout Standard
8584 attempts to center the table caption/title.
8585 This seems to produce a bad interaction in AAS\SpecialChar TeX
8586 so you should click somewhere in the caption/title,
8589 Edit\SpecialChar menuseparator
8591 \begin_inset space ~
8606 This took care of it for me.
8609 \begin_layout Paragraph
8613 \begin_layout Standard
8615 1) I have noticed some funny spacing in the reference entries in the text.
8616 When you enter the bibliography item data,
8621 space between the last author and the parenthesis setting off the year;
8625 \begin_inset space \thinspace{}
8629 \begin_inset space \space{}
8644 2) Entering the references at all is not obvious.
8645 The easiest thing is to start typing your first reference at the end of the document,
8646 then mark it as type
8651 That will put a small gray box in front of what you just typed.
8652 Click on the box to fill in the rest of the information.
8654 go to the end of an existing reference and press return.
8655 That will create a new line with its own box,
8659 \begin_layout Paragraph
8663 \begin_layout Standard
8664 Even though AAS\SpecialChar TeX
8665 provides its own figure commands (
8673 I much prefer \SpecialChar LaTeX
8674 's standard figure commands (with the default graphicx).
8683 \begin_inset space ~
8686 commands as \SpecialChar TeX
8687 code into a Figure Float box if you desire,
8688 but I never have much luck getting the layout right.
8689 With the standard graphics,
8695 usepackage{graphicx}
8697 command into the \SpecialChar LaTeX
8698 preamble and handle the figures in the standard \SpecialChar LaTeX2e
8700 interspersing the figures in the text.
8701 I believe ApJ accepts figures exactly this way now;
8702 AJ might still use the
8703 \begin_inset Quotes eld
8706 stack everything at the end
8707 \begin_inset Quotes erd
8713 \begin_layout Paragraph
8714 Things I could have done,
8718 \begin_layout Standard
8720 \begin_inset Quotes eld
8724 \begin_inset Quotes erd
8727 things I could have implemented,
8730 I saw no point in double-spacing the text in the \SpecialChar LyX
8732 even though it is double-spaced in the paper manuscript.
8734 I chose not to make separate layouts for the preprint and preprint2 styles.
8735 Since I assume you will spend most of your time in the plain manuscript mode anyway,
8736 I decided not to chew up more disk space with this.
8740 \begin_layout Subsubsection
8744 \begin_layout Standard
8745 Your mileage may vary.
8746 I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
8748 the last 2% was the \SpecialChar LaTeX
8749 post-processing and a few cleanups.
8750 I have had no trouble with the submission process,
8751 and I'm sure the journals were never aware that there might be a difference.
8753 go forth and publish!
8756 \begin_layout Subsection
8758 \change_inserted 564990737 1671442131
8762 \begin_layout Standard
8764 \change_inserted 564990737 1671642768
8768 \begin_inset space \thinspace{}
8777 document class together with the style
8781 to facilitate the description of chess games.
8784 File\SpecialChar menuseparator
8785 Open Example\SpecialChar menuseparator
8786 Articles\SpecialChar menuseparator
8800 \begin_layout Subsection
8802 \change_inserted 564990737 1671042028
8806 \begin_layout Standard
8808 \change_inserted 564990737 1671617396
8812 \begin_inset space \thinspace{}
8822 This provides the following additional environments:
8826 \begin_inset space ~
8835 \begin_inset space ~
8844 \begin_inset space ~
8864 A template is available in the menu
8869 ile\SpecialChar menuseparator
8871 \begin_inset space ~
8879 \begin_inset space ~
8882 Template\SpecialChar menuseparator
8883 Articles\SpecialChar menuseparator
8887 It has been customized with further environments and contains all the information you may need.
8889 the documentation is also available from
8890 \begin_inset CommandInset href
8893 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
8901 \begin_layout Subsection
8903 \change_inserted 564990737 1671042046
8907 \begin_layout Standard
8909 \change_inserted 564990737 1671042046
8913 \begin_inset space \thinspace{}
8918 provides an alternative to the
8923 It provides similar functionality,
8924 but you might prefer this layout with sans serif sections,
8929 \begin_layout Subsection
8934 \begin_layout Standard
8940 \begin_layout Standard
8941 \begin_inset VSpace bigskip
8947 \begin_layout Standard
8952 \begin_inset space ~
8957 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
8959 \begin_inset Formula $\beta$
8966 \begin_layout Standard
8973 which works with Rev\SpecialChar TeX
8976 v3.1 is basically obsolete,
8977 as it works with \SpecialChar LaTeX
8979 That means that it doesn't interact very well with \SpecialChar LyX
8981 which requires \SpecialChar LaTeX2e
8983 although it has been kludged to work.
8984 Since Rev\SpecialChar TeX
8985 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
8992 \begin_inset space ~
8997 textclass should also be pretty easy to use.
9000 \begin_layout Standard
9001 These documents are supposed to be used in
9005 to the Rev\SpecialChar TeX
9007 so we don't describe any of the special Rev\SpecialChar TeX
9009 and assume you'll know what to put in the preamble if necessary.
9012 \begin_layout Subsubsection
9016 \begin_layout Standard
9017 All you need to do is install Rev\SpecialChar TeX
9019 as described in the package's README file.
9020 The package can be found at The Rev\SpecialChar TeX
9022 \begin_inset Flex URL
9025 \begin_layout Plain Layout
9027 http://publish.aps.org/revtex4/
9033 Install it somewhere that \SpecialChar LaTeX
9035 Test it by trying to \SpecialChar LaTeX
9036 a short Rev\SpecialChar TeX
9037 4 document in some random directory (i.
9038 \begin_inset space \thinspace{}
9042 \begin_inset space \space{}
9045 not the directory where you installed the class file.) Then,
9046 if you reconfigure \SpecialChar LyX
9048 it will find the class file and let you use the Rev\SpecialChar TeX
9052 \begin_layout Standard
9053 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
9062 \begin_inset space ~
9068 found in the templates directory.
9071 \begin_layout Subsubsection
9075 \begin_layout Standard
9076 Optional arguments to
9084 \begin_inset Quotes eld
9088 \begin_inset Quotes erd
9092 \begin_inset Quotes eld
9096 \begin_inset Quotes erd
9103 \begin_inset space ~
9111 \begin_inset space ~
9118 Remember that in Rev\SpecialChar TeX
9120 at least one optional argument is required!
9124 \begin_layout Standard
9125 Other preamble matter,
9133 \begin_inset space ~
9140 \begin_inset space ~
9149 \begin_layout Subsubsection
9153 \begin_layout Standard
9154 The layouts basically correspond to the commands in Rev\SpecialChar TeX
9157 the Email layout corresponds to
9164 Note that (at least as of Rev\SpecialChar TeX
9174 layouts are exactly equivalent,
9175 so you shouldn't need to use both.
9179 \begin_layout Plain Layout
9180 In case you're curious,
9181 both were included so that
9185 would be able to translate both
9205 \begin_layout Subsubsection
9209 \begin_layout Standard
9210 There are a couple of important unique aspects of Rev\SpecialChar TeX
9211 4 which might cause bugs that will be even more confusing in \SpecialChar LyX
9215 \begin_layout Standard
9216 In Rev\SpecialChar TeX
9235 The \SpecialChar LyX
9236 equivalent is that there is a separate Thanks layout.
9241 write footnotes in the
9246 or weird things may happen.
9247 See the Rev\SpecialChar TeX
9248 4 documentation for more details.
9251 \begin_layout Standard
9256 \begin_inset space ~
9265 \begin_inset space ~
9275 layouts must be placed
9283 layout and the corresponding
9301 the \SpecialChar LaTeX
9305 \begin_layout Subsection
9307 \change_inserted 564990737 1671042072
9311 \begin_layout Standard
9313 \change_inserted 564990737 1671042072
9318 classes were replaced in 2013 with a completely new
9323 This package provides a \SpecialChar LaTeX
9324 class and templates for books to be published at Springer Gabler Research,
9325 Springer Vieweg Research,
9326 Springer Spektrum Research,
9327 Springer VS Research,
9328 or Springer VS Forschung.
9329 The documentation is available in German from
9330 \begin_inset CommandInset href
9333 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
9341 \begin_layout Section
9343 \change_inserted 564990737 1670439560
9347 \begin_layout Standard
9349 \change_inserted 564990737 1670439581
9350 See also the document classes in the Collections (section
9351 \begin_inset space ~
9355 \begin_inset CommandInset ref
9357 reference "sec:Collections"
9365 \begin_layout Subsection
9369 \begin_layout Standard
9375 \begin_layout Subsubsection
9379 \begin_layout Standard
9380 Memoir is a very powerful and constantly evolving class.
9381 It has been designed with regard to fictional and non-fictional literature.
9382 Its aim is to let the user have maximum control over the typesetting of his document.
9383 Memoir is based on the standard book class,
9384 but it can also emulate the article class (see below).
9387 \begin_layout Standard
9389 the developer of Memoir,
9390 is known as the author of lots of useful packages in the \SpecialChar LaTeX
9392 Most of them have been merged with Memoir.
9394 it is much easier to layout the table of contents,
9396 chapter designs and such.
9400 does not support all of these goodies natively.
9401 Some of them might be added to forthcoming releases
9405 \begin_layout Plain Layout
9406 You are invited to send suggestions to
9407 \begin_inset Flex URL
9410 \begin_layout Plain Layout
9412 lyx-devel@lists.lyx.org
9423 lots will probably never be supported,
9424 due to the limitations of \SpecialChar LyX
9426 Of course you can still use all features with the help of some native \SpecialChar LaTeX
9427 commands (\SpecialChar TeX
9432 \begin_layout Plain Layout
9437 \begin_layout Plain Layout
9447 \begin_inset space ~
9451 \begin_inset CommandInset ref
9453 reference "sec:Inserting-TeX-Code"
9465 we can only list those features that are natively supported by \SpecialChar LyX
9467 For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
9471 \begin_layout Plain Layout
9476 \begin_layout Plain Layout
9486 \begin_inset Flex URL
9489 \begin_layout Plain Layout
9491 CTAN:/macros/latex/memoir/memman.pdf
9502 which is not only a user guide for the class,
9503 but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
9506 \begin_layout Subsubsection
9507 Basic features and restrictions
9510 \begin_layout Standard
9511 Memoir supports basically all features of the standard book classes.
9518 \begin_layout Description
9520 \begin_inset space ~
9524 Memoir has a broader range of font sizes:
9533 \begin_layout Description
9535 \begin_inset space ~
9539 The fancy page style is not supported,
9540 due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
9541 which confuses \SpecialChar LaTeX
9544 Memoir comes with a number of its own page styles (see
9546 Document\SpecialChar menuseparator
9547 Settings\SpecialChar menuseparator
9549 \begin_inset space ~
9555 If you want to use these for the chapter pages,
9556 you have to use the command
9562 in the main text or in preamble (e.
9563 \begin_inset space \thinspace{}
9567 \begin_inset space \space{}
9574 chapterstyle{companion}
9579 \begin_layout Description
9581 Sectionings (chapter,
9583 subsection etc.) come with an optional argument in the standard classes.
9585 you can specify an alternative version of the title for the table of contents and the headers (for instance,
9586 if the title is too long).
9591 Insert\SpecialChar menuseparator
9593 \begin_inset space ~
9598 at the beginning of a chapter/section.
9599 Memoir features a second optional argument and thus separates the table of contents from the header.
9600 You can define three variants of a title with this:
9601 one for the main text,
9602 one for the table of contents,
9603 and one for the headers.
9605 makes these available in form of specific
9616 \begin_layout Description
9618 In the standard classes (and in many other classes),
9619 the table of contents,
9620 the list of figures and the list of table start a new page automatically.
9621 Memoir does not follow this route.
9622 You have to insert a page break yourself,
9623 if you want to have one.
9626 \begin_layout Description
9628 For some unknown reason,
9629 Memoir uses pagination on the title page (in the standard classes,
9631 \begin_inset Quotes eld
9635 \begin_inset Quotes erd
9639 If you want an empty title page,
9644 aliaspagestyle{title}{empty}
9649 \begin_layout Description
9651 With the class option
9657 Document\SpecialChar menuseparator
9658 Settings\SpecialChar menuseparator
9659 Class Settings\SpecialChar menuseparator
9661 \begin_inset space ~
9667 you can emulate article style.
9669 counters (footnotes,
9671 tables etc.) will not be reset on new chapters,
9672 chapters don't start a new page (but are—
9674 \begin_inset Quotes eld
9678 \begin_inset Quotes erd
9689 \begin_layout Description
9692 Memoir does not allow the use of the deprecated font commands,
9693 which have been used in the old \SpecialChar LaTeX
9695 \begin_inset space \thinspace{}
9699 \begin_inset space \space{}
9716 It produces an error and stops \SpecialChar LaTeX
9717 whenever such a command appears.
9722 reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
9724 Since a lot of packages and particularly Bib\SpecialChar TeX
9725 style files are still using those commands,
9726 we have decided to use this option by default.
9729 \begin_layout Subsubsection
9733 \begin_layout Standard
9734 We will only describe the features supported by \SpecialChar LyX
9735 (which is not much currently).
9736 Please consult the Memoir manual
9740 \begin_layout Plain Layout
9745 \begin_layout Plain Layout
9755 \begin_inset Flex URL
9758 \begin_layout Plain Layout
9760 CTAN:/macros/latex/memoir/memman.pdf
9773 \begin_layout Description
9775 You may wonder why an abstract is an extra feature.
9777 it is in book class.
9778 Usually books don't have abstracts.
9782 You can use it wherever and how often you like.
9785 \begin_layout Description
9787 You may know this older typesetting style:
9788 The contents of a chapter are summarized below the title and also in the table of contents (e.
9789 \begin_inset space \thinspace{}
9793 \begin_inset space \space{}
9798 Our hero arrives in Troia;
9799 he loses some friends;
9803 Chapterprecis does exactly this.
9804 It is therefore only sensible below a chapter.
9807 \begin_layout Description
9809 An epigraph is a smart slogan or motto at the beginning of a chapter.
9810 The epigraph environment provides an elegant way of typesetting such a motto.
9811 The motto itself (text) and its (optional) author (source) are divided by a short line.
9812 The author (source) can be inserted via
9814 Insert\SpecialChar menuseparator
9821 \begin_layout Description
9823 Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
9825 can only support a few of them.
9827 which is a centered title for poems,
9828 which will also be added to the table of contents (verse is the standard environment for poems.
9829 Memoir has some enhanced versions of verse,
9830 but you need to use \SpecialChar TeX
9832 because they have to be nested inside regular verse environments,
9833 which is not possible with \SpecialChar LyX
9837 \begin_layout Description
9840 but it adds no entry to the table of contents.
9843 \begin_layout Subsection
9845 \change_inserted 564990737 1671442175
9849 \begin_layout Standard
9851 \change_inserted 564990737 1671442175
9859 \begin_inset space \thinspace{}
9864 document class but adds two environments:
9867 \begin_layout Description
9869 \change_inserted 564990737 1671442175
9870 Recipe a numbered section environment at the
9874 level which generates a bold centered heading above a double horizontal rule
9877 \begin_layout Description
9879 \change_inserted 564990737 1671442175
9890 are what are being described and the environment ends with a horizontal rule.
9893 \begin_layout Standard
9895 \change_inserted 564990737 1671642866
9898 File\SpecialChar menuseparator
9899 Open Example\SpecialChar menuseparator
9900 Books\SpecialChar menuseparator
9903 illustrates its use.
9906 \begin_layout Standard
9908 \change_inserted 564990737 1671442175
9909 It is designed for typesetting one or two recipes per page,
9910 with dimensions of 5.5
9911 \begin_inset Quotes qrd
9915 \begin_inset Quotes qrd
9919 The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient,
9920 and the pages can be joined together or printed 2 per page to normal letterpaper easily.
9921 The size was chosen to work in half-page 3-ring binder cover sheets,
9922 because un-laminated paper just doesn't last in the kitchen.
9925 \begin_layout Standard
9927 \change_inserted 564990737 1671442175
9928 The half-letter pages can be printed two per page using your printer driver,
9929 or bound together using
9931 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
9941 is the compiled version of your recipes.
9944 \begin_layout Section
9946 \change_inserted 564990737 1671442207
9950 \begin_layout Subsection
9952 \change_inserted 564990737 1671442208
9956 \begin_layout Standard
9958 \change_inserted 564990737 1671642942
9962 \begin_inset space \space{}
9966 \begin_inset space \thinspace{}
9976 an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
9979 File\SpecialChar menuseparator
9980 Open Example\SpecialChar menuseparator
9981 Curricula Vitae\SpecialChar menuseparator
9984 offers guidance on its use.
9985 Its documentation is available from
9986 \begin_inset CommandInset href
9989 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
9997 \begin_layout Subsection
9999 \change_inserted 564990737 1671442208
10003 \begin_layout Standard
10005 \change_inserted 564990737 1671642984
10009 \begin_inset space \space{}
10013 \begin_inset space \thinspace{}
10023 an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
10026 File\SpecialChar menuseparator
10027 Open Example\SpecialChar menuseparator
10028 Curricula Vitae\SpecialChar menuseparator
10031 offers guidance on its use.
10032 Its documentation is available from
10033 \begin_inset CommandInset href
10036 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
10044 \begin_layout Subsection
10046 \change_inserted 564990737 1671442208
10050 \begin_layout Standard
10052 \change_inserted 564990737 1671643003
10056 \begin_inset space \space{}
10060 \begin_inset space \thinspace{}
10070 This allows the creation of customizable CVs.
10073 File\SpecialChar menuseparator
10074 Open Example\SpecialChar menuseparator
10075 Curricula Vitae\SpecialChar menuseparator
10078 offers guidance on its use.
10079 Its documentation is available from
10080 \begin_inset CommandInset href
10083 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
10091 \begin_layout Subsection
10093 \change_inserted 564990737 1671442208
10097 \begin_layout Standard
10099 \change_inserted 564990737 1671643024
10103 \begin_inset space \space{}
10107 \begin_inset space \thinspace{}
10117 originally developed for use with \SpecialChar LyX
10121 File\SpecialChar menuseparator
10122 Open Example\SpecialChar menuseparator
10123 Curricula Vitae\SpecialChar menuseparator
10126 offers guidance on its use.
10127 Its documentation is available from
10128 \begin_inset CommandInset href
10131 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
10139 \begin_layout Section
10141 \change_inserted 564990737 1672652454
10145 \begin_layout Standard
10147 \change_inserted 564990737 1672652455
10151 \begin_inset space \space{}
10157 \begin_inset space ~
10161 \begin_inset CommandInset ref
10163 reference "subsec:The-new-letter"
10171 \begin_inset space \space{}
10174 (with extra font sizes)
10177 \begin_inset space ~
10181 \begin_inset CommandInset ref
10183 reference "subsec:Extra-font-sizes"
10188 ) document classes .
10191 \begin_layout Subsection
10193 \change_inserted 564990737 1671041970
10197 \begin_layout Standard
10199 \change_inserted 564990737 1671617528
10208 document class for writing letters according to the
10210 Deutsches Institut für Normung
10213 The file in the menu
10218 ile\SpecialChar menuseparator
10220 \begin_inset space ~
10228 \begin_inset space ~
10231 Template\SpecialChar menuseparator
10232 Letters\SpecialChar menuseparator
10235 offers guidance on its use.
10236 The documentation is available from
10237 \begin_inset CommandInset href
10240 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
10248 \begin_layout Subsection
10250 \change_inserted 564990737 1672652499
10254 \begin_layout Standard
10256 \change_inserted 564990737 1672652499
10260 \begin_inset space \space{}
10269 document class for writing letters according to French conventions.
10270 The file in the menu
10275 ile\SpecialChar menuseparator
10277 \begin_inset space ~
10285 \begin_inset space ~
10288 Template\SpecialChar menuseparator
10289 Letters\SpecialChar menuseparator
10291 \begin_inset space \space{}
10296 offers guidance on its use.
10299 \begin_layout Subsection
10301 \change_inserted 564990737 1672652499
10305 \begin_layout Standard
10307 \change_inserted 564990737 1672652499
10311 \begin_inset space \thinspace{}
10320 document class for writing letters in German.
10321 The file in the menu
10326 ile\SpecialChar menuseparator
10328 \begin_inset space ~
10336 \begin_inset space ~
10339 Template\SpecialChar menuseparator
10340 Letters\SpecialChar menuseparator
10342 \begin_inset space \thinspace{}
10347 offers guidance on its use.
10348 The documentation is available from
10349 \begin_inset CommandInset href
10352 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
10360 \begin_layout Subsection
10362 \change_inserted 564990737 1671458835
10366 \begin_layout Standard
10368 \change_inserted 564990737 1671617591
10377 document class for English letters and to create mailing labels.
10378 The file in the menu
10383 ile\SpecialChar menuseparator
10385 \begin_inset space ~
10393 \begin_inset space ~
10396 Template\SpecialChar menuseparator
10397 Letters\SpecialChar menuseparator
10398 Letter (Standard Class)
10400 offers guidance on its use.
10403 \begin_layout Subsection
10405 \change_inserted 564990737 1672652527
10409 \begin_layout Standard
10411 \change_inserted 564990737 1672652527
10415 \begin_inset space \space{}
10424 document class for writing letters,
10425 faxes and envelopes in French.
10426 The file in the menu
10431 ile\SpecialChar menuseparator
10433 \begin_inset space ~
10441 \begin_inset space ~
10444 Template\SpecialChar menuseparator
10445 Letters\SpecialChar menuseparator
10447 \begin_inset space \space{}
10452 offers guidance on its use.
10453 The documentation is available from
10454 \begin_inset CommandInset href
10457 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
10465 \begin_layout Section
10467 \change_inserted 564990737 1670439660
10471 \begin_layout Subsection
10473 \change_inserted 564990737 1671458922
10477 \begin_layout Standard
10479 \change_inserted 564990737 1671617655
10483 \begin_inset space \thinspace{}
10492 document class for creating presentations.
10493 The file in the menu
10498 ile\SpecialChar menuseparator
10500 \begin_inset space ~
10508 \begin_inset space ~
10511 Template\SpecialChar menuseparator
10512 Presentations\SpecialChar menuseparator
10515 offers guidance on its use.
10516 The documentation is available from
10517 \begin_inset CommandInset href
10520 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
10528 \begin_layout Subsection
10531 Foil\SpecialChar TeX
10535 \begin_inset CommandInset label
10544 \begin_layout Standard
10546 \change_inserted 564990737 1672743383
10552 updated by the \SpecialChar LyX
10556 \begin_layout Subsubsection
10558 \change_inserted 564990737 1672743383
10562 \begin_layout Standard
10564 \change_inserted 564990737 1672743396
10568 \begin_inset space \thinspace{}
10571 (Foil\SpecialChar TeX
10578 document class to make slides for overhead projectors.
10579 There are two document classes that can do this:
10583 \begin_inset space \thinspace{}
10588 document class (section
10589 \begin_inset space ~
10593 \begin_inset CommandInset ref
10595 reference "sec:slitex"
10605 Foil\SpecialChar TeX
10609 As of 2023 the former has continued to be maintained whereas
10611 Foil\SpecialChar TeX
10614 has not been maintained since 2008.
10615 This section documents the latter.
10616 If your machine doesn’t have the
10619 \begin_inset space \thinspace{}
10622 (Foil\SpecialChar TeX
10625 document class installed,
10626 you’ll probably have to use the
10629 \begin_inset space \thinspace{}
10635 If you want to install the
10640 it is available from
10641 \begin_inset CommandInset href
10644 target "https://www.ctan.org/pkg/foiltex"
10650 You should also read the
10652 Installing New Document Classes
10659 \change_deleted 564990737 1672743436
10665 \begin_layout Standard
10667 \change_deleted 564990737 1672743383
10671 \begin_layout Standard
10673 \change_deleted 564990737 1672743383
10674 This section describes how to use \SpecialChar LyX
10675 to make slides for overhead projectors.
10676 There are two document classes that can do this:
10677 the default slides class and the
10679 Foil\SpecialChar TeX
10683 This section documents the latter.
10686 \begin_layout Standard
10688 \change_deleted 564990737 1672743383
10689 I'm going to say this again,
10691 so that there's no misunderstanding:
10694 \begin_layout Standard
10696 \change_deleted 564990737 1672743383
10697 \begin_inset VSpace bigskip
10703 \begin_layout Standard
10706 \change_deleted 564990737 1672743383
10709 This section documents the class
10710 \begin_inset Quotes eld
10718 \begin_inset Quotes erd
10726 \begin_layout Standard
10728 \change_deleted 564990737 1672743383
10729 \begin_inset VSpace bigskip
10735 \begin_layout Standard
10737 \change_deleted 564990737 1672743383
10738 If you're looking for the documentation for
10739 \begin_inset Quotes eld
10747 \begin_inset Quotes erd
10752 \begin_inset space ~
10756 \begin_inset CommandInset ref
10758 reference "sec:slitex"
10764 If your machine doesn't have the
10773 you'll probably have to use the default
10778 which isn't quite as good as
10783 \begin_layout Standard
10785 \change_deleted 564990737 1672743383
10790 class is designed for use with version
10791 \begin_inset space ~
10799 class file which is now an integral part of \SpecialChar LaTeX2e
10805 \begin_layout Subsubsection
10809 \begin_layout Standard
10811 to use this document class,
10823 \begin_inset space ~
10829 There are some settings in the
10832 \begin_inset space ~
10837 dialog that you should know about that are specific to this class:
10840 \begin_layout Itemize
10841 Don't change the options
10852 \begin_inset space ~
10858 They're ignored by the
10865 \begin_layout Itemize
10866 The default font size is 20
10867 \begin_inset space \thinspace{}
10870 pt with the other options being 17
10871 \begin_inset space \thinspace{}
10876 \begin_inset space \thinspace{}
10880 \begin_inset space \thinspace{}
10886 \begin_layout Itemize
10887 The default font is
10895 but all math equations are still typeset in the usual roman font.
10898 \begin_layout Itemize
10901 Foil\SpecialChar TeX
10904 supports A4 and Letter paper sizes as well as a special size for working with 35
10905 \begin_inset space \thinspace{}
10909 It doesn't support A5,
10911 legal or executive paper sizes.
10914 \begin_layout Itemize
10915 Don't bother changing the
10919 settings because they are ignored anyway.
10920 All floats appear where they are defined in the text.
10923 \begin_layout Itemize
10928 setting behaves a bit differently for this class.
10931 Foil\SpecialChar TeX
10934 provides extensive footer and header capabilities including a user-defined logo.
10936 \begin_inset space ~
10940 \begin_inset CommandInset ref
10942 reference "sec:foilfoot"
10948 The title page is treated differently to all other pages in the document and is
10956 has the logo centered at the bottom of the page (if one is defined).
10957 The possible page style choices and what they do are as follows:
10961 \begin_layout Labeling
10962 \labelwidthstring MMMMMMM
10969 The final output contains no page numbers,
10970 or other headers or footers (except footnotes of course).
10974 \begin_layout Labeling
10975 \labelwidthstring MMMMMMM
10982 The final output contains page numbers centered at the bottom of the page.
10983 No other headings or footers (other than footnotes).
10986 \begin_layout Labeling
10987 \labelwidthstring MMMMMMM
10992 Page numbers in lower right corner.
10993 Additional headers and footers are also shown.
10994 This is also the default.
10997 \begin_layout Labeling
10998 \labelwidthstring MMMMMMM
11003 Gives you access to the
11007 package although its use with
11009 Foil\SpecialChar TeX
11012 is discouraged by the writer of the
11014 Foil\SpecialChar TeX
11017 package because of some potential page layout clashes.
11021 \begin_layout Paragraph
11025 \begin_layout Standard
11026 The following options may be used in the extra class options in the
11028 Document\SpecialChar menuseparator
11034 \begin_layout Labeling
11035 \labelwidthstring MMMMMMx
11040 This sets up the page layout for 7.33
11041 \begin_inset space \thinspace{}
11045 \begin_inset space \thinspace{}
11049 which is about the same aspect ratio as a 35
11050 \begin_inset space \thinspace{}
11054 making it a bit easier to work with this medium.
11057 \begin_layout Labeling
11058 \labelwidthstring MMMMMMx
11063 Places a rule across the page below the header on every page except the title page.
11066 \begin_layout Labeling
11067 \labelwidthstring MMMMMMx
11072 Places a rule across the page above the footer on every page except the title page.
11075 \begin_layout Labeling
11076 \labelwidthstring MMMMMMx
11081 This is automatically set each time you create a new
11088 Foil\SpecialChar TeX
11091 to use the dvips driver to rotate those pages that are set as landscape foils.
11094 \begin_layout Labeling
11095 \labelwidthstring MMMMMMx
11100 Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
11101 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.
11102 Note that this option effectively reverses the roles of the
11110 environments (don't worry these are described in the next section).
11113 \begin_layout Labeling
11114 \labelwidthstring MMMMMMx
11119 Equation numbers on the left.
11122 \begin_layout Labeling
11123 \labelwidthstring MMMMMMx
11128 Flush-left equations.
11131 \begin_layout Subsubsection
11132 Supported Environments
11135 \begin_layout Standard
11136 Most of the environments commonly supported in other classes are also supported by the
11141 There are several additional environments provided by
11143 Foil\SpecialChar TeX
11146 as well as a couple added by \SpecialChar LyX
11148 The following environments are shared with other classes:
11151 \begin_layout Standard
11152 \begin_inset Flex Multiple Columns
11155 \begin_layout Itemize
11161 \begin_layout Itemize
11167 \begin_layout Itemize
11173 \begin_layout Itemize
11179 \begin_layout Itemize
11185 \begin_layout Itemize
11192 \begin_layout Itemize
11198 \begin_layout Itemize
11204 \begin_layout Itemize
11210 \begin_layout Itemize
11216 \begin_layout Itemize
11222 \begin_layout Itemize
11228 \begin_layout Itemize
11234 \begin_layout Itemize
11240 \begin_layout Itemize
11251 \begin_layout Standard
11253 all the major environments apart from the sectioning environments.
11254 Since foils are essentially self-contained sections,
11255 with a title and body,
11258 Foil\SpecialChar TeX
11261 provides specific commands for starting new foils and these are:
11264 \begin_layout Itemize
11270 \begin_layout Itemize
11276 \begin_layout Standard
11278 also provides slightly modified versions of these two environments called:
11281 \begin_layout Itemize
11287 \begin_layout Itemize
11290 ShortRotatefoilhead
11293 \begin_layout Standard
11294 and the differences will be explained in the next section.
11297 \begin_layout Standard
11298 Since foils are often used in presenting ideas or new theorems and such
11300 Foil\SpecialChar TeX
11303 also provides a comprehensive box of goodies for presenting them:
11306 \begin_layout Standard
11307 \begin_inset Flex Multiple Columns
11310 \begin_layout Itemize
11316 \begin_layout Itemize
11322 \begin_layout Itemize
11328 \begin_layout Itemize
11334 \begin_layout Itemize
11340 \begin_layout Itemize
11346 \begin_layout Itemize
11352 \begin_layout Itemize
11358 \begin_layout Itemize
11364 \begin_layout Itemize
11370 \begin_layout Itemize
11381 \begin_layout Standard
11382 The starred versions are unnumbered while the unstarred versions are numbered.
11383 There are also two list environments added by \SpecialChar LyX
11387 \begin_layout Itemize
11393 \begin_layout Itemize
11399 \begin_layout Standard
11402 Foil\SpecialChar TeX
11405 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.
11406 If you want to change these settings in your document the best place to do so is at the very top of a foil,
11408 \begin_inset space \thinspace{}
11414 \begin_inset space \space{}
11419 straight after the foilhead.
11422 \begin_layout Standard
11424 the following command styles are provided [
11431 \begin_layout Standard
11432 \begin_inset Flex Multiple Columns
11435 \begin_layout Itemize
11439 \begin_inset space ~
11445 \begin_layout Itemize
11451 \begin_layout Itemize
11455 \begin_inset space ~
11461 \begin_layout Itemize
11465 \begin_inset space ~
11471 \begin_layout Itemize
11475 \begin_inset space ~
11482 \begin_layout Plain Layout
11483 \begin_inset space ~
11495 \begin_layout Standard
11496 There are also a few commands provided by
11498 Foil\SpecialChar TeX
11501 that aren't directly supported by \SpecialChar LyX
11502 but I'll tell you what they do and how to use them in section
11503 \begin_inset space ~
11507 \begin_inset CommandInset ref
11509 reference "sec:unsuppfoils"
11517 \begin_layout Subsubsection
11518 Building a Set of Foils
11521 \begin_layout Standard
11522 This section will give a simple introduction to using the different environments to build a set of foils.
11523 If you want to see an example set of foils,
11525 \change_deleted 564990737 1671643085
11530 file you find in \SpecialChar LyX
11536 \change_inserted 564990737 1671643099
11539 File\SpecialChar menuseparator
11540 Open Example\SpecialChar menuseparator
11541 Presentations\SpecialChar menuseparator
11549 \begin_layout Paragraph
11550 Give It a Title Page
11553 \begin_layout Standard
11554 Unlike other classes that provide
11577 creates the title on a page of its own.
11578 If you leave out the
11582 environment \SpecialChar LaTeX
11583 will substitute the current date (every time you regenerate the output).
11586 \begin_layout Paragraph
11590 \begin_layout Standard
11591 As I mentioned earlier,
11592 there are four ways of starting a new foil.
11593 For portrait foils you should use
11602 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.
11605 \begin_layout Standard
11606 Landscape foils are generated using the
11612 ShortRotatefoilhead
11615 Again the only difference is the spacing between foilhead and body.
11616 Both of the short versions have 0.5
11617 \begin_inset space ~
11620 inches less separation between the foilhead and the body.
11624 \begin_layout Standard
11625 One problem with the support for landscape foils is the requirement that you have to use the
11629 driver to generate the PostScript output otherwise the foils won't be rotated.
11630 It is possible to get landscape foils even if you haven't got the
11634 driver provided you can feed your foils sideways through your printer ;-)
11637 \begin_layout Paragraph
11643 \begin_layout Standard
11644 You can't have two of the same type of these environments directly following each other.
11645 If you use a normal paragraph break,
11647 you will just be extending the previous environment as if you had merged the two environments together.
11649 you need to insert a so-called separator.
11650 Please refer to the section entitled
11661 \begin_layout Paragraph
11665 \begin_layout Standard
11666 You get all the commonly supported list styles found in other classes as well as two new ones.
11667 I'll only describe the new ones here.
11668 If you want to find out more about the other list environments check out the
11673 If you intend to use itemized lists you might also want to read about the
11676 \begin_inset space ~
11680 \begin_inset space ~
11685 dialog described above in section
11686 \begin_inset space ~
11690 \change_inserted 564990737 1671355684
11692 \begin_inset CommandInset ref
11694 reference "chap:bullets"
11700 \change_deleted 564990737 1671355684
11702 \begin_inset CommandInset ref
11704 reference "sec:bullet"
11714 \begin_layout Standard
11715 The two new list styles,
11725 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.
11726 These lists are in fact dedicated variants of the
11731 They do however require that you have the
11735 packages installed.
11738 \begin_layout Paragraph
11742 \begin_layout Standard
11745 Foil\SpecialChar TeX
11748 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.
11749 In fact if you change the float placement settings they are simply ignored.
11752 \begin_layout Paragraph
11753 Page Headers and Footers
11754 \begin_inset CommandInset label
11756 name "sec:foilfoot"
11763 \begin_layout Standard
11767 \begin_inset space ~
11776 are two commands used to control the left-footer text string.
11777 The first is meant to allow you to include a graphic logo on your foils and defaults to
11778 \begin_inset Quotes eld
11783 Foil\SpecialChar TeX
11787 \begin_inset Quotes erd
11791 While the second is meant to provide a classification for the audience,
11795 \begin_inset space \thinspace{}
11801 \begin_inset space \space{}
11805 It is empty by default.
11808 \begin_layout Standard
11809 The remaining page corners can be filled by
11812 \begin_inset space ~
11817 (which defaults to page numbers),
11821 \begin_inset space ~
11829 \begin_inset space ~
11837 \begin_layout Subsubsection
11840 Foil\SpecialChar TeX
11844 \begin_inset CommandInset label
11846 name "sec:unsuppfoils"
11853 \begin_layout Standard
11854 All the commands mentioned below need to be set in a
11864 within another environment.
11867 \begin_layout Paragraph
11871 \begin_layout Standard
11872 All lengths are adjusted using the
11895 should be replaced by the name given to the length you want to change and
11899 is the length value.
11900 All lengths should be specified in units of length such as inches (
11913 ) or relative to some document or font-based length such as
11923 \begin_layout Standard
11924 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
11937 \begin_inset space \space{}
11940 in closer to their bodies put the following in the preamble:
11947 foilheadskip}{-0.5in}
11950 \begin_layout Standard
11951 The spacings around floats can be adjusted by setting these lengths:
11954 \begin_layout Labeling
11955 \labelwidthstring MMMMMMMMMMM
11962 Separation between the text and the top of the float
11965 \begin_layout Labeling
11966 \labelwidthstring MMMMMMMMMMM
11973 Separation between the float and the caption
11976 \begin_layout Labeling
11977 \labelwidthstring MMMMMMMMMMM
11984 Separation between the caption and the following text
11987 \begin_layout Labeling
11988 \labelwidthstring MMMMMMMMMMM
11995 You can make the captions narrower than the surrounding text by adjusting this length.
11996 Best done relative to
12005 \begin_layout Standard
12006 There are also several title page related lengths that you may find useful if you have a long title or several authors:
12009 \begin_layout Labeling
12010 \labelwidthstring MMMMMMMMMMM
12017 Separation from headers to
12022 \begin_layout Labeling
12023 \labelwidthstring MMMMMMMMMMM
12041 \begin_layout Labeling
12042 \labelwidthstring MMMMMMMMMMM
12056 \begin_layout Labeling
12057 \labelwidthstring MMMMMMMMMMM
12073 \begin_layout Labeling
12074 \labelwidthstring MMMMMMMMMMM
12090 \begin_layout Standard
12091 The last length related command affects all the list environments.
12102 a list environment then all the vertical spacing between the list items is removed.
12103 Note that this is a command not a length so it doesn't require
12109 like the stuff mentioned above.
12112 \begin_layout Paragraph
12113 Headers and Footers
12116 \begin_layout Standard
12129 commands control whether the logo in the
12133 definition appear on a given page.
12140 in the preamble then none of the foils will have the logo on them.
12141 If you don't want the logo on a particular page place the
12147 directly after the foilhead of that page and the
12153 directly after the next foilhead.
12156 \begin_layout Standard
12157 If you decide to use the
12161 page style setting in the
12164 \begin_inset space ~
12169 dialog you should probably add
12179 to your preamble so headers and footers on landscape pages are correctly placed when rotated.
12180 This is due to some clashes between the page layouts provided by the
12191 \begin_layout Subsection
12193 \change_inserted 564990737 1671459032
12197 \begin_layout Standard
12199 \change_inserted 564990737 1671643165
12203 \begin_inset space \thinspace{}
12212 document class for creating presentations.
12215 File\SpecialChar menuseparator
12216 Open Example\SpecialChar menuseparator
12217 Presentations\SpecialChar menuseparator
12220 offers guidance on its use.
12221 The documentation is available from
12222 \begin_inset CommandInset href
12225 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
12233 \begin_layout Subsection
12235 \change_inserted 564990737 1671459032
12236 \begin_inset CommandInset label
12238 name "subsec:Seminar"
12247 \begin_layout Standard
12249 \change_inserted 564990737 1671643194
12253 \begin_inset space \thinspace{}
12262 document class for creating presentations.
12265 File\SpecialChar menuseparator
12266 Open Example\SpecialChar menuseparator
12267 Presentations\SpecialChar menuseparator
12270 offers guidance on its use.
12271 The documentation is available from
12272 \begin_inset CommandInset href
12275 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
12283 \begin_layout Subsection
12286 Sli\SpecialChar TeX
12290 \begin_inset CommandInset label
12299 \begin_layout Standard
12301 \change_inserted 564990737 1672743492
12307 updated by the \SpecialChar LyX
12311 \begin_layout Subsubsection
12313 \change_inserted 564990737 1672743492
12317 \begin_layout Standard
12319 \change_inserted 564990737 1672743492
12320 This section describes how to use \SpecialChar LyX
12321 to make slides for overhead projectors.
12322 There are two document classes that can do this:
12326 \begin_inset space \thinspace{}
12331 document class and the
12334 \begin_inset space \thinspace{}
12337 (Foil\SpecialChar TeX
12341 This section documents the former.
12342 If you’re looking for the documentation for
12345 \begin_inset space \thinspace{}
12348 (Foil\SpecialChar TeX
12353 \begin_inset space ~
12357 \begin_inset CommandInset ref
12359 reference "sec:Foiltex"
12365 As of 2023 the former has continued to be maintained whereas
12367 Foil\SpecialChar TeX
12370 has not been maintained since 2008.
12372 \change_deleted 564990737 1672743492
12380 \begin_layout Standard
12382 \change_deleted 564990737 1672743492
12386 \begin_layout Standard
12388 \change_deleted 564990737 1672743492
12389 This section describes how to use \SpecialChar LyX
12390 to make slides for overhead projectors.
12391 There are two document classes that can do this:
12392 the default slides class and the
12394 Foil\SpecialChar TeX
12398 This section documents the former.
12401 \begin_layout Standard
12403 \change_deleted 564990737 1672743492
12404 I'm going to say this again,
12406 so that there's no misunderstanding:
12409 \begin_layout Standard
12411 \change_deleted 564990737 1672743492
12412 \begin_inset VSpace bigskip
12418 \begin_layout Standard
12421 \change_deleted 564990737 1672743492
12424 This section documents the class
12425 \begin_inset Quotes eld
12433 \begin_inset Quotes erd
12441 \begin_layout Standard
12443 \change_deleted 564990737 1672743492
12444 \begin_inset VSpace bigskip
12450 \begin_layout Standard
12452 \change_deleted 564990737 1672743492
12453 If you're looking for the documentation for
12454 \begin_inset Quotes eld
12459 slides (Foil\SpecialChar TeX
12463 \begin_inset Quotes erd
12468 \begin_inset space ~
12472 \begin_inset CommandInset ref
12474 reference "sec:foiltex"
12485 \begin_inset Quotes eld
12490 slides (Foil\SpecialChar TeX
12494 \begin_inset Quotes erd
12497 ] is actually somewhat better than the default
12505 \begin_layout Plain Layout
12507 or so I've been told repeatedly by its advocates.
12508 Having never used it,
12509 I have no idea if this claim is true or not.
12514 which this section documents.
12517 \begin_layout Standard
12519 \change_deleted 564990737 1672743492
12520 This class is the \SpecialChar LaTeX2e
12521 improvement of the old
12523 Sli\SpecialChar TeX
12527 Every \SpecialChar LaTeX2e
12528 distribution includes this class [which I'll just refer to as
12529 \begin_inset Quotes eld
12537 \begin_inset Quotes erd
12541 so you're bound to have it.
12542 As I noted earlier,
12543 there are other classes,
12549 which also produce slides for overhead projectors and do a better job at it.
12551 there are some things which
12555 can do which the others can't,
12556 such as generate overlays.
12557 Read on to learn more!
12562 \begin_layout Subsubsection
12564 \begin_inset CommandInset label
12566 name "sec:slidesetup"
12573 \begin_layout Standard
12575 to use this document class,
12577 \begin_inset Quotes eld
12585 \begin_inset Quotes erd
12588 from the class list in the
12590 Document\SpecialChar menuseparator
12594 There are some other special things you should know about this class:
12597 \begin_layout Itemize
12598 Don't bother changing the options
12603 They're not supported by the
12611 \begin_layout Itemize
12615 \begin_inset space ~
12620 behaves a bit differently for this class.
12621 The possible choices and what they do are as follows:
12625 \begin_layout Description
12630 The final output contains page numbers in the lower right corner.
12633 \begin_layout Description
12643 but also prints out any time markers you've put in.
12644 This is the default.
12647 \begin_layout Description
12652 The final output contains no page numbers,
12654 or alignment markers.
12658 \begin_layout Itemize
12663 class has an extra option:
12671 \begin_inset Quotes eld
12679 \begin_inset Quotes erd
12682 in the extra class options.
12686 \begin_layout Standard
12687 Using this options allows you to add time markers to
12693 \begin_inset space ~
12697 \begin_inset CommandInset ref
12699 reference "sec:slideNote"
12708 \begin_layout Standard
12709 You can also use the template file
12710 \change_deleted 564990737 1671617694
12712 \begin_inset Quotes eld
12720 \begin_inset Quotes erd
12725 to automatically set up a document to use the
12730 \change_deleted 564990737 1671617699
12735 File\SpecialChar menuseparator
12737 \begin_inset space ~
12741 \begin_inset space ~
12745 \change_inserted 564990737 1671617723
12746 \SpecialChar menuseparator
12747 Presentations\SpecialChar menuseparator
12752 to open your new document
12753 \change_deleted 564990737 1671617728
12757 The template file also contains some examples of the special paragraph environments used by this class.
12758 I'll describe those next.
12761 \begin_layout Subsubsection
12762 Paragraph Environments
12765 \begin_layout Paragraph
12766 Supported Environments
12769 \begin_layout Standard
12770 The first thing you'll notice when you start up a new
12774 document is the font size and type:
12775 it's the equivalent of the size
12776 \begin_inset Quotes eld
12784 \begin_inset Quotes erd
12790 \begin_inset space ~
12796 This is also what's used in the output.
12798 \begin_inset Quotes eld
12802 \begin_inset Quotes erd
12805 to remind you that this is a slide.
12806 Your final slides will use a larger font;
12808 you'll have less space.
12810 the larger default screen font isn't WYSIWYG,
12814 \begin_layout Standard
12815 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
12816 Most of the paragraph environments you're used to seeing are missing.
12817 There are also five new ones.
12822 class itself only supports certain paragraph environments:
12825 \begin_layout Itemize
12831 \begin_layout Itemize
12837 \begin_layout Itemize
12843 \begin_layout Itemize
12849 \begin_layout Itemize
12855 \begin_layout Itemize
12861 \begin_layout Itemize
12867 \begin_layout Itemize
12873 \begin_layout Itemize
12879 \begin_layout Itemize
12886 \begin_layout Standard
12887 All of the other standard environments,
12888 including the section-heading environments,
12896 \begin_layout Standard
12898 you'll notice the following new environments:
12901 \begin_layout Itemize
12907 \begin_layout Itemize
12913 \begin_layout Itemize
12919 \begin_layout Itemize
12925 \begin_layout Itemize
12931 \begin_layout Standard
12932 These five are kind of quirky,
12934 \begin_inset Quotes eld
12938 \begin_inset Quotes erd
12941 in \SpecialChar LyX
12945 doesn't permit you to nest any other paragraph environment into an empty environment.
12947 that's fine and dandy,
12948 but it means that you wouldn't be able to start a slide with anything except plain text.
12950 I've performed a little
12951 \begin_inset Quotes eld
12956 \begin_inset Quotes erd
12962 \begin_layout Paragraph
12963 Quirks of the New Environments
12964 \begin_inset CommandInset label
12966 name "sec:slideQuirk"
12973 \begin_layout Standard
12974 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
12976 As I just mentioned,
12978 forbids environments that begin with another environment.
12979 To get around this,
12984 environment isn't a paragraph environment as described in the
12992 \begin_layout Standard
12993 You should consider
13008 \begin_inset Quotes eld
13011 pseudo-environments.
13012 \begin_inset Quotes erd
13015 They look like a section heading or a
13016 \begin_inset Quotes eld
13024 \begin_inset Quotes erd
13027 but really begin a [and,
13029 end the previous] paragraph environment.
13040 \begin_inset Quotes eld
13044 \begin_inset Quotes erd
13047 These two perform some action.
13050 \begin_layout Standard
13051 A common feature of all five environments,
13076 is a rather long-ish label.
13077 The text following this label —
13078 ordinarily the contents of the paragraph environment —
13079 is utterly irrelevant for
13104 completely ignores it.
13106 you can leave these five environments completely empty.
13110 \begin_layout Standard
13115 to put any text after the rather long-ish label,
13117 This could be a short description of the contents of the
13124 enter your descriptive comment and hit
13128 as you normally would.
13131 \begin_layout Standard
13134 you don't want to enter any descriptive text,
13135 you'll hit another \SpecialChar LyX
13141 and will not let you start a new paragraph environment until you put something in the old one.
13146 \begin_layout Itemize
13147 Start entering the text that will
13178 \begin_layout Itemize
13179 Now move to the beginning of that paragraph.
13183 \begin_layout Itemize
13193 \begin_layout Itemize
13196 empty paragraph to a
13223 \begin_layout Standard
13224 Some future version of \SpecialChar LyX
13227 resolve this quirkiness\SpecialChar ldots
13231 \begin_layout Subsubsection
13232 Making a Presentation with
13246 \begin_layout Paragraph
13254 \begin_layout Standard
13255 If you're expecting this section to teach you how to actually make a presentation,
13256 you'll be sorely disappointed.
13258 I'll describe all of the ways the
13262 class can assist you in preparing the materials for a presentation.
13263 Filling in the contents,
13271 the \SpecialChar LyX
13275 \begin_layout Standard
13280 environment [in the manner described in section
13281 \begin_inset space ~
13285 \begin_inset CommandInset ref
13287 reference "sec:slideQuirk"
13292 ] tells \SpecialChar LyX
13293 to begin a new slide [duh].
13294 The label for this environment/
13295 \begin_inset Quotes erd
13299 \begin_inset Quotes erd
13303 \begin_inset Quotes eld
13307 \begin_inset Quotes erd
13311 followed by the label,
13313 \begin_inset Quotes eld
13317 \begin_inset Quotes erd
13321 Any text or paragraph environments that follow this one go on the new slide.
13325 \begin_layout Standard
13326 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
13327 (this can be specified in the
13334 once you finish entering the contents of one slide.
13335 If you've entered more text than can physically fit on a slide,
13336 the extra overflows onto a new slide.
13337 I don't recommend doing this,
13339 since the overflow slide won't have any page number on it.
13341 it may interfere with any
13345 you've made to accompany the oversized
13352 \begin_layout Standard
13361 environments work the same way as the
13366 They both create an
13367 \begin_inset Quotes eld
13371 \begin_inset Quotes erd
13374 followed by a label [
13375 \begin_inset Quotes eld
13379 \begin_inset Quotes erd
13383 \begin_inset Quotes eld
13387 \begin_inset Quotes erd
13392 The color is a stunning magenta instead of blue,
13394 \begin_inset Quotes eld
13398 \begin_inset Quotes erd
13401 will look different,
13402 in style and in length.
13403 The label fonts of all three also differ from one another.
13406 \begin_layout Standard
13412 if the contents of a
13420 exceed the physical size of a slide or sheet of paper,
13421 the extra will overflow onto a new sheet.
13423 you should avoid this.
13424 It defeats the whole purpose of
13435 \begin_layout Paragraph
13445 \begin_layout Standard
13450 is a slide that sits atop another slide.
13451 Perhaps you wish to discuss a figure on the main
13455 before displaying the text associated with it.
13456 One way to accomplish this is tape a flap of dark paper over the part of the
13460 you want to display later.
13463 if you wish to overlap one graph with another,
13465 You would then have to fumble while speaking to align the two separate,
13470 s to align the two graphs.
13475 environment in both cases makes life much easier.
13478 \begin_layout Standard
13483 receives the page number of its
13484 \begin_inset Quotes eld
13488 \begin_inset Quotes erd
13497 \begin_inset Quotes eld
13505 \begin_inset Quotes erd
13512 \begin_layout Plain Layout
13519 \begin_inset Quotes eld
13527 \begin_inset Quotes erd
13532 \begin_inset Quotes eld
13540 \begin_inset Quotes erd
13545 \begin_inset Quotes eld
13553 \begin_inset Quotes erd
13558 \begin_inset space ~
13561 appended to the page number of the parent
13572 you want the contents of both the
13580 to each fit on a single physical slide!
13581 You should probably consider an
13586 \begin_inset Quotes eld
13590 \begin_inset Quotes erd
13599 the \SpecialChar LyX
13604 class provides a visual cue for this:
13605 the label at the start of an
13609 is shorter than that at the start of a
13615 when you generate printable output,
13616 you'll find alignment markers in all four corners of both the
13620 page and its parent
13625 These will assist you in lining up the two physical slides.
13628 \begin_layout Standard
13629 The major problem in overlaying two slides is aligning the contents of the two transparencies.
13630 How much space should you leave for that graph on the second slide?
13632 what if you want a graph and a sentence on second slide,
13633 but there is text on the main transparency that goes in between them?
13634 You could try and insert vertical space of the right size.
13635 The better way is to use
13646 \begin_layout Standard
13647 As their names imply,
13656 are two command-like paragraph environments that make all subsequent text invisible and visible,
13659 \begin_inset space ~
13663 \begin_inset CommandInset ref
13665 reference "sec:slideQuirk"
13670 that you don't place anything
13674 these two environments,
13681 it inserts a centered,
13682 sky-blue label into the page reading
13683 \begin_inset Quotes eld
13686 <Invisible Text Follows>
13687 \begin_inset Quotes erd
13691 For paragraphs following this label,
13701 it doesn't matter which] where they would be contain instead blank space.
13705 \begin_layout Standard
13711 the corresponding centered label is
13712 \begin_inset Quotes eld
13715 <Visible Text Follows>
13716 \begin_inset Quotes erd
13720 Paragraphs following this label behave normally.
13721 Note that the beginning of a new
13735 automatically shuts off an
13740 It's therefore not necessary to use
13751 \begin_layout Standard
13753 it should be obvious how to create overlay transparencies using the proper combination of
13772 \begin_layout Enumerate
13778 including everything that will appear on it,
13779 whether on the main slide or on the
13786 \begin_layout Enumerate
13787 Before each figure or paragraph that will appear only on the
13802 environment after the
13809 \begin_layout Enumerate
13814 immediately following the
13821 \begin_layout Enumerate
13822 Copy the contents of this
13833 \begin_layout Enumerate
13850 \begin_layout Standard
13852 You've just made an
13859 \begin_layout Standard
13860 There's one problem with the way I've designed the \SpecialChar LyX
13866 you can't make text in the middle of a paragraph invisible,
13867 nor make text in the middle of an invisible paragraph visible again.
13868 To accomplish this feat,
13869 you'll need to use some inlined \SpecialChar LaTeX
13874 \begin_layout Plain Layout
13875 The commands of interest are:
13879 \begin_layout Itemize
13884 invisible \SpecialChar ldots
13888 \begin_layout Itemize
13893 visible \SpecialChar ldots
13897 \begin_layout Plain Layout
13899 and need to be marked as \SpecialChar TeX
13902 \begin_inset Quotes eld
13906 \begin_inset Quotes erd
13909 you wish to change goes in between the brackets [and after the
13922 If you don't know how to mark text as \SpecialChar TeX
13924 see the appropriate section of the
13936 \begin_layout Paragraph
13946 \begin_inset CommandInset label
13948 name "sec:slideNote"
13955 \begin_layout Standard
13965 is associated with a
13966 \begin_inset Quotes eld
13970 \begin_inset Quotes erd
13980 the \SpecialChar LyX
13985 class provides visual cues.
13990 is shorter than that of a
13994 [yet longer than that of an
13999 like the label of an
14003 is shockingly magenta.
14009 has the page number of its
14010 \begin_inset Quotes eld
14014 \begin_inset Quotes erd
14023 \begin_inset Quotes eld
14031 \begin_inset Quotes erd
14036 \begin_inset Quotes eld
14044 \begin_inset Quotes erd
14049 \begin_inset Quotes eld
14057 \begin_inset Quotes erd
14062 You can have multiple
14066 s associated with a single
14081 you'll probably want to break up long
14085 s so that they fit on a single sheet of paper.
14088 \begin_layout Standard
14094 it contains anything additional you might want to say about a
14099 It could also be used as a sheet of reminders for a particular
14104 In the case of the latter,
14105 you might want to make use of time markers.
14107 the \SpecialChar LyX
14113 \begin_inset Quotes eld
14117 \begin_inset Quotes erd
14120 support for time markers,
14123 Sli\SpecialChar TeX
14128 you'll have to resort to using the \SpecialChar LaTeX
14132 \begin_layout Standard
14133 To use time markers,
14134 you'll need to specify the extra class option
14135 \begin_inset Quotes eld
14143 \begin_inset Quotes erd
14147 \begin_inset space ~
14151 \begin_inset CommandInset ref
14153 reference "sec:slidesetup"
14159 This option turns on timing marks,
14160 which will appear in the lower-left-hand corner of every
14165 To set what appears in the time marker,
14166 you use the \SpecialChar LaTeX
14168 \begin_inset Quotes eld
14178 \begin_inset Quotes erd
14182 \begin_inset Quotes eld
14192 \begin_inset Quotes erd
14196 The arguments of both commands are time measured in seconds.
14198 \begin_inset Quotes eld
14208 \begin_inset Quotes erd
14211 sets the time marker to a given time.
14213 \begin_inset Quotes eld
14223 \begin_inset Quotes erd
14226 increments the time marker by the specified amount.
14227 Using time markers and
14232 you can remind yourself how much time to spend on a particular
14239 \begin_layout Standard
14240 There's one last feature to describe.
14242 you'd like to print out all of your
14250 s on transparencies while printing all of your
14268 with which it is associated.
14269 What's a person to do?
14272 \begin_layout Standard
14274 there are two \SpecialChar LaTeX
14275 commands that allow you to select what to print out.
14276 Both must be placed into the preamble of your document.
14278 \begin_inset Quotes eld
14290 \begin_inset Quotes erd
14293 will cause the output to contain only the
14304 \begin_inset Quotes eld
14316 \begin_inset Quotes erd
14319 prevents the output of anything but
14324 I'd advise placing both commands in the preamble and initially comment both out.
14325 You can then preview your entire presentation as you write.
14326 When you're done writing,
14327 you can then uncomment one of the two to select what you want to print.
14328 I like to uncomment
14329 \begin_inset Quotes eld
14341 \begin_inset Quotes erd
14345 print to a file with
14346 \begin_inset Quotes eld
14354 \begin_inset Quotes erd
14358 comment it back out,
14360 \begin_inset Quotes eld
14372 \begin_inset Quotes erd
14376 \begin_inset Quotes eld
14384 \begin_inset Quotes erd
14388 I can then send either file to a printer,
14389 loading transparencies or plain paper as appropriate.
14392 \begin_layout Standard
14393 You can also provide other arguments to the
14394 \begin_inset Quotes eld
14404 \begin_inset Quotes erd
14408 \begin_inset Quotes eld
14418 \begin_inset Quotes erd
14422 See a good \SpecialChar LaTeX
14426 \begin_layout Subsubsection
14431 Class Template File
14434 \begin_layout Standard
14435 I have also provided a template file
14436 \change_deleted 564990737 1671617750
14439 \begin_inset Quotes eld
14447 \begin_inset Quotes erd
14459 begin your new presentation with
14461 File\SpecialChar menuseparator
14463 \begin_inset space ~
14467 \begin_inset space ~
14471 \change_inserted 564990737 1671616988
14472 \SpecialChar menuseparator
14473 Presentations\SpecialChar menuseparator
14479 Your new \SpecialChar LyX
14480 presentation file will contain an example
14501 additionally contain an example of the use of
14511 the preamble will contain:
14514 \begin_layout LyX-Code
14515 % Uncomment to print out only slides and overlays
14518 \begin_layout LyX-Code
14522 \begin_layout LyX-Code
14528 \begin_inset Newline newline
14534 \begin_layout LyX-Code
14535 % Uncomment to print out only notes
14538 \begin_layout LyX-Code
14542 \begin_layout LyX-Code
14550 \begin_layout Standard
14552 I created this class to support the \SpecialChar LaTeX2e
14554 \begin_inset Quotes eld
14559 Sli\SpecialChar TeX
14563 \begin_inset Quotes erd
14567 one of the built-in \SpecialChar LaTeX2e
14569 Neither I nor the rest of the \SpecialChar LyX
14570 Team endorse or oppose the use of this built-in slide class.
14571 It's here if you want it or need it.
14572 There exist other \SpecialChar LaTeX2e
14573 classes for creating presentations,
14579 \begin_inset space ~
14583 \begin_inset CommandInset ref
14585 reference "sec:foiltex"
14591 \begin_inset Quotes eld
14599 \begin_inset Quotes erd
14602 package [present on some \SpecialChar TeX
14604 The latter is not yet supported under \SpecialChar LyX
14609 \begin_layout Plain Layout
14610 Perhaps you can take on the task\SpecialChar ldots
14616 I know nothing about these other classes.
14617 Try them out to see what sort of alternative they provide.
14620 \begin_layout Section
14622 \change_inserted 564990737 1670439661
14626 \begin_layout Subsection
14628 \change_inserted 564990737 1670439661
14632 \begin_layout Standard
14634 \change_inserted 564990737 1670439661
14643 document class for preparing reports.
14649 this provides parts,
14650 chapters and sections but does not provide the paragraph styles needed for a book;
14656 it provides the abstract paragraph style.
14658 it does not start a new chapter on the right hand page.
14661 \begin_layout Standard
14663 \change_inserted 564990737 1672743528
14668 document classes are described in the Collections (section
14669 \begin_inset space ~
14673 \begin_inset CommandInset ref
14675 reference "sec:Collections"
14683 \begin_layout Standard
14685 \change_inserted 564990737 1672743530
14689 \begin_inset space \thinspace{}
14692 (Japanese in vertical writing)
14697 \begin_inset space \thinspace{}
14704 \begin_inset space ~
14708 \begin_inset CommandInset ref
14710 reference "subsec:Japanese"
14718 \begin_layout Standard
14720 \change_inserted 564990737 1672743530
14724 \begin_inset space \thinspace{}
14731 \begin_inset space ~
14735 \begin_inset CommandInset ref
14737 reference "subsec:KOMA-Script"
14745 \begin_layout Standard
14747 \change_inserted 564990737 1672743530
14751 \begin_inset space \thinspace{}
14754 (with extra font sizes)
14758 \begin_inset space ~
14762 \begin_inset CommandInset ref
14764 reference "subsec:Extra-font-sizes"
14772 \begin_layout Standard
14774 \change_inserted 564990737 1672743569
14778 \begin_inset space \thinspace{}
14781 (Polish version by M.
14782 \begin_inset space \thinspace{}
14789 \begin_inset space ~
14793 \begin_inset CommandInset ref
14795 reference "subsec:Polish-M.W.collection"
14806 \begin_layout Section
14808 \change_inserted 564990737 1670439674
14812 \begin_layout Subsection
14816 \begin_layout Standard
14822 \begin_layout Subsubsection
14826 \begin_layout Standard
14827 Broadway is for writing plays.
14828 The format is more decorative than Hollywood,
14829 and much less standardized.
14830 This format should be suitable for workshops.
14833 \begin_layout Subsubsection
14837 \begin_layout Standard
14838 The same as in Hollywood.
14841 \begin_layout Subsubsection
14845 \begin_layout Standard
14850 names as labels then cross-reference the label to insert the name.
14851 The cross-reference dialog will show the current cast of characters.
14854 \begin_layout Subsubsection
14855 Paper size and Margins
14858 \begin_layout Standard
14866 \begin_layout Subsubsection
14870 \begin_layout Standard
14871 The following environments are available.
14872 You can use broadway.bind to get the bind keys shown at the right.
14875 \begin_layout Itemize
14879 \begin_inset Newline newline
14884 You should not have to use this,
14885 but it is here for anything that does not fit otherwise.
14888 \begin_layout Itemize
14892 \begin_inset space \hfill{}
14896 \begin_inset Newline newline
14901 Used to describe stage setting and the action.
14902 First use of speaker names in all CAPs.
14905 \begin_layout Itemize
14909 \begin_inset space \hfill{}
14913 \begin_inset Newline newline
14918 Automatically numbered.
14919 On screen it will be arabic,
14920 but will print as Roman.
14923 \begin_layout Itemize
14927 \begin_inset space \hfill{}
14931 \begin_inset Newline newline
14941 It is just centered text.
14944 \begin_layout Itemize
14948 \begin_inset space \hfill{}
14952 \begin_inset Newline newline
14957 Not automatically numbered.
14958 You supply the number.
14959 This is because I couldn't figure out how.
14962 \begin_layout Itemize
14966 \begin_inset space \hfill{}
14970 \begin_inset Newline newline
14975 A special case of Narrative to describe the setting and action as the curtain rises.
14978 \begin_layout Itemize
14982 \begin_inset space \hfill{}
14986 \begin_inset Newline newline
14991 The speaker's (actor's) title,
14992 centered in all CAPS.
14995 \begin_layout Itemize
14999 \begin_inset space \hfill{}
15003 \begin_inset Newline newline
15008 Instructions to the speaker.
15009 The parentheses are automatically inserted.
15010 The ( will appear on screen,
15011 but both will be in the printed play.
15012 This environment is only used within
15019 \begin_layout Itemize
15023 \begin_inset space \hfill{}
15027 \begin_inset Newline newline
15032 What the Speaker says.
15035 \begin_layout Itemize
15039 \begin_inset space \hfill{}
15043 \begin_inset Newline newline
15048 The curtain comes down.
15051 \begin_layout Itemize
15055 \begin_inset space \hfill{}
15061 \begin_layout Itemize
15065 \begin_inset space \hfill{}
15071 \begin_layout Itemize
15075 \begin_inset space \hfill{}
15081 \begin_layout Standard
15085 \begin_layout Subsection
15086 Hollywood (Hollywood spec scripts)
15089 \begin_layout Standard
15095 \begin_layout Subsubsection
15099 \begin_layout Standard
15100 Getting the format of a Hollywood script right is a
15101 \begin_inset Quotes eld
15105 \begin_inset Quotes erd
15108 It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
15109 Each page of a script should be one minute of film.
15110 Nothing goes in a script that you cannot see or hear on screen.
15111 The courier 12 pt font should be used throughout.
15115 \begin_layout Subsubsection
15119 \begin_layout Standard
15120 Speakers' lines should NEVER break in mid-sentence.
15121 If a speaker's lines continue over a page break,
15126 title followed by (Cont'd).
15129 \begin_layout Subsubsection
15133 \begin_layout Standard
15138 names as labels then cross-reference the label to insert the name.
15139 The cross-reference dialog will show the current cast of characters.
15140 You can use this to insert the speaker name in narratives also.
15143 \begin_layout Subsubsection
15144 Paper size and Margins
15147 \begin_layout Standard
15155 \begin_layout Subsubsection
15159 \begin_layout Standard
15160 The following environments are available.
15161 You can use hollywood.bind to get the bind keys shown at the right.
15164 \begin_layout Itemize
15168 \begin_inset Newline newline
15173 Used where nothing else works.
15177 \begin_layout Itemize
15183 \begin_inset space \hfill{}
15191 \begin_inset Newline newline
15194 Usually followed by something like
15195 \begin_inset Quotes eld
15198 on Sally waking up.
15199 \begin_inset Quotes erd
15205 \begin_layout Itemize
15209 \begin_inset space \hfill{}
15213 \begin_inset Newline newline
15218 Introduces a new INTERIOR camera set-up.
15219 Always followed by DAY or NIGHT,
15220 or something similar to define the lighting required.
15221 Everthing on this line in CAPS.
15224 \begin_layout Itemize
15228 \begin_inset space \hfill{}
15232 \begin_inset Newline newline
15237 Introduces a new EXTERIOR camera set-up.
15238 Everthing on this line in CAPS.
15241 \begin_layout Itemize
15245 \begin_inset space \hfill{}
15249 \begin_inset Newline newline
15254 The character speaking.
15257 \begin_layout Itemize
15261 \begin_inset space \hfill{}
15265 \begin_inset Newline newline
15270 Instructions to the speaker.
15271 The () are automatically inserted.
15274 \begin_layout Itemize
15278 \begin_inset space \hfill{}
15282 \begin_inset Newline newline
15294 \begin_layout Itemize
15298 \begin_inset space \hfill{}
15302 \begin_inset Newline newline
15307 Camera movement instruction.
15309 \begin_inset space \thinspace{}
15313 \begin_inset space \space{}
15319 \begin_layout Itemize
15323 \begin_inset space \hfill{}
15329 \begin_layout Itemize
15333 \begin_inset space \hfill{}
15339 \begin_layout Itemize
15343 \begin_inset space \hfill{}
15349 \begin_layout Itemize
15353 \begin_inset space \hfill{}
15359 \begin_layout Subsubsection
15363 \begin_layout Itemize
15368 \begin_layout Itemize
15373 \begin_layout Itemize
15375 \begin_inset space \thinspace{}
15383 \begin_layout Itemize
15389 \begin_layout Itemize
15394 \begin_layout Itemize
15399 \begin_layout Chapter
15401 \change_inserted 564990737 1671185876
15405 \begin_layout Section
15407 \change_inserted 564990737 1671716212
15408 Academic Field Specifics
15411 \begin_layout Subsection
15413 \change_inserted 564990737 1671716212
15415 Hazard and Precautionary Statements
15418 \begin_layout Standard
15420 \change_inserted 564990737 1671716212
15421 This module provides two insets to typeset numbers and phrases of chemical hazard and precautionary statements.
15422 For a description see
15424 File\SpecialChar menuseparator
15425 Open Example\SpecialChar menuseparator
15426 Modules\SpecialChar menuseparator
15427 Hazard and Precautionary Statements
15431 Help\SpecialChar menuseparator
15432 Specific Manuals\SpecialChar menuseparator
15433 Hazard and Precautionary Statements
15438 \begin_layout Subsection
15440 \change_inserted 564990737 1671716212
15444 Risk and Safety Statements
15447 \begin_layout Standard
15449 \change_inserted 564990737 1671716212
15450 This module provides two insets,
15460 accessible via the menu
15465 nsert\SpecialChar menuseparator
15467 \begin_inset space ~
15472 and an environment to typeset numbers and phrases of chemical risk and safety statements.
15475 \begin_layout Subsection
15477 \change_inserted 564990737 1671716212
15481 \begin_layout Standard
15483 \change_inserted 564990737 1671716212
15484 This module uses the
15488 package to add environments useful for linguistics (numbered examples,
15492 You can obtain information about this module in
15497 elp\SpecialChar menuseparator
15503 \begin_inset space ~
15506 Manuals\SpecialChar menuseparator
15515 File\SpecialChar menuseparator
15516 Open Example\SpecialChar menuseparator
15517 Modules\SpecialChar menuseparator
15523 \begin_layout Section
15525 \change_inserted 564990737 1671788778
15529 \begin_layout Subsection
15531 \change_inserted 564990737 1671788778
15535 \begin_layout Standard
15537 \change_inserted 564990737 1671788778
15538 This module supports the Braille writing system.
15539 It requires the \SpecialChar LaTeX
15545 This and its documentation can be obtained from
15546 \begin_inset CommandInset href
15549 target "https://www.ctan.org/pkg/braille"
15555 You do not have to reconfigure your system after installing it.
15561 elp\SpecialChar menuseparator
15567 \begin_inset space ~
15570 Manuals\SpecialChar menuseparator
15579 File\SpecialChar menuseparator
15580 Open Example\SpecialChar menuseparator
15581 Modules\SpecialChar menuseparator
15587 \begin_layout Section
15589 \change_inserted 564990737 1671788778
15590 Annotation & Revision
15593 \begin_layout Subsection
15595 \change_inserted 564990737 1671788778
15599 \begin_layout Standard
15601 \change_inserted 564990737 1671788778
15602 This module provides “FiXme” (marginal) annotations for document revision purposes.
15603 A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
15604 The annotations are customizable via the LaTeX preamble.
15605 See the FiXme documentation which can be obtained from
15606 \begin_inset CommandInset href
15609 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
15618 \begin_layout Paragraph
15620 \change_inserted 564990737 1671788778
15624 \begin_layout Standard
15626 \change_inserted 564990737 1671788778
15628 the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
15630 Document\SpecialChar menuseparator
15631 Settings\SpecialChar menuseparator
15632 Document Class\SpecialChar menuseparator
15633 Class Options\SpecialChar menuseparator
15637 To display them always,
15646 Document\SpecialChar menuseparator
15647 Settings\SpecialChar menuseparator
15655 \begin_layout Subsection
15657 \change_inserted 564990737 1671788778
15661 \begin_layout Standard
15663 \change_inserted 564990737 1671788778
15664 This module provides various kinds of annotations for PDF output.
15667 Help\SpecialChar menuseparator
15668 Specific Manuals\SpecialChar menuseparator
15669 PDF comments and File\SpecialChar menuseparator
15670 Open Example\SpecialChar menuseparator
15671 Modules\SpecialChar menuseparator
15677 \begin_layout Subsection
15679 \change_inserted 564990737 1671788778
15685 \begin_layout Standard
15687 \change_inserted 564990737 1671788778
15688 This module provides fields and buttons for PDF forms.
15690 \begin_inset CommandInset href
15692 name "hyperref documentation"
15693 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
15701 Help\SpecialChar menuseparator
15702 Specific Manuals\SpecialChar menuseparator
15703 PDF forms and File\SpecialChar menuseparator
15704 Open Example\SpecialChar menuseparator
15705 Modules\SpecialChar menuseparator
15711 \begin_layout Subsection
15713 \change_inserted 564990737 1671788778
15719 \begin_layout Standard
15721 \change_inserted 564990737 1671788778
15722 This module defines an inset to typeset reading aids (ruby,
15723 furigana) to Chinese characters.
15724 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on the TeX engine) or a fallback definition.
15728 \begin_layout Subsection
15730 \change_inserted 564990737 1671788778
15736 \begin_layout Standard
15738 \change_inserted 564990737 1671788778
15739 This module provides custom insets to insert TODO items in your document.
15740 In order to generate a “List of TODOs,” the module provides a paragraph style.
15741 Inserting “final” in
15743 Document\SpecialChar menuseparator
15744 Settings\SpecialChar menuseparator
15745 Document Class\SpecialChar menuseparator
15746 Class Options\SpecialChar menuseparator
15749 ) suppresses the output of TODO notes.
15751 \begin_inset CommandInset href
15753 name "todonotes documentation"
15754 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
15762 \begin_layout Section
15764 \change_inserted 564990737 1671829045
15768 \begin_layout Subsection
15770 \change_inserted 564990737 1671829045
15771 APA Style with NatBib
15774 \begin_layout Standard
15776 \change_inserted 564990737 1671829045
15777 This module adds support for using natbib together with apacite (the bibliography style need not be apacite —
15778 it could be apacite,
15780 or any bibliography that works with both the natbib and apacite packages.)
15783 \begin_layout Section
15785 \change_inserted 564990737 1671829045
15789 \begin_layout Subsection
15791 \change_inserted 564990737 1671829045
15792 Fancy Colored Boxes
15795 \begin_layout Standard
15797 \change_inserted 564990737 1671829045
15798 This module adds ten custom insets that support colored boxes via the tcolorbox package.
15801 Help\SpecialChar menuseparator
15802 Specific Manuals\SpecialChar menuseparator
15808 File\SpecialChar menuseparator
15809 Open Example\SpecialChar menuseparator
15810 Modules\SpecialChar menuseparator
15814 \begin_inset CommandInset href
15816 name "tcolorbox documentation"
15817 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
15826 \begin_layout Subsection
15828 \change_inserted 564990737 1671829045
15832 \begin_layout Standard
15834 \change_inserted 564990737 1671829045
15835 This provides the custom insets
15853 to scale and rotate its content.
15856 \begin_layout Standard
15858 \change_inserted 564990737 1671829045
15863 is a simple way of reversing text without any other enhancement:
15866 \begin_layout Standard
15868 \change_inserted 564990737 1671829045
15869 \begin_inset Flex Reflectbox
15872 \begin_layout Plain Layout
15874 \change_inserted 564990737 1671829045
15875 Great Western Railway
15885 \begin_layout Standard
15887 \change_inserted 564990737 1671829045
15888 (You will need to use Ctrl-R to see any of these examples.)
15891 \begin_layout Standard
15893 \change_inserted 564990737 1671829045
15898 allows you to specify the dimensions of the text or image;
15899 permissible units are em,
15921 it scales by the width factor:
15924 \begin_layout Standard
15926 \change_inserted 564990737 1671829045
15927 \begin_inset Flex Resizebox
15930 \begin_layout Plain Layout
15932 \change_inserted 564990737 1671829045
15933 \begin_inset Argument 1
15936 \begin_layout Plain Layout
15938 \change_inserted 564990737 1671829045
15947 \begin_inset Argument 2
15950 \begin_layout Plain Layout
15952 \change_inserted 564990737 1671829045
15960 Great Western Railway
15970 \begin_layout Standard
15972 \change_inserted 564990737 1671829045
15977 allows you to rotate text around the reference point of the box.
15978 If you wish to rotate the box around a different origin,
15979 place the cursor inside the box and select Insert\SpecialChar menuseparator
16009 or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
16013 \begin_layout Standard
16015 \change_inserted 564990737 1671829045
16016 \begin_inset Flex Rotatebox
16019 \begin_layout Plain Layout
16021 \change_inserted 564990737 1671829045
16022 \begin_inset Argument 1
16025 \begin_layout Plain Layout
16027 \change_inserted 564990737 1671829045
16036 \begin_inset Argument 2
16039 \begin_layout Plain Layout
16041 \change_inserted 564990737 1671829045
16049 Great Western Railway
16059 \begin_layout Standard
16061 \change_inserted 564990737 1671829045
16062 You can combine boxes as in:
16065 \begin_layout Standard
16067 \change_inserted 564990737 1671829045
16068 \begin_inset Flex Rotatebox
16071 \begin_layout Plain Layout
16073 \change_inserted 564990737 1671829045
16074 \begin_inset Argument 1
16077 \begin_layout Plain Layout
16079 \change_inserted 564990737 1671829045
16088 \begin_inset Argument 2
16091 \begin_layout Plain Layout
16093 \change_inserted 564990737 1671829045
16102 \begin_inset Flex Resizebox
16105 \begin_layout Plain Layout
16107 \change_inserted 564990737 1671829045
16108 \begin_inset Argument 1
16111 \begin_layout Plain Layout
16113 \change_inserted 564990737 1671829045
16122 \begin_inset Argument 2
16125 \begin_layout Plain Layout
16127 \change_inserted 564990737 1671829045
16136 \begin_inset Flex Reflectbox
16139 \begin_layout Plain Layout
16141 \change_inserted 564990737 1671829045
16142 Great Western Railway
16166 \begin_layout Standard
16168 \change_inserted 564990737 1671829045
16174 select Insert\SpecialChar menuseparator
16175 V-Factor to add a vertical factor.
16176 If the vertical factor is omitted,
16177 the horizontal is used.
16178 Adding different horizontal and vertical values creates distortion as in
16181 \begin_layout Standard
16183 \change_inserted 564990737 1671829045
16186 \begin_inset Flex Scalebox
16189 \begin_layout Plain Layout
16191 \change_inserted 564990737 1671829045
16192 \begin_inset Argument 1
16195 \begin_layout Plain Layout
16197 \change_inserted 564990737 1671829045
16206 \begin_inset Argument 2
16209 \begin_layout Plain Layout
16211 \change_inserted 564990737 1671829045
16221 Great Western Railway
16231 \begin_layout Standard
16233 \change_inserted 564990737 1671829045
16234 A negative horizontal value reverses the text and a negative vertical value inverts it so that you get
16237 \begin_layout Standard
16239 \change_inserted 564990737 1671829045
16240 \begin_inset Flex Scalebox
16243 \begin_layout Plain Layout
16245 \change_inserted 564990737 1671829045
16246 \begin_inset Argument 1
16249 \begin_layout Plain Layout
16251 \change_inserted 564990737 1671829045
16260 \begin_inset Argument 2
16263 \begin_layout Plain Layout
16265 \change_inserted 564990737 1671829045
16273 Great Western Railway
16281 \begin_inset Flex Scalebox
16284 \begin_layout Plain Layout
16286 \change_inserted 564990737 1671829045
16287 \begin_inset Argument 1
16290 \begin_layout Plain Layout
16292 \change_inserted 564990737 1671829045
16301 \begin_inset Argument 2
16304 \begin_layout Plain Layout
16306 \change_inserted 564990737 1671829045
16314 Great Western Railway
16324 \begin_layout Subsection
16326 \change_inserted 564990737 1671884699
16330 \begin_layout Standard
16332 \change_inserted 564990737 1671884699
16333 This module defines Boxes with section header.
16334 It is mainly intended for the SciPoster Document class.
16338 \begin_layout Subsection
16340 \change_inserted 564990737 1671884699
16341 Variable-width Minipages
16344 \begin_layout Standard
16346 \change_inserted 564990737 1671884699
16350 \begin_inset space \thinspace{}
16357 Insert\SpecialChar menuseparator
16369 package provides a variable-width minipage,
16370 whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
16371 The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
16373 Insert\SpecialChar menuseparator
16375 \begin_inset space \thinspace{}
16386 Insert\SpecialChar menuseparator
16388 \begin_inset space \thinspace{}
16402 File\SpecialChar menuseparator
16403 Open Example\SpecialChar menuseparator
16404 Variable-width Minipages
16410 \begin_layout Section
16412 \change_inserted 564990737 1671884699
16416 \begin_layout Subsection
16418 \change_inserted 564990737 1671884699
16419 Fix Computer Modern Fonts
16422 \begin_layout Standard
16424 \change_inserted 564990737 1671884699
16425 This module uses the
16429 package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
16431 \begin_inset CommandInset href
16433 name "fix-cm documentation"
16434 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
16443 \begin_layout Subsection
16445 \change_inserted 564990737 1671884699
16447 Kernel Fixes (Obsolete)
16450 \begin_layout Standard
16452 \change_inserted 564990737 1671884699
16453 This module loads the \SpecialChar LaTeX
16458 which contains some bug fixes for \SpecialChar LaTeX
16460 If you use this module your typeset document may look different when you process it,
16461 depending on the respective version of
16469 \begin_layout Paragraph
16471 \change_inserted 564990737 1671884699
16475 \begin_layout Standard
16477 \change_inserted 564990737 1671884699
16478 recent \SpecialChar LaTeX
16479 kernels (as of 2015/01/01) include the functionality of
16488 module is obsolete with newer \SpecialChar LaTeX
16493 \begin_layout Subsection
16495 \change_inserted 564990737 1671884699
16496 Minimalistic Insets
16499 \begin_layout Standard
16501 \change_inserted 564990737 1671884699
16502 This module redefines several insets (Index,
16504 URL) as being Minimalistic.
16507 \begin_layout Subsection
16509 \change_inserted 564990737 1671884699
16510 Title and Preamble Hacks
16513 \begin_layout Standard
16515 \change_inserted 564990737 1671884699
16516 This module provides two new paragraph styles:
16520 \begin_layout Enumerate
16522 \change_inserted 564990737 1671884699
16527 which puts whatever is entered into it into the preamble.
16530 to include preamble code in the body of a LyX document.
16534 \begin_layout Enumerate
16536 \change_inserted 564990737 1671884699
16541 which that will put its contents into the body of the LaTeX document,
16549 This is useful for making branches and notes in title-related material.
16551 if you put these in a Standard layout,
16552 this signals to LyX to output
16559 which may then come too early.)
16562 \begin_layout Section
16564 \change_inserted 564990737 1672081439
16568 \begin_layout Subsection
16570 \change_inserted 564990737 1672081439
16574 \begin_layout Standard
16576 \change_inserted 564990737 1672081439
16577 This module uses the
16581 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
16582 Use the Algorithm paragraph style to enter and indent the algorithm.
16584 \begin_inset CommandInset href
16586 name "algorithm2e documentation"
16587 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
16595 \begin_layout Subsection
16597 \change_inserted 564990737 1672081439
16598 Bilingual Captions AKA Multilingual Captions
16601 \begin_layout Standard
16603 \change_inserted 564990737 1672081439
16604 This module provides the paragraph style
16607 \begin_inset space ~
16612 with which to typeset multilingual captions.
16613 Within this paragraph style
16615 Insert\SpecialChar menuseparator
16618 allows you to enter the desired language using one of the babel names.
16621 File\SpecialChar menuseparator
16622 Open Example\SpecialChar menuseparator
16623 Multilingual Captions
16627 Help\SpecialChar menuseparator
16628 Specific Manuals\SpecialChar menuseparator
16629 Multilingual Captions
16631 further information on its use.
16634 \begin_layout Subsection
16636 \change_inserted 564990737 1672081439
16637 Number Figures by Section
16640 \begin_layout Standard
16642 \change_inserted 564990737 1672081439
16643 This module resets the figure number at section start and prepends the section number to the figure number,
16644 as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
16647 \begin_layout Subsection
16649 \change_inserted 564990737 1672081439
16650 Number Tables by Section
16653 \begin_layout Standard
16655 \change_inserted 564990737 1672081439
16656 This module resets the table number at section start and prepends the section number to the table number,
16657 as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
16660 \begin_layout Section
16662 \change_inserted 564990737 1672081439
16666 \begin_layout Subsection
16668 \change_inserted 564990737 1672081439
16672 \begin_layout Standard
16674 \change_inserted 564990737 1672081439
16675 This module adds an endnote inset,
16676 in addition to footnotes.
16682 which has some limitations but works with older LaTeX distributions as well.
16685 Insert\SpecialChar menuseparator
16686 Custom Inset\SpecialChar menuseparator
16689 to insert an endnote and
16691 Insert\SpecialChar menuseparator
16692 List/Contents/References\SpecialChar menuseparator
16695 to insert the endnotes list where you want the endnotes to appear.
16698 Help\SpecialChar menuseparator
16699 Embedded\SpecialChar menuseparator
16700 Objects\SpecialChar menuseparator
16701 Notes\SpecialChar menuseparator
16707 \begin_layout Subsection
16709 \change_inserted 564990737 1672081439
16710 Endnotes (Extended)
16713 \begin_layout Standard
16715 \change_inserted 564990737 1672081439
16716 This module adds an endnote inset,
16717 in addition to footnotes.
16722 package which is more powerful and customizable than the
16727 but requires a fairly modern LaTeX distribution (with LaTeX3).
16730 Insert\SpecialChar menuseparator
16731 Custom Inset\SpecialChar menuseparator
16734 to insert an endnote and
16736 Insert\SpecialChar menuseparator
16737 List/Contents/References\SpecialChar menuseparator
16740 to insert the endnotes list where you want the endnotes to appear.
16743 Help\SpecialChar menuseparator
16744 Embedded\SpecialChar menuseparator
16745 Objects\SpecialChar menuseparator
16746 Notes\SpecialChar menuseparator
16752 \begin_layout Subsection
16754 \change_inserted 564990737 1672081439
16755 Footnotes as Endnotes (Basic)
16758 \begin_layout Standard
16760 \change_inserted 564990737 1672081439
16761 This module sets all footnotes as endnotes.
16767 which has some limitations but works with older LaTeX distributions as well.
16770 Insert\SpecialChar menuseparator
16771 List/Contents/References\SpecialChar menuseparator
16774 to insert the endnotes list where you want the endnotes to appear.
16777 Help\SpecialChar menuseparator
16778 Embedded\SpecialChar menuseparator
16779 Objects\SpecialChar menuseparator
16780 Notes\SpecialChar menuseparator
16786 \begin_layout Subsection
16788 \change_inserted 564990737 1672081439
16789 Footnotes as Endnotes (Extended)
16792 \begin_layout Standard
16794 \change_inserted 564990737 1672081439
16795 This module sets all footnotes as endnotes.
16800 package which is more powerful and customizable than then
16805 but requires a fairly modern LaTeX distribution (with LaTeX3).
16808 Insert\SpecialChar menuseparator
16809 List/Contents/References\SpecialChar menuseparator
16812 to insert the endnotes list where you want the endnotes to appear.
16815 Help\SpecialChar menuseparator
16816 Embedded\SpecialChar menuseparator
16817 Objects\SpecialChar menuseparator
16818 Notes\SpecialChar menuseparator
16824 \begin_layout Section
16826 \change_inserted 564990737 1672081439
16831 \begin_layout Subsection
16833 \change_inserted 564990737 1672081439
16837 \begin_layout Standard
16839 \change_inserted 564990737 1672081439
16840 This module provides support for the
16844 package to print chess games.
16847 File\SpecialChar menuseparator
16848 Open Example\SpecialChar menuseparator
16849 Articles\SpecialChar menuseparator
16852 where you will find
16861 \begin_inset CommandInset href
16863 name "chessboard documentation"
16864 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
16872 \begin_layout Subsection
16874 \change_inserted 564990737 1672081439
16875 Lilypond Music Notation
16878 \begin_layout Standard
16880 \change_inserted 564990737 1672081439
16881 This module provides an inset via
16886 nsert\SpecialChar menuseparator
16887 Custom Inset\SpecialChar menuseparator
16890 in which to enter code for the LilyPond music editor.
16891 It will then be processed in the output.
16894 Help\SpecialChar menuseparator
16895 Specific Manuals\SpecialChar menuseparator
16900 File\SpecialChar menuseparator
16901 Open Example\SpecialChar menuseparator
16902 Modules\SpecialChar menuseparator
16906 It cannot be used if the modules
16909 \begin_inset space \thinspace{}
16917 \begin_layout Section
16919 \change_inserted 564990737 1672138150
16923 \begin_layout Subsection
16925 \change_inserted 564990737 1672138150
16927 \begin_inset CommandInset label
16929 name "subsec:Customizable-Lists"
16936 \begin_layout Standard
16938 \change_inserted 564990737 1672138150
16939 This module uses the
16943 package to enable the customization of various list environments.
16946 \begin_layout Subsubsection
16948 \change_inserted 564990737 1672138150
16949 Custom Enumerate Lists
16952 \begin_layout Standard
16955 \change_inserted 564990737 1672138150
16956 The default numbering of numbered lists can be changed by adding an optional argument (menu
16961 nsert\SpecialChar menuseparator
16968 ) to the first item of each level in the list.
16969 There you add the command
16972 \begin_layout Standard
16974 \change_inserted 564990737 1672138150
16982 \begin_layout Standard
16984 \change_inserted 564990737 1672138150
16985 in \SpecialChar TeX
16995 \begin_layout Standard
16997 \change_inserted 564990737 1672138150
17002 is the first level counter of the enumeration.
17003 To change the numbering for the list sublevels,
17008 ” in the command by the small Roman numeral of the level (
17030 \begin_layout Standard
17032 \change_inserted 564990737 1672138150
17039 outputs the counter as a small Roman numeral.
17040 For capital Roman numerals replace
17052 in the command above.
17053 For Arabic numerals use
17061 \begin_inset Quotes eld
17065 \begin_inset Quotes erd
17068 items with capital or small Latin letters use
17084 \begin_layout Standard
17087 \change_inserted 564990737 1672138150
17088 \begin_inset Note Greyedout
17091 \begin_layout Plain Layout
17093 \change_inserted 564990737 1672138150
17099 You can only number 26
17100 \begin_inset space ~
17103 items with Latin letters,
17104 because this numbering is limited to single letters.
17112 \begin_layout Standard
17114 \change_inserted 564990737 1672138150
17115 Here is a list with custom numbering:
17118 \begin_layout Enumerate
17120 \change_inserted 564990737 1672138150
17121 \begin_inset Argument 1
17124 \begin_layout Plain Layout
17126 \change_inserted 564990737 1672138150
17130 \begin_layout Plain Layout
17132 \change_inserted 564990737 1672138150
17153 \begin_inset Separator latexpar
17160 \begin_layout Enumerate
17162 \change_inserted 564990737 1672138150
17163 \begin_inset Argument 1
17166 \begin_layout Plain Layout
17168 \change_inserted 564990737 1672138150
17172 \begin_layout Plain Layout
17174 \change_inserted 564990737 1672138150
17195 \begin_layout Enumerate
17197 \change_inserted 564990737 1672138150
17199 \begin_inset Separator latexpar
17206 \begin_layout Enumerate
17208 \change_inserted 564990737 1672138150
17209 \begin_inset Argument 1
17212 \begin_layout Plain Layout
17214 \change_inserted 564990737 1672138150
17218 \begin_layout Plain Layout
17220 \change_inserted 564990737 1672138150
17239 \begin_inset Separator latexpar
17246 \begin_layout Enumerate
17248 \change_inserted 564990737 1672138150
17249 \begin_inset Argument 1
17252 \begin_layout Plain Layout
17254 \change_inserted 564990737 1672138150
17258 \begin_layout Plain Layout
17260 \change_inserted 564990737 1672138150
17284 \begin_layout Standard
17286 \change_inserted 564990737 1672138150
17287 For this list these commands were used:
17290 \begin_layout Standard
17293 \change_inserted 564990737 1672138150
17303 \begin_inset Newline newline
17311 \begin_inset Newline newline
17319 \begin_inset Newline newline
17329 \begin_layout Standard
17331 \change_inserted 564990737 1672138150
17338 makes the label emphasized and
17347 \begin_layout Standard
17349 \change_inserted 564990737 1672138150
17350 \begin_inset Note Greyedout
17353 \begin_layout Plain Layout
17355 \change_inserted 564990737 1672138150
17361 When you change the label of a list level,
17362 it will be used for all following lists until you change the definition.
17370 \begin_layout Standard
17372 \change_inserted 564990737 1672138150
17376 \begin_layout Plain Layout
17378 \change_inserted 564990737 1672138150
17396 \begin_layout Subsubsection
17398 \change_inserted 564990737 1672138150
17399 Numbered Paragraphs in Reports
17402 \begin_layout Enumerate
17404 \change_inserted 564990737 1672138213
17405 Official reports often include numbered paragraphs;
17406 you can achieve this with a variation on the approach outlined in the footnote
17407 \begin_inset space ~
17411 \begin_inset CommandInset ref
17413 reference "fn:If-you-really"
17426 in each command with
17433 \begin_layout Enumerate
17435 \change_inserted 564990737 1672138150
17436 These numbered paragraphs were generated by inserting the \SpecialChar TeX
17438 \begin_inset Separator latexpar
17445 \begin_layout Standard
17447 \change_inserted 564990737 1672138150
17461 \begin_layout Standard
17463 \change_inserted 564990737 1672138150
17464 before the start of the section;
17471 uses the \SpecialChar LaTeX
17472 section counter to generate the first part of the number.
17476 \begin_layout Enumerate
17478 \change_inserted 564990737 1672138150
17479 I have ignored the subsection heading in this example because,
17480 with paragraphs numbered in this way,
17481 subsections are less likely to be used.
17484 \begin_layout Subsubsection
17486 \change_inserted 564990737 1672138150
17487 Resumed Enumeration
17490 \begin_layout Standard
17492 \change_inserted 564990737 1672138150
17496 \begin_layout Plain Layout
17498 \change_inserted 564990737 1672138150
17514 \begin_layout Standard
17516 \change_inserted 564990737 1672138150
17517 Enumerations can be resumed after intermediate paragraphs:
17520 \begin_layout Enumerate
17522 \change_inserted 564990737 1672138150
17523 \begin_inset Argument 1
17526 \begin_layout Plain Layout
17528 \change_inserted 564990737 1672138150
17532 \begin_layout Plain Layout
17534 \change_inserted 564990737 1672138150
17551 \begin_inset Note Note
17554 \begin_layout Plain Layout
17556 \change_inserted 564990737 1672138150
17557 goes back to default numbering
17565 \begin_layout Enumerate
17567 \change_inserted 564990737 1672138150
17571 \begin_layout Standard
17573 \change_inserted 564990737 1672138150
17577 \begin_layout Enumerate-Resume
17579 \change_inserted 564990737 1672138150
17583 \begin_layout Standard
17585 \change_inserted 564990737 1672138150
17586 To resume an enumeration,
17592 Its numbering appears in blue within \SpecialChar LyX
17593 to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
17598 \begin_layout Standard
17600 \change_inserted 564990737 1672138150
17601 \begin_inset Note Greyedout
17604 \begin_layout Plain Layout
17606 \change_inserted 564990737 1672138150
17612 If there is no previous enumeration to resume,
17613 you will get a \SpecialChar LaTeX
17622 \begin_layout Standard
17624 \change_inserted 564990737 1672138150
17625 Perhaps you might want to resume the list with a different number from the next one.
17626 Or you want to start a new enumeration with a defined number.
17627 This is possible by adding an optional argument to the first list item of a normal enumeration.
17632 \begin_layout Standard
17634 \change_inserted 564990737 1672138150
17640 \begin_layout Standard
17642 \change_inserted 564990737 1672138150
17647 is the number with which you want to resume the list.
17651 \begin_layout Enumerate
17653 \change_inserted 564990737 1672138150
17657 \begin_layout Enumerate
17659 \change_inserted 564990737 1672138150
17663 \begin_layout Standard
17665 \change_inserted 564990737 1672138150
17666 Enumeration starting at a given value:
17669 \begin_layout Enumerate
17671 \change_inserted 564990737 1672138150
17672 \begin_inset Argument 1
17675 \begin_layout Plain Layout
17677 \change_inserted 564990737 1672138150
17681 \begin_layout Plain Layout
17683 \change_inserted 564990737 1672138150
17697 This enumeration starts at 4
17700 \begin_layout Subsubsection
17702 \change_inserted 564990737 1672138150
17704 \begin_inset Index idx
17709 \begin_layout Plain Layout
17711 \change_inserted 564990737 1672138150
17723 \begin_layout Standard
17725 \change_inserted 564990737 1672138150
17726 In some cases you might want less or more vertical space between the items of a list.
17727 For example if the default space is too much in your opinion in this case:
17730 \begin_layout Itemize
17732 \change_inserted 564990737 1672138150
17736 \begin_layout Itemize
17738 \change_inserted 564990737 1672138150
17739 with standard spacing
17742 \begin_layout Standard
17744 \change_inserted 564990737 1672138150
17745 You can decrease the space by adding an optional argument to the first item of the list.
17746 Add there the command
17750 to get no additional list space like in this example:
17753 \begin_layout Itemize
17755 \change_inserted 564990737 1672138150
17756 \begin_inset Argument 1
17759 \begin_layout Plain Layout
17761 \change_inserted 564990737 1672138150
17765 \begin_layout Plain Layout
17767 \change_inserted 564990737 1672138150
17784 \begin_layout Itemize
17786 \change_inserted 564990737 1672138150
17790 \begin_layout Itemize
17792 \change_inserted 564990737 1672138150
17796 \begin_layout Standard
17798 \change_inserted 564990737 1672138150
17799 To add space you can use several other commands provided by the
17804 \begin_inset Index idx
17809 \begin_layout Plain Layout
17811 \change_inserted 564990737 1672138150
17822 For more information see the
17823 \begin_inset CommandInset href
17825 name "enumitem documentation"
17826 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
17834 \begin_layout Standard
17836 \change_inserted 564990737 1672138150
17837 There are also many commands available to change the horizontal spacing and indentation.
17838 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
17839 \begin_inset space \thinspace{}
17842 cm so that the number is in the page margin:
17845 \begin_layout Enumerate
17847 \change_inserted 564990737 1672138150
17848 \begin_inset Argument 1
17851 \begin_layout Plain Layout
17853 \change_inserted 564990737 1672138150
17857 \begin_layout Plain Layout
17859 \change_inserted 564990737 1672138150
17879 \begin_layout Enumerate
17881 \change_inserted 564990737 1672138150
17882 with negative indentation
17885 \begin_layout Subsubsection
17887 \change_inserted 564990737 1672138150
17888 Further Customization
17889 \begin_inset Index idx
17894 \begin_layout Plain Layout
17896 \change_inserted 564990737 1672138150
17908 \begin_layout Standard
17910 \change_inserted 564990737 1672138150
17911 You can also change the style of description lists.
17915 \begin_layout Standard
17917 \change_inserted 564990737 1672138150
17923 \begin_layout Standard
17925 \change_inserted 564990737 1672138150
17926 changes the description label font,
17930 \begin_layout Standard
17932 \change_inserted 564990737 1672138150
17941 \begin_layout Standard
17943 \change_inserted 564990737 1672138150
17944 sets the list style.
17947 \begin_layout Standard
17949 \change_inserted 564990737 1672138150
17950 An example where the command
17953 \begin_layout Standard
17955 \change_inserted 564990737 1672138150
17964 \begin_layout Standard
17966 \change_inserted 564990737 1672138150
17970 \begin_layout Description
17972 \change_inserted 564990737 1672138150
17974 \begin_inset space ~
17979 \begin_inset Argument 1
17982 \begin_layout Plain Layout
17984 \change_inserted 564990737 1672138150
17988 \begin_layout Plain Layout
17990 \change_inserted 564990737 1672138150
18009 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
18010 therefore ionizing them.
18013 \begin_layout Description
18015 \change_inserted 564990737 1672138150
18017 \begin_inset space ~
18021 In computer science,
18022 reference counting is a technique of storing the number of references,
18024 or handles to a resource such as an object,
18026 disk space or other resource.
18029 \begin_layout Standard
18031 \change_inserted 564990737 1672138150
18032 There are many more commands and features provided by the
18037 \begin_inset Index idx
18042 \begin_layout Plain Layout
18044 \change_inserted 564990737 1672138150
18055 For more information see the
18056 \begin_inset CommandInset href
18058 name "enumitem documentation"
18059 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18067 \begin_layout Subsection
18069 \change_inserted 564990737 1672138150
18075 \begin_layout Standard
18077 \change_inserted 564990737 1672138150
18078 This module uses the package
18082 to provide nine new list environments.
18083 Itemized and enumerated lists can be typeset within paragraphs,
18084 as paragraphs and in a compact version.
18085 Most environments have optional arguments to format the labels.
18087 the \SpecialChar LaTeX
18088 list environments itemize and enumerate are extended to use a similar optional argument.
18089 For further details see
18091 File\SpecialChar menuseparator
18092 Open Example\SpecialChar menuseparator
18093 Modules\SpecialChar menuseparator
18094 Paragraph Lists (paralist)
18099 Help\SpecialChar menuseparator
18100 Specific Manuals\SpecialChar menuseparator
18104 \begin_inset CommandInset href
18106 name "paralist documentation"
18107 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
18115 \begin_layout Section
18117 \change_inserted 564990737 1672161542
18118 Literate Programming
18121 \begin_layout Subsection
18123 \change_inserted 564990737 1672161542
18127 \begin_layout Standard
18129 \change_inserted 564990737 1672161542
18130 This module allows the use of Noweb as a literate programming tool.
18131 The files and the documentation for Noweb can be obtained from
18132 \begin_inset CommandInset href
18135 target "https://www.ctan.org/pkg/noweb"
18141 Literate programming is described in section
18142 \begin_inset space ~
18146 \begin_inset CommandInset ref
18148 reference "sec:Literate-Programming"
18153 and there are three example files:
18156 File\SpecialChar menuseparator
18157 Open Example\SpecialChar menuseparator
18158 Modules\SpecialChar menuseparator
18164 File\SpecialChar menuseparator
18165 Open Example\SpecialChar menuseparator
18166 Modules\SpecialChar menuseparator
18171 File\SpecialChar menuseparator
18172 Open Example\SpecialChar menuseparator
18173 Modules\SpecialChar menuseparator
18174 Noweb2\SpecialChar LyX
18180 \begin_layout Subsection
18182 \change_inserted 564990737 1672161542
18186 \begin_layout Standard
18188 \change_inserted 564990737 1672161542
18189 This module uses the
18199 \begin_inset Flex Code
18202 \begin_layout Plain Layout
18204 \change_inserted 564990737 1672161542
18212 package in R for dynamic report generation has to be installed for this module to work:
18214 \begin_inset Flex Code
18217 \begin_layout Plain Layout
18219 \change_inserted 564990737 1672161542
18220 install.packages(“knitr”)
18231 \begin_layout Paragraph
18233 \change_inserted 564990737 1672161542
18237 \begin_layout Standard
18239 \change_inserted 564990737 1672161542
18240 it depends on R >= 2.14.1.
18242 \begin_inset Flex URL
18245 \begin_layout Plain Layout
18247 \change_inserted 564990737 1672161542
18249 http://yihui.name/knitr
18260 \begin_layout Standard
18262 \change_inserted 564990737 1672161542
18267 also has to be installed.
18268 It cannot be used if the modules
18271 \begin_inset space ~
18283 Help\SpecialChar menuseparator
18284 Specific Manuals\SpecialChar menuseparator
18290 File\SpecialChar menuseparator
18291 Open Example\SpecialChar menuseparator
18292 Modules\SpecialChar menuseparator
18296 \begin_inset space ~
18300 \begin_inset CommandInset ref
18302 reference "sec:Literate-Programming"
18307 for information about literate programming.
18310 \begin_layout Subsection
18312 \change_inserted 564990737 1672161542
18316 \begin_layout Standard
18318 \change_inserted 564990737 1672161542
18319 This module allows the use of the statistical language S/R as a literate programming tool.
18330 \begin_inset CommandInset href
18333 target "https://www.ctan.org/pkg/includernw"
18339 \begin_inset CommandInset href
18342 target "https://www.ctan.org/pkg/fancyvrb"
18347 are available from CTAN.
18348 It cannot be used if the module
18351 \begin_inset space ~
18359 Help\SpecialChar menuseparator
18360 Specific Manuals\SpecialChar menuseparator
18366 File\SpecialChar menuseparator
18367 Open Example\SpecialChar menuseparator
18368 Modules\SpecialChar menuseparator
18372 \begin_inset space ~
18376 \begin_inset CommandInset ref
18378 reference "sec:Literate-Programming"
18383 for information about literate programming.
18386 \begin_layout Section
18388 \change_inserted 564990737 1672224959
18392 \begin_layout Subsection
18394 \change_inserted 564990737 1672224959
18398 \begin_layout Standard
18400 \change_inserted 564990737 1672224959
18401 This modules defines theorem environments and the proof environment using the extended AMS machinery.
18402 Both numbered and unnumbered types are provided.
18404 the theorems are numbered consecutively throughout the document.
18405 This can be changed by loading one of the
18407 AMS Theorems (Numbered by \SpecialChar ldots
18411 It cannot be used if the modules
18417 Standard Theorems (Unnumbered)
18422 \begin_layout Subsection
18424 \change_inserted 564990737 1672224959
18425 AMS Theorems (Extended)
18428 \begin_layout Standard
18430 \change_inserted 564990737 1672224959
18431 This module defines some additional theorem environments for use with the
18435 package (which must be loaded).
18436 It includes Criterion,
18447 Case and Question in both numbered and unnumbered forms.
18450 \begin_layout Subsection
18452 \change_inserted 564990737 1672224959
18453 AMS Theorems (Extended,
18454 Numbered by Type within Chapters)
18457 \begin_layout Standard
18459 \change_inserted 564990737 1672224959
18460 This module defines some additional theorem environments for use with the
18462 AMS Theorems (Numbered by Type within Chapters)
18464 package (which must be loaded).
18465 It includes Criterion,
18474 Assumption and Case in both numbered and unnumbered forms.
18477 AMS Theorems (Extended)
18480 the different theorem types provided here each have a separate counter,
18481 restarted with each new chapter (e.g.,
18488 axiom 2.1\SpecialChar ldots
18490 as opposed to criterion 1,
18496 \begin_layout Subsection
18498 \change_inserted 564990737 1672224959
18499 AMS Theorems (Extended,
18503 \begin_layout Standard
18505 \change_inserted 564990737 1672224959
18506 This module defines some additional theorem environments for use with the
18508 AMS Theorems (Numbered by Type)
18510 package (which must be loaded).
18511 It includes Criterion,
18520 Assumption and Case in both numbered and unnumbered forms.
18523 AMS Theorems (Extended)
18526 the different theorem types provided here each have a separate counter (e.g.,
18534 as opposed to criterion 1,
18542 \begin_layout Subsection
18544 \change_inserted 564990737 1672224959
18545 AMS Theorems (Numbered by Type within Chapters)
18548 \begin_layout Standard
18550 \change_inserted 564990737 1672224959
18551 This module defines theorem environments and the proof environment using the extended AMS machinery.
18552 Both numbered and unnumbered types are provided.
18558 the different theorem types provided here each have a separate counter (e.g.,
18567 as opposed to theorem 1,
18573 The numbering restarts for each chapter:
18577 It cannot be used if the modules
18589 Standard Theorems (Numbered by Type)
18593 Standard Theorems (Unnumbered)
18598 \begin_layout Subsection
18600 \change_inserted 564990737 1672224959
18601 AMS Theorems (Numbered by Type)
18604 \begin_layout Standard
18606 \change_inserted 564990737 1672224959
18607 This module defines theorem environments and the proof environment using the extended AMS machinery.
18608 Both numbered and unnumbered types are provided.
18614 the different theorem types provided here each have a separate counter (e.g.,
18623 as opposed to theorem 1,
18629 The numbering’s scope is the whole document.
18630 For chapter- and section-wide numbering,
18631 use one of the ‘within Sections’/‘within Chapters’ modules,
18633 It cannot be used if the modules
18645 Standard Theorems (Numbered by Type)
18649 Standard Theorems (Unnumbered)
18654 \begin_layout Subsection
18656 \change_inserted 564990737 1672224959
18657 Number Equations by Section
18660 \begin_layout Standard
18662 \change_inserted 564990737 1672224959
18663 This module resets the equation number at section start and prepends the section number to the equation number,
18667 \begin_layout Subsection
18669 \change_inserted 564990737 1672224959
18673 \begin_layout Standard
18675 \change_inserted 564990737 1672224959
18676 This module defines some theorem environments for use with non-AMS classes.
18678 the theorems are numbered consecutively throughout the document.
18679 This can be changed by loading one of the
18681 Standard Theorems (Numbered by \SpecialChar ldots
18685 It cannot be used if the modules
18691 Standard Theorems (Unnumbered)
18697 \begin_layout Subsection
18699 \change_inserted 564990737 1672224959
18700 Standard Theorems (Nameable)
18703 \begin_layout Standard
18705 \change_inserted 564990737 1672224959
18706 This module facilitates the use of named theorems.
18707 The name of the theorem goes into the “Additional Theorem Text” argument.
18711 \begin_layout Subsection
18713 \change_inserted 564990737 1672224959
18714 Standard Theorems (Numbered by Chapter)
18717 \begin_layout Standard
18719 \change_inserted 564990737 1672224959
18720 This module numbers theorems and the like by chapter (i.e.,
18721 the counter is reset at each chapter start).
18722 Use this module only with document classes that provide a chapter environment.
18732 It cannot be used if the module
18734 Standard Theorems (Numbered by Section)
18739 \begin_layout Subsection
18741 \change_inserted 564990737 1672224959
18742 Standard Theorems (Numbered by Section)
18745 \begin_layout Standard
18747 \change_inserted 564990737 1672224959
18748 This module numbers theorems and the like by section (i.e.,
18749 the counter is reset at each section start).
18759 It cannot be used if the module
18761 Standard Theorems (Numbered by Chapter)
18766 \begin_layout Subsection
18768 \change_inserted 564990737 1672224959
18769 Standard Theorems (Numbered by Type within Chapters)
18772 \begin_layout Standard
18774 \change_inserted 564990737 1672224959
18775 This module defines some theorem environments for use with non-AMS classes.
18785 the different theorem types provided here each have a separate counter (e.g.,
18794 as opposed to theorem 1,
18800 The numbering is reset at each chapter start.
18803 AMS Theorems (Numbered by Type)
18807 Standard Theorems (Numbered by Type)
18810 It cannot be used if any of the modules
18822 Standard Theorems (Unnumbered)
18827 Standard Theorems (Numbered by Sections)
18831 Standard Theorems (Numbered by Type within Sections)
18836 \begin_layout Subsection
18838 \change_inserted 564990737 1672224959
18839 Standard Theorems (Numbered by Type within Sections)
18842 \begin_layout Standard
18844 \change_inserted 564990737 1672224959
18845 This module defines some theorem environments for use with non-AMS classes.
18855 the different theorem types provided here each have a separate counter (e.g.,
18864 as opposed to theorem 1,
18870 The numbering is reset at each section start.
18873 AMS Theorems (Numbered by Type)
18877 Standard Theorems (Numbered by Type)
18880 It cannot be used if any of the modules
18892 Standard Theorems (Unnumbered)
18897 Standard Theorems (Numbered by Chapters)
18901 Standard Theorems (Numbered by Type within Chapters)
18906 \begin_layout Subsection
18908 \change_inserted 564990737 1672224959
18909 Standard Theorems (Numbered by Type)
18912 \begin_layout Standard
18914 \change_inserted 564990737 1672224959
18915 This module defines some theorem environments for use with non-AMS classes.
18925 the different theorem types provided here each have a separate counter (e.g.,
18934 as opposed to theorem 1,
18940 The numbering’s scope is the whole document.
18941 For chapter- and section-wide numbering,
18942 use one of the “within Chapters”/“within Sections” modules,
18944 It cannot be used if any of the modules
18956 Standard Theorems (Unnumbered)
18960 AMS Theorems (Numbered by Type)
18965 \begin_layout Subsection
18967 \change_inserted 564990737 1672224959
18968 Standard Theorems (Unnumbered)
18971 \begin_layout Standard
18973 \change_inserted 564990737 1672224959
18974 This module defines only unnumbered theorem environments and the proof environment,
18975 using the extended AMS machinery.
18976 It cannot be used if either of the modules
18987 \begin_layout Subsection
18989 \change_inserted 564990737 1672224959
18993 \begin_layout Standard
18995 \change_inserted 564990737 1672224959
18996 This module provides a straightforward way to segregate subequations in LyX.
18999 Help\SpecialChar menuseparator
19000 Math\SpecialChar menuseparator
19007 \begin_layout Section
19009 \change_inserted 564990737 1672236008
19013 \begin_layout Subsection
19015 \change_inserted 564990737 1672236008
19016 Custom Header/Footer Text
19019 \begin_layout Standard
19021 \change_inserted 564990737 1672236008
19022 This module requires the
19025 \begin_inset space ~
19039 ocument\SpecialChar menuseparator
19044 ettings\SpecialChar menuseparator
19046 \begin_inset space ~
19051 dialog to be set to
19056 It adds six environments to document classes which support the
19063 \begin_layout Itemize
19065 \change_inserted 564990737 1672236008
19071 \begin_layout Itemize
19073 \change_inserted 564990737 1672236008
19079 \begin_layout Itemize
19081 \change_inserted 564990737 1672236008
19087 \begin_layout Itemize
19089 \change_inserted 564990737 1672236008
19095 \begin_layout Itemize
19097 \change_inserted 564990737 1672236008
19103 \begin_layout Itemize
19105 \change_inserted 564990737 1672236008
19111 \begin_layout Subsubsection
19113 \change_inserted 564990737 1672236008
19114 Fancy Headers and Footers
19117 \begin_layout Standard
19119 \change_inserted 564990737 1672236008
19120 The default page layout is rather plain;
19122 \begin_inset Flex Code
19125 \begin_layout Plain Layout
19127 \change_inserted 564990737 1672236008
19136 all you get is a centered page number at the bottom of the page.
19137 This document uses KOMA-script’s book class;
19138 so it appears to be a bit fancier.
19142 \begin_inset space ~
19156 ocument\SpecialChar menuseparator
19161 ettings\SpecialChar menuseparator
19165 \begin_inset Quotes eld
19169 \begin_inset Quotes erd
19173 you will find that the page header is divided into three fields,
19174 not surprisingly labeled
19175 \begin_inset Quotes eld
19179 \begin_inset Quotes erd
19184 \begin_inset Quotes eld
19188 \begin_inset Quotes erd
19193 \begin_inset Quotes eld
19197 \begin_inset Quotes erd
19201 The footer is also divided into these three fields.
19202 The \SpecialChar LaTeX
19203 commands to set these fields in the simplest manner are
19232 Suppose you wish to put your name in the upper left hand corner of each page.
19233 Simply insert the following command in the preamble:
19237 \begin_layout Standard
19239 \change_inserted 564990737 1672236008
19255 \begin_layout Standard
19257 \change_inserted 564990737 1672236008
19258 You will now see your name in the upper left.
19259 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,
19261 \begin_inset space \thinspace{}
19267 \begin_layout Standard
19269 \change_inserted 564990737 1672236008
19277 \begin_layout Standard
19279 \change_inserted 564990737 1672236008
19282 an easier way to make simple changes.
19288 ocument\SpecialChar menuseparator
19293 ettings\SpecialChar menuseparator
19294 Modules\SpecialChar menuseparator
19295 Page Layout\SpecialChar menuseparator
19296 Custom Header/Footer Text
19299 you will find you have six new environments corresponding to the six fields described above.
19302 \begin_layout Standard
19304 \change_inserted 564990737 1672236008
19305 Let's get really fancy:
19306 lets put the section number with the word
19307 \begin_inset Quotes eld
19311 \begin_inset Quotes erd
19315 \begin_inset space \thinspace{}
19319 \begin_inset space \space{}
19322 Section 3) in the upper left,
19323 the page number (e.
19324 \begin_inset space \thinspace{}
19328 \begin_inset space \space{}
19331 Page 4) in the upper right,
19332 your name in the lower left,
19333 and the date in the lower right.
19334 Use your newly enabled environments to add these entries:
19337 \begin_layout Standard
19339 \change_inserted 564990737 1672236008
19340 \begin_inset VSpace defskip
19346 \begin_layout Standard
19348 \change_inserted 564990737 1672236008
19352 \begin_inset space ~
19370 \begin_layout Standard
19372 \change_inserted 564990737 1672236008
19378 \begin_layout Standard
19380 \change_inserted 564990737 1672236008
19395 \begin_layout Standard
19397 \change_inserted 564990737 1672236008
19407 \begin_layout Standard
19409 \change_inserted 564990737 1672236008
19415 \begin_layout Standard
19417 \change_inserted 564990737 1672236008
19432 \begin_layout Standard
19434 \change_inserted 564990737 1672236008
19435 \begin_inset VSpace defskip
19441 \begin_layout Standard
19443 \change_inserted 564990737 1672236008
19444 Make sure you enter the commands
19463 as \SpecialChar TeX
19481 access \SpecialChar LaTeX
19482 ’s section and page counters,
19483 and so print out the current section and page numbers.
19490 simply prints out today’s date.
19493 \begin_layout Standard
19495 \change_inserted 564990737 1672236008
19496 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
19497 If you don't want one of the rules,
19498 set its thickness to 0.
19499 The header rule has a default thickness of 0.4pt,
19500 the footer rule is 0pt.
19501 For this you will need to use \SpecialChar TeX
19505 \begin_layout Standard
19507 \change_inserted 564990737 1672236008
19514 headrulewidth}{0.4pt}
19519 \begin_layout Standard
19521 \change_inserted 564990737 1672236008
19528 footrulewidth}{0.4pt}
19530 to set the thicknesses.
19533 \begin_layout Standard
19535 \change_inserted 564990737 1672236008
19536 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
19541 thispagestyle{empty}
19548 thispagestyle{plain}
19555 thispagestyle{fancy}
19558 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
19561 title pages are marked as plain by default,
19562 while following pages are marked fancy when using the global fancy setting.
19566 \begin_layout Standard
19568 \change_inserted 564990737 1672236008
19569 If you want a header or footer to be on the outer side of a two sided document,
19570 you need to use something like:
19573 \begin_layout Standard
19575 \change_inserted 564990737 1672236008
19578 \begin_inset Flex Strong
19581 \begin_layout Plain Layout
19583 \change_inserted 564990737 1672236008
19599 \begin_layout Standard
19601 \change_inserted 564990737 1672236008
19604 \begin_inset Flex Strong
19607 \begin_layout Plain Layout
19609 \change_inserted 564990737 1672236008
19627 \begin_layout Standard
19629 \change_inserted 564990737 1672236008
19630 The first command clears all existing footers avoiding any conflicts with your new command.
19633 \begin_layout Standard
19635 \change_inserted 564990737 1672236008
19636 You can enter any of these commands,
19637 the simpler ones in any of your new environments,
19638 the more complex ones as \SpecialChar TeX
19640 at any point in your document and they will take effect on the next page.
19643 \begin_layout Standard
19645 \change_inserted 564990737 1672236008
19646 As a final example,
19647 it is possible to include an image in the header or footer.
19648 Suppose you want to put a company logo in the upper left hand corner.
19649 You might try something like
19652 \begin_layout Standard
19654 \change_inserted 564990737 1672236008
19663 includegraphics{logo.eps}}}
19666 \begin_layout Standard
19669 \change_inserted 564990737 1672236008
19670 (you may need to preface this with
19674 usepackage{graphics}
19676 if you don't include graphics elsewhere in your document).
19679 \begin_layout Standard
19681 \change_inserted 564990737 1672236008
19682 For more information on fancy headers,
19684 \begin_inset Flex Code
19687 \begin_layout Plain Layout
19689 \change_inserted 564990737 1672236008
19698 \begin_inset CommandInset href
19701 target "http://www.ctan.org/pkg/fancyhdr"
19710 \begin_layout Subsection
19712 \change_inserted 564990737 1672236008
19713 Landscape Document Parts
19716 \begin_layout Standard
19718 \change_inserted 564990737 1672236008
19719 This module outputs parts of the document in landscape mode using
19721 Insert\SpecialChar menuseparator
19722 Custom Insets\SpecialChar menuseparator
19727 Insert\SpecialChar menuseparator
19728 Custom Insets\SpecialChar menuseparator
19729 Landscape (Floating)
19734 \begin_layout Subsection
19736 \change_inserted 564990737 1672236008
19737 \begin_inset CommandInset label
19739 name "sec:Multiple-Columns"
19746 \begin_layout Standard
19748 \change_inserted 564990737 1672236008
19749 This module uses the
19754 \begin_inset Index idx
19759 \begin_layout Plain Layout
19761 \change_inserted 564990737 1672236008
19771 package and is independent of the option
19784 ocument\SpecialChar menuseparator
19789 ettings\SpecialChar menuseparator
19791 \begin_inset space ~
19797 If you want to have two columns for the whole document,
19798 you are recommended to use the
19807 For all other cases use this module.
19808 \change_deleted 564990737 1672236008
19809 Multiple Text Columns
19812 \begin_layout Standard
19814 \change_deleted 564990737 1672236008
19815 This feature is independent of the option
19817 Two-column document
19819 in the document settings under
19824 If you want to have 2
19825 \begin_inset space ~
19828 columns for the whole document,
19829 it is recommended to use the
19831 Two-column document
19834 For all other cases use this feature.
19837 \begin_layout Standard
19839 \change_deleted 564990737 1672236008
19840 To use multiple text columns in your document,
19841 you have to load the module
19847 Document\SpecialChar menuseparator
19848 Settings\SpecialChar menuseparator
19851 ) and must have the \SpecialChar LaTeX
19853 \begin_inset Flex Code
19856 \begin_layout Plain Layout
19867 \begin_layout Standard
19868 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
19869 Within the different columns you can use everything,
19870 with the limitation that for floats you need to
19871 \change_deleted 564990737 1672236179
19872 use the float option
19875 \change_inserted 564990737 1672236179
19884 \begin_inset space ~
19894 dit\SpecialChar menuseparator
19900 \begin_inset space ~
19910 \begin_layout Subsubsection
19914 \begin_layout Standard
19915 If you want to have 2
19916 \begin_inset space ~
19919 columns in your text,
19920 insert a multicolumn inset via the menu
19922 Insert\SpecialChar menuseparator
19924 \begin_inset space ~
19927 Insets\SpecialChar menuseparator
19929 \begin_inset space ~
19934 where the columns should start.
19935 Write all text that should be printed in 2
19936 \begin_inset space ~
19939 columns into this inset.
19942 \begin_layout Standard
19943 Here is an example:
19946 \begin_layout Standard
19948 \begin_inset Flex Multiple Columns
19951 \begin_layout Plain Layout
19956 The Adventure of the Empty House
19959 \begin_inset Newline newline
19962 by Sir Arthur Conan Doyle
19965 \begin_layout Plain Layout
19968 It was in the spring of the year 1894 that all London was interested,
19969 and the fashionable world dismayed,
19970 by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
19971 The public has already learned those particulars of the crime which came out in the police investigation,
19972 but a good deal was suppressed upon that occasion,
19973 since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
19975 at the end of nearly ten years,
19976 am I allowed to supply those missing links which make up the whole of that remarkable chain.
19977 The crime was of interest in itself,
19978 but that interest was as nothing to me compared to the inconceivable sequel,
19979 which afforded me the greatest shock and surprise of any event in my adventurous life.
19981 after this long interval,
19982 I find myself thrilling as I think of it,
19983 and feeling once more that sudden flood of joy,
19985 and incredulity which utterly submerged my mind.
19986 Let me say to that public,
19987 which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
19988 that they are not to blame me if I have not shared my knowledge with them,
19989 for I should have considered it my first duty to do so,
19990 had I not been barred by a positive prohibition from his own lips,
19991 which was only withdrawn upon the third of last month.
19999 \begin_layout Standard
20000 To get 3 or more columns,
20001 set the cursor into the multicolumn inset and use the menu
20003 Insert\SpecialChar menuseparator
20005 \begin_inset space ~
20009 \begin_inset space ~
20015 The number of the desired columns is written into that inset (for 3
20016 \begin_inset space ~
20020 \begin_inset Quotes eld
20024 \begin_inset Quotes erd
20028 \begin_inset Newline newline
20031 Here is an example with 3
20032 \begin_inset space ~
20038 \begin_layout Standard
20039 \begin_inset Flex Multiple Columns
20042 \begin_layout Plain Layout
20045 \begin_inset Argument 1
20048 \begin_layout Plain Layout
20055 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
20056 and that after his disappearance I never failed to read with care the various problems which came before the public.
20057 And I even attempted,
20059 for my own private satisfaction,
20060 to employ his methods in their solution,
20061 though with indifferent success.
20064 which appealed to me like this tragedy of Ronald Adair.
20065 As I read the evidence at the inquest,
20066 which led up to a verdict of willful murder against some person or persons unknown,
20067 I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
20068 There were points about this strange business which would,
20070 have specially appealed to him,
20071 and the efforts of the police would have been supplemented,
20072 or more probably anticipated,
20073 by the trained observation and the alert mind of the first criminal agent in Europe.
20075 as I drove upon my round,
20076 I turned over the case in my mind and found no explanation which appeared to me to be adequate.
20077 At the risk of telling a twice-told tale,
20078 I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
20086 \begin_layout Standard
20087 You can have up to 10
20088 \begin_inset space ~
20091 columns if you want to,
20092 but that might not be very pleasant for the readers of your document.
20095 \begin_layout Standard
20097 \change_deleted 564990737 1672236245
20098 \begin_inset Newpage newpage
20106 \begin_layout Subsubsection
20107 Columns inside Columns
20110 \begin_layout Standard
20111 You can also have columns inside columns:
20114 \begin_layout Standard
20115 \begin_inset Flex Multiple Columns
20118 \begin_layout Plain Layout
20121 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
20122 at that time governor of one of the Australian colonies.
20123 Adair's mother had returned from Australia to undergo the operation for cataract,
20126 and her daughter Hilda were living together at 427 Park Lane.
20129 \begin_layout Plain Layout
20130 \begin_inset Flex Multiple Columns
20133 \begin_layout Plain Layout
20136 The youth moved in the best society
20137 \begin_inset space ~
20141 so far as was known,
20142 no enemies and no particular vices.
20143 He had been engaged to Miss Edith Woodley,
20145 but the engagement had been broken off by mutual consent some months before,
20146 and there was no sign that it had left any very profound feeling behind it.
20147 For the rest {sic} the man's life moved in a narrow and conventional circle,
20148 for his habits were quiet and his nature unemotional.
20149 Yet it was upon this easy-going young aristocrat that death came,
20150 in most strange and unexpected form,
20151 between the hours of ten and eleven-twenty on the night of March 30,
20160 \begin_layout Plain Layout
20163 Ronald Adair was fond of cards
20164 \begin_inset space ~
20167 – playing continually,
20168 but never for such stakes as would hurt him.
20169 He was a member of the Baldwin,
20171 and the Bagatelle card clubs.
20173 after dinner on the day of his death,
20174 he had played a rubber of whist at the latter club.
20175 He had also played there in the afternoon.
20180 The evidence of those who had played with him
20181 \begin_inset space ~
20188 \begin_inset space ~
20191 – showed that the game was whist,
20192 and that there was a fairly equal fall of the cards.
20193 Adair might have lost five pounds,
20195 His fortune was a considerable one,
20196 and such a loss could not in any way affect him.
20197 He had played nearly every day at one club or other,
20198 but he was a cautious player,
20199 and usually rose a winner.
20200 It came out in evidence that,
20201 in partnership with Colonel Moran,
20202 he had actually won as much as four hundred and twenty pounds in a sitting,
20204 from Godfrey Milner and Lord Balmoral.
20205 So much for his recent history as it came out at the inquest.
20213 \begin_layout Subsubsection
20217 \begin_layout Standard
20218 The examples in this section show some more special features of multiple columns.
20221 \begin_layout Standard
20222 For more features of multiple columns,
20224 \begin_inset CommandInset href
20226 name "documentation"
20227 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
20232 of the \SpecialChar LaTeX
20234 \begin_inset Flex Code
20237 \begin_layout Plain Layout
20246 \begin_layout Paragraph
20250 \begin_layout Standard
20251 To add a preface text for multiple columns,
20252 set the cursor into the multicolumn inset and use the menu
20254 Insert\SpecialChar menuseparator
20258 Write your preface text into that inset.
20259 \begin_inset Newline newline
20262 This is an example with some preface text:
20265 \begin_layout Standard
20266 \begin_inset VSpace bigskip
20272 \begin_layout Standard
20273 \begin_inset Flex Multiple Columns
20276 \begin_layout Plain Layout
20277 \begin_inset Argument 2
20280 \begin_layout Plain Layout
20281 And the story continues and continues and continues and continues\SpecialChar ldots
20289 On the evening of the crime,
20290 he returned from the club exactly at ten.
20291 His mother and sister were out spending the evening with a relation.
20292 The servant deposed that she heard him enter the front room on the second floor,
20293 generally used as his sitting-room.
20294 She had lit a fire there,
20295 and as it smoked she had opened the window.
20296 No sound was heard from the room until eleven-twenty,
20297 the hour of the return of Lady Maynooth and her daughter.
20298 Desiring to say good-night,
20299 she attempted to enter her son's room.
20300 The door was locked on the inside,
20301 and no answer could be got to their cries and knocking.
20303 and the door forced.
20304 The unfortunate young man was found lying near the table.
20305 His head had been horribly mutilated by an expanding revolver bullet,
20306 but no weapon of any sort was to be found in the room.
20314 \begin_layout Standard
20315 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
20317 For example the command
20320 \begin_layout LyX-Code
20323 subsection{subsection title}
20326 \begin_layout Standard
20327 creates a subsection.
20328 In this example the preface is a subsubsection:
20331 \begin_layout Standard
20332 \begin_inset Flex Multiple Columns
20335 \begin_layout Plain Layout
20336 \begin_inset Argument 2
20339 \begin_layout Plain Layout
20343 \begin_layout Plain Layout
20352 This is a subsubsection heading as a preface
20356 \begin_layout Plain Layout
20370 A minute examination of the circumstances served only to make the case more complex.
20371 In the first place,
20372 no reason could be given why the young man should have fastened the door upon the inside.
20373 There was the possibility that the murderer had done this,
20374 and had afterwards escaped by the window.
20375 The drop was at least twenty feet,
20377 and a bed of crocuses in full bloom lay beneath.
20378 Neither the flowers nor the earth showed any sign of having been disturbed,
20379 nor were there any marks upon the narrow strip of grass which separated the house from the road.
20382 it was the young man himself who had fastened the door.
20383 But how did he come by his death?
20384 No one could have climbed up to the window without leaving traces.
20385 Suppose a man had fired through the window,
20386 he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
20388 Park Lane is a frequented thoroughfare;
20389 there is a cab stand within a hundred yards of the house.
20390 No one had heard a shot.
20398 \begin_layout Standard
20399 If there is less vertical space than 6
20400 \begin_inset space ~
20403 text lines is left on the page at the beginning of the multiple columns,
20404 a page break will be inserted before the multiple columns.
20405 Depending on the number of lines of the preface text,
20406 you might want to change this space.
20407 This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
20409 Insert\SpecialChar menuseparator
20411 \begin_inset space ~
20415 \begin_inset space ~
20419 \begin_inset space ~
20425 Insert into that inset the amount of space like e.
20426 \begin_inset space \thinspace{}
20430 \begin_inset space \space{}
20434 \begin_inset Quotes eld
20438 \begin_inset Quotes erd
20442 \begin_inset Newline newline
20445 In this example the space is set to 7
20446 \begin_inset space ~
20449 text lines by using
20450 \begin_inset Flex Code
20453 \begin_layout Plain Layout
20462 \begin_inset Flex Code
20465 \begin_layout Plain Layout
20473 needs to be inserted as \SpecialChar TeX
20477 \begin_layout Standard
20478 \begin_inset Flex Multiple Columns
20481 \begin_layout Plain Layout
20482 \begin_inset Argument 3
20485 \begin_layout Plain Layout
20490 \begin_layout Plain Layout
20506 On the evening of the crime,
20507 he returned from the club exactly at ten.
20508 His mother and sister were out spending the evening with a relation.
20509 The servant deposed that she heard him enter the front room on the second floor,
20510 generally used as his sitting-room.
20511 She had lit a fire there,
20512 and as it smoked she had opened the window.
20513 No sound was heard from the room until eleven-twenty,
20514 the hour of the return of Lady Maynooth and her daughter.
20515 Desiring to say good-night,
20516 she attempted to enter her son's room.
20517 The door was locked on the inside,
20518 and no answer could be got to their cries and knocking.
20520 and the door forced.
20521 The unfortunate young man was found lying near the table.
20522 His head had been horribly mutilated by an expanding revolver bullet,
20523 but no weapon of any sort was to be found in the room.
20531 \begin_layout Paragraph
20535 \begin_layout Standard
20536 The amount of space before and after multiple columns can be changed by changing the length
20537 \begin_inset Flex Code
20540 \begin_layout Plain Layout
20549 For example the command
20552 \begin_layout LyX-Code
20560 \begin_layout Standard
20561 in \SpecialChar TeX
20562 Code changes its value to 3
20563 \begin_inset space \thinspace{}
20567 The change must be made before the multiple columns' start.
20568 The predefined value is 13
20569 \begin_inset space \thinspace{}
20575 \begin_layout Standard
20577 \begin_inset Flex Code
20580 \begin_layout Plain Layout
20589 \begin_inset space \thinspace{}
20595 \begin_layout Standard
20599 \begin_layout Plain Layout
20605 multicolsep}{2.5cm}
20613 \begin_layout Standard
20614 \begin_inset Flex Multiple Columns
20617 \begin_layout Plain Layout
20620 All day I turned these facts over in my mind,
20621 endeavouring to hit upon some theory which could reconcile them all,
20622 and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
20623 I confess that I made little progress.
20624 In the evening I strolled across the Park,
20625 and found myself about six o'clock at the Oxford Street end of Park Lane.
20626 A group of loafers upon the pavements,
20627 all staring up at a particular window,
20628 directed me to the house which I had come to see.
20630 thin man with coloured glasses,
20631 whom I strongly suspected of being a plain-clothes detective,
20632 was pointing out some theory of his own,
20633 while the others crowded round to listen to what he said.
20634 I got as near him as I could,
20635 but his observations seemed to me to be absurd,
20636 so I withdrew again in some disgust.
20637 As I did so I struck against an elderly,
20639 who had been behind me,
20640 and I knocked down several books which he was carrying.
20648 \begin_layout Standard
20649 \begin_inset Note Greyedout
20652 \begin_layout Plain Layout
20658 The values you set with
20659 \begin_inset Flex Code
20662 \begin_layout Plain Layout
20670 will be used for all following multiple columns until you change them again.
20678 \begin_layout Standard
20682 \begin_layout Plain Layout
20694 \begin_inset Note Note
20697 \begin_layout Plain Layout
20698 go back to the default
20706 \begin_layout Standard
20708 \change_deleted 564990737 1672236355
20709 \begin_inset Newpage newpage
20717 \begin_layout Paragraph
20721 \begin_layout Standard
20722 A column break can be forced by inserting the command
20723 \begin_inset Flex Code
20726 \begin_layout Plain Layout
20734 as \SpecialChar TeX
20735 Code to that position in the text where the column should be broken.
20736 Note that this leads in most cases to whitespace in the text.
20737 \begin_inset Newline newline
20740 Here is an example:
20743 \begin_layout Standard
20744 \begin_inset Flex Multiple Columns
20747 \begin_layout Plain Layout
20750 \begin_inset Quotes eld
20753 You're surprised to see me,
20755 \begin_inset Quotes erd
20763 \begin_layout Plain Layout
20766 I acknowledged that I was.
20769 \begin_layout Plain Layout
20772 \begin_inset Quotes eld
20778 and when I chanced to see you go into this house,
20779 as I came hobbling after you,
20780 I thought to myself,
20781 I'll just step in and see that kind gentleman,
20782 and tell him that if I was a bit gruff in my manner there was not any harm meant,
20783 and that I am much obliged to him for picking up my books.
20784 \begin_inset Quotes erd
20790 \begin_layout Plain Layout
20793 \begin_inset Quotes eld
20796 You make too much of a trifle,
20797 \begin_inset Quotes erd
20802 \begin_inset Quotes eld
20805 May I ask how you knew who I was?
20806 \begin_inset Quotes erd
20809 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
20813 \begin_layout Plain Layout
20825 \begin_layout Plain Layout
20828 \begin_inset Quotes eld
20833 if it isn't too great a liberty,
20834 I am a neighbour of yours,
20835 for you'll find my little bookshop at the corner of Church Street,
20836 and very happy to see you,
20838 Maybe you collect yourself,
20843 \begin_inset space ~
20859 \begin_inset space ~
20864 With five volumes you could just fill that gap on that second shelf.
20868 \begin_inset Quotes erd
20879 \begin_layout Paragraph
20883 \begin_layout Standard
20884 The width of the columns is automatically calculated,
20885 but you can modify the space between the columns.
20886 This is done by changing the length
20887 \begin_inset Flex Code
20890 \begin_layout Plain Layout
20899 Its predefined value is 10
20900 \begin_inset space \thinspace{}
20904 Here is an example where
20905 \begin_inset Flex Code
20908 \begin_layout Plain Layout
20917 \begin_inset space \thinspace{}
20923 \begin_layout Standard
20927 \begin_layout Plain Layout
20941 \begin_layout Standard
20942 \begin_inset Flex Multiple Columns
20945 \begin_layout Plain Layout
20948 My observations of No.
20949 \begin_inset space \space{}
20952 427 Park Lane did little to clear up the problem in which I was interested.
20953 The house was separated from the street by a low wall and railing,
20954 the whole not more than five feet high.
20955 It was perfectly easy,
20957 for anyone to get into the garden,
20958 but the window was entirely inaccessible,
20959 since there was no water pipe or anything which could help the most active man to climb it.
20960 More puzzled than ever,
20961 I retraced my steps to Kensington.
20962 I had not been in my study five minutes when the maid entered to say that a person desired to see me.
20963 To my astonishment it was none other than my strange old book collector,
20965 wizened face peering out from a frame of white hair,
20966 and his precious volumes,
20967 a dozen of them at least,
20968 wedged under his right arm.
20976 \begin_layout Standard
20980 \begin_layout Plain Layout
20992 \begin_inset Note Note
20995 \begin_layout Plain Layout
20996 go back to the default
21004 \begin_layout Paragraph
21008 \begin_layout Standard
21009 Between the columns a rule with a width of the length
21010 \begin_inset Flex Code
21013 \begin_layout Plain Layout
21022 If this rule width is set to 0
21023 \begin_inset space \thinspace{}
21026 pt (this is the default),
21027 the rule is suppressed.
21028 In the following example the rule is 2
21029 \begin_inset space \thinspace{}
21035 \begin_layout Standard
21039 \begin_layout Plain Layout
21045 columnseprule}{2pt}
21053 \begin_layout Standard
21054 \begin_inset Flex Multiple Columns
21057 \begin_layout Plain Layout
21060 \begin_inset Quotes eld
21063 You're surprised to see me,
21065 \begin_inset Quotes erd
21073 \begin_layout Plain Layout
21076 I acknowledged that I was.
21079 \begin_layout Plain Layout
21082 \begin_inset Quotes eld
21088 and when I chanced to see you go into this house,
21089 as I came hobbling after you,
21090 I thought to myself,
21091 I'll just step in and see that kind gentleman,
21092 and tell him that if I was a bit gruff in my manner there was not any harm meant,
21093 and that I am much obliged to him for picking up my books.
21094 \begin_inset Quotes erd
21100 \begin_layout Plain Layout
21103 \begin_inset Quotes eld
21106 You make too much of a trifle,
21107 \begin_inset Quotes erd
21112 \begin_inset Quotes eld
21115 May I ask how you knew who I was?
21116 \begin_inset Quotes erd
21122 \begin_layout Plain Layout
21125 \begin_inset Quotes eld
21130 if it isn't too great a liberty,
21131 I am a neighbour of yours,
21132 for you'll find my little bookshop at the corner of Church Street,
21133 and very happy to see you,
21135 Maybe you collect yourself,
21140 \begin_inset space ~
21156 \begin_inset space ~
21161 With five volumes you could just fill that gap on that second shelf.
21165 \begin_inset Quotes erd
21176 \begin_layout Standard
21177 \begin_inset VSpace defskip
21183 \begin_layout Standard
21184 The rule can be colored by redefining the command
21185 \begin_inset Flex Code
21188 \begin_layout Plain Layout
21197 This is done by inserting the command
21200 \begin_layout LyX-Code
21205 columnseprulecolor}{
21210 \begin_layout Standard
21211 as \SpecialChar TeX
21212 Code before the multicolumn inset.
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21223 in this command by a color of your choice.
21224 You can use all pre- and self-defined colors.
21233 \begin_inset space ~
21238 for more information about pre- and self-defined colors.
21239 To go back to the default color insert the command
21242 \begin_layout LyX-Code
21247 columnseprulecolor}{
21252 \begin_layout Standard
21253 Here is the example with a cyan rule and 1
21254 \begin_inset space \thinspace{}
21257 cm column separation:
21260 \begin_layout Standard
21264 \begin_layout Plain Layout
21273 \begin_layout Plain Layout
21279 columnseprulecolor}{
21289 \begin_layout Standard
21290 \begin_inset Flex Multiple Columns
21293 \begin_layout Plain Layout
21296 \begin_inset Quotes eld
21299 You're surprised to see me,
21301 \begin_inset Quotes erd
21309 \begin_layout Plain Layout
21312 I acknowledged that I was.
21315 \begin_layout Plain Layout
21318 \begin_inset Quotes eld
21324 and when I chanced to see you go into this house,
21325 as I came hobbling after you,
21326 I thought to myself,
21327 I'll just step in and see that kind gentleman,
21328 and tell him that if I was a bit gruff in my manner there was not any harm meant,
21329 and that I am much obliged to him for picking up my books.
21330 \begin_inset Quotes erd
21336 \begin_layout Plain Layout
21339 \begin_inset Quotes eld
21342 You make too much of a trifle,
21343 \begin_inset Quotes erd
21348 \begin_inset Quotes eld
21351 May I ask how you knew who I was?
21352 \begin_inset Quotes erd
21358 \begin_layout Plain Layout
21361 \begin_inset Quotes eld
21366 if it isn't too great a liberty,
21367 I am a neighbour of yours,
21368 for you'll find my little bookshop at the corner of Church Street,
21369 and very happy to see you,
21371 Maybe you collect yourself,
21376 \begin_inset space ~
21392 \begin_inset space ~
21397 With five volumes you could just fill that gap on that second shelf.
21401 \begin_inset Quotes erd
21412 \begin_layout Standard
21416 \begin_layout Plain Layout
21422 columnseprule}{0pt}
21425 \begin_layout Plain Layout
21431 columnseprulecolor}{
21439 \begin_inset Note Note
21442 \begin_layout Plain Layout
21443 go back to the default
21451 \begin_layout Section
21453 \change_inserted 564990737 1671270380
21457 \begin_layout Subsection
21459 \change_inserted 564990737 1671270398
21461 \change_deleted 564990737 1671270396
21467 \begin_layout Standard
21470 as well as any other text processor uses by default rectangular paragraphs.
21471 For special cases like for example posters,
21472 invitation cards or poems you can modify the paragraph shape to one of your choice.
21474 \change_deleted 564990737 1672311802
21475 This can be done by using the \SpecialChar LaTeX
21477 \begin_inset Flex Code
21480 \begin_layout Plain Layout
21486 which is loaded by using in the document settings the module
21488 Custom paragraph shapes
21491 \change_inserted 564990737 1672311802
21492 This module uses the
21496 package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
21502 \begin_layout Subsubsection
21506 \begin_layout Standard
21511 provides the following shapes:
21514 \begin_layout Standard
21515 \begin_inset Tabular
21516 <lyxtabular version="3" rows="13" columns="3">
21517 <features booktabs="true" islongtable="true" longtabularalignment="center">
21518 <column alignment="left" valignment="middle" width="16col%">
21519 <column alignment="left" valignment="middle" width="40col%">
21520 <column alignment="left" valignment="middle" width="35col%">
21521 <row endhead="true">
21522 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21525 \begin_layout Plain Layout
21534 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21537 \begin_layout Plain Layout
21546 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21549 \begin_layout Plain Layout
21559 <row interlinespace="default">
21560 <cell alignment="left" valignment="top" usebox="none">
21563 \begin_layout Plain Layout
21571 <cell alignment="left" valignment="top" usebox="none">
21574 \begin_layout Plain Layout
21577 Circle with circular hole (in the size of a CD/DVD)
21582 <cell alignment="left" valignment="top" usebox="none">
21585 \begin_layout Plain Layout
21589 take care there is not too much text
21595 <row interlinespace="default">
21596 <cell alignment="left" valignment="top" usebox="none">
21599 \begin_layout Plain Layout
21607 <cell alignment="left" valignment="top" usebox="none">
21610 \begin_layout Plain Layout
21618 <cell alignment="left" valignment="top" usebox="none">
21621 \begin_layout Plain Layout
21625 calculation might fail
21631 <row interlinespace="default">
21632 <cell alignment="left" valignment="top" usebox="none">
21635 \begin_layout Plain Layout
21643 <cell alignment="left" valignment="top" usebox="none">
21646 \begin_layout Plain Layout
21649 Rhomboid (symbolizing a
21650 \begin_inset Quotes eld
21654 \begin_inset Quotes erd
21662 <cell alignment="left" valignment="top" usebox="none">
21665 \begin_layout Plain Layout
21674 <row interlinespace="default">
21675 <cell alignment="left" valignment="top" usebox="none">
21678 \begin_layout Plain Layout
21686 <cell alignment="left" valignment="top" usebox="none">
21689 \begin_layout Plain Layout
21697 <cell alignment="left" valignment="top" usebox="none">
21700 \begin_layout Plain Layout
21709 <row interlinespace="default">
21710 <cell alignment="left" valignment="top" usebox="none">
21713 \begin_layout Plain Layout
21721 <cell alignment="left" valignment="top" usebox="none">
21724 \begin_layout Plain Layout
21732 <cell alignment="left" valignment="top" usebox="none">
21735 \begin_layout Plain Layout
21744 <row interlinespace="default">
21745 <cell alignment="left" valignment="top" usebox="none">
21748 \begin_layout Plain Layout
21756 <cell alignment="left" valignment="top" usebox="none">
21759 \begin_layout Plain Layout
21762 Nut for bolt (hexagon with circular hole)
21767 <cell alignment="left" valignment="top" usebox="none">
21770 \begin_layout Plain Layout
21779 <row interlinespace="default">
21780 <cell alignment="left" valignment="top" usebox="none">
21783 \begin_layout Plain Layout
21791 <cell alignment="left" valignment="top" usebox="none">
21794 \begin_layout Plain Layout
21802 <cell alignment="left" valignment="top" usebox="none">
21805 \begin_layout Plain Layout
21814 <row interlinespace="default">
21815 <cell alignment="left" valignment="top" usebox="none">
21818 \begin_layout Plain Layout
21826 <cell alignment="left" valignment="top" usebox="none">
21829 \begin_layout Plain Layout
21837 <cell alignment="left" valignment="top" usebox="none">
21840 \begin_layout Plain Layout
21849 <row interlinespace="default">
21850 <cell alignment="left" valignment="top" usebox="none">
21853 \begin_layout Plain Layout
21861 <cell alignment="left" valignment="top" usebox="none">
21864 \begin_layout Plain Layout
21872 <cell alignment="left" valignment="top" usebox="none">
21875 \begin_layout Plain Layout
21884 <row interlinespace="default">
21885 <cell alignment="left" valignment="top" usebox="none">
21888 \begin_layout Plain Layout
21896 <cell alignment="left" valignment="top" usebox="none">
21899 \begin_layout Plain Layout
21902 Normal/reversed rain drop
21907 <cell alignment="left" valignment="top" usebox="none">
21910 \begin_layout Plain Layout
21914 calculation might fail
21920 <row interlinespace="default">
21921 <cell alignment="left" valignment="top" usebox="none">
21924 \begin_layout Plain Layout
21933 <cell alignment="left" valignment="top" usebox="none">
21936 \begin_layout Plain Layout
21939 The \SpecialChar TeX
21945 <cell alignment="left" valignment="top" usebox="none">
21948 \begin_layout Plain Layout
21957 <row interlinespace="default">
21958 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
21961 \begin_layout Plain Layout
21965 \begin_inset Newline newline
21973 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
21976 \begin_layout Plain Layout
21979 Triangles in different orientations
21984 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
21987 \begin_layout Plain Layout
22003 \begin_layout Standard
22004 To use a shape for your paragraph,
22005 simply select it in \SpecialChar LyX
22006 's pull-down box for environments in the toolbar.
22009 \begin_layout Standard
22010 \begin_inset Newpage newpage
22016 \begin_layout Standard
22017 Here is an example paragraph in the shape of a nut:
22020 \begin_layout Standard
22021 \begin_inset VSpace bigskip
22030 Lorem ipsum dolor sit amet,
22031 consetetur sadipscing elitr,
22032 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22034 At vero eos et accusam et justo duo dolores et ea rebum.
22035 Stet clita kasd gubergren,
22036 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22037 Lorem ipsum dolor sit amet,
22038 consetetur sadipscing elitr,
22039 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22043 \begin_layout Standard
22044 \begin_inset VSpace bigskip
22050 \begin_layout Standard
22051 \begin_inset Note Greyedout
22054 \begin_layout Plain Layout
22064 paragraphs cannot run over a page break.
22072 \begin_layout Standard
22073 \begin_inset VSpace bigskip
22079 \begin_layout Standard
22081 \begin_inset Flex Code
22084 \begin_layout Plain Layout
22090 takes care that the shape will always be preserved,
22091 no matter how much text is in the paragraph.
22092 Therefore the paragraph size changes with the amount of contained text.
22093 This can lead to paragraph sizes exceeding the page margins.
22094 To demonstrate the size scaling,
22095 here is the same example paragraph but with twice as much text:
22098 \begin_layout Standard
22099 \begin_inset Newpage newpage
22108 Lorem ipsum dolor sit amet,
22109 consetetur sadipscing elitr,
22110 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22112 At vero eos et accusam et justo duo dolores et ea rebum.
22113 Stet clita kasd gubergren,
22114 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22115 Lorem ipsum dolor sit amet,
22116 consetetur sadipscing elitr,
22117 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22119 Lorem ipsum dolor sit amet,
22120 consetetur sadipscing elitr,
22121 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22123 At vero eos et accusam et justo duo dolores et ea rebum.
22124 Stet clita kasd gubergren,
22125 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22126 Lorem ipsum dolor sit amet,
22127 consetetur sadipscing elitr,
22128 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22132 \begin_layout Standard
22133 \begin_inset VSpace bigskip
22139 \begin_layout Standard
22140 An exception is the shape
22145 It cannot be scaled because it must fit the size of a CD/DVD.
22146 Therefore the amount of text that fits into the shape is limited.
22147 \begin_inset Newline newline
22159 meaning that the calculation of their size can fail,
22160 depending on the amount of text.
22161 You will then get the \SpecialChar LaTeX
22163 \begin_inset Quotes eld
22166 Arithmetic overflow
22167 \begin_inset Quotes erd
22171 In this case one can try to remove or add some text;
22172 if nothing works one has to use another shape.
22175 \begin_layout Standard
22176 \begin_inset VSpace bigskip
22182 \begin_layout Standard
22183 For shapes with tips you will maybe see that \SpecialChar LaTeX
22184 's hyphenation routine fails for text in the tips.
22185 Therefore it is often necessary to add hyphenation points
22190 arg "specialchar-insert hyphenation"
22195 ) to the corresponding text parts.
22198 \begin_layout Standard
22199 \begin_inset VSpace bigskip
22205 \begin_layout Standard
22206 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
22207 You can therefore not use the paragraph dialog to align such paragraphs.
22208 A solution is to put the paragraph into a minipage or parbox and align the box.
22209 The problem is hereby to find the right width for the box.
22210 Because if it is too wide and you center the box,
22211 the paragraph is not centered too because it sticks at the left side of the box.
22212 So you might have to play a bit with the width until it fits.
22213 Here are two heart-shaped paragraphs,
22214 the first one is not aligned,
22215 the second one is right-aligned:
22218 \begin_layout Standard
22219 \begin_inset Newpage newpage
22225 \begin_layout Heart
22229 Lo\SpecialChar softhyphen
22230 rem ipsum dolor sit amet,
22231 consetetur sadipscing elitr,
22232 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22234 At vero eos et accusam et justo duo dolores et ea rebum.
22235 Stet clita kasd gubergren,
22236 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22239 \begin_layout Standard
22240 \begin_inset VSpace bigskip
22246 \begin_layout Standard
22249 \begin_inset Box Frameless
22259 height_special "totalheight"
22264 backgroundcolor "none"
22267 \begin_layout Heart
22271 Lo\SpecialChar softhyphen
22272 rem ipsum dolor sit amet,
22273 consetetur sadipscing elitr,
22274 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22276 At vero eos et accusam et justo duo dolores et ea rebum.
22277 Stet clita kasd gubergren,
22278 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22286 \begin_layout Subsubsection
22290 \begin_layout Standard
22291 You can define any shape you want.
22292 Doing this manually is a lot of work because every coordinate must be specified.
22293 But there is a way to let the computer calculate the coordinates:
22296 \begin_layout Enumerate
22297 Install the program
22298 \begin_inset CommandInset href
22301 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
22309 \begin_layout Enumerate
22316 TeX/LaTeX\SpecialChar menuseparator
22317 Settings\SpecialChar menuseparator
22320 and select the font size you are using in your document.
22321 For example this document uses the size 12
22322 \begin_inset space \thinspace{}
22328 \begin_layout Enumerate
22332 \begin_layout Enumerate
22335 TeX/LaTeX\SpecialChar menuseparator
22338 to export the shape to coordinates.
22339 In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
22343 \begin_layout Plain Layout
22344 For more information see
22345 \begin_inset CommandInset href
22347 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
22360 \begin_layout Standard
22361 The coordinates are written into a \SpecialChar TeX
22363 To use it for your \SpecialChar LyX
22367 \begin_layout Enumerate
22368 Place the cursor before the first character of your paragraph (or into a new empty one).
22371 \begin_layout Enumerate
22372 Open in \SpecialChar LyX
22375 Insert\SpecialChar menuseparator
22376 File\SpecialChar menuseparator
22378 \begin_inset space ~
22384 select the file and use
22393 \begin_layout Standard
22394 \begin_inset VSpace defskip
22400 \begin_layout Standard
22401 \begin_inset Note Greyedout
22404 \begin_layout Plain Layout
22410 The changed shape only applies to the current paragraph;
22411 everything is reset to normal for the next paragraph.
22412 Therefore the shape definition file must be input into every paragraph with the desired shape.
22420 \begin_layout Standard
22421 \begin_inset VSpace bigskip
22427 \begin_layout Standard
22428 Here is an example:
22431 \begin_layout Standard
22432 \begin_inset VSpace bigskip
22438 \begin_layout Standard
22439 \begin_inset CommandInset include
22441 filename "SpecialParagraphShape.tex"
22448 Lorem ipsum dolor sit amet,
22449 consetetur sadipscing elitr,
22450 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22452 At vero eos et accusam et justo duo dolores et ea rebum.
22453 Stet clita kasd gubergren,
22454 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22455 Lorem ipsum dolor sit amet,
22456 consetetur sadipscing elitr,
22457 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22461 \begin_layout Standard
22462 \begin_inset VSpace bigskip
22468 \begin_layout Standard
22474 to draw complexer shapes in
22478 you can draw the shape in a program of your choice and import the resulting image to
22483 Then you only need to draw a line or spline along the outline of the image.
22486 \begin_layout Standard
22487 \begin_inset VSpace bigskip
22493 \begin_layout Standard
22496 Custom paragraph shapes
22498 also provides the two commands
22506 which can be used to define custom shapes coordinate by coordinate.
22510 \begin_layout Plain Layout
22511 These commands are internally used for all shapes described here.
22516 For information how these styles are used and about further customization possibilities,
22518 \begin_inset CommandInset href
22520 name "documentation"
22521 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
22527 \begin_inset Flex Code
22530 \begin_layout Plain Layout
22539 \begin_layout Subsection
22541 \change_inserted 564990737 1672311925
22545 \begin_layout Hanging
22547 \change_inserted 564990737 1672311925
22548 This module adds the
22554 one where all but the first line of the paragraph is indented.
22555 This may not appear in your \SpecialChar LyX
22556 document but will appear in the final output.
22559 \begin_layout Subsection
22561 \change_inserted 564990737 1672311925
22562 \begin_inset CommandInset label
22564 name "subsec:Initials"
22568 Initials (Drop Caps)
22571 \begin_layout Initial
22573 \change_inserted 564990737 1672311925
22574 \begin_inset Argument 2
22577 \begin_layout Plain Layout
22579 \change_inserted 564990737 1672311925
22588 \begin_inset Argument 3
22591 \begin_layout Plain Layout
22593 \change_inserted 564990737 1672311925
22601 module adds a drop capitals paragraph style
22605 for paragraph environments which you can use wherever you want to have drop capitals.
22606 You then have three more items in the
22613 \begin_layout Itemize
22615 \change_inserted 564990737 1672311925
22620 which creates an inset for the drop capital
22623 \begin_layout Itemize
22625 \change_inserted 564990737 1672311925
22630 which creates an inset for the rest of the word
22633 \begin_layout Itemize
22635 \change_inserted 564990737 1672311925
22640 which allow you configure the formatting of the drop capital.
22643 \begin_layout Standard
22645 \change_inserted 564990737 1672311925
22646 To customize the appearance of the style,
22649 Help\SpecialChar menuseparator
22650 Embedded Objects\SpecialChar menuseparator
22651 Objects Surrounded by Text\SpecialChar menuseparator
22657 \begin_layout Section
22659 \change_inserted 564990737 1672312011
22663 \begin_layout Subsection
22665 \change_inserted 564990737 1672312011
22666 Hyphenatable Text Markup
22669 \begin_layout Standard
22671 \change_inserted 564990737 1672312011
22672 This package defines text styles to highlight,
22675 underline and capitalize/small-cap text by means of the
22680 As opposed to the markup provided by the Text Properties dialog,
22681 words marked-up with
22687 \begin_inset CommandInset href
22689 name "soul documentation"
22690 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
22698 \begin_layout Subsection
22700 \change_inserted 564990737 1672312011
22704 \begin_layout Standard
22706 \change_inserted 564990737 1672312011
22707 This module defines some character styles for logical markup:
22711 \begin_inset Flex Noun
22714 \begin_layout Plain Layout
22716 \change_inserted 564990737 1672312011
22732 \begin_inset Flex Emph
22735 \begin_layout Plain Layout
22737 \change_inserted 564990737 1672312011
22751 \begin_inset Flex Strong
22754 \begin_layout Plain Layout
22756 \change_inserted 564990737 1672312011
22766 \begin_inset Flex Code
22769 \begin_layout Plain Layout
22771 \change_inserted 564990737 1672312011
22779 which are accessed via the
22784 dit\SpecialChar menuseparator
22786 \begin_inset space ~
22790 \begin_inset space ~
22802 \begin_layout Chapter
22804 \change_deleted 564990737 1671304317
22808 \change_inserted 564990737 1671304322
22810 \change_deleted 564990737 1671304331
22811 ies with Bib\SpecialChar TeX
22817 \begin_layout Standard
22818 The most basic information about how to use Bib\SpecialChar TeX
22823 with \SpecialChar LyX
22824 is contained in the section
22826 Bibliography databases
22833 The following subsections explain special bibliography features supported by \SpecialChar LyX
22837 \begin_layout Section
22838 Alternative Citation Styles
22841 \begin_layout Standard
22842 Standard Bib\SpecialChar TeX
22844 \begin_inset space \thinspace{}
22848 \begin_inset space \space{}
22852 \begin_inset Quotes eld
22856 \begin_inset Quotes erd
22859 ) to refer to a cited work.
22861 in many scientific disciplines,
22862 other citation styles are in use.
22863 The most common one is the author-year style (e.
22864 \begin_inset space \thinspace{}
22868 \begin_inset space \space{}
22872 \begin_inset Quotes eld
22876 \begin_inset Quotes erd
22881 supports three packages that provide this style,
22883 \begin_inset Flex Code
22886 \begin_layout Plain Layout
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22905 \begin_inset Flex Code
22908 \begin_layout Plain Layout
22915 Each of these packages has their pros and cons,
22916 which cannot be listed in detail.
22917 If you only want to have simple author-year (or author-numerical) style,
22918 or if you want to use one of the countless style files for
22919 \begin_inset Flex Code
22922 \begin_layout Plain Layout
22929 then the established
22930 \begin_inset Flex Code
22933 \begin_layout Plain Layout
22939 package is probably your choice.
22940 If you look for specific citation styles common in law studies,
22941 you might consider the
22942 \begin_inset Flex Code
22945 \begin_layout Plain Layout
22952 If you want to have full control over the formatting or look for advanced features such as ibidem,
22953 footnote citations,
22954 full title citations,
22955 advanced date formats (such as 400 BC) or full localization to other languages than English,
22956 you should definitely consider
22957 \begin_inset Flex Code
22960 \begin_layout Plain Layout
22967 which exceeds all other packages in terms of features,
22968 but is also quite heavy and more resource-hungry.
22971 \begin_layout Standard
22972 The handling of these packages in \SpecialChar LyX
22973 is basically the same.
22975 \begin_inset Flex Noun
22978 \begin_layout Plain Layout
22979 Document\SpecialChar menuseparator
22986 \begin_inset Flex Noun
22989 \begin_layout Plain Layout
22996 \begin_inset Flex Noun
22999 \begin_layout Plain Layout
23006 \begin_inset Flex Noun
23009 \begin_layout Plain Layout
23017 \begin_inset Flex Noun
23020 \begin_layout Plain Layout
23028 \begin_inset Flex Noun
23031 \begin_layout Plain Layout
23032 Biblatex (Natbib mode)
23039 \begin_inset Flex Noun
23042 \begin_layout Plain Layout
23049 \begin_inset Flex Noun
23052 \begin_layout Plain Layout
23059 \begin_inset space ~
23062 6.5.3 in the User's Guide for more information on these choices).
23063 With all these packages,
23064 you will get some extra features in the citation dialog and you can select the style of the reference (
23065 \begin_inset Quotes eld
23069 \begin_inset Quotes erd
23074 \begin_inset Quotes eld
23078 \begin_inset Quotes erd
23083 \begin_inset Quotes eld
23088 \begin_inset Quotes erd
23093 \begin_inset Quotes eld
23097 \begin_inset Quotes erd
23101 Note that either package needs specifically designed style files.
23102 They all ship their own,
23103 but there are lots of additional style files,
23104 and there is even an interactive style file builder
23108 \begin_layout Plain Layout
23110 \begin_inset Flex URL
23113 \begin_layout Plain Layout
23115 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
23126 \begin_inset Flex Code
23129 \begin_layout Plain Layout
23138 \begin_layout Section
23139 Subdivided Bibliographies
23142 \begin_layout Standard
23143 Sometimes you might need to divide your bibliography into several sections.
23144 If you are for instance a historian,
23145 the possibility to separate sources and scientific works is most likely a
23146 \begin_inset Quotes eld
23150 \begin_inset Quotes erd
23155 Bib\SpecialChar TeX
23156 itself does not allow you to do this.
23157 But with the help of some \SpecialChar LaTeX
23159 Bib\SpecialChar TeX
23160 can be extended to fit your needs.
23163 \begin_layout Standard
23165 provides native support for one of these packages,
23174 \begin_layout Plain Layout
23176 \begin_inset Flex URL
23179 \begin_layout Plain Layout
23181 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
23191 The advantage of this package (compared to other packages such as
23195 ) is that you don't need to define new citation commands.
23197 you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
23199 If you want to divide your bibliography into the sections
23200 \begin_inset Quotes eld
23204 \begin_inset Quotes erd
23208 \begin_inset Quotes eld
23212 \begin_inset Quotes erd
23216 you first need to create two bibliographic databases,
23218 \begin_inset space \thinspace{}
23222 \begin_inset space \space{}
23226 \begin_inset Flex Code
23229 \begin_layout Plain Layout
23236 \begin_inset Flex Code
23239 \begin_layout Plain Layout
23249 \begin_layout Standard
23251 \begin_inset Flex Noun
23254 \begin_layout Plain Layout
23255 Document\SpecialChar menuseparator
23262 \begin_inset Flex Noun
23265 \begin_layout Plain Layout
23272 \begin_inset Flex Noun
23275 \begin_layout Plain Layout
23276 Subdivided bibliography
23282 Now you can insert multiple Bib\SpecialChar TeX
23284 one for each section of your bibliography.
23285 Returning to our example:
23286 Insert the Bib\SpecialChar TeX
23288 \begin_inset Flex Code
23291 \begin_layout Plain Layout
23297 and a second one for the database
23298 \begin_inset Flex Code
23301 \begin_layout Plain Layout
23308 You are free to use the same or different styles for each section.
23310 you can choose if the bibliography section should contain
23311 \begin_inset Quotes eld
23314 all cited references
23315 \begin_inset Quotes erd
23318 of the specified database(s) (which is the default),
23320 \begin_inset Quotes eld
23323 all uncited references
23324 \begin_inset Quotes erd
23328 \begin_inset Quotes eld
23332 \begin_inset Quotes erd
23336 This might be useful if you would like to separate your bibliography into three sections:
23338 \begin_inset Quotes eld
23342 \begin_inset Quotes erd
23347 \begin_inset Quotes eld
23351 \begin_inset Quotes erd
23356 \begin_inset Quotes eld
23360 \begin_inset Quotes erd
23364 The titles for the sections can be added as ordinary sections or subsections.
23366 \begin_inset Flex Code
23369 \begin_layout Plain Layout
23375 removes the bibliography title,
23376 you have to manually re-add that,
23377 too (as a chapter* or section*,
23381 \begin_layout Standard
23387 the procedure is a bit different.
23398 \begin_inset Flex Noun
23401 \begin_layout Plain Layout
23402 Subdivided bibliography
23407 option is disabled if you use
23417 provides its own means to generate subdivided bibliographies.
23418 You can either add keywords to bibliography entries via the
23419 \begin_inset Flex Code
23422 \begin_layout Plain Layout
23428 entry option and then filter bibliography sections by keyword (by adding
23429 \begin_inset Flex Code
23432 \begin_layout Plain Layout
23439 \begin_inset Flex Noun
23442 \begin_layout Plain Layout
23448 field of the dialog that opens if you left-click on the
23449 \begin_inset Flex Noun
23452 \begin_layout Plain Layout
23453 Biblatex Generated Bibliography
23459 or you can filter by entry types (such as
23468 \begin_inset space \thinspace{}
23473 \begin_inset Flex Code
23476 \begin_layout Plain Layout
23483 \begin_inset Flex Code
23486 \begin_layout Plain Layout
23493 \begin_inset Flex Noun
23496 \begin_layout Plain Layout
23503 or you can create so-called
23504 \begin_inset Quotes eld
23507 Bibliography Categories
23508 \begin_inset Quotes erd
23511 to which you can assign individual entries.
23512 Please refer to the Biblatex manual,
23515 Subdivided Bibliographies
23521 \begin_layout Section
23522 Multiple Bibliographies
23523 \begin_inset CommandInset label
23525 name "subsec:Multiple-Bibliographies"
23532 \begin_layout Standard
23533 Multiple bibliographies,
23535 \begin_inset space \thinspace{}
23539 \begin_inset space \space{}
23542 a bibliography for each part,
23545 subsection or child (sub-document) of the document,
23546 are also supported by \SpecialChar LyX
23548 In order to enable it,
23550 \begin_inset Flex Noun
23553 \begin_layout Plain Layout
23554 Document\SpecialChar menuseparator
23555 Settings\SpecialChar menuseparator
23561 and select the relevant unit (e.
23562 \begin_inset space \thinspace{}
23567 \begin_inset Quotes eld
23571 \begin_inset Quotes erd
23575 \begin_inset Flex Noun
23578 \begin_layout Plain Layout
23579 Multiple Bibliographies
23585 Then add a Bib(la)\SpecialChar TeX
23586 bibliography to each unit (e.
23587 \begin_inset space \thinspace{}
23591 section) of your document.
23593 a separate bibliography,
23594 containing only the references done in the current unit is generated.
23597 \begin_layout Standard
23598 If you use Bib\SpecialChar TeX
23601 \begin_inset Flex Code
23604 \begin_layout Plain Layout
23611 \begin_inset Flex Code
23614 \begin_layout Plain Layout
23620 package is used to create multiple bibliographies.
23621 The former package is used if you select
23622 \begin_inset Quotes eld
23626 \begin_inset Quotes erd
23634 \begin_inset Flex Noun
23637 \begin_layout Plain Layout
23638 Sectioned Bibliography
23644 In all other cases,
23646 \begin_inset Flex Code
23649 \begin_layout Plain Layout
23659 \begin_layout Plain Layout
23660 An alternative approach,
23661 if you are willing to use some
23662 \begin_inset Flex Noun
23665 \begin_layout Plain Layout
23673 \begin_inset space ~
23677 \begin_inset CommandInset ref
23679 reference "sec:Inserting-TeX-Code"
23686 \begin_inset Flex Code
23689 \begin_layout Plain Layout
23701 \begin_inset Flex Code
23704 \begin_layout Plain Layout
23712 encloses the specified units in
23713 \begin_inset Flex Code
23716 \begin_layout Plain Layout
23723 \begin_inset Flex Code
23726 \begin_layout Plain Layout
23735 \begin_inset Flex Code
23738 \begin_layout Plain Layout
23746 in order to create the units.
23747 Note that this approach has some limitations.
23749 every citation reference has to be inside some
23750 \begin_inset Flex Code
23753 \begin_layout Plain Layout
23760 So citations outside a defined unit (e.
23761 \begin_inset space \thinspace{}
23765 before the first section if you use
23766 \begin_inset Quotes eld
23770 \begin_inset Quotes erd
23774 \begin_inset Quotes eld
23778 \begin_inset Quotes erd
23782 You can also create your own units by entering
23783 \begin_inset Flex Code
23786 \begin_layout Plain Layout
23795 \begin_inset Flex Code
23798 \begin_layout Plain Layout
23806 as \SpecialChar TeX
23807 code (for instance to work around the mentioned limitation).
23811 \begin_inset Flex Code
23814 \begin_layout Plain Layout
23820 s cannot be nested.
23821 A second limitation is that
23822 \begin_inset Flex Code
23825 \begin_layout Plain Layout
23831 always processes all references of a bibliography database,
23832 even if they are not cited.
23833 This can result in odd labels (e.
23834 \begin_inset space \thinspace{}
23839 \begin_inset Quotes eld
23843 \begin_inset Quotes erd
23846 if two works of this author from 2014 are in the database,
23847 even if only one is cited).
23850 \begin_layout Standard
23857 \begin_inset Flex Code
23860 \begin_layout Plain Layout
23866 option is used instead.
23867 If you need specific units,
23868 you can start them with the \SpecialChar TeX
23870 \begin_inset Flex Code
23873 \begin_layout Plain Layout
23882 \begin_inset Flex Code
23885 \begin_layout Plain Layout
23895 If you also want to control the end of the unit,
23896 use the environment
23897 \begin_inset Flex Code
23900 \begin_layout Plain Layout
23910 \begin_inset Flex Code
23913 \begin_layout Plain Layout
23925 \begin_inset Flex Code
23928 \begin_layout Plain Layout
23934 s cannot be nested.
23935 In addition to the individual bibliography of the current unit,
23940 also provides an easy way to output all bibliographies,
23943 \begin_inset space \thinspace{}
23947 at the end of the document).
23949 \begin_inset Quotes eld
23952 all reference units
23953 \begin_inset Quotes erd
23956 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
23957 Please refer to the
23961 manual for more information on this topic.
23964 \begin_layout Chapter
23966 \change_deleted 564990737 1671355654
23970 \change_inserted 564990737 1671355667
23972 \change_deleted 564990737 1671355661
23974 \change_inserted 564990737 1671355684
23976 \begin_inset CommandInset label
23978 name "chap:bullets"
23983 \change_deleted 564990737 1671355684
23985 \begin_inset CommandInset label
23996 \begin_layout Standard
24002 \begin_layout Section
24006 \begin_layout Standard
24008 provides 216 bullet shapes that can be accessed from a simple dialog.
24009 Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
24010 These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
24014 \begin_layout Plain Layout
24016 actually you can but you'll have to do it by hand.
24024 \begin_layout Section
24028 \begin_layout Standard
24029 Open the dialog by selecting the
24030 \begin_inset Flex Noun
24033 \begin_layout Plain Layout
24034 Document\SpecialChar menuseparator
24040 menu item and then select the
24041 \begin_inset Flex Noun
24044 \begin_layout Plain Layout
24053 \begin_layout Standard
24054 The dialog provides you with a table of bullet shapes.
24055 A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
24056 The row of buttons across the top is used to select which bullet depth you are changing.
24058 \change_deleted 244031559 1603875981
24059 A text entry under the table shows the currently selected bullet shape's \SpecialChar LaTeX
24060 equivalent and this can be edited if desired.
24061 If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
24067 \begin_layout Standard
24068 The six panels are divided up by the packages they require.
24069 The following table shows the mappings from button name to \SpecialChar LaTeX
24073 \begin_layout Standard
24075 \begin_inset Tabular
24076 <lyxtabular version="3" rows="7" columns="2">
24077 <features tabularvalignment="middle">
24078 <column alignment="center" valignment="top" width="0pt">
24079 <column alignment="center" valignment="top" width="0pt">
24081 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
24084 \begin_layout Plain Layout
24099 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
24102 \begin_layout Plain Layout
24119 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24122 \begin_layout Plain Layout
24137 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24140 \begin_layout Plain Layout
24149 base \SpecialChar LaTeX
24157 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24160 \begin_layout Plain Layout
24175 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24178 \begin_layout Plain Layout
24195 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24198 \begin_layout Plain Layout
24213 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24216 \begin_layout Plain Layout
24233 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24236 \begin_layout Plain Layout
24251 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24254 \begin_layout Plain Layout
24271 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24274 \begin_layout Plain Layout
24289 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24292 \begin_layout Plain Layout
24309 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
24312 \begin_layout Plain Layout
24327 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
24330 \begin_layout Plain Layout
24353 \begin_layout Standard
24355 doesn't stop you using bullets from packages you don't have.
24356 If you get errors from \SpecialChar LaTeX
24357 when you try to view or print the file,
24358 then it is likely you are missing a package.
24362 \begin_layout Plain Layout
24364 doesn't restrict your use since you may be editing locally and exporting elsewhere.
24372 \begin_layout Section
24376 \begin_layout Standard
24377 Select which bullet depth you want to change then select the bullet shape and size.
24378 Any changes will not be visible in \SpecialChar LyX
24380 but are visible when viewing the document.
24383 \begin_layout Standard
24384 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
24388 \begin_layout Plain Layout
24390 \change_inserted 564990737 1672138075
24391 \begin_inset CommandInset label
24393 name "fn:If-you-really"
24403 want to have multiple sets of paragraphs with different sets of bullets in each,
24404 then you're going to have to get your hands dirty with \SpecialChar TeX
24406 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
24407 code for a wide range of bullet shapes.
24408 To make your own custom paragraphs you have the following options:
24411 \begin_layout Plain Layout
24415 \begin_layout Plain Layout
24431 \begin_layout Plain Layout
24435 \begin_layout Plain Layout
24457 \begin_layout Itemize
24458 Use the \SpecialChar LaTeX
24460 \begin_inset Flex Code
24463 \begin_layout Plain Layout
24471 to specify a new bullet shape for a given depth.
24472 You'll also need to save the current bullet shape so you can restore it again afterwards.
24473 In this itemized list the following \SpecialChar LaTeX
24474 code was used to change the bullet used for the first depth.
24478 \begin_layout LyX-Code
24488 \begin_layout LyX-Code
24505 \begin_layout Itemize
24506 Note that the itemize depth is specified in Roman numerals as part of the
24515 \begin_layout Itemize
24516 \begin_inset Argument item:1
24519 \begin_layout Plain Layout
24523 \begin_layout Plain Layout
24541 Specify each individual entry by starting each item with the bullet shape enclosed in a
24542 \begin_inset Quotes eld
24546 \begin_inset Quotes erd
24549 inset (available at
24551 Insert\SpecialChar menuseparator
24555 \begin_inset Flex Noun
24558 \begin_layout Plain Layout
24567 this item was started with
24568 \begin_inset Flex Code
24571 \begin_layout Plain Layout
24586 \begin_layout Plain Layout
24590 \begin_layout Plain Layout
24606 \begin_layout Plain Layout
24607 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
24608 The way used here was:
24611 \begin_layout LyX-Code
24626 \begin_layout Chapter
24630 \begin_layout Section
24631 Multipart Documents
24634 \begin_layout Subsection
24638 \begin_layout Standard
24639 When you are working on a large file with many sections,
24640 it is often convenient to break up the document into several files,
24641 or perhaps you have something where a table may change from time to time,
24642 but the preceding text does not.
24644 you should seriously consider using multipart documents.
24646 scientific papers often have five major sections:
24652 Each of these could be its own separate \SpecialChar LyX
24655 \begin_inset Quotes eld
24659 \begin_inset Quotes erd
24662 file which contains the title,
24667 plus the five included files.
24668 It is important to note that each of these files is a full \SpecialChar LyX
24669 file which can be formatted and printed on its own,
24670 as well as included in a master file.
24671 Each of these files must have the same document class,
24673 don't attempt to mix book classes with article classes.
24674 You may also include \SpecialChar LaTeX
24677 these files must not have their own preamble (i.
24678 \begin_inset space \thinspace{}
24682 \begin_inset space \space{}
24685 everything up to and including the
24686 \begin_inset Flex Code
24689 \begin_layout Plain Layout
24697 line as well as the
24698 \begin_inset Flex Code
24701 \begin_layout Plain Layout
24709 line must be deleted) or else errors will be generated when you try to make a DVI file.
24712 \begin_layout Standard
24714 allows you to include files quite easily with
24715 \begin_inset Flex Noun
24718 \begin_layout Plain Layout
24719 Insert\SpecialChar menuseparator
24721 \begin_inset space ~
24730 When you click on this selection a small box is inserted into the file at the current cursor location.
24731 Clicking on the box raises a dialog which allows you to select the file to be included,
24732 and the method of its inclusion.
24736 \begin_layout Standard
24737 The file selection box should by now be obvious.
24738 The three inclusion methods are
24739 \begin_inset Quotes eld
24743 \begin_inset Quotes erd
24748 \begin_inset Quotes eld
24752 \begin_inset Quotes erd
24757 \begin_inset Quotes eld
24761 \begin_inset Quotes erd
24766 \begin_inset Quotes eld
24770 \begin_inset Quotes erd
24774 \begin_inset Quotes eld
24778 \begin_inset Quotes erd
24781 are similar in many ways,
24782 but there are also some notable differences:
24785 \begin_layout Enumerate
24787 \begin_inset Quotes eld
24791 \begin_inset Quotes erd
24794 are typeset beginning on a new page,
24795 while files that are
24796 \begin_inset Quotes eld
24800 \begin_inset Quotes erd
24803 are typeset starting on the current page.
24806 \begin_layout Enumerate
24807 \begin_inset Quotes eld
24811 \begin_inset Quotes erd
24814 files cannot themselves
24815 \begin_inset Quotes eld
24819 \begin_inset Quotes erd
24823 \begin_inset Quotes eld
24827 \begin_inset Quotes erd
24832 \begin_inset Quotes eld
24836 \begin_inset Quotes erd
24841 infinite sub-inputting is possible.
24844 \begin_layout Enumerate
24845 \begin_inset Quotes eld
24849 \begin_inset Quotes erd
24852 allow for the output of only selected
24853 \begin_inset Quotes eld
24857 \begin_inset Quotes erd
24861 while maintaining the actual counters (pagination etc.) and references (please refer to the section
24864 \begin_inset space ~
24872 \begin_inset space ~
24877 manual for details).
24880 \begin_layout Standard
24883 \begin_inset Quotes eld
24887 \begin_inset Quotes erd
24890 is the preferred method for chapters that are outsourced to child documents,
24892 \begin_inset Quotes eld
24896 \begin_inset Quotes erd
24899 is more suitable for arbitrary file inheritance.
24902 \begin_layout Standard
24904 \begin_inset Quotes eld
24908 \begin_inset Quotes erd
24911 included file allows you to include a file typeset exactly as it appears in the file,
24913 \begin_inset space \thinspace{}
24917 \begin_inset space \space{}
24921 \begin_inset Flex Code
24924 \begin_layout Plain Layout
24931 with the characters set in a fixed-width typewriter font.
24933 spaces in this file are invisible,
24934 though two consecutive spaces are conserved,
24935 unlike \SpecialChar LyX
24936 's normal treatment of spaces.
24939 \begin_inset Flex Noun
24942 \begin_layout Plain Layout
24944 \begin_inset space ~
24948 \begin_inset space ~
24952 \begin_inset space ~
24960 checkbox typesets a mark to unambiguously define the presence of a space.
24964 \begin_layout Standard
24966 the master file is converted into a full \SpecialChar LaTeX
24967 file before typesetting,
24968 while the included files are converted to \SpecialChar LaTeX
24969 files that do not have all the preamble information.
24972 \begin_layout Subsection
24973 Cross-References Between Files
24976 \begin_layout Standard
24977 \begin_inset Box Shadowbox
24987 height_special "totalheight"
24992 backgroundcolor "none"
24995 \begin_layout Plain Layout
24996 This section is somewhat out of date.
24997 Need to describe default master documents and how children are opened when the master is.
25006 \begin_layout Standard
25007 It is possible to set up cross-references between the different files.
25009 open all the files in question:
25010 let's call them A and B in a two file example,
25011 where B is included in A.
25012 Let's say you insert a label in A,
25013 then want to reference it in B.
25014 Open the cross-reference dialog whilst in document B,
25015 and you can select the
25016 \begin_inset Quotes eld
25020 \begin_inset Quotes erd
25026 \begin_layout Subsection
25027 Bibliography Lists in all Subdocuments
25030 \begin_layout Standard
25031 If you work with child documents,
25032 you might want to have only one main bibliography at the end,
25033 but still be able to have a selected bibliography for the child if you output it on its own.
25034 Here is how to achieve this.
25037 \begin_layout Standard
25038 For the main document,
25039 you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
25040 If the bibliography inset is in the master file,
25041 the references will be inherited by all children,
25042 so they are available in the citation dialog within each child.
25045 \begin_layout Standard
25046 For child-specific bibliographies,
25047 insert bibliography insets within the child documents,
25048 at the place where the bibliography should appear when the child is compiled separately.
25050 the trick is to insert them into a branch (
25052 Insert\SpecialChar menuseparator
25053 Branch\SpecialChar menuseparator
25054 Insert New Branch...
25058 \begin_inset space \thinspace{}
25063 \begin_inset Quotes eld
25067 \begin_inset Quotes erd
25071 Within the children,
25072 activate the branch (
25074 Document\SpecialChar menuseparator
25075 Settings...\SpecialChar menuseparator
25080 deactivate the branch (
25082 Document\SpecialChar menuseparator
25083 Settings...\SpecialChar menuseparator
25087 Now the child's bibliography will be ignored by the master,
25088 but considered by the child.
25091 \begin_layout Standard
25092 If you need multiple bibliographies (e.
25093 \begin_inset space \thinspace{}
25097 one per child in the
25102 please refer to sec.
25103 \begin_inset space ~
25107 \begin_inset CommandInset ref
25109 reference "subsec:Multiple-Bibliographies"
25117 \begin_layout Section
25122 \begin_layout Standard
25123 Users sometimes need to be able to
25124 \begin_inset Quotes eld
25128 \begin_inset Quotes erd
25132 file together with all the images (and other files) on which it depends,
25133 either for sending to a publisher or for sharing with a co-author.
25135 includes a Python script (
25136 \begin_inset Flex Code
25139 \begin_layout Plain Layout
25145 ) that automates this process.
25147 you must have either the
25148 \begin_inset Flex Code
25151 \begin_layout Plain Layout
25158 \begin_inset Flex Code
25161 \begin_layout Plain Layout
25167 python modules installed on your system.
25169 the script prefers the
25170 \begin_inset Flex Code
25173 \begin_layout Plain Layout
25180 \begin_inset Flex Code
25183 \begin_layout Plain Layout
25189 format on Unix-like systems and the
25190 \begin_inset Flex Code
25193 \begin_layout Plain Layout
25202 \begin_layout Standard
25204 's configuration process will set the script up to export a `\SpecialChar LyX
25206 and this format will then be available under
25207 \begin_inset Flex Code
25210 \begin_layout Plain Layout
25211 File\SpecialChar menuseparator
25220 \begin_layout Standard
25221 Independently of the platform,
25222 the generation of a particular archive format can be forced by adding either the
25223 \begin_inset Flex Code
25226 \begin_layout Plain Layout
25233 \begin_inset Flex Code
25236 \begin_layout Plain Layout
25243 \begin_inset Flex Code
25246 \begin_layout Plain Layout
25253 \begin_inset Flex Code
25256 \begin_layout Plain Layout
25262 format) switch to the
25263 \begin_inset Flex Code
25266 \begin_layout Plain Layout
25268 \SpecialChar menuseparator
25276 \begin_inset Flex Code
25279 \begin_layout Plain Layout
25280 Tools\SpecialChar menuseparator
25281 Preferences\SpecialChar menuseparator
25282 File Handling\SpecialChar menuseparator
25289 (Make sure you add the switch after the script name,
25293 \begin_layout Section
25294 Fancy Headers and Footers
25297 \begin_layout Standard
25298 The default page layout is rather plain;
25300 \begin_inset Flex Code
25303 \begin_layout Plain Layout
25310 all you get is a centered page number at the bottom of the page.
25311 This document uses KOMA-script's book class,
25312 so it appears to be a bit fancier.
25313 But to really put on a show,
25314 you need to set the document page style to
25315 \begin_inset Quotes eld
25319 \begin_inset Quotes erd
25323 as mentioned in the
25328 This section describes the \SpecialChar LaTeX
25329 code you need to insert in your \SpecialChar LaTeX
25330 preamble in order to get the desired effects.
25333 \begin_layout Standard
25334 For more information on fancy headers,
25336 \begin_inset Flex Code
25339 \begin_layout Plain Layout
25345 package documentation.
25347 \begin_inset Flex URL
25350 \begin_layout Plain Layout
25352 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
25360 \begin_layout Standard
25361 The page header is divided into three fields,
25362 not surprisingly labeled
25363 \begin_inset Quotes eld
25367 \begin_inset Quotes erd
25372 \begin_inset Quotes eld
25376 \begin_inset Quotes erd
25381 \begin_inset Quotes eld
25385 \begin_inset Quotes erd
25389 The footer is also divided into these three fields.
25390 The \SpecialChar LaTeX
25391 commands to set these fields in the simplest manner are
25392 \begin_inset Flex Code
25395 \begin_layout Plain Layout
25405 \begin_inset Flex Code
25408 \begin_layout Plain Layout
25418 \begin_inset Flex Code
25421 \begin_layout Plain Layout
25431 \begin_inset Flex Code
25434 \begin_layout Plain Layout
25444 Suppose you wish to put your name in the upper left hand corner of each page.
25445 Simply insert the following command in the preamble:
25449 \begin_layout Standard
25458 \begin_layout Standard
25459 You will now see your name in the upper left.
25460 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,
25462 \begin_inset space \thinspace{}
25468 \begin_layout Standard
25476 \begin_layout Standard
25477 Let's get really fancy:
25478 lets put the section number with the word
25479 \begin_inset Quotes eld
25483 \begin_inset Quotes erd
25487 \begin_inset space \thinspace{}
25491 \begin_inset space \space{}
25494 Section 3) in the upper left,
25495 the page number (e.
25496 \begin_inset space \thinspace{}
25500 \begin_inset space \space{}
25503 Page 4) in the upper right,
25504 your name in the lower left,
25505 and the date in the lower right.
25506 The following commands should now appear in the preamble:
25509 \begin_layout Standard
25519 \begin_layout Standard
25527 \begin_layout Standard
25537 \begin_layout Standard
25546 \begin_layout Standard
25554 \begin_layout Standard
25564 \begin_layout Standard
25566 \begin_inset Flex Code
25569 \begin_layout Plain Layout
25578 \begin_inset Flex Code
25581 \begin_layout Plain Layout
25589 access \SpecialChar LaTeX
25590 's section and page counters,
25591 and so print out the current section and page number.
25593 \begin_inset Flex Code
25596 \begin_layout Plain Layout
25604 simply prints out today's date.
25607 \begin_layout Standard
25608 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
25609 If you don't want one of the rules,
25610 set its thickness to 0.
25611 The header rule has a default thickness of 0.4pt,
25612 the footer rule is 0pt.
25618 \begin_inset Flex Code
25621 \begin_layout Plain Layout
25626 headrulewidth}{0.4pt}
25632 \begin_inset Flex Code
25635 \begin_layout Plain Layout
25640 footrulewidth}{0.4pt}
25645 to set the thicknesses.
25648 \begin_layout Standard
25649 You can switch the header/footer settings on and off for individual pages using commands like
25650 \begin_inset Flex Code
25653 \begin_layout Plain Layout
25656 thispagestyle{empty}
25663 \begin_inset Flex Code
25666 \begin_layout Plain Layout
25669 thispagestyle{plain}
25676 \begin_inset Flex Code
25679 \begin_layout Plain Layout
25682 thispagestyle{fancy}
25688 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
25691 title pages are marked as plain by default,
25692 while following pages are marked fancy when using the global fancy setting.
25695 \begin_layout Standard
25696 As a final example,
25697 it is possible to include an image in the header or footer.
25698 Suppose you want to put a company logo in the upper lefthand corner.
25699 You might try something like
25702 \begin_layout Standard
25711 includegraphics{logo.eps}}}
25714 \begin_layout Standard
25716 (you may need to preface this with
25717 \begin_inset Flex Code
25720 \begin_layout Plain Layout
25723 usepackage{graphics}
25728 if you don't include graphics elsewhere in your document).
25731 \begin_layout Chapter
25733 and the World Wide Web
25736 \begin_layout Standard
25738 has long supported the export of documents to various web-friendly formats,
25740 Before version 2.0,
25742 HTML export was always accomplished by the use of external converters.
25746 \begin_layout Plain Layout
25747 For details on the use of external converters with \SpecialChar LyX
25753 section of the Customization manual.
25758 These fall into two large groups:
25759 there are converters that use \SpecialChar LaTeX
25760 as an intermediate format,
25762 \begin_inset Flex Code
25765 \begin_layout Plain Layout
25773 \begin_inset Flex Code
25776 \begin_layout Plain Layout
25784 \begin_inset Flex Code
25787 \begin_layout Plain Layout
25794 relying upon \SpecialChar LyX
25795 to produce the \SpecialChar LaTeX
25797 and there is a converter that works directly on \SpecialChar LyX
25800 \begin_inset Flex Code
25803 \begin_layout Plain Layout
25811 All of these have different advantages and disadvantages.
25815 \begin_layout Standard
25816 The \SpecialChar LaTeX
25817 -based converters have the advantage that,
25819 they know everything about the exported document that \SpecialChar LaTeX
25821 Such converters do not care,
25823 if a certain block of code was produced by \SpecialChar LyX
25824 or was Evil Red Text.
25825 These converters know about
25826 \begin_inset Flex Code
25829 \begin_layout Plain Layout
25838 and can often make use of the
25839 \begin_inset Flex Code
25842 \begin_layout Plain Layout
25848 files generated by Bib\SpecialChar TeX
25852 is a very hard language to parse—
25853 it is sometimes said that only \SpecialChar TeX
25854 itself understands \SpecialChar TeX
25856 and \SpecialChar LaTeX
25857 -based converters will often choke on what seem to be quite simple constructs;
25858 complex ones can throw them completely,
25859 and as of this writing,
25865 manual will not export with
25866 \begin_inset Flex Code
25869 \begin_layout Plain Layout
25876 though the others will.
25877 The other issue concerns how math is handled.
25878 These converters typically convert the formulae into little pictures that are then linked from the HTML document.
25879 Since these are actually generated by \SpecialChar LaTeX
25882 But they do not scale well,
25883 and just getting them to look as if they are actually meant to be in your document—
25884 so that the font sizes seem to be roughly the same—
25885 can be a challenge.
25888 \begin_layout Standard
25890 \begin_inset Flex Code
25893 \begin_layout Plain Layout
25901 \begin_inset CommandInset href
25903 name "http://pinchito.es/elyxer/"
25904 target "http://pinchito.es/elyxer/"
25909 ) solves some of these problems.
25911 the formulae it produces scale perfectly,
25912 since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
25913 But even moderately complex formula are rendered less well than with
25914 \begin_inset Flex Code
25917 \begin_layout Plain Layout
25924 this reflects the limitations of HTML.
25928 \begin_layout Plain Layout
25931 \begin_inset Flex Code
25934 \begin_layout Plain Layout
25941 can also use jsMath and MathJax for equations,
25942 but this setting is only available globally and requires one to have access to a server that runs the backend.
25947 More importantly (as of version 1.1.1,
25950 \begin_inset Flex Code
25953 \begin_layout Plain Layout
25960 has limited support for math macros and no support for user-defined paragraph or character styles.
25961 These limitations make
25962 \begin_inset Flex Code
25965 \begin_layout Plain Layout
25972 unsuitable for many of the documents \SpecialChar LyX
25976 these problems could be solved,
25977 but the \SpecialChar LyX
25978 developers have decided to follow a different path and have made \SpecialChar LyX
25979 itself capable of writing XHTML,
25980 just as it is capable of writing \SpecialChar LaTeX
25986 \begin_layout Standard
25987 As of this writing,
25988 XHTML output remains under development and should probably be regarded as
25989 \begin_inset Quotes eld
25993 \begin_inset Quotes erd
26000 \begin_layout Plain Layout
26002 \begin_inset Flex Code
26005 \begin_layout Plain Layout
26006 development/HTML/HTML.notes
26012 which can be found in the \SpecialChar LyX
26014 \begin_inset CommandInset href
26016 name "accessed online"
26017 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
26023 usually contains up-to-date information about the state of XHTML output.
26024 See also the list of XHTML bugs on
26025 \begin_inset CommandInset href
26027 name "the bug tracker"
26028 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"
26039 the developers have chosen this approach because it has several potential advantages over the other two.
26042 \begin_layout Standard
26043 These advantages are primarily due to the fact that the XHTML output routines,
26044 since they are part of \SpecialChar LyX
26046 know everything \SpecialChar LyX
26047 knows about the document being exported.
26051 \begin_layout Plain Layout
26052 Another advantage is that,
26053 since these routines are internal to \SpecialChar LyX
26055 they are immune to changes in \SpecialChar LyX
26057 or to changes in the semantics of existing insets.
26062 So they know about the table of contents (as displayed in the outline),
26063 about the counters associated with different paragraph styles,
26064 and about user-defined styles.
26065 The XHTML output routines know what \SpecialChar LyX
26066 knows about internationalization,
26068 so they will output
26069 \begin_inset Quotes eld
26073 \begin_inset Quotes erd
26077 \begin_inset Quotes eld
26085 \begin_inset Quotes erd
26089 depending upon the language in effect at the time.
26093 \begin_layout Standard
26095 the output routines know what \SpecialChar LyX
26096 knows about document layout,
26098 about how the document is to be rendered on screen.
26099 We use this information when we output the document as XHTML.
26106 generates CSS style information corresponding to the layout information it uses to render the document on screen:
26107 if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
26109 then (by default) they will be sans-serif and bold when viewed in a web browser,
26111 And this is true not just for pre-defined styles,
26114 including user-defined styles.
26116 the XHTML output routines make no distinction between user-defined paragraph and
26117 \change_deleted 244031559 1603876931
26119 \change_inserted 244031559 1603876940
26122 styles and \SpecialChar LyX
26123 's own pre-defined styles:
26125 everything \SpecialChar LyX
26126 knows about the styles is contained in the layout files.
26127 And much the same is true as regards pre-defined textual insets,
26129 and various custom insets.
26133 \begin_layout Standard
26134 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
26135 output can be customized and extended:
26136 through layout files and modules.
26137 See chapter five of the
26141 manual for the details.
26144 \begin_layout Standard
26145 The remainder of this chapter contains more detailed information on XHTML output,
26147 and ways to work around those limitations.
26150 \begin_layout Section
26151 Math Output in XHTML
26154 \begin_layout Standard
26156 offers four choices for how math is rendered.
26157 These have various advantages and disadvantages:
26160 \begin_layout Itemize
26162 \begin_inset Newline newline
26165 MathML is a dialect of XML designed specifically for mathematics on the web,
26166 and it typically renders very well in browsers that support it.
26167 The disadvantage is that not all browsers support MathML,
26168 and support is not complete even in the Gecko-based browsers,
26170 \begin_inset Newline newline
26173 If \SpecialChar LyX
26174 is unable to render a formula as MathML—
26176 if the formula uses the
26177 \begin_inset Flex Code
26180 \begin_layout Plain Layout
26187 then it will instead output the formula as an image.
26191 \begin_layout Itemize
26193 \begin_inset Newline newline
26196 As mentioned above,
26198 \begin_inset Flex Code
26201 \begin_layout Plain Layout
26207 outputs math as HTML,
26212 \begin_layout Plain Layout
26214 has borrowed some of the CSS for its HTML output from
26215 \begin_inset Flex Code
26218 \begin_layout Plain Layout
26229 For simple formulae,
26230 this can work quite well,
26231 though with more complicated formulae it tends to break down.
26233 this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
26234 fairly simple math.
26235 \begin_inset Newline newline
26238 If Lyx is unable to render a formula as HTML—
26240 if the formula uses the
26241 \begin_inset Flex Code
26244 \begin_layout Plain Layout
26251 then it will instead output the formula as an image.
26255 \begin_layout Itemize
26257 \begin_inset Newline newline
26261 \begin_inset Flex Code
26264 \begin_layout Plain Layout
26272 will output formulae as images,
26273 the very same images,
26275 that are used for instant preview.
26279 \begin_layout Plain Layout
26280 Instant preview does
26284 have to be on for images to be output,
26290 The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
26292 so they are very accurate.
26294 as mentioned earlier,
26295 is that these are bitmapped images,
26296 so they do not scale terribly well,
26297 and one cannot copy them,
26299 \begin_inset Newline newline
26302 The size of the images can be controlled by setting the
26303 \begin_inset Quotes eld
26306 Math Images Scaling
26307 \begin_inset Quotes erd
26311 \begin_inset Flex Noun
26314 \begin_layout Plain Layout
26315 Document\SpecialChar menuseparator
26316 Settings\SpecialChar menuseparator
26326 \begin_layout Plain Layout
26327 For those who want to know,
26328 this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
26334 \begin_inset Newline newline
26337 If \SpecialChar LyX
26338 for some reason fails to create an image for a formula (e.g.,
26339 if a required \SpecialChar LaTeX
26340 package is not installed),
26341 then it will fall back to outputing the raw \SpecialChar LaTeX
26345 \begin_layout Itemize
26348 \begin_inset Newline newline
26353 will happily output math as \SpecialChar LaTeX
26355 As well as being the output of last resort,
26356 this method can be used with such tools as
26357 \begin_inset CommandInset href
26360 target "http://www.math.union.edu/~dpvc/jsMath/"
26366 which uses JavaScript to render \SpecialChar LaTeX
26367 embedded in HTML documents.
26369 wraps the \SpecialChar LaTeX
26371 \begin_inset Flex Code
26374 \begin_layout Plain Layout
26380 (for inline formulas) or
26381 \begin_inset Flex Code
26384 \begin_layout Plain Layout
26390 (for displayed formulas) with
26391 \begin_inset Flex Code
26394 \begin_layout Plain Layout
26401 as is required for jsMath.
26404 \begin_layout Standard
26405 One of these output methods must be selected under
26406 \begin_inset Flex Noun
26409 \begin_layout Plain Layout
26410 Document\SpecialChar menuseparator
26411 Settings\SpecialChar menuseparator
26421 This is a document-wide setting,
26425 \begin_layout Standard
26428 will offer the user the option to select an alternate output method for a particular inset,
26430 one that isn't being rendered very well by MathML.
26434 \begin_layout Plain Layout
26436 since \SpecialChar LyX
26437 falls back to images if the inset contains ERT,
26438 then one can force output as an image by putting some harmless ERT into the math,
26441 \begin_inset Formula $a=b\relax$
26452 \begin_layout Section
26453 Bibliography and Citations
26456 \begin_layout Standard
26457 XHTML output fully supports bibliographies and citations.
26461 \begin_layout Standard
26462 Citation labels are generated by the same machinery that generates \SpecialChar LyX
26463 's on-screen labels,
26464 so the labels will look in the output much as they do in \SpecialChar LyX
26467 If you are using numerical citations,
26468 then \SpecialChar LyX
26469 will output numerical labels,
26470 such as [1] or [17],
26471 rather than simply showing the citation key in square brackets,
26472 as it does on-screen.
26473 If you are using author-year citations,
26474 then \SpecialChar LyX
26475 will add lowercase letters to the years,
26476 just as Bib\SpecialChar TeX
26478 if it finds more than one citation for a given author-year combination.
26479 The labels will be printed with the bibliography entries.
26480 Note that there is,
26482 no way to customize the appearance of the labels,
26484 to choose between square brackets and parentheses.
26487 \begin_layout Standard
26488 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
26489 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.
26490 The formatting can be customized in your layout file or,
26497 manual for the details.
26500 \begin_layout Standard
26501 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
26502 So you can see things like this:
26505 \begin_layout Quote
26508 \begin_inset Quotes eld
26511 Context and Logical Form
26512 \begin_inset Quotes erd
26518 Language in Context:
26522 Oxford University Press,
26528 \begin_layout Quote
26531 \begin_inset Quotes eld
26534 Semantics in Context
26535 \begin_inset Quotes erd
26541 Language in Context:
26545 Oxford University Press,
26551 \begin_layout Standard
26552 This should be fixed before long.
26555 \begin_layout Standard
26556 There is no support at present for sectioned bibliographies.
26557 If you have multiple bibliographies,
26558 then \SpecialChar LyX
26559 will print the same bibliography over and over.
26562 \begin_layout Section
26566 \begin_layout Standard
26568 will happily export indexes as XHTML,
26569 but with certain limitations at the moment.
26572 \begin_layout Standard
26573 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
26581 \begin_layout Plain Layout
26582 The main issue here is that \SpecialChar LyX
26583 itself does not really handle these.
26584 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
26590 We'll describe how they are handled using the subsection headings from that section.
26593 \begin_layout Itemize
26594 Grouping Index Entries (aka,
26597 makes an effort to support these,
26598 but the entries must be separated by
26599 \begin_inset Quotes eld
26604 \begin_inset Quotes erd
26609 there must be spaces around the exclamation point.
26610 This is because it is otherwise too difficult to check for escaped exclamation points,
26615 \begin_layout Itemize
26617 There is no support at all for page ranges,
26618 since these make no sense with XHMTL.
26620 you will just get two index entries,
26624 \begin_layout Itemize
26626 There is no support for cross-referencing.
26627 If \SpecialChar LyX
26628 finds an entry containing the
26629 \begin_inset Quotes eld
26632 |see\SpecialChar ldots
26634 \begin_inset Quotes erd
26638 it is just dropped,
26639 and the rest is treated as an ordinary index entry.
26642 \begin_layout Itemize
26645 does support attempts to fix the sorting order.
26646 It will take what is before the first `@' it finds and use that for sorting,
26647 taking what follows the first `@' to be the actual entry.
26650 does not check for escaped `@',
26651 so do not try to index email addresses.
26654 \begin_layout Itemize
26655 Index Entry Layout:
26656 You can format entries by using the text style dialog,
26657 or by using any other method available within \SpecialChar LyX
26659 There is no support for constructs like:
26661 \begin_inset Quotes eld
26665 \begin_inset Quotes erd
26670 if \SpecialChar LyX
26671 finds a pipe symbol,
26674 it will delete it and everything that follows it.
26677 \begin_layout Itemize
26679 There is no support for multiple indexes.
26681 all index entries will be printed as one large index.
26682 To avoid our printing several versions of the index,
26683 we print only the main index,
26684 so make sure you have one.
26687 \begin_layout Section
26688 Nomenclature and Glossary
26691 \begin_layout Standard
26692 There is at present no support for glossaries.
26693 Adding it would be fairly trivial,
26697 \begin_layout Chapter
26699 \change_inserted 1075283030 1616534180
26703 \begin_layout Standard
26705 \change_inserted 1075283030 1616534386
26708 can generate documents in the DocBook XML vocabulary.
26709 With versions 2.3 and before,
26710 only select templates could be used to generate DocBook documents (only version 4).
26711 Starting with \SpecialChar LyX
26713 most \SpecialChar LyX
26714 layouts can generate valid DocBook documents (only version 5).
26715 This feature is built into \SpecialChar LyX
26716 and does not require the use of external tools.
26719 \begin_layout Standard
26721 \change_inserted 1075283030 1616534437
26722 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
26723 output can be customized and extended:
26724 through layout files and modules.
26725 See chapter five of the
26729 manual for the details.
26732 \begin_layout Standard
26734 \change_inserted 1075283030 1616534475
26735 Most \SpecialChar LyX
26736 features are supported with DocBook,
26740 \begin_layout Itemize
26742 \change_inserted 1075283030 1616534741
26743 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
26747 All formulae are also available in raw \SpecialChar TeX
26748 in the DocBook output for further processing.
26751 \begin_layout Itemize
26753 \change_inserted 1075283030 1616534852
26754 Bibliographies and citations are implemented,
26755 including with an external BibTeX file.
26756 Bibliography entries are not prerendered when the detailed information are available,
26757 but rather output with the standard DocBook constructs.
26758 The external DocBook processor is expected to handle the rendering of entries.
26761 \begin_layout Itemize
26763 \change_inserted 1075283030 1616534863
26764 Indexes are supported,
26765 including multiple indices.
26772 and cross-references (
26777 with the exception of the same symbols escaped.
26786 ) are not supported.
26787 There is no support for escaping of index entries.
26790 \begin_layout Itemize
26792 \change_inserted 1075283030 1616534884
26793 Glossaries are implemented.
26796 \begin_layout Standard
26798 \change_inserted 1075283030 1616534894
26799 Two major parameters can be set at the document level.
26802 \begin_layout Itemize
26804 \change_inserted 1075283030 1616534948
26807 can generate tables either as HTML (default value) or CALS,
26808 depending on the user's requirements.
26809 Most DocBook processors accept both formats.
26812 \begin_layout Itemize
26814 \change_inserted 1075283030 1616535006
26817 MathML is included within its own name space,
26819 The implication is that there must be an indication of the tags belonging to the MathML standard.
26820 Three choices are offered:
26825 \begin_layout Itemize
26827 \change_inserted 1075283030 1616535044
26829 the MathML name space is defined for each formula (using the
26833 attribute on each formula)
26836 \begin_layout Itemize
26838 \change_inserted 1075283030 1616535090
26844 the MathML name space is defined at the document level (using the
26848 attribute on the root element).
26849 Each MathML is prefixed with
26860 \begin_layout Itemize
26862 \change_inserted 1075283030 1616620405
26878 \begin_layout Standard
26880 \change_inserted 1075283030 1616620470
26881 This option is especially useful if you want \SpecialChar LyX
26882 to match your personal style or to work with buggy software that only accepts one prefix for MathML.
26888 \begin_layout Chapter
26889 The \SpecialChar LyX
26893 \begin_layout Section
26897 \begin_layout Standard
26898 The `\SpecialChar LyX
26899 server' allows other programs to talk to \SpecialChar LyX
26901 invoke \SpecialChar LyX
26903 and retrieve information about the \SpecialChar LyX
26905 This is only intended for advanced users,
26906 but they should find it useful.
26907 It is by writing to the \SpecialChar LyX
26910 that bibliography managers,
26913 \begin_inset Quotes eld
26917 \begin_inset Quotes erd
26920 citations to \SpecialChar LyX
26924 \begin_layout Section
26925 Starting the \SpecialChar LyX
26927 \begin_inset CommandInset label
26929 name "sec:Starting-the-Server"
26936 \begin_layout Standard
26937 The \SpecialChar LyX
26938 server works through the use of a pair of named pipes.
26939 These are usually located in
26940 \begin_inset Flex Code
26943 \begin_layout Plain Layout
26950 (except on Windows,
26955 named pipes are special objects located in
26956 \begin_inset Flex Code
26959 \begin_layout Plain Layout
26971 ) and have the names
26972 \begin_inset Quotes eld
26976 \begin_inset Flex Code
26979 \begin_layout Plain Layout
26986 \begin_inset Quotes erd
26990 \begin_inset Quotes eld
26994 \begin_inset Flex Code
26997 \begin_layout Plain Layout
27004 \begin_inset Quotes erd
27008 External programs write into
27009 \begin_inset Flex Code
27012 \begin_layout Plain Layout
27018 and read back data from
27019 \begin_inset Flex Code
27022 \begin_layout Plain Layout
27029 The stem of the pipe names can be defined in the
27030 \begin_inset Flex Noun
27033 \begin_layout Plain Layout
27034 Tools\SpecialChar menuseparator
27042 \begin_inset Flex Code
27045 \begin_layout Plain Layout
27046 "/home/myhome/lyxpipe"
27053 \begin_inset Flex Code
27056 \begin_layout Plain Layout
27070 on Windows (where any working path instead of lyxpipe can be used,
27072 \begin_inset Flex Code
27075 \begin_layout Plain Layout
27098 configure this manually in order for the server to start.
27101 \begin_layout Standard
27104 \begin_inset Flex Code
27107 \begin_layout Plain Layout
27114 \begin_inset Flex Code
27117 \begin_layout Plain Layout
27123 ' to create the pipes.
27124 If one of the pipes already exists,
27126 will assume that another \SpecialChar LyX
27127 process is already running and will not start the server.
27128 On POSIX (Unix like) systems,
27129 if for some other reason,
27131 \begin_inset Quotes eld
27135 \begin_inset Quotes erd
27138 pipe is left in existence when \SpecialChar LyX
27140 then \SpecialChar LyX
27141 will try to delete it.
27142 If this fails for some reason,
27143 you will need to delete the pipes manually and then restart \SpecialChar LyX
27146 pipes are deleted by the OS on program termination or crash,
27148 \begin_inset Quotes eld
27152 \begin_inset Quotes erd
27155 pipes should not be possible.
27158 \begin_layout Standard
27159 To have several \SpecialChar LyX
27160 processes with servers at the same time,
27161 you have to use different configurations,
27162 perhaps by using separate user directories,
27164 \begin_inset Flex Code
27167 \begin_layout Plain Layout
27177 \begin_layout Standard
27178 If you are developing a client program,
27179 you might find it useful to enable debugging information from the \SpecialChar LyX
27181 Do this by starting \SpecialChar LyX
27183 \begin_inset Flex Code
27186 \begin_layout Plain Layout
27195 \begin_layout Standard
27196 You can find a complete example client written in C++ in the source distribution as
27197 \begin_inset Flex Code
27200 \begin_layout Plain Layout
27201 development/lyxserver/server_monitor.cpp
27209 \begin_layout Standard
27210 Another useful tool is the command-line based client found in
27211 \begin_inset Flex Code
27214 \begin_layout Plain Layout
27215 src/client/lyxclient
27223 \begin_layout Section
27224 Normal communication
27227 \begin_layout Standard
27228 To issue a \SpecialChar LyX
27230 the client writes a line of ASCII text into the input pipe.
27231 This line has the following format:
27234 \begin_layout Quote
27248 \begin_layout Description
27249 clientname is a name that the client can choose arbitrarily.
27250 Its only use is that \SpecialChar LyX
27251 will echo it if it sends an answer—
27252 so a client can dispatch results from different requesters.
27255 \begin_layout Description
27256 function is the function you want \SpecialChar LyX
27258 It is the same as the commands you'd use in the minibuffer.
27261 \begin_layout Description
27262 argument is an optional argument which is meaningful only to some functions (for instance,
27264 \begin_inset Quotes eld
27268 \begin_inset Quotes erd
27271 LFUN will insert the argument as text at the cursor position).
27274 \begin_layout Standard
27275 The answer from \SpecialChar LyX
27276 will arrive in the output pipe and be of the form
27279 \begin_layout Quote
27293 \begin_layout Standard
27302 are just echoed from the command request,
27307 is more or less useful information filled according to how the command execution worked out.
27310 \begin_inset Quotes eld
27314 \begin_inset Quotes erd
27318 will return information about the internal state of \SpecialChar LyX
27320 while other will return an empty data-response.
27321 This means that the command execution went fine.
27324 \begin_layout Standard
27326 the response from \SpecialChar LyX
27327 will have this form
27330 \begin_layout Quote
27344 \begin_layout Standard
27349 should contain an explanation of why the command failed.
27352 \begin_layout Standard
27356 \begin_layout LyX-Code
27357 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
27358 \begin_inset Newline newline
27361 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
27362 \begin_inset Newline newline
27365 read a <~/.lyxpipe.out
27366 \begin_inset Newline newline
27372 \begin_layout Subsection
27373 AppleScript (Mac OS X)
27376 \begin_layout Standard
27377 Since \SpecialChar LyX
27380 supports basic interactions with AppleScript for normal communication through the command run.
27381 This command takes a direct argument (the
27385 to perform) and an optional argument.
27386 It either returns the output of the function or triggers an error with the error message and code.
27389 \begin_layout Standard
27393 \begin_layout LyX-Code
27394 tell application "\SpecialChar LyX
27398 \begin_layout LyX-Code
27402 \begin_layout LyX-Code
27403 -- Stores the current file name into f
27406 \begin_layout LyX-Code
27407 set f to (run "server-get-filename" with argument "")
27410 \begin_layout LyX-Code
27411 on error the error_message number the error_number
27414 \begin_layout LyX-Code
27415 display dialog "Error:
27416 " & the error_number & ".
27420 \begin_layout LyX-Code
27421 & the error_message buttons {"OK"} default button 1
27424 \begin_layout LyX-Code
27428 \begin_layout LyX-Code
27432 \begin_layout Section
27436 \begin_layout Standard
27438 can notify clients of events going on asynchronously.
27439 Currently it will only do this if the user binds a key sequence with the function
27440 \begin_inset Quotes eld
27444 \begin_inset Quotes erd
27448 The format of the string \SpecialChar LyX
27449 sends is as follows:
27452 \begin_layout Quote
27453 \begin_inset Flex Code
27456 \begin_layout Plain Layout
27467 \begin_layout Standard
27472 is the printed representation of the key sequence that was actually typed by the user.
27475 \begin_layout Standard
27476 This mechanism can be used to extend \SpecialChar LyX
27477 's command set and implement macros.
27478 Bind some key sequence to
27479 \begin_inset Quotes eld
27483 \begin_inset Quotes erd
27487 Then start a client that listens on the output pipe,
27488 dispatches the command according to the sequence,
27489 and starts a function that may use \SpecialChar LyX
27490 calls and \SpecialChar LyX
27491 requests to issue a command or a series of commands to \SpecialChar LyX
27495 \begin_layout Section
27496 The simple \SpecialChar LyX
27500 \begin_layout Standard
27502 implements a simple protocol that can be used for session management.
27503 All messages are of the form
27506 \begin_layout Quote
27516 \begin_layout Standard
27522 \begin_inset Quotes eld
27526 \begin_inset Quotes erd
27530 \begin_inset Quotes eld
27534 \begin_inset Quotes erd
27539 \begin_inset Quotes eld
27543 \begin_inset Quotes erd
27546 is received from a client,
27548 will report back to inform the client that it's listening to it's messages,
27550 \begin_inset Quotes eld
27554 \begin_inset Quotes erd
27557 sent from \SpecialChar LyX
27558 will inform clients that \SpecialChar LyX
27562 \begin_layout Section
27563 Reverse DVI/PDF search
27566 \begin_layout Standard
27567 Some DVI/PDF viewers
27571 \begin_layout Plain Layout
27572 The following viewers offer the reverse PDF search feature:
27573 Okular on KDE/Linux,
27575 Skim on Mac OSX and SumatraPDF on Windows.
27584 facility (also called
27589 This means that you can tell \SpecialChar LyX
27590 to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
27592 the viewer must be able to communicate with \SpecialChar LyX
27594 This is done via the \SpecialChar LyX
27595 server either by using the named pipe (
27600 or the UNIX domain socket (
27604 ) that \SpecialChar LyX
27605 creates in its temporary directory (this is the way the
27606 \begin_inset Flex Code
27609 \begin_layout Plain Layout
27615 program communicates with \SpecialChar LyX
27618 you need a helper script that mediates between the viewer and \SpecialChar LyX
27621 the viewer can communicate with \SpecialChar LyX
27623 This depends on the selected viewer and on your operating system.
27624 The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
27626 we will thus describe how to setup reverse search for specific viewers.
27627 Before we turn to this,
27629 we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
27632 \begin_layout Subsection
27634 \begin_inset CommandInset label
27636 name "subsec:rev-search"
27643 \begin_layout Standard
27644 In most cases \SpecialChar LyX
27645 will do the work for you by pressing the following button in the toolbar:
27649 arg "buffer-toggle-output-sync"
27654 you can also enable the feature by checking
27656 Synchronize with Output
27659 \begin_inset Flex Noun
27662 \begin_layout Plain Layout
27663 Document\SpecialChar menuseparator
27664 Settings\SpecialChar menuseparator
27671 In such a case \SpecialChar LyX
27672 will automatically insert the necessary Sync\SpecialChar TeX
27673 macro (for PDF) or load the srcltx package (for DVI) respectively.
27674 This option can be easily reached also on
27675 \begin_inset Flex Code
27678 \begin_layout Plain Layout
27687 \begin_layout Standard
27688 If you need a different setting,
27689 you can select or input a custom macro from the drop down box just below
27690 \begin_inset Flex Noun
27693 \begin_layout Plain Layout
27694 Document\SpecialChar menuseparator
27695 Settings\SpecialChar menuseparator
27696 Output\SpecialChar menuseparator
27697 Synchronize with Output
27705 \begin_layout Standard
27706 Note that the method
27707 \begin_inset Flex Code
27710 \begin_layout Plain Layout
27718 enables gzip compression.
27719 If your viewer does not support it,
27720 you should instead use
27721 \begin_inset Flex Code
27724 \begin_layout Plain Layout
27735 \begin_layout Standard
27736 Please also note that including the
27737 \begin_inset Flex Code
27740 \begin_layout Plain Layout
27747 \begin_inset Flex Code
27750 \begin_layout Plain Layout
27756 sometimes has an undesired impact on the typesetting.
27758 you should switch output synchronization off for the final typesetting if you use the
27759 \begin_inset Flex Code
27762 \begin_layout Plain Layout
27769 \begin_inset Flex Code
27772 \begin_layout Plain Layout
27782 \begin_layout Standard
27783 In case you need some more special settings that are not covered by the automatic settings,
27784 read the next section about how to set up output synchronization manually.
27785 If the automatic setup suits your needs,
27786 you can readily jump to section
27787 \begin_inset space ~
27791 \begin_inset CommandInset ref
27793 reference "subsec:configuring-viewers"
27799 where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
27802 \begin_layout Subsection
27806 \begin_layout Standard
27808 provides several different methods for reverse search.
27809 Some are built-in in the
27810 \begin_inset Flex Code
27813 \begin_layout Plain Layout
27820 some are provided by external packages.
27821 Your choice depends on whether your \SpecialChar LaTeX
27822 distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
27823 The available methods are described in the following.
27826 \begin_layout Subsubsection*
27827 Built-in DVI-search via src-specials (DVI only)
27830 \begin_layout Standard
27831 This method provides the DVI file with the necessary information for reverse search.
27832 It is available in \SpecialChar LaTeX
27833 since quite some time (any somewhat recent \SpecialChar LaTeX
27834 distribution should include it),
27835 and it works reliably.
27838 \begin_inset Flex Noun
27841 \begin_layout Plain Layout
27852 \begin_inset Flex Noun
27855 \begin_layout Plain Layout
27866 \begin_inset Flex Noun
27869 \begin_layout Plain Layout
27870 Preferences\SpecialChar menuseparator
27871 File Handling\SpecialChar menuseparator
27878 \begin_inset Flex Code
27881 \begin_layout Plain Layout
27882 latex -src-specials $$i
27888 If this doesn't work,
27889 check if your \SpecialChar TeX
27890 engine needs different options (the syntax might differ in some distributions).
27893 \begin_layout Subsubsection*
27894 External Packages (PDFSync and scrltx)
27897 \begin_layout Standard
27906 provide reverse search facility for PDF output (via pdflatex) and DVI output,
27908 In order to enable it,
27909 load the packages in the \SpecialChar LyX
27914 \begin_layout Itemize
27915 \begin_inset Flex Code
27918 \begin_layout Plain Layout
27921 usepackage{pdfsync}
27926 for reverse PDF search,
27929 \begin_layout Itemize
27930 \begin_inset Flex Code
27933 \begin_layout Plain Layout
27936 usepackage[active]{srcltx}
27941 for reverse DVI search.
27944 \begin_layout Standard
27945 If you want to be able to perform both DVI and PDF reverse searches,
27946 you can also insert in the preamble the following lines
27949 \begin_layout LyX-Code
27953 \begin_inset Newline newline
27959 \begin_inset Newline newline
27964 usepackage{pdfsync}
27965 \begin_inset Newline newline
27971 \begin_inset Newline newline
27976 usepackage[active]{srcltx}
27977 \begin_inset Newline newline
27985 \begin_layout Standard
27987 you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
27990 \begin_layout Standard
27991 Note that PDFSync might affect the output layout of your document.
27992 It is therefore advised to disable PDFsync for final documents.
27995 \begin_layout Subsubsection*
27996 Built-in reverse search via Sync\SpecialChar TeX
28000 \begin_layout Standard
28002 \begin_inset Flex Code
28005 \begin_layout Plain Layout
28011 have built-in support for both PDF and DVI reverse search.
28014 Sync\SpecialChar TeX
28017 facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
28022 You need at least \SpecialChar TeX
28023 Live 2008 or a recent Mik\SpecialChar TeX
28024 distribution in order to use it.
28028 \begin_layout Plain Layout
28030 Mik\SpecialChar TeX
28031 does not understand/obey the command \SpecialChar LyX
28032 inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
28035 \begin_layout Plain Layout
28036 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
28037 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
28038 by adding the -synctex=1 switch).
28043 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
28045 SumatraPDF on Windows;
28046 see the next section for details) already provide Sync\SpecialChar TeX
28050 \begin_layout Standard
28051 To enable Sync\SpecialChar TeX
28054 \begin_inset Flex Noun
28057 \begin_layout Plain Layout
28068 \begin_inset Flex Noun
28071 \begin_layout Plain Layout
28076 (plain) -> DraftDVI
28082 \begin_inset Flex Noun
28085 \begin_layout Plain Layout
28086 Preferences\SpecialChar menuseparator
28087 File Handling\SpecialChar menuseparator
28094 \begin_inset Flex Code
28097 \begin_layout Plain Layout
28098 latex -synctex=1 $$i
28104 and for PDF output,
28106 \begin_inset Flex Noun
28109 \begin_layout Plain Layout
28114 (pdflatex) -> PDF (pdflatex)
28120 \begin_inset Flex Code
28123 \begin_layout Plain Layout
28124 pdflatex -synctex=1 $$i
28130 Should your viewer not be considered in the following description,
28131 or in case of missing success,
28132 please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
28137 \begin_layout Plain Layout
28138 Note that the option
28139 \begin_inset Flex Code
28142 \begin_layout Plain Layout
28148 option enables gzip compression.
28149 If your viewer does not support it,
28150 you should instead use
28151 \begin_inset Flex Code
28154 \begin_layout Plain Layout
28168 \begin_layout Subsection
28169 Configuring and using specific viewers
28170 \begin_inset CommandInset label
28172 name "subsec:configuring-viewers"
28179 \begin_layout Subsubsection*
28180 Xdvi (all platforms)
28183 \begin_layout Standard
28185 \begin_inset Flex Code
28188 \begin_layout Plain Layout
28195 you don't need to do anything else for performing a reverse DVI search,
28196 as \SpecialChar LyX
28197 already provides the necessary hooks for automatically using the
28198 \begin_inset Flex Code
28201 \begin_layout Plain Layout
28208 Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
28212 \begin_layout Standard
28214 if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
28216 simply change the DVI viewer in
28217 \begin_inset Flex Noun
28220 \begin_layout Plain Layout
28221 Preferences\SpecialChar menuseparator
28222 File Handling\SpecialChar menuseparator
28232 \begin_layout Plain Layout
28233 On Mac OSX you have to use
28234 \begin_inset Flex Code
28237 \begin_layout Plain Layout
28238 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
28249 \begin_inset Flex Code
28252 \begin_layout Plain Layout
28253 xdvi -editor "lyxeditor.sh %f %l"
28260 \begin_inset Flex Code
28263 \begin_layout Plain Layout
28269 is a suitable script.
28271 a minimal shell script is the following one:
28274 \begin_layout LyX-Code
28276 \begin_inset Newline newline
28279 LYXPIPE="/path/to/lyxpipe"
28280 \begin_inset Newline newline
28283 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
28284 \begin_inset Newline newline
28287 echo "$COMMAND" > "${LYXPIPE}".in || exit
28288 \begin_inset Newline newline
28291 read TMP < "${LYXPIPE}".out || exit
28294 \begin_layout Standard
28296 \begin_inset Flex Code
28299 \begin_layout Plain Layout
28305 is the LyXServer pipe path specified in
28306 \begin_inset Flex Noun
28309 \begin_layout Plain Layout
28310 Preferences\SpecialChar menuseparator
28320 \begin_layout Plain Layout
28322 \begin_inset Flex Code
28325 \begin_layout Plain Layout
28331 folder of a source distribution you can find a
28332 \begin_inset Flex Code
28335 \begin_layout Plain Layout
28341 script which is able to locate the
28345 based on your preferences.
28353 \begin_layout Subsubsection*
28357 \begin_layout Standard
28359 \begin_inset Flex Code
28362 \begin_layout Plain Layout
28363 /Applications/MacDviX_Folder/calleditor.script
28369 add the following lines:
28372 \begin_layout LyX-Code
28373 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
28374 \begin_inset Newline newline
28380 \begin_layout Standard
28381 Modify the lines accordingly if you install \SpecialChar LyX
28382 somewhere else than in the Applications folder.
28385 \begin_layout Standard
28386 Reverse search is triggered by Alt-click (OPTION-click).
28389 \begin_layout Subsubsection*
28393 \begin_layout Standard
28395 \begin_inset Flex Code
28398 \begin_layout Plain Layout
28399 open -a Skim.app $$i
28404 to the viewer setting in
28405 \begin_inset Flex Noun
28408 \begin_layout Plain Layout
28409 Preferences\SpecialChar menuseparator
28410 File Handling\SpecialChar menuseparator
28411 File formats\SpecialChar menuseparator
28419 \begin_inset Flex Noun
28422 \begin_layout Plain Layout
28423 Skim\SpecialChar menuseparator
28424 Preferences\SpecialChar menuseparator
28431 \begin_inset Flex Noun
28434 \begin_layout Plain Layout
28440 preset and enter command
28441 \begin_inset Flex Noun
28444 \begin_layout Plain Layout
28445 /Applications/\SpecialChar LyX
28446 .app/Contents/MacOS/lyxeditor
28454 \begin_layout Standard
28455 Reverse search is triggered by COMMAND-SHIFT-click
28458 \begin_layout Subsubsection*
28462 \begin_layout Standard
28463 Reverse search with evince does not work out of the box,
28464 but it can be achieved by means of some third party helper scripts.
28466 \begin_inset CommandInset href
28468 target "https://wiki.lyx.org/LyX/SyncTeX"
28476 \begin_layout Subsubsection*
28480 \begin_layout Standard
28482 \begin_inset Flex Noun
28485 \begin_layout Plain Layout
28486 Settings\SpecialChar menuseparator
28487 Configure Okular\SpecialChar menuseparator
28494 \begin_inset Quotes erd
28498 This inserts the appropriate command (
28499 \begin_inset Flex Code
28502 \begin_layout Plain Layout
28511 \begin_layout Standard
28512 Reverse search is triggered by SHIFT-click.
28514 \change_inserted -712698321 1578211026
28515 Note that this only works if Okular is in
28516 \begin_inset Quotes eld
28520 \begin_inset Quotes erd
28524 \begin_inset space \thinspace{}
28528 the hand symbol is clicked).
28533 \begin_layout Subsubsection*
28537 \begin_layout Standard
28538 Qpdfview supports Sync\SpecialChar TeX
28539 since version 0.3.5.
28541 \begin_inset Flex Noun
28544 \begin_layout Plain Layout
28545 Edit\SpecialChar menuseparator
28546 Settings\SpecialChar menuseparator
28553 click on the input field of the
28554 \begin_inset Quotes eld
28558 \begin_inset Quotes erd
28561 item and add the command
28562 \begin_inset Flex Code
28565 \begin_layout Plain Layout
28574 \begin_layout Standard
28575 Reverse search is triggered by double-click or,
28576 in more recent versions,
28580 \begin_layout Subsubsection*
28584 \begin_layout Standard
28587 \begin_inset Flex Noun
28590 \begin_layout Plain Layout
28591 View\SpecialChar menuseparator
28597 menu and select the
28598 \begin_inset Quotes eld
28602 \begin_inset Quotes erd
28607 \begin_inset Quotes eld
28610 New\SpecialChar ldots
28612 \begin_inset Quotes erd
28616 in the window that opens,
28618 \begin_inset Quotes eld
28623 \begin_inset Quotes erd
28626 (or any other name you like) in the
28627 \begin_inset Quotes eld
28631 \begin_inset Quotes erd
28635 Now click on the button labeled
28636 \begin_inset Quotes eld
28641 \begin_inset Quotes erd
28644 to open a file dialog and navigate to the directory containing the batch file
28645 \begin_inset Flex Code
28648 \begin_layout Plain Layout
28656 \begin_inset Flex Code
28659 \begin_layout Plain Layout
28665 and then specify the program arguments as
28666 \begin_inset Flex Code
28669 \begin_layout Plain Layout
28677 \begin_inset Flex Code
28680 \begin_layout Plain Layout
28686 wrapper is used for communicating with \SpecialChar LyX
28694 \begin_layout LyX-Code
28696 \begin_inset Newline newline
28699 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
28708 \begin_inset Newline newline
28722 \begin_layout Standard
28723 Make sure that the \SpecialChar LyX
28724 Server pipe path you specified in \SpecialChar LyX
28726 \begin_inset Flex Code
28729 \begin_layout Plain Layout
28744 otherwise change the
28745 \begin_inset Flex Code
28748 \begin_layout Plain Layout
28754 wrapper accordingly.
28757 \begin_layout Standard
28759 reverse search is triggered by double-click.
28762 \begin_layout Subsubsection*
28763 SumatraPDF (Windows)
28766 \begin_layout Standard
28767 In order to use SumatraPDF for inverse search,
28769 \begin_inset Flex Code
28772 \begin_layout Plain Layout
28773 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
28778 in the viewer setting in
28779 \begin_inset Flex Noun
28782 \begin_layout Plain Layout
28783 Preferences\SpecialChar menuseparator
28784 File Handling\SpecialChar menuseparator
28785 File formats\SpecialChar menuseparator
28793 \begin_inset Flex Code
28796 \begin_layout Plain Layout
28802 is the previous wrapper.
28803 If SumatraPDF.exe is not in your command PATH,
28804 use its full file name.
28807 \begin_layout Standard
28808 Reverse search is triggered by double-click.
28811 \begin_layout Subsubsection*
28815 \begin_layout Standard
28817 make sure that yap is your default DVI viewer in the Windows environment,
28820 \begin_inset Flex Noun
28823 \begin_layout Plain Layout
28824 View\SpecialChar menuseparator
28830 menu and select the
28831 \begin_inset Quotes eld
28835 \begin_inset Quotes erd
28840 \begin_inset Quotes eld
28843 New\SpecialChar ldots
28845 \begin_inset Quotes erd
28849 in the window that opens,
28851 \begin_inset Quotes eld
28856 \begin_inset Quotes erd
28859 (or any other name you like) in the
28860 \begin_inset Quotes eld
28864 \begin_inset Quotes erd
28868 Now click on the button labeled
28869 \begin_inset Quotes eld
28874 \begin_inset Quotes erd
28877 to open a file dialog and navigate to the directory containing the
28878 \begin_inset Flex Code
28881 \begin_layout Plain Layout
28887 program (which is installed by default on Cygwin along with the \SpecialChar LyX
28890 \begin_inset Flex Code
28893 \begin_layout Plain Layout
28899 and then specify the program arguments as
28900 \begin_inset Flex Code
28903 \begin_layout Plain Layout
28911 you will be using the
28915 for communicating with \SpecialChar LyX
28918 for whatever reason,
28919 you want to use the
28925 \begin_inset Flex Code
28928 \begin_layout Plain Layout
28934 option and be sure to specify the \SpecialChar LyX
28935 Server pipe path in the \SpecialChar LyX
28939 \begin_layout Standard
28941 reverse search is triggered by double-click.
28944 \begin_layout Subsubsection*
28945 SumatraPDF (Cygwin)
28948 \begin_layout Standard
28949 In order to use SumatraPDF for inverse search,
28951 \begin_inset Flex Code
28954 \begin_layout Plain Layout
28955 SumatraPDF -inverse-search "lyxeditor -g %f %l"
28960 in the viewer setting in
28961 \begin_inset Flex Noun
28964 \begin_layout Plain Layout
28965 Preferences\SpecialChar menuseparator
28966 File Handling\SpecialChar menuseparator
28967 File formats\SpecialChar menuseparator
28974 If SumatraPDF.exe is not in your command PATH,
28975 use its full posix path.
28977 \begin_inset Flex Code
28980 \begin_layout Plain Layout
28986 enables communication via the
28993 \begin_inset Flex Code
28996 \begin_layout Plain Layout
29002 option if you want to use the
29007 and be sure to specify the \SpecialChar LyX
29008 Server pipe path in the \SpecialChar LyX
29012 \begin_layout Standard
29013 Reverse search is triggered by double-click.
29016 \begin_layout Section
29020 \begin_layout Standard
29022 as the name implies,
29024 \begin_inset Quotes eld
29028 \begin_inset Quotes erd
29032 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
29034 If forward search is set up (as described in what follows),
29035 you can put the cursor anywhere in your \SpecialChar LyX
29038 \begin_inset Flex Noun
29041 \begin_layout Plain Layout
29042 Navigate\SpecialChar menuseparator
29049 \begin_inset Flex Noun
29052 \begin_layout Plain Layout
29058 in the context menu via right mouse click),
29059 and then the viewer will jump to that position as well.
29062 that your viewer supports this function.
29065 \begin_layout Standard
29066 To make forward search possible,
29067 you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
29069 This can be done via the methods described in the section
29070 \begin_inset CommandInset ref
29072 reference "subsec:rev-search"
29080 \begin_layout Standard
29082 you need to configure \SpecialChar LyX
29083 for using your viewers in
29084 \begin_inset Flex Noun
29087 \begin_layout Plain Layout
29088 Tools\SpecialChar menuseparator
29089 Preferences\SpecialChar menuseparator
29090 Output\SpecialChar menuseparator
29097 We provide a range of tested configurations for some viewers,
29098 which you can select from the drop down list.
29099 If none of these configurations suits you,
29100 you have to find out and enter a suitable configuration yourself.
29101 The definition syntax uses the following placeholders:
29104 \begin_layout Itemize
29106 \begin_inset Flex Code
29109 \begin_layout Plain Layout
29119 \begin_layout Itemize
29121 \begin_inset Flex Code
29124 \begin_layout Plain Layout
29131 name of the (temporary) exported .tex file (without path)
29134 \begin_layout Itemize
29136 \begin_inset Flex Code
29139 \begin_layout Plain Layout
29146 name of the (temporary) exported .tex file (including path)
29149 \begin_layout Itemize
29151 \begin_inset Flex Code
29154 \begin_layout Plain Layout
29161 name of the exported output file (either dvi or pdf,
29162 depending on which one exists in the temporary directory)
29165 \begin_layout Standard
29166 Note that only some of the viewers provide full and usable forward search functionality out of the box,
29173 \begin_layout Plain Layout
29174 You might want to set
29175 \begin_inset Flex Code
29178 \begin_layout Plain Layout
29185 \begin_inset Flex Noun
29188 \begin_layout Plain Layout
29189 Tools\SpecialChar menuseparator
29190 Preferences\SpecialChar menuseparator
29191 File Handling\SpecialChar menuseparator
29193 \begin_inset space ~
29212 \begin_layout Plain Layout
29213 SumatraPDF can also use DDE commands through the external program CMCDDE —
29215 \begin_inset CommandInset href
29217 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
29233 \begin_layout Plain Layout
29234 Forward search with evince can be achieved by means of third party helper scripts.
29236 \begin_inset CommandInset href
29238 target "https://wiki.lyx.org/LyX/SyncTeX"
29249 require some extra tools in order to use forward search.
29250 While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
29251 some other viewers – e.
29252 \begin_inset space \thinspace{}
29256 xpdf – allow at least to reload the document and jump to a specific page of the file,
29257 so you can at least navigate
29258 \begin_inset Quotes eld
29262 \begin_inset Quotes erd
29266 This latter functionality is provided by an external call of synctex (see the predefined example configurations).
29270 \begin_layout Standard
29271 Forward search works both with DVI and PDF output.
29273 simply checks which preview format you have used before (i.
29274 \begin_inset space \thinspace{}
29278 which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
29279 \change_deleted 564990737 1672743015
29283 \begin_layout Standard
29285 \change_deleted 564990737 1672743015
29286 Special Document Classes
29289 \begin_layout Standard
29291 \change_deleted 564990737 1669742044
29295 \begin_layout Standard
29297 \change_deleted 564990737 1669742044
29303 \begin_layout Standard
29305 \change_deleted 564990737 1669742044
29309 \begin_layout Standard
29311 \change_deleted 564990737 1669742044
29312 This section describes how \SpecialChar LyX
29313 can be used to write articles for submission to the scientific journal
29315 Astronomy and Astrophysics
29318 \begin_inset Flex URL
29321 \begin_layout Plain Layout
29323 https://www.aanda.org/
29328 ) using Version 5.01 of the document class
29333 This package can be downloaded from the ftp site
29336 \begin_layout Standard
29338 \change_deleted 564990737 1669742044
29339 \begin_inset VSpace medskip
29345 \begin_layout Standard
29348 \change_deleted 564990737 1669742044
29349 \begin_inset Flex URL
29352 \begin_layout Plain Layout
29354 ftp://ftp.edpsciences.org/pub/aa/readme.html
29362 \begin_layout Standard
29364 \change_deleted 564990737 1669742044
29365 \begin_inset VSpace medskip
29371 \begin_layout Standard
29373 \change_deleted 564990737 1669742044
29374 A manual comes together with that package,
29375 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.
29379 \begin_layout Standard
29381 \change_deleted 564990737 1669742044
29382 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
29384 That change involved also some slight changes to the style files,
29385 namely the removal of the thesaurus command.
29386 The \SpecialChar LyX
29387 class aa supports the newest version of these style files,
29389 If you have an older version installed,
29392 the old (version 4) layout has been kept as
29397 Please refer to the comments in
29400 Dir/layouts/aapaper.layout
29405 \begin_layout Standard
29407 \change_deleted 564990737 1669742044
29411 \begin_layout Standard
29413 \change_deleted 564990737 1669742044
29414 It is recommended you start from the example template distributed with \SpecialChar LyX
29416 If you are not using a template,
29417 note the following settings:
29420 \begin_layout Itemize
29422 \change_deleted 564990737 1669742044
29429 Document\SpecialChar menuseparator
29433 that one was obvious).
29436 \begin_layout Itemize
29438 \change_deleted 564990737 1669742044
29439 Don't change the option
29442 \begin_inset space ~
29453 The whole layout is done by the macros,
29454 you shouldn't change anything.
29457 \begin_layout Standard
29459 \change_deleted 564990737 1669742044
29463 \begin_layout Standard
29465 \change_deleted 564990737 1669742044
29466 First thing to enter is the header information.
29467 It consists of seven entries,
29468 of which some are optional.
29472 \begin_layout Itemize
29474 \change_deleted 564990737 1669742044
29483 \begin_layout Itemize
29485 \change_deleted 564990737 1669742044
29494 \begin_layout Itemize
29496 \change_deleted 564990737 1669742044
29505 \begin_layout Itemize
29507 \change_deleted 564990737 1669742044
29516 \begin_layout Itemize
29518 \change_deleted 564990737 1669742044
29524 [optional] if more than one author:
29525 whom to contact for offprint requests.
29528 \begin_layout Itemize
29530 \change_deleted 564990737 1669742044
29536 [optional] mail address for contacts.
29539 \begin_layout Itemize
29541 \change_deleted 564990737 1669742044
29548 Suggested format is
29555 \begin_layout Standard
29557 \change_deleted 564990737 1669742044
29558 There is no need to issue the
29565 this is done automatically by \SpecialChar LyX
29566 when the header is finished.
29567 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
29568 just to get the best optics and meets the layout of the real document.
29571 \begin_layout Standard
29573 \change_deleted 564990737 1669742044
29574 If you want to place footnotes in the header block,
29576 \begin_inset space \thinspace{}
29580 \begin_inset space \space{}
29583 to state your present address,
29584 just use the standard footnote via the menu
29586 Insert\SpecialChar menuseparator
29591 will automagically use the term
29600 \begin_layout Standard
29602 \change_deleted 564990737 1669742044
29605 Edit\SpecialChar menuseparator
29609 you'll find two insets which are relevant for the titling:
29612 \begin_layout Itemize
29614 \change_deleted 564990737 1669742044
29621 to mark corresponding author\SpecialChar breakableslash
29623 The institutes are numbered sequentially as they appear in the
29628 so you have to put a marker to each author.
29631 \begin_layout Itemize
29633 \change_deleted 564990737 1669742044
29638 to supply an email address for fast contact.
29641 \begin_layout Standard
29643 \change_deleted 564990737 1669742044
29644 In addition to these topics,
29645 the macros use one additional \SpecialChar LaTeX
29646 command that has no counterpart in \SpecialChar LyX
29650 \begin_layout Itemize
29652 \change_deleted 564990737 1669742044
29659 to separate different names for more than one author and institute,
29663 \begin_layout Standard
29665 \change_deleted 564990737 1669742044
29666 The appropriate command has to be entered in \SpecialChar LyX
29667 and marked as \SpecialChar LaTeX
29673 \begin_layout Standard
29675 \change_deleted 564990737 1669742044
29679 \begin_layout Standard
29681 \change_deleted 564990737 1669742044
29682 The abstract should immediately follow the header block.
29683 With version 5 the abstract environment was changed to a command,
29684 and there is now a restriction to only one paragraph.
29686 it should contain an entry with the keywords.
29687 This is done via the paragraph style
29692 Refer to the example paper.
29695 \begin_layout Standard
29697 \change_deleted 564990737 1669742044
29698 Supported environments
29701 \begin_layout Standard
29703 \change_deleted 564990737 1669742044
29704 The A&A paper layout supports the following environments for structuring your text:
29707 \begin_layout Itemize
29709 \change_deleted 564990737 1669742044
29715 \begin_layout Itemize
29717 \change_deleted 564990737 1669742044
29723 \begin_layout Itemize
29725 \change_deleted 564990737 1669742044
29731 \begin_layout Itemize
29733 \change_deleted 564990737 1669742044
29739 \begin_layout Itemize
29741 \change_deleted 564990737 1669742044
29747 \begin_layout Itemize
29749 \change_deleted 564990737 1669742044
29755 \begin_layout Itemize
29757 \change_deleted 564990737 1669742044
29763 \begin_layout Itemize
29765 \change_deleted 564990737 1669742044
29771 \begin_layout Itemize
29773 \change_deleted 564990737 1669742044
29779 \begin_layout Itemize
29781 \change_deleted 564990737 1669742044
29787 \begin_layout Itemize
29789 \change_deleted 564990737 1669742044
29795 \begin_layout Itemize
29797 \change_deleted 564990737 1669742044
29804 \begin_layout Standard
29806 \change_deleted 564990737 1669742044
29807 Commands not supported by \SpecialChar LyX
29811 \begin_layout Standard
29813 \change_deleted 564990737 1669742044
29814 Some commands are not yet supported by the
29818 layout for \SpecialChar LyX
29820 Some have already been mentioned.
29821 For the sake of completeness,
29822 they are listed all together here:
29825 \begin_layout Itemize
29827 \change_deleted 564990737 1669742044
29835 \begin_layout Itemize
29837 \change_deleted 564990737 1669742044
29845 \begin_layout Itemize
29847 \change_deleted 564990737 1669742044
29855 \begin_layout Itemize
29857 \change_deleted 564990737 1669742044
29865 \begin_layout Standard
29867 \change_deleted 564990737 1669742044
29868 If you want to use any of these commands,
29869 you have to enter them yourself.
29872 Do not forget to mark them as \SpecialChar LaTeX
29876 \begin_layout Standard
29878 \change_deleted 564990737 1669742044
29879 Figure and Table Floats
29882 \begin_layout Standard
29884 \change_deleted 564990737 1669742044
29886 provides support for the necessary float environments
29897 therefore we won't tell much about it here.
29901 \begin_inset space ~
29907 Just remember that tables should be left-aligned.
29909 select the table and change the alignment in
29911 Edit\SpecialChar menuseparator
29913 \begin_inset space ~
29919 \begin_layout Standard
29921 \change_deleted 564990737 1669742044
29922 There is only one special thing:
29923 the figures with caption besides the figure.
29924 To create such a figure,
29925 you have to do the following:
29928 \begin_layout Enumerate
29930 \change_deleted 564990737 1669742044
29931 Create a wide figure float:
29934 Insert\SpecialChar menuseparator
29935 Float\SpecialChar menuseparator
29939 then right click in the figure and select
29942 \begin_inset space ~
29950 \begin_layout Enumerate
29952 \change_deleted 564990737 1669742044
29953 Enter your caption text.
29956 \begin_layout Enumerate
29958 \change_deleted 564990737 1669742044
29963 to move the cursor above the caption.
29966 \begin_layout Enumerate
29968 \change_deleted 564990737 1669742044
29972 \begin_layout Enumerate
29974 \change_deleted 564990737 1669742044
29975 Position the cursor behind the figure and insert a horizontal fill:
29978 Insert\SpecialChar menuseparator
29980 \begin_inset space ~
29983 Character\SpecialChar menuseparator
29985 \begin_inset space ~
29993 \begin_layout Enumerate
29995 \change_deleted 564990737 1669742044
29996 Switch to \SpecialChar LaTeX
30001 \begin_inset space ~
30009 \begin_layout Enumerate
30011 \change_deleted 564990737 1669742044
30021 Do not close the brace!
30024 \begin_layout Enumerate
30026 \change_deleted 564990737 1669742044
30027 Position the cursor behind the caption text,
30028 switch to \SpecialChar LaTeX
30029 mode and insert the closing brace:
30033 \begin_inset space ~
30045 \begin_layout Standard
30047 \change_deleted 564990737 1669742044
30049 refer to the figures in the example paper.
30052 \begin_layout Standard
30054 \change_deleted 564990737 1669742044
30058 \begin_layout Standard
30060 \change_deleted 564990737 1669742044
30062 the paper has to be formated in a special double-spacing layout.
30064 you have to give the option
30068 to the document class.
30069 This must be done using the custom class options field in the
30071 Document\SpecialChar menuseparator
30075 Just enter the string
30082 \begin_layout Standard
30084 \change_deleted 564990737 1669742044
30088 \begin_layout Standard
30090 \change_deleted 564990737 1669742044
30095 directory contains an example paper written with \SpecialChar LyX
30097 It is the example paper from the original macro package,
30098 translated to \SpecialChar LyX
30100 Use it for inspiration,
30101 and compare the original \SpecialChar LaTeX
30102 code with \SpecialChar LyX
30106 \begin_layout Standard
30108 \change_deleted 564990737 1671097429
30112 \begin_layout Standard
30114 \change_deleted 564990737 1671097429
30119 can be used to type letters according to German conventions.
30120 A template file is included in
30122 .../lyx/share/templates
30124 for you to use as a starting point.
30127 \begin_layout Standard
30129 \change_deleted 564990737 1671097429
30133 \begin_layout Standard
30135 \change_deleted 564990737 1671097429
30136 See the \SpecialChar LyX
30142 It contains all infos you need.
30145 \begin_layout Standard
30147 \change_deleted 564990737 1669755802
30151 \begin_layout Standard
30153 \change_deleted 564990737 1669755802
30156 Panayotis Papasotiriou
30159 \begin_layout Standard
30161 \change_deleted 564990737 1669755802
30165 \begin_layout Standard
30167 \change_deleted 564990737 1669755802
30168 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
30170 International Journal of Modern Physics C
30174 the ijmpd package is for creating manuscripts to be submitted to the
30176 International Journal of Modern Physics D
30179 Both journals are published by World Scientific.
30180 The corresponding document classes are named
30191 together with instructions for the authors,
30192 can be downloaded from the sites
30193 \begin_inset Flex URL
30196 \begin_layout Plain Layout
30198 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
30204 \begin_inset Flex URL
30207 \begin_layout Plain Layout
30209 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
30215 Both packages are modified versions of the standard
30216 \begin_inset Quotes eld
30220 \begin_inset Quotes erd
30224 and they are almost (but not exactly) identical.
30225 Most of their features are supported by \SpecialChar LyX
30227 I have used \SpecialChar LyX
30228 successfully to write articles submitted to both journals without any problem.
30231 \begin_layout Standard
30233 \change_deleted 564990737 1669755802
30237 \begin_layout Standard
30239 \change_deleted 564990737 1669755802
30241 the easiest way to write a paper is to start with a template.
30244 File\SpecialChar menuseparator
30261 This will give an (almost) empty document that includes the most common fields found in a manuscript.
30262 Simply overwrite the existing text (including the brackets,
30268 You should keep in mind the following remarks.
30271 \begin_layout Enumerate
30273 \change_deleted 564990737 1669755802
30275 won't let you change the font size and the page style of the document,
30276 because such modifications are not allowed by both packages.
30279 \begin_layout Enumerate
30281 \change_deleted 564990737 1669755802
30282 The language of the document should not be changed.
30283 Before previewing your paper,
30284 be sure that the babel package is not used.
30289 arg "dialog-show document"
30294 \SpecialChar menuseparator
30299 \begin_inset Quotes eld
30303 \begin_inset Quotes erd
30313 \begin_layout Enumerate
30315 \change_deleted 564990737 1669755802
30317 \begin_inset Quotes eld
30321 \begin_inset Quotes erd
30324 style must be used to define keywords.
30327 \begin_layout Enumerate
30329 \change_deleted 564990737 1669755802
30330 The ijmpc package provides a style named
30331 \begin_inset Quotes eld
30334 Classification Codes
30335 \begin_inset Quotes erd
30339 which can be used to define classification codes,
30340 such as PACS numbers.
30341 Note that this facility is not supported by the ijmpd package.
30344 \begin_layout Enumerate
30346 \change_deleted 564990737 1669755802
30347 Several new environments are available:
30349 \begin_inset Quotes eld
30353 \begin_inset Quotes erd
30358 \begin_inset Quotes eld
30362 \begin_inset Quotes erd
30367 \begin_inset Quotes eld
30371 \begin_inset Quotes erd
30376 \begin_inset Quotes eld
30380 \begin_inset Quotes erd
30385 \begin_inset Quotes eld
30389 \begin_inset Quotes erd
30394 \begin_inset Quotes eld
30398 \begin_inset Quotes erd
30403 \begin_inset Quotes eld
30407 \begin_inset Quotes erd
30412 \begin_inset Quotes eld
30416 \begin_inset Quotes erd
30421 \begin_inset Quotes eld
30425 \begin_inset Quotes erd
30430 \begin_inset Quotes eld
30434 \begin_inset Quotes erd
30439 \begin_inset Quotes eld
30443 \begin_inset Quotes erd
30448 \begin_inset Quotes eld
30452 \begin_inset Quotes erd
30457 \begin_inset Quotes eld
30461 \begin_inset Quotes erd
30466 \begin_inset Quotes eld
30470 \begin_inset Quotes erd
30474 Their use is more or less obvious.
30476 supports all these environments;
30477 it will use the proper label,
30479 and numbering scheme for each of them.
30482 \begin_layout Enumerate
30484 \change_deleted 564990737 1669755802
30485 Both packages use basic citations;
30486 the natbib package should not be used.
30487 In \SpecialChar LyX
30489 citation references are shown as usual;
30491 citations are shown as superscripts.
30492 If you want to use a citation as normal text,
30499 \begin_inset space \thinspace{}
30503 \begin_inset space \space{}
30507 \begin_inset Quotes eld
30511 \begin_inset space \space{}
30521 \begin_inset Quotes erd
30527 \begin_layout Enumerate
30529 \change_deleted 564990737 1669755802
30531 \begin_inset Quotes eld
30535 \begin_inset Quotes erd
30538 section in both packages.
30539 To put acknowledgments,
30541 \begin_inset Quotes eld
30545 \begin_inset Quotes erd
30551 \begin_layout Enumerate
30553 \change_deleted 564990737 1669755802
30554 Appendices may be added to the paper,
30559 the Acknowledgments and
30565 provides a special environment,
30567 \begin_inset Quotes eld
30571 \begin_inset Quotes erd
30574 which marks the beginning of the appendices.
30575 This environment should be left blank;
30576 it just sends a \SpecialChar LaTeX
30578 but nothing is really printed.
30579 In \SpecialChar LyX
30582 \begin_inset Quotes eld
30586 \begin_inset Quotes erd
30589 is printed with blue letters,
30590 as a signal that all sections after that point are appendices.
30591 To write an appendix,
30593 \begin_inset Quotes eld
30597 \begin_inset Quotes erd
30602 will number each appendix with capital letters,
30603 as required by both journals.
30605 \begin_inset Quotes eld
30609 \begin_inset Quotes erd
30616 be present before the first appendix;
30618 all appendices will be numbered as normal sections in the output.
30621 \begin_layout Enumerate
30623 \change_deleted 564990737 1669755802
30624 The ijmpc and the ijmpd packages use the
30628 command to implement table captions.
30630 a table created by \SpecialChar LyX
30631 is printed correctly,
30632 but its caption is ignored.
30634 you can use some \SpecialChar TeX
30635 code to overcome this problem,
30636 so that captions are printed as expected.
30638 create a float table as usual,
30639 remove the caption,
30640 and replace it with the \SpecialChar TeX
30652 you must also the \SpecialChar TeX
30657 immediately after the tabular material.
30658 Study the example table included in the template files to see how this trick is implemented.
30660 If you need table captions,
30661 you should implement the whole table float in a
30666 then include this file to the \SpecialChar LyX
30669 Insert\SpecialChar menuseparator
30670 File\SpecialChar menuseparator
30672 \begin_inset space ~
30678 Details on how to create a table float can be found in the files
30687 included in the corresponding packages.
30690 \begin_layout Standard
30692 \change_deleted 564990737 1669755802
30693 Preparing a paper for submission
30696 \begin_layout Standard
30698 \change_deleted 564990737 1669755802
30699 Before you submit your paper you must export the \SpecialChar LyX
30700 document as a \SpecialChar LaTeX
30703 File\SpecialChar menuseparator
30704 Export\SpecialChar menuseparator
30712 \begin_layout Plain Layout
30713 Actually you have the choice between \SpecialChar LaTeX
30714 (plain) and pdflatex.
30715 If you intend to use pdflatex to prepare the paper,
30716 you should use the pdflatex option so that included graphics are converted to PDF format,
30717 ready for use by pdflatex.
30723 then make the following changes to the resulting
30730 \begin_layout Enumerate
30732 \change_deleted 564990737 1669755802
30733 Remove the comment lines before the
30742 \begin_layout Enumerate
30744 \change_deleted 564990737 1669755802
30745 Remove everything between (and including) the
30758 except for any commands you specifically put into the \SpecialChar LaTeX
30762 \begin_layout Standard
30764 \change_deleted 564990737 1672743015
30769 file should be saved and processed through \SpecialChar LaTeX
30770 as many times as necessary.
30771 You may also want to check the resulting
30778 \begin_layout Standard
30780 \change_deleted 564990737 1669801478
30784 \begin_layout Standard
30786 \change_deleted 564990737 1669801478
30792 \begin_layout Standard
30794 \change_deleted 564990737 1669801478
30798 \begin_layout Standard
30800 \change_deleted 564990737 1669801478
30801 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
30802 Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
30803 \begin_inset Flex URL
30806 \begin_layout Plain Layout
30808 ftp://ftp.iop.org/pub/journals/latex2e
30816 \begin_layout Standard
30818 \change_deleted 564990737 1669801478
30822 \begin_layout Standard
30824 \change_deleted 564990737 1669801478
30825 The easiest way to write a paper is to start with the template
30829 that is available via
30831 File\SpecialChar menuseparator
30834 The template explains how to use the special text environments.
30835 Here are the most important advices:
30838 \begin_layout Itemize
30840 \change_deleted 564990737 1669801478
30841 To be able to compile your document to a PDF,
30844 ensure that the no AMS packages are loaded in
30846 Document\SpecialChar menuseparator
30847 Settings\SpecialChar menuseparator
30853 \begin_layout Itemize
30855 \change_deleted 564990737 1669801478
30858 The title environment defines the kind of your paper.
30859 So use one of the following environments for the title:
30863 \begin_layout Itemize
30865 \change_deleted 564990737 1669801478
30874 \begin_layout Itemize
30876 \change_deleted 564990737 1669801478
30885 \begin_layout Itemize
30887 \change_deleted 564990737 1669801478
30893 for a Topical review
30896 \begin_layout Itemize
30898 \change_deleted 564990737 1669801478
30907 \begin_layout Itemize
30909 \change_deleted 564990737 1669801478
30918 \begin_layout Itemize
30920 \change_deleted 564990737 1669801478
30926 for a Paper (same as Title)
30929 \begin_layout Itemize
30931 \change_deleted 564990737 1669801478
30937 for a Preliminary communication
30940 \begin_layout Itemize
30942 \change_deleted 564990737 1669801478
30948 for a Rapid communication
30951 \begin_layout Itemize
30953 \change_deleted 564990737 1669801478
30959 for a Letter to the editor
30963 \begin_layout Itemize
30965 \change_deleted 564990737 1669801478
30968 All title environments except of
30972 can have an optional short title.
30975 \begin_layout Itemize
30977 \change_deleted 564990737 1669801478
30978 There is a general title environment
30982 which is not directly supported by \SpecialChar LyX
30984 This can be used as \SpecialChar TeX
30985 code when your document doesn't fit into one of the other title types.
30988 \begin_layout Standard
30990 \change_deleted 564990737 1672743015
30991 For more informations like hints for special table and formula formatting,
30992 look at the IOP author guidelines.
30995 \begin_layout Standard
30997 \change_deleted 564990737 1670317155
31001 \begin_layout Standard
31003 \change_deleted 564990737 1670317155
31006 Panayotis Papasotiriou
31009 \begin_layout Standard
31011 \change_deleted 564990737 1670317155
31015 \begin_layout Standard
31017 \change_deleted 564990737 1670317155
31018 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
31019 Most known of them (at least in my domain of interest) are
31021 Astrophysics and Space Science
31028 but there are many others (see a complete list at
31029 \begin_inset Flex URL
31032 \begin_layout Plain Layout
31034 http://www.wkap.nl/jrnllist.htm/JRNLHOME
31040 The Kluwer package may be downloaded from the site
31041 \begin_inset Flex URL
31044 \begin_layout Plain Layout
31046 http://www.wkap.nl/kaphtml.htm/STYLEFILES
31052 A complete user guide is contained in that package (but it can also be downloaded separately).
31055 \begin_layout Standard
31057 \change_deleted 564990737 1670317155
31059 supports many features of the package but not everything.
31061 the \SpecialChar TeX
31062 code needed is reduced to some
31063 \begin_inset Quotes eld
31067 \begin_inset Quotes erd
31070 commands of the package (see
31071 \begin_inset space ~
31075 \begin_inset CommandInset ref
31077 reference "subsec:kluwer_peculiarities"
31083 I have recently used \SpecialChar LyX
31084 to write an article submitted to the
31086 Astrophysics and Space Science
31088 without any problem.
31091 \begin_layout Standard
31093 \change_deleted 564990737 1670317155
31097 \begin_layout Standard
31099 \change_deleted 564990737 1670317155
31100 The easiest way to write a paper is to start with the Kluwer template file.
31103 File\SpecialChar menuseparator
31116 This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
31117 As in most templates,
31118 simply overwrite the existing text (including the brackets,
31123 ) with the correct information.
31126 \begin_layout Standard
31128 \change_deleted 564990737 1670317155
31129 Preparing a paper for submission
31132 \begin_layout Standard
31134 \change_deleted 564990737 1670317155
31135 As in the AAS\SpecialChar TeX
31137 before you submit your paper to a journal you must
31138 \begin_inset Quotes eld
31142 \begin_inset Quotes erd
31148 \begin_layout Enumerate
31150 \change_deleted 564990737 1670317155
31151 Export your paper as a \SpecialChar LaTeX
31156 File\SpecialChar menuseparator
31157 Export\SpecialChar menuseparator
31165 \begin_layout Enumerate
31167 \change_deleted 564990737 1670317155
31172 file with a text editor and make the following changes
31176 \begin_layout Enumerate
31178 \change_deleted 564990737 1670317155
31179 remove the comment lines before the
31188 \begin_layout Enumerate
31190 \change_deleted 564990737 1670317155
31191 remove everything between (and including) the
31204 except for any commands you specifically put into the \SpecialChar LaTeX
31208 \begin_layout Standard
31210 \change_deleted 564990737 1670317155
31219 \begin_layout Enumerate
31221 \change_deleted 564990737 1670317155
31226 file through \SpecialChar LaTeX
31227 as many times as necessary (usually up to three).
31230 \begin_layout Enumerate
31232 \change_deleted 564990737 1670317155
31239 \begin_inset space \thinspace{}
31243 \begin_inset space \space{}
31251 and check if everything is OK (it should,
31252 if you didn't make any mistake).
31255 \begin_layout Standard
31257 \change_deleted 564990737 1670317155
31258 \begin_inset Quotes eld
31262 \begin_inset Quotes erd
31265 of the Kluwer package
31266 \begin_inset CommandInset label
31268 name "subsec:kluwer_peculiarities"
31275 \begin_layout Standard
31277 \change_deleted 564990737 1670317155
31278 The Kluwer package has the following
31279 \begin_inset Quotes eld
31283 \begin_inset Quotes erd
31289 \begin_layout Enumerate
31291 \change_deleted 564990737 1670317155
31292 It is possible to write multiple articles in the same \SpecialChar LaTeX
31297 \begin_layout Plain Layout
31298 I can't imagine any good reason to do this.
31304 Each article must be included in the environment
31305 \begin_inset Quotes eld
31309 \begin_inset Quotes erd
31314 this environment cannot be omitted,
31315 even if you write just one article.
31317 each article starts with the command
31325 ends with the command
31332 Although this can be implemented in \SpecialChar LyX
31334 I didn't included it,
31335 since it looks ugly and can confuse the novice user.
31337 you need to enter them directly and mark them as \SpecialChar LaTeX
31338 code (the well-known
31339 \begin_inset Quotes eld
31344 \begin_inset Quotes erd
31350 \begin_layout Enumerate
31352 \change_deleted 564990737 1670317155
31353 Information given at the beginning of the article (i.
31354 \begin_inset space \thinspace{}
31358 \begin_inset space \space{}
31367 abstract and keywords) must be included in an environment called
31368 \begin_inset Quotes eld
31372 \begin_inset Quotes erd
31376 This is not implemented in \SpecialChar LyX
31378 so you must enter title,
31380 \begin_inset space ~
31383 between two \SpecialChar TeX
31399 \begin_layout Enumerate
31401 \change_deleted 564990737 1670317155
31402 According to the user manual,
31403 the label of each bibliography item must be written as
31426 \begin_layout Standard
31428 \change_deleted 564990737 1670317155
31433 template takes care of all these
31434 \begin_inset Quotes eld
31438 \begin_inset Quotes erd
31442 If you start a new paper using this template you don't need to do anything special.
31446 \begin_layout Enumerate
31448 \change_deleted 564990737 1670317155
31449 don't delete the \SpecialChar TeX
31450 code included in the template,
31454 \begin_layout Enumerate
31456 \change_deleted 564990737 1670317155
31457 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
31460 \begin_layout Standard
31462 \change_deleted 564990737 1671097446
31466 \begin_layout Standard
31468 \change_deleted 564990737 1671097446
31473 provides an alternative to the standard
31478 It provides similar functionality,
31479 but you might prefer this layout with sans serif sections,
31484 \begin_layout Standard
31486 \change_deleted 564990737 1671097446
31487 Springer Journals (
31494 \begin_layout Standard
31496 \change_deleted 564990737 1671097446
31502 \begin_layout Standard
31504 \change_deleted 564990737 1671097446
31508 \begin_layout Standard
31510 \change_deleted 564990737 1671097446
31511 These are the layout files for some of the journal formats used by Springer Verlag and listed on
31512 \begin_inset Flex URL
31515 \begin_layout Plain Layout
31517 http://www.springer.de/author/tex/help-journals.html
31523 where you should also go to fetch the class files (yes,
31524 these are \SpecialChar LaTeX2e
31526 It is a modular system:
31527 the things common to all journals are implemented in
31532 which journal-specific layout files (such as,
31534 \begin_inset space \thinspace{}
31538 \begin_inset space \space{}
31545 for Journal of Geodesy) can include.
31548 \begin_layout Standard
31550 \change_deleted 564990737 1671097446
31551 This means that implementing support for any other Springer journal on this list is as simple as writing your own
31559 file following the outline given in
31567 \begin_layout Standard
31569 \change_deleted 564990737 1671097446
31570 It is reasonably well tested only for the Journal of Geodesy.
31579 come with the standard \SpecialChar LyX
31581 Install the relevant class file (downloaded from Springer) in a proper directory,
31582 reconfigure \SpecialChar LaTeX
31583 (in the te\SpecialChar TeX
31589 as root if necessary —
31590 doesn't \SpecialChar LyX
31591 take care of this?),
31592 reconfigure \SpecialChar LyX
31593 and it should work.
31596 \begin_layout Standard
31598 \change_deleted 564990737 1671097446
31602 \begin_layout Standard
31604 \change_deleted 564990737 1671097446
31605 A large number of theorem-like styles —
31620 \begin_layout Standard
31622 \change_deleted 564990737 1671097446
31628 Running_\SpecialChar LaTeX
31639 See the Springer class file documentation for details.
31642 \begin_layout Standard
31644 \change_deleted 564990737 1671097446
31648 \begin_layout Itemize
31650 \change_deleted 564990737 1671097446
31664 \begin_layout Itemize
31666 \change_deleted 564990737 1671097446
31669 Probability Theory and Related Fields
31677 Jean-Marc Lasgouttes
31680 \begin_layout Standard
31682 \change_deleted 564990737 1671097446
31687 \begin_layout Standard
31689 \change_deleted 564990737 1671097446
31693 \begin_layout Standard
31695 \change_deleted 564990737 1671097446
31696 These files are partly based on the older
31701 which was again based on a tinkered-with version of an old \SpecialChar LaTeX
31702 2.09 style file from Springer.
31710 Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
31711 layout file mechanism.
31714 \begin_layout Standard
31716 \change_deleted 564990737 1671097446
31720 \begin_layout Standard
31722 \change_deleted 564990737 1671097446
31724 But probably less than in the old hacked-\SpecialChar LaTeX
31732 \begin_layout Chapter
31734 Features needing Extra Software
31737 \begin_layout Section
31738 Checking \SpecialChar TeX
31742 \begin_layout Standard
31748 \begin_layout Subsection
31752 \begin_layout Standard
31761 \begin_layout Plain Layout
31766 is not yet available when you are using the \SpecialChar LaTeX
31767 distribution MiK\SpecialChar TeX
31782 \begin_inset space ~
31793 \begin_inset Newline newline
31797 \begin_inset CommandInset href
31799 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
31807 \begin_layout Standard
31810 Chk\SpecialChar TeX
31813 package is a program that was written by
31814 \begin_inset Flex Noun
31817 \begin_layout Plain Layout
31819 \begin_inset space ~
31827 in frustration because some constructs in \SpecialChar LaTeX
31828 are sometimes non-intuitive,
31829 and easy to forget.
31830 The program runs over your \SpecialChar LaTeX
31832 checks the integrity of the file,
31833 and flags some common errors.
31834 In other technical words,
31839 for \SpecialChar LaTeX
31843 \begin_layout Standard
31845 what is a syntax checker doing in \SpecialChar LyX
31846 which is supposed to produce correct \SpecialChar LaTeX
31848 The answer is simple:
31853 not only checks the
31862 checks for type-errors,
31865 Chk\SpecialChar TeX
31868 catches some common
31873 in addition to the syntactical ones.
31877 Chk\SpecialChar TeX
31880 is capable of detecting several common errors,
31884 \begin_layout Itemize
31885 Ellipsis detection:
31886 \begin_inset Newline newline
31889 Use \SpecialChar ldots
31893 \begin_layout Itemize
31894 No space in front of/after parenthesis:
31895 \begin_inset Newline newline
31901 \begin_layout Itemize
31902 Enforcement of normal space after common abbreviations:
31903 \begin_inset Newline newline
31907 \begin_inset space \thinspace{}
31911 \begin_inset space \space{}
31914 is too wide spacing.
31917 \begin_layout Itemize
31918 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
31919 \begin_inset Newline newline
31923 And this is wrong spacing.
31926 \begin_layout Itemize
31927 Space in front of labels and similar commands:
31928 \begin_inset Newline newline
31931 The label should stick right up to the text to avoid falling to a wrong page.
31933 \begin_inset CommandInset label
31943 \begin_layout Plain Layout
31944 This footnote is in danger of falling off to a wrong page
31949 The label is separated too much.
31952 \begin_layout Itemize
31953 Space in front of references,
31954 instead of hard spaces:
31955 \begin_inset Newline newline
31958 If you have bad luck,
31959 the text will break right between the referenced text and reference number,
31962 \begin_inset CommandInset ref
31964 reference "sec:chktex"
31972 \begin_layout Itemize
31974 \begin_inset Quotes eld
31978 \begin_inset Quotes erd
31982 \begin_inset Formula $\times$
31986 \begin_inset Newline newline
31989 2x2 looks cheap compared to
31990 \begin_inset Formula $2\times2$
31996 \begin_layout Standard
31997 and more \SpecialChar ldots
31998 It is an invaluable tool when you are
31999 \begin_inset Quotes eld
32003 \begin_inset Quotes erd
32006 your document before printing,
32007 and you should run it right after the obligatory spelling check,
32008 and before you go fine tuning the typesetting.
32011 \begin_layout Subsection
32015 \begin_layout Standard
32016 If you have the program installed,
32017 usage is as simple as choosing
32019 Tools\SpecialChar menuseparator
32021 \begin_inset space ~
32027 This will make \SpecialChar LyX
32028 generate a \SpecialChar LaTeX
32029 file of your document,
32032 Chk\SpecialChar TeX
32036 and then make \SpecialChar LyX
32038 \begin_inset Quotes eld
32042 \begin_inset Quotes erd
32045 with the warnings from
32047 Chk\SpecialChar TeX
32052 The warnings will be placed close to the point of the mistake,
32053 and you can quickly find them by using the
32055 Navigate\SpecialChar menuseparator
32059 or the shortcut key
32068 Open the error boxes by clicking on them with the mouse,
32069 or use the shortcut key
32078 or the corresponding
32087 Read the warning and correct the mistake,
32088 if it is a mistake.
32089 If you have trouble understanding what the warning is about,
32090 you can safely ignore it.
32091 Remember that there is a hidden layer between the document on screen and the technical details in invoking
32093 Chk\SpecialChar TeX
32097 and this gap can make some warnings seem arcane or just plain silly.
32100 \begin_layout Standard
32101 This document is an excellent testing bed for the feature,
32102 and it should provide quite a few warnings for you to fiddle with.
32103 Since computers are only so smart,
32104 expect most of the warnings to be false alarms,
32108 \begin_layout Subsection
32109 How to fine tune it
32112 \begin_layout Standard
32116 Chk\SpecialChar TeX
32119 makes more noise than suits your mood.
32120 Then you can choose not to use it,
32121 wait until your mood changes,
32122 or try to customize
32124 Chk\SpecialChar TeX
32127 to get better along with you.
32130 \begin_layout Standard
32133 Chk\SpecialChar TeX
32140 very configurable and extensible,
32141 you should not expect to solve all problems with
32143 Chk\SpecialChar TeX
32146 in \SpecialChar LyX
32148 Since \SpecialChar LyX
32149 has to generate a somewhat special \SpecialChar LaTeX
32150 file to be able to match the line numbers from the
32152 Chk\SpecialChar TeX
32159 \begin_layout Plain Layout
32160 You can inspect the specific output from
32166 Document\SpecialChar menuseparator
32169 \begin_inset space ~
32183 to the internal document structure,
32184 some of the warnings will not appear correctly.
32185 There are two things you can do about this:
32188 \begin_layout Itemize
32191 Chk\SpecialChar TeX
32194 invocation command line in
32195 \begin_inset Flex Noun
32198 \begin_layout Plain Layout
32199 Tools\SpecialChar menuseparator
32200 Preferences\SpecialChar menuseparator
32201 Output\SpecialChar menuseparator
32202 LaTeX\SpecialChar menuseparator
32211 Chk\SpecialChar TeX
32214 installation configuration file (usually with the file
32219 See below to learn what warnings can be enabled and disabled on the command line.
32222 \begin_layout Itemize
32223 Export your document as a raw \SpecialChar LaTeX
32226 File\SpecialChar menuseparator
32227 Export\SpecialChar menuseparator
32236 Invoked in this way,
32237 it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
32239 but with a little patience,
32240 you should be able to do it.
32243 \begin_layout Standard
32244 Here follows the warning messages that can be enabled and disabled in
32253 to disable a warning,
32258 to enable a warning.
32259 The emphasized entries are disabled by default,
32260 because the default is "
32262 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
32267 \begin_layout Standard
32268 Notice that you should only use the options that enable and disable warnings,
32269 because \SpecialChar LyX
32270 relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
32277 \begin_layout Enumerate
32281 Command terminated with space.
32284 \begin_layout Enumerate
32287 Non-breaking space (
32288 \begin_inset Quotes eld
32296 \begin_inset Quotes erd
32299 ) should have been used.
32302 \begin_layout Enumerate
32306 You should enclose the previous parenthesis with
32307 \begin_inset Quotes eld
32315 \begin_inset Quotes erd
32321 \begin_layout Enumerate
32324 Italic correction (
32325 \begin_inset Quotes eld
32335 \begin_inset Quotes erd
32338 ) found in non-italic buffer.
32341 \begin_layout Enumerate
32344 Italic correction (
32345 \begin_inset Quotes eld
32355 \begin_inset Quotes erd
32358 ) found more than once.
32361 \begin_layout Enumerate
32365 No italic correction (
32366 \begin_inset Quotes eld
32376 \begin_inset Quotes erd
32382 \begin_layout Enumerate
32386 \begin_inset Quotes eld
32394 \begin_inset Quotes erd
32398 \begin_inset Quotes eld
32406 \begin_inset Quotes erd
32412 \begin_layout Enumerate
32415 Wrong length of dash may have been used.
32418 \begin_layout Enumerate
32422 \begin_inset Quotes eld
32430 \begin_inset Quotes erd
32435 \begin_inset Quotes eld
32443 \begin_inset Quotes erd
32449 \begin_layout Enumerate
32453 \begin_inset Quotes eld
32461 \begin_inset Quotes erd
32467 \begin_layout Enumerate
32471 \begin_inset Quotes eld
32479 \begin_inset Quotes erd
32482 to achieve an ellipsis.
32485 \begin_layout Enumerate
32488 Inter-word spacing (
32489 \begin_inset Quotes eld
32499 \begin_inset Quotes eld
32502 ) should perhaps be used.
32505 \begin_layout Enumerate
32508 Inter-sentence spacing (
32509 \begin_inset Quotes eld
32519 \begin_inset Quotes erd
32522 ) should perhaps be used.
32525 \begin_layout Enumerate
32528 Could not find argument for command.
32531 \begin_layout Enumerate
32535 \begin_inset Quotes eld
32543 \begin_inset Quotes erd
32549 \begin_layout Enumerate
32552 Math mode still on at end of \SpecialChar LaTeX
32556 \begin_layout Enumerate
32560 \begin_inset Quotes eld
32568 \begin_inset Quotes erd
32571 doesn't match the number of
32572 \begin_inset Quotes eld
32580 \begin_inset Quotes erd
32586 \begin_layout Enumerate
32589 You should use either
32592 \begin_inset Quotes eld
32600 \begin_inset Quotes erd
32605 as an alternative to
32606 \begin_inset Quotes eld
32614 \begin_inset Quotes erd
32620 \begin_layout Enumerate
32627 " (ASCII 39) instead of "
32634 \begin_layout Enumerate
32637 User-specified pattern found.
32640 \begin_layout Enumerate
32643 This command might not be intended.
32646 \begin_layout Enumerate
32653 \begin_layout Enumerate
32671 \begin_layout Enumerate
32674 Delete this space to maintain correct page references.
32677 \begin_layout Enumerate
32681 You might wish to put this between a pair of
32682 \begin_inset Quotes eld
32690 \begin_inset Quotes erd
32696 \begin_layout Enumerate
32699 You ought to remove spaces in front of punctuation.
32702 \begin_layout Enumerate
32705 Could not execute \SpecialChar LaTeX
32709 \begin_layout Enumerate
32718 in front of small punctuation.
32721 \begin_layout Enumerate
32729 may look prettier here.
32732 \begin_layout Enumerate
32736 Multiple spaces detected in output.
32739 \begin_layout Enumerate
32742 This text may be ignored.
32745 \begin_layout Enumerate
32751 \begin_inset Quotes eld
32756 to begin quotation,
32764 \begin_layout Enumerate
32775 \begin_inset Quotes eld
32783 \begin_layout Enumerate
32789 \begin_layout Enumerate
32792 You should perhaps use
32793 \begin_inset Quotes eld
32801 \begin_inset Quotes erd
32807 \begin_layout Enumerate
32810 You should put a space in front of/after parenthesis.
32813 \begin_layout Enumerate
32816 You should avoid spaces in front of/after parenthesis.
32819 \begin_layout Enumerate
32823 You should not use punctuation in front of/after quotes.
32826 \begin_layout Enumerate
32829 Double space found.
32832 \begin_layout Enumerate
32835 You should put punctuation outside inner/inside display math mode.
32838 \begin_layout Enumerate
32841 You ought to not use primitive \SpecialChar TeX
32842 in \SpecialChar LaTeX
32846 \begin_layout Enumerate
32849 You should remove spaces in front of
32850 \begin_inset Quotes eld
32858 \begin_inset Quotes erd
32864 \begin_layout Enumerate
32867 \begin_inset Quotes eld
32875 \begin_inset Quotes erd
32878 is normally not followed by
32879 \begin_inset Quotes eld
32887 \begin_inset Quotes erd
32893 \begin_layout Standard
32894 In later versions of \SpecialChar LyX
32896 we hope to provide a more complete interface to this tool (and it's smaller cousin
32900 ) to exploit the full power of it.
32901 But it's not exactly useless as it is now:
32902 go try it on one of your existing documents of a certain length and be surprised.
32905 \begin_layout Section
32906 Version Control in \SpecialChar LyX
32910 \begin_layout Standard
32913 Lars Gullik Bjønnes
32920 \begin_layout Subsection
32924 \begin_layout Standard
32926 supports some of the most basic RCS/CVS/SVN/GIT commands.
32927 If you need something a bit more sophisticated you will have to do that manually in a terminal.
32930 \begin_layout Standard
32931 Also note that CVS support is not as good as subversion support,
32932 so we advise using SVN instead.
32933 A good place to start learning Subversion is the SVN Book
32937 \begin_layout Plain Layout
32938 \begin_inset CommandInset href
32940 target "http://svnbook.red-bean.com/"
32951 In the case of RCS you should read
32952 \begin_inset Quotes eld
32956 \begin_inset Quotes erd
32965 This file describes all the basic features of RCS.
32966 You should especially notice the comment about a RCS directory,
32967 and the notion of a master RCS file (the file ending in
32974 \begin_layout Standard
32975 Before you begin to use the version control features in \SpecialChar LyX
32977 you should be familiar with RCS/CVS/SVN/GIT usage.
32978 The implementation in \SpecialChar LyX
32979 assumes a recent version of the GNU RCS or CVS/SVN package —
32980 no guarantees are made for older versions.
32981 Most of the log messages are not currently displayed after operations —
32982 you can check them in the Messages pane if you are unsure.
32983 Regular users of version control will appreciate the VC toolbar,
32984 which can be enabled via
32986 View\SpecialChar menuseparator
32987 Toolbars\SpecialChar menuseparator
32989 \begin_inset space ~
32997 \begin_layout Standard
32998 For introducing your own external commands consult
32999 \begin_inset Flex Code
33002 \begin_layout Plain Layout
33016 \begin_layout Standard
33017 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
33019 Document\SpecialChar menuseparator
33023 Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
33024 Compressed LyX documents are binary files,
33025 which cannot be merged by version control systems.
33028 \begin_layout Subsection
33029 RCS commands in \SpecialChar LyX
33033 \begin_layout Standard
33034 The following sections describe the RCS commands supported by \SpecialChar LyX
33036 You can find them in the
33038 File\SpecialChar menuseparator
33040 \begin_inset space ~
33047 was tested against RCS 5.7/5.8.
33050 \begin_layout Subsubsection
33056 \begin_layout Standard
33057 If your document is not under revision control,
33058 this is the only item shown in the menu.
33059 And if it is under revision control,
33064 item is not visible.
33068 \begin_layout Standard
33069 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
33070 You are asked interactively to supply an initial description of the document.
33071 The document is now set in Read-Only mode and you have to
33074 \begin_inset space ~
33078 \begin_inset space ~
33082 \begin_inset space ~
33088 before making any changes to it.
33089 A document under revision control has a
33090 \begin_inset Quotes eld
33093 [RCS:<version> <locker>]
33094 \begin_inset Quotes erd
33097 item tagged to the filename in the minibuffer.
33100 \begin_layout Standard
33101 RCS command that is run:
33104 \begin_layout LyX-Code
33107 ci -q -u -i -t-"<initial description>" <file-name>
33110 \begin_layout Standard
33115 to understand the switches.
33119 \begin_layout Subsubsection
33125 \begin_layout Standard
33126 When you are finished editing a file,
33127 you check in your changes.
33129 you are asked for a description of the changes.
33130 This is stored in the history log.
33131 The version number is bumped,
33132 your changes are applied to the master RCS file,
33133 the document is unlocked and set to Read-Only mode.
33136 \begin_layout Itemize
33140 ci -q -u -m"<description>" <file-name>
33143 \begin_layout Subsubsection
33149 \begin_layout Standard
33150 By doing this you lock the document so that only you can edit it.
33151 This will also make the document Read-Write only for you.
33152 You will usually continue editing for a while and when you are finished you check in your changes.
33153 The status line is changed to reflect that you have locked the file.
33156 \begin_layout Itemize
33160 co -q -l <file-name>
33163 \begin_layout Subsubsection
33166 Revert To Repository Version
33169 \begin_layout Standard
33170 This will discard all changes made to the document since the last check in.
33171 You get a warning before changes are discarded.
33174 \begin_layout Itemize
33178 co -f -u<version> <file-name>
33181 \begin_layout Subsubsection
33187 \begin_layout Standard
33188 This will create a copy of the current document.
33189 Since RCS does not support copy operations natively,
33190 the version history is not preserved,
33191 and the copy is added as a new file.
33192 It requires a clean document without any changes since the last checkin.
33193 You are asked for a file name and a description of the copy operation.
33194 After that the copy is created,
33195 both locally and in the repository.
33196 If the parent directories of the copied and original document differ,
33197 all relative paths of included files of the copy are adjusted (like in
33199 File\SpecialChar menuseparator
33205 the copy is loaded instead of the original document.
33208 \begin_layout Labeling
33209 \labelwidthstring 00.00.0000
33211 \begin_inset space ~
33216 \begin_inset space ~
33220 \begin_inset Newline newline
33224 \begin_inset Flex Code
33227 \begin_layout Plain Layout
33230 \begin_inset Quotes qld
33234 \begin_inset Quotes qld
33243 \begin_inset Flex Code
33246 \begin_layout Plain Layout
33249 \begin_inset Quotes qld
33253 \begin_inset Quotes qld
33262 \begin_inset Newline newline
33266 \begin_inset Flex Code
33269 \begin_layout Plain Layout
33273 \begin_inset Quotes qld
33277 \begin_inset Quotes qld
33288 \begin_layout Subsubsection
33294 \begin_layout Standard
33295 This makes as if the last check in never happened.
33296 No changes are made to the document loaded into \SpecialChar LyX
33298 but the last version is removed from the master RCS file.
33301 \begin_layout Itemize
33305 rcs -o<version> <file-name>
33308 \begin_layout Subsubsection
33314 \begin_layout Standard
33315 This shows the complete history of the RCS document.
33320 is shown in a browser.
33328 \begin_layout Subsubsection
33332 \begin_layout Standard
33334 supports RCS version number,
33336 date and time of last commit.
33337 All those are extracted from
33339 rlog -r <file-name>
33343 \begin_inset CommandInset ref
33345 reference "subsec:VCS-Revision-Information"
33353 \begin_layout Subsection
33354 CVS commands in \SpecialChar LyX
33358 \begin_layout Standard
33359 A subset of CVS operations is supported by \SpecialChar LyX
33361 You can find the commands in the
33363 File\SpecialChar menuseparator
33365 \begin_inset space ~
33371 The version control system SVN is more powerful,
33372 so please use it instead of CVS if possible.
33375 \begin_layout Subsubsection
33381 \begin_layout Standard
33382 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
33383 If you're using a client-server setup you may need to login before doing the first repository checkout.
33386 \begin_layout Standard
33387 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.
33388 Standard CVS repositories don't operate with a file locking mechanism.
33389 This may be surprising,
33390 but conflicts only occur if people disagree on the proper content of the same part of a document.
33392 if co-workers are used to communicate regularly,
33393 these conflicts occur rarely.
33394 If they don't communicate they have a fundamental problem anyway.
33395 Nevertheless some people like to work with so called
33396 \begin_inset Quotes eld
33400 \begin_inset Quotes erd
33404 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.
33405 When the changes are checked in the working copy returns to readonly state.
33406 With \SpecialChar LyX
33407 one has to edit the
33408 \begin_inset Flex Code
33411 \begin_layout Plain Layout
33417 file and add the line
33418 \begin_inset Flex Code
33421 \begin_layout Plain Layout
33427 to work with reserved checkouts.
33428 The benefit is the possibility to see who is using a writable copy of some document.
33429 It's not guaranteed only one user makes a copy writable.
33432 \begin_layout Standard
33434 tries to guess if you're using reserved or non-reserved checkouts.
33435 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.
33436 When a reserved checkout is detected you have to use
33437 \begin_inset Flex Noun
33440 \begin_layout Plain Layout
33446 to make your working copy writable if it's readonly.
33448 \begin_inset Flex Noun
33451 \begin_layout Plain Layout
33457 operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
33460 \begin_layout Standard
33461 More information about CVS can be found here
33462 \begin_inset Flex URL
33465 \begin_layout Plain Layout
33467 http://www.nongnu.org/cvs
33473 \begin_inset Flex URL
33476 \begin_layout Plain Layout
33478 http://ximbiot.com/cvs
33486 \begin_layout Standard
33491 to understand the sub-commands and the switches mentioned below.
33494 \begin_layout Subsubsection
33500 \begin_layout Standard
33501 If your document is not under revision control,
33502 this is the only item shown in the menu.
33503 And if it is under revision control,
33508 item is not visible.
33512 \begin_layout Standard
33513 This command registers in CVS your document
33514 \begin_inset Flex Strong
33517 \begin_layout Plain Layout
33525 in the case you have already the documents directory under CVS control (in particular
33530 This means you have to create or checkout the archive by yourself using external tools.
33531 (In case you forget that step \SpecialChar LyX
33532 registers the document with RCS.)
33535 \begin_layout Standard
33536 Then you are asked interactively to supply an initial description of the document.
33537 Don't forget that registered file is not yet checked in.
33540 \begin_layout Standard
33541 CVS command that is run:
33544 cvs -q add -m"<entered message>" "<file-name>"
33547 \begin_layout Standard
33552 above and for all other CVS commands is an abbreviation for
33553 \begin_inset Quotes eld
33556 change the current working directory to file location and use the file name without path component as argument
33557 \begin_inset Quotes erd
33563 \begin_layout Subsubsection
33569 \begin_layout Standard
33570 When you are finished editing a file,
33571 you commit your changes.
33572 When you do this and you had changed the document,
33573 you are asked for a description of the changes.
33574 After that changes are written to the repository.
33575 In case you didn't change the document and a reserved checkout is detected the reservation made on
33576 \begin_inset Flex Noun
33579 \begin_layout Plain Layout
33588 \begin_layout Labeling
33589 \labelwidthstring 00.00.0000
33591 \begin_inset space ~
33596 \begin_inset space ~
33600 \begin_inset Newline newline
33604 \begin_inset Flex Code
33607 \begin_layout Plain Layout
33610 -q commit -m"<description>" "<file-name>"
33616 \begin_inset Newline newline
33620 \begin_inset Flex Code
33623 \begin_layout Plain Layout
33634 \begin_layout Subsubsection
33640 \begin_layout Standard
33641 When you are sharing a repository with others,
33642 you may have to incorporate their changes into your working copy.
33645 \begin_layout Standard
33649 cvs -q update "<file-name>"
33652 \begin_layout Standard
33653 If a readonly checkout is detected the working copy is made writable and reserved.
33656 \begin_layout Standard
33660 cvs -q edit "<file-name>"
33663 \begin_layout Subsubsection
33666 Revert To Repository Version
33669 \begin_layout Standard
33670 This will discard all changes made to the document since the last check in.
33671 You get a warning before changes are discarded.
33672 Firstly the file is deleted,
33673 secondly CVS update command is run.
33676 \begin_layout Standard
33680 cvs -q update "<file-name>"
33683 \begin_layout Standard
33684 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
33687 \begin_layout Standard
33691 cvs -q unedit "<file-name>"
33694 \begin_layout Subsubsection
33700 \begin_layout Standard
33701 This will create a copy of the current document.
33702 Since CVS does not support copy operations natively,
33703 the version history is not preserved,
33704 and the copy is added as a new file.
33705 It requires a clean document without any changes since the last checkin.
33706 You are asked for a file name and a description of the copy operation.
33707 After that the copy is created,
33708 both locally and in the repository.
33709 If the parent directories of the copied and original document differ,
33710 all relative paths of included files of the copy are adjusted (like in
33712 File\SpecialChar menuseparator
33718 the copy is loaded instead of the original document.
33721 \begin_layout Labeling
33722 \labelwidthstring 00.00.0000
33724 \begin_inset space ~
33729 \begin_inset space ~
33733 \begin_inset Newline newline
33737 \begin_inset Flex Code
33740 \begin_layout Plain Layout
33747 \begin_inset Flex Code
33750 \begin_layout Plain Layout
33757 \begin_inset Newline newline
33761 \begin_inset Flex Code
33764 \begin_layout Plain Layout
33765 cvs -q add "<new-file-name>"
33773 \begin_layout Subsubsection
33779 \begin_layout Standard
33780 This will rename the current document.
33781 Since CVS does not support rename operations natively,
33782 the version history is not preserved,
33783 the renamed document is added as a new file,
33784 and the original document is deleted.
33785 It requires a clean document without any changes since the last checkin.
33786 You are asked for a file name and a description of the rename operation.
33787 After that the document is renamed,
33788 both locally and in the repository.
33789 If the parent directories of the new and old file names differ,
33790 all relative paths of included files are adjusted (like in
33792 File\SpecialChar menuseparator
33798 the document is reloaded using the new name.
33801 \begin_layout Labeling
33802 \labelwidthstring 00.00.0000
33804 \begin_inset space ~
33809 \begin_inset space ~
33813 \begin_inset Newline newline
33817 \begin_inset Flex Code
33820 \begin_layout Plain Layout
33827 \begin_inset Flex Code
33830 \begin_layout Plain Layout
33837 \begin_inset Newline newline
33841 \begin_inset Flex Code
33844 \begin_layout Plain Layout
33845 cvs -q add "<new-file-name>"
33851 \begin_inset Newline newline
33855 \begin_inset Flex Code
33858 \begin_layout Plain Layout
33859 cvs -q remove "<file-name>"
33867 \begin_layout Subsubsection
33868 Update of the local directory checkout from repository
33871 \begin_layout Standard
33872 Once your documents gets more complex,
33873 containing sub-documents and pictures,
33875 \begin_inset Flex Code
33878 \begin_layout Plain Layout
33884 files and so on using version control becomes more complicated.
33886 supports updating the whole tree in which resides the document.
33887 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.
33888 You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
33889 It's good practice anyway to store multipart documents in an extra directory.
33892 \begin_layout Standard
33894 \begin_inset Flex Code
33897 \begin_layout Plain Layout
33898 Update local directory from repository
33903 command updates the whole directory.
33904 If local changes are detected user is warned before update starts.
33905 In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
33906 You have to review and correct the result of the merge.
33907 You'll find the conflicts enclosed in pairs of
33908 \begin_inset Flex Code
33911 \begin_layout Plain Layout
33918 \begin_inset Flex Code
33921 \begin_layout Plain Layout
33928 \begin_inset Flex Code
33931 \begin_layout Plain Layout
33938 The first part is your version as before the update operation with the document name prepended.
33939 The second one is the repository version with the version number after the sequence of
33940 \begin_inset Flex Code
33943 \begin_layout Plain Layout
33952 \begin_layout Labeling
33953 \labelwidthstring 00.00.0000
33955 \begin_inset space ~
33960 \begin_inset space ~
33964 \begin_inset Newline newline
33968 \begin_inset Flex Code
33971 \begin_layout Plain Layout
33980 (Ask if changes are detected.)
33981 \begin_inset Newline newline
33985 \begin_inset Flex Code
33988 \begin_layout Plain Layout
34000 \begin_layout Standard
34002 \begin_inset Flex Code
34005 \begin_layout Plain Layout
34011 stands for the path to the document.
34014 \begin_layout Subsubsection
34020 \begin_layout Standard
34021 This shows the complete history of the CVS document.
34024 cvs log "<file-name>"
34026 is shown in a browser.
34029 \begin_layout Subsubsection
34033 \begin_layout Standard
34035 supports CVS version number,
34037 date and time of last commit.
34038 All those are extracted from
34040 cvs log -r <file-name>
34044 \begin_inset CommandInset ref
34046 reference "subsec:VCS-Revision-Information"
34054 \begin_layout Subsection
34055 SVN commands in \SpecialChar LyX
34059 \begin_layout Standard
34060 SVN is now partially supported by \SpecialChar LyX
34062 You can find the commands in the
34064 File\SpecialChar menuseparator
34066 \begin_inset space ~
34072 Please note that if you use password protected access to repository via ssh,
34073 you will be asked in terminal window.
34075 was tested against SVN 1.5,
34081 \begin_layout Plain Layout
34082 Most of the commands will work with 1.4 too,
34084 \begin_inset CommandInset ref
34086 reference "subsec:SVN-Repo-Update"
34092 There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
34100 \begin_layout Subsubsection
34106 \begin_layout Standard
34107 If your document is not under revision control,
34108 this is the only item shown in the menu.
34109 And if it is under revision control,
34114 item is not visible.
34117 \begin_layout Standard
34118 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
34123 This means you have to checkout the archive by yourself.
34126 \begin_layout Standard
34127 Then you are asked interactively to supply an initial description of the document.
34128 Don't forget that registered file is not yet commited.
34131 \begin_layout Standard
34132 SVN command that is run:
34136 \begin_inset Quotes qld
34140 \begin_inset Quotes qld
34146 \begin_layout Standard
34151 to understand the switches.
34154 \begin_layout Subsubsection
34160 \begin_layout Standard
34161 When you are finished editing a file,
34162 you commit your changes.
34164 you are asked for a description of the changes.
34165 After that changes are commited.
34168 \begin_layout Standard
34173 \begin_layout Plain Layout
34174 In case locking is not enabled.
34176 \begin_inset CommandInset ref
34178 reference "subsec:SVN-File-Locking"
34190 svn commit -q -m"<description>" <file-name>
34193 \begin_layout Subsubsection
34199 \begin_layout Standard
34200 Updates the changes of this file from the repository.
34201 Be sure you understand SVN merging and conflicts resolving before using this function,
34202 because all conflicts has to be resolved manually by you!
34205 \begin_layout Standard
34210 \begin_layout Plain Layout
34218 svn update --non-interactive
34219 \begin_inset Quotes qld
34223 \begin_inset Quotes qld
34229 \begin_layout Subsubsection
34232 Revert To Repository Version
34235 \begin_layout Standard
34236 This will discard all changes made to the document since the last check in.
34237 You get a warning before changes are discarded.
34240 \begin_layout Standard
34245 \begin_inset Quotes qld
34249 \begin_inset Quotes qld
34255 \begin_layout Subsubsection
34261 \begin_layout Standard
34262 This will create a copy of the current document including the version history.
34263 It requires a clean document without any changes since the last checkin.
34264 You are asked for a file name and a description of the copy operation.
34265 After that the copy is created,
34266 both locally and in the repository.
34267 If the parent directories of the copied and original document differ,
34268 all relative paths of included files of the copy are adjusted (like in
34270 File\SpecialChar menuseparator
34276 the copy is loaded instead of the original document.
34279 \begin_layout Labeling
34280 \labelwidthstring 00.00.0000
34282 \begin_inset space ~
34287 \begin_inset space ~
34291 \begin_inset Newline newline
34295 \begin_inset Flex Code
34298 \begin_layout Plain Layout
34302 \begin_inset Quotes qld
34306 \begin_inset Quotes qld
34310 \begin_inset Quotes qld
34314 \begin_inset Quotes qld
34323 \begin_inset Newline newline
34327 \begin_inset Flex Code
34330 \begin_layout Plain Layout
34339 \begin_layout Subsubsection
34345 \begin_layout Standard
34346 This will rename the current document including the version history.
34347 It requires a clean document without any changes since the last checkin.
34348 You are asked for a file name and a description of the rename operation.
34349 After that the document is renamed,
34350 both locally and in the repository.
34351 If the parent directories of the new and old file names differ,
34352 all relative paths of included files are adjusted (like in
34354 File\SpecialChar menuseparator
34360 the document is reloaded using the new name.
34363 \begin_layout Labeling
34364 \labelwidthstring 00.00.0000
34366 \begin_inset space ~
34371 \begin_inset space ~
34375 \begin_inset Newline newline
34379 \begin_inset Flex Code
34382 \begin_layout Plain Layout
34386 \begin_inset Quotes qld
34390 \begin_inset Quotes qld
34394 \begin_inset Quotes qld
34398 \begin_inset Quotes qld
34407 \begin_inset Newline newline
34411 \begin_inset Flex Code
34414 \begin_layout Plain Layout
34423 \begin_layout Subsubsection
34424 \begin_inset CommandInset label
34426 name "subsec:SVN-Repo-Update"
34430 Update of the local directory checkout from repository
34434 \begin_layout Plain Layout
34435 Note that this command will work only with subversion
34436 \begin_inset Formula $\geqq1.5$
34447 \begin_layout Standard
34448 All the commands above have one shortcoming – they deal with the current document only.
34449 Once your document contains pictures,
34451 \begin_inset Flex Code
34454 \begin_layout Plain Layout
34460 files and so on administration becomes more complicated.
34462 now supports updating the whole tree in which resides the document
34466 \begin_layout Plain Layout
34467 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
34474 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.
34478 \begin_layout Standard
34479 \begin_inset Flex Code
34482 \begin_layout Plain Layout
34483 Update local directory from repository
34488 command updates the whole directory and in case of merge conflicts local version of the files are left,
34489 so no unintended data loss occurs.
34490 If local changes are detected user is warned before update starts.
34493 \begin_layout Labeling
34494 \labelwidthstring 00.00.0000
34496 \begin_inset space ~
34501 \begin_inset space ~
34505 \begin_inset Newline newline
34509 \begin_inset Flex Code
34512 \begin_layout Plain Layout
34518 (Ask if changes are detected.)
34519 \begin_inset Newline newline
34523 \begin_inset Flex Code
34526 \begin_layout Plain Layout
34527 svn update --accept mine-full $path
34535 \begin_layout Standard
34537 \begin_inset Flex Code
34540 \begin_layout Plain Layout
34546 stands for the path to the document.
34549 \begin_layout Subsubsection
34555 \begin_layout Standard
34556 This shows the complete history of the SVN document.
34560 \begin_inset Quotes qld
34564 \begin_inset Quotes qld
34569 is shown in a browser.
34572 \begin_layout Subsubsection
34574 \begin_inset CommandInset label
34576 name "subsec:SVN-File-Locking"
34583 \begin_layout Standard
34584 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.
34585 When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
34586 which guarantees that only one user is allowed to edit file at the given time.
34589 \begin_layout Standard
34590 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
34592 \begin_inset CommandInset ref
34594 reference "subsec:Automatical-Locking-Property"
34600 \begin_inset Flex Code
34603 \begin_layout Plain Layout
34613 \begin_layout Plain Layout
34614 \begin_inset Flex URL
34617 \begin_layout Plain Layout
34619 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
34630 If this property is detected for a given document \SpecialChar LyX
34631 starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
34632 This in particular means there are two different modes of file use in \SpecialChar LyX
34636 \begin_layout Itemize
34638 The loaded file is in the read-only mode.
34639 For editing on needs to check-out.
34644 consists of updating from the repository and gaining write lock.
34645 If the lock is not possible to obtain,
34646 we remain in unlocked state.
34649 \begin_layout Itemize
34651 The loaded file is in the
34652 \begin_inset Quotes els
34656 \begin_inset Quotes ers
34660 No other user is allowed to edit the file.
34665 consists of commiting changes and releasing write-lock.
34666 If no changes have been made to the document,
34667 no commit will be produced
34671 \begin_layout Plain Layout
34672 Don't be puzzled by the fact that you will be asked for commit message anyway.
34677 and only the write-lock will be released.
34680 \begin_layout Standard
34684 \begin_layout Labeling
34685 \labelwidthstring 00.00.0000
34689 svn commit -q -m"<description>" "<file-name>"
34690 \begin_inset Newline newline
34693 svn unlock "<file-name>"
34696 \begin_layout Labeling
34697 \labelwidthstring 00.00.0000
34701 svn update "<file-name>"
34702 \begin_inset Newline newline
34705 svn lock "<file-name>"
34708 \begin_layout Subsubsection
34711 \begin_inset CommandInset label
34713 name "subsec:Automatical-Locking-Property"
34719 Automatic Locking Property
34722 \begin_layout Standard
34723 The above mentioned automatic setting of write permissions of the .lyx file can be set through
34725 File\SpecialChar menuseparator
34727 \begin_inset space ~
34730 Control\SpecialChar menuseparator
34731 Use Locking Property
34734 This command is active only when the file is not locked on the svn server (i.e.
34735 you need to check-out before proceeding).
34738 \begin_layout Labeling
34739 \labelwidthstring 00.00.0000
34741 \begin_inset space ~
34747 \begin_layout Labeling
34748 \labelwidthstring 00.00.0000
34752 svn propset svn:needs-lock ON "<file-name>"
34755 \begin_layout Labeling
34756 \labelwidthstring 00.00.0000
34760 svn propdel svn:needs-lock "<file-name>"
34763 \begin_layout Subsubsection
34764 \begin_inset CommandInset label
34766 name "subsec:VCS-Revision-Information"
34770 Revision Information in Documents
34773 \begin_layout Standard
34774 There are more possibilities how to activate revision information in our document.
34777 \begin_layout Itemize
34783 \begin_layout Itemize
34784 tree revision information (
34785 \begin_inset Flex Code
34788 \begin_layout Plain Layout
34795 The result is the output of the
34796 \begin_inset Flex Code
34799 \begin_layout Plain Layout
34806 the following table gives you an idea,
34807 how to read the results.
34810 \begin_layout Standard
34812 \begin_inset Tabular
34813 <lyxtabular version="3" rows="6" columns="2">
34814 <features tabularvalignment="middle">
34815 <column alignment="left" valignment="top">
34816 <column alignment="left" valignment="top">
34818 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
34821 \begin_layout Plain Layout
34829 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
34832 \begin_layout Plain Layout
34842 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
34845 \begin_layout Plain Layout
34851 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34854 \begin_layout Plain Layout
34855 mixed revision working copy
34862 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
34865 \begin_layout Plain Layout
34871 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34874 \begin_layout Plain Layout
34875 modified working copy
34882 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
34885 \begin_layout Plain Layout
34891 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34894 \begin_layout Plain Layout
34895 switched working copy
34902 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
34905 \begin_layout Plain Layout
34911 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34914 \begin_layout Plain Layout
34915 partial working copy,
34916 from a sparse checkout
34923 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
34926 \begin_layout Plain Layout
34932 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
34935 \begin_layout Plain Layout
34938 switched working copy
34951 \begin_layout Itemize
34952 file revision information.
34953 The result comes from parsing the output of
34954 \begin_inset Flex Code
34957 \begin_layout Plain Layout
34959 \begin_inset space ~
34963 \begin_inset space ~
34967 \begin_inset space ~
34976 Supported flags are:
34980 \begin_layout Itemize
34981 version number of the last commit (
34982 \begin_inset Flex Code
34985 \begin_layout Plain Layout
34994 \begin_layout Itemize
34995 author of the last commit (
34996 \begin_inset Flex Code
34999 \begin_layout Plain Layout
35008 \begin_layout Itemize
35009 date of the last commit (
35010 \begin_inset Flex Code
35013 \begin_layout Plain Layout
35022 \begin_layout Itemize
35023 time of the last commit (
35024 \begin_inset Flex Code
35027 \begin_layout Plain Layout
35037 \begin_layout Standard
35038 You can obtain this info via InsetInfo (
35039 \change_inserted 5863208 1564400022
35040 Insert\SpecialChar menuseparator
35041 Field\SpecialChar menuseparator
35042 Version Control Revision
35043 \change_deleted 5863208 1564399852
35046 \begin_inset Flex Code
35049 \begin_layout Plain Layout
35050 info-insert buffer vcs-date
35058 The information will be available only when you have the file stored under svn managment (i.e.
35060 \begin_inset Flex Code
35063 \begin_layout Plain Layout
35069 directory is available with your document).
35073 \begin_layout Itemize
35076 possibility is to use svn keywords
35080 \begin_layout Plain Layout
35081 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
35087 In short – you set file keywords property (e.g.
35090 svn propset svn:keywords 'Rev' file.lyx
35092 ) and then paste keyword \SpecialChar TeX
35097 \begin_layout Plain Layout
35098 This is an easy way how to ensure that \SpecialChar LyX
35099 won't break the line in the middle of keyword tag.
35104 tag in your document (e.g.
35106 \begin_inset Flex Code
35109 \begin_layout Plain Layout
35116 This way svn client will automatically substitute revision number (e.g.
35118 \begin_inset Flex Code
35121 \begin_layout Plain Layout
35128 ) after each update and commit.
35129 There are more problems with this approach.
35131 the '$' character is used in \SpecialChar TeX
35132 world for math equations,
35133 so any occurence of math formula
35134 \begin_inset Formula $Rev$
35138 \begin_inset Formula $Rev:59$
35141 in your \SpecialChar LyX
35143 Similarly for other keywords like Id,
35147 Secondly svn output is dependent on your locales,
35148 so its very easy that svn would produce some problematic strings once Date is used.
35149 Thirdly you get the whole 'Rev:
35150 59' string in your document instead of the plain number.
35151 Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
35152 to support it directly.
35155 \begin_layout Subsection
35156 SVN and Windows Environment
35159 \begin_layout Quote
35160 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
35161 they would be well advised to use TortoiseSVN.
35168 \begin_layout Subsubsection
35172 \begin_layout Standard
35173 In addition to installing \SpecialChar LyX
35175 and having access to a Subversion repository,
35176 the user will need to install the Subversion client program.
35177 A Windows installer for the client program is available from
35178 \begin_inset CommandInset href
35181 target "http://www.collab.net/nonav/downloads/subversion/"
35187 The user may also want to install
35188 \begin_inset CommandInset href
35191 target "http://tortoisesvn.tigris.org/"
35197 which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
35198 Operations done outside \SpecialChar LyX
35199 will typically be more convenient using the Explorer context menu.
35200 Note that TortoiseSVN is not a replacement for the client program,
35201 which is what \SpecialChar LyX
35205 \begin_layout Subsubsection
35206 Bringing a document under Subversion control
35209 \begin_layout Standard
35210 Before a \SpecialChar LyX
35211 document can be brought under version control in Subversion,
35212 its parent directory needs to be under version control.
35213 If the document is being added to a project already in the repository,
35214 this is accomplished by checking the project out to the directory where the new document will be placed.
35215 If the project itself is not yet under version control (for instance,
35216 if this document starts a new project),
35217 the directory must be imported into the repository.
35218 This is done outside \SpecialChar LyX
35220 Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
35221 or alternatively can be done using the command line client at a DOS prompt.
35222 The procedure for importing the project using TortoiseSVN is described below,
35223 assuming an existing repository and a new project being started in
35230 For information on using the Subversion client program,
35238 \begin_layout Enumerate
35245 in Windows Explorer,
35249 TortoiseSVN\SpecialChar menuseparator
35254 adjust the URL for the repository,
35258 \begin_layout Enumerate
35259 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
35263 Supply a name for the project folder and click OK.
35264 Add a message for the log file if desired,
35265 then click OK again.
35266 The new project folder should appear in the repository.
35268 click OK again to exit the repository browser.
35271 \begin_layout Enumerate
35272 Once again right click
35279 this time selecting SVN Checkout\SpecialChar ldots
35280 Select the URL of the project folder you just created in the repository,
35281 and set the checkout directory to
35289 You will be warned about a non-empty folder;
35290 click OK to proceed.
35291 You should now have a
35302 \begin_layout Enumerate
35303 Create or open your document in \SpecialChar LyX
35306 File\SpecialChar menuseparator
35308 \begin_inset space ~
35311 Control\SpecialChar menuseparator
35315 Add a log message and click OK to commit the document to version control.
35318 \begin_layout Standard
35319 From this point onward,
35320 you should have full functionality in the
35322 File\SpecialChar menuseparator
35324 \begin_inset space ~
35330 You also have the option of checking the document in and out,
35331 viewing its history,
35333 using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
35336 \begin_layout Subsubsection
35337 SSH tunnel used with SVN under Windows
35340 \begin_layout Standard
35341 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
35342 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,
35343 also be prepared for a great deal of frustration\SpecialChar ldots
35347 \begin_layout Enumerate
35348 Get an svn client for windows,
35349 as described in the previous sections.
35350 When it is a fresh install run some svn command (e.g.
35352 \begin_inset Flex Code
35355 \begin_layout Plain Layout
35361 ) to create config files,
35362 which you will need to change later on.
35365 \begin_layout Enumerate
35366 Choose an ssh client for Windows.
35367 There are several possibilities,
35368 we will use the one from Putty tools
35372 \begin_layout Plain Layout
35373 \begin_inset Flex URL
35376 \begin_layout Plain Layout
35378 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
35389 You will need to set the connection up so that the client doesn't ask for any password from you.
35390 To keep things easy we will use only keys without any additional password protection etc.
35394 \begin_layout Enumerate
35396 \begin_inset Flex Code
35399 \begin_layout Plain Layout
35406 Save your private .ppk key file and put the public one on the server side.
35407 If the SVN server runs on Linux,
35408 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
35409 \begin_inset Quotes eld
35414 Public key for pasting into OpenSSH authorized_keys file
35417 \begin_inset Quotes erd
35420 edit field into the server's
35421 \begin_inset Flex Code
35424 \begin_layout Plain Layout
35425 ~/.ssh/authorized_keys
35431 \begin_inset Flex Code
35434 \begin_layout Plain Layout
35443 \begin_layout Enumerate
35445 \begin_inset Flex Code
35448 \begin_layout Plain Layout
35455 In the SVN config file
35459 \begin_layout Plain Layout
35460 Exact path depends on Windows version,
35461 usually somewhere around
35462 \begin_inset Flex Code
35465 \begin_layout Plain Layout
35468 Documents and Settings
35482 \begin_inset Flex Code
35485 \begin_layout Plain Layout
35505 \begin_inset Flex Code
35508 \begin_layout Plain Layout
35509 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
35518 \begin_layout Plain Layout
35519 It will usually take a lot of time to get exact command right and it depends on many things.
35520 For example do not have some remote server saved as a default session in Putty etc.
35522 try to connect via plink without SVN first.
35531 \begin_layout Enumerate
35532 Checkout the SVN archive,
35534 \begin_inset space \thinspace{}
35538 \begin_inset Newline newline
35542 \begin_inset Flex Code
35545 \begin_layout Plain Layout
35546 svn co svn+ssh://user@server/repository_path
35554 \begin_layout Subsubsection
35555 End-of-Line Conversions
35558 \begin_layout Standard
35559 When the collaborators are mixing Linux and Windows environments,
35561 will use different line endings inside the .lyx files.
35562 This is not a problem as far as \SpecialChar LyX
35563 functionality is concerned,
35564 but the commit diffs will be huge and merge-conflicts prone.
35565 Fortunately SVN itself knows
35569 \begin_layout Plain Layout
35570 \begin_inset Flex URL
35573 \begin_layout Plain Layout
35575 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
35585 how to deal with CR/LF problems when switching .lyx files to the
35586 \begin_inset Flex Code
35589 \begin_layout Plain Layout
35599 \begin_layout Plain Layout
35602 \begin_inset Flex Code
35605 \begin_layout Plain Layout
35606 svn propset svn:eol-style native FILE_NAME
35619 \begin_layout Subsection
35620 GIT commands in \SpecialChar LyX
35624 \begin_layout Standard
35625 A minimal subset of GIT commands is now supported by \SpecialChar LyX
35627 You can find the commands in the
35629 File\SpecialChar menuseparator
35631 \begin_inset space ~
35637 Please note that if you use password protected access to repository via ssh,
35638 you will be asked in terminal window.
35640 was tested against GIT 1.7.
35644 \begin_layout Plain Layout
35645 Windows users please note that you need to ensure that git is on the path.
35646 This can be set from within \SpecialChar LyX
35649 Tools\SpecialChar menuseparator
35650 Preferences\SpecialChar menuseparator
35651 Paths\SpecialChar menuseparator
35662 \begin_layout Standard
35663 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
35664 With traditional version control systems there is one central server which hosts the repository.
35665 Users commit their changes to the server,
35666 and get updates made by other users from it.
35668 users commit to a local repository.
35669 The local repository can be synchronized with one or more remote repositories using the
35670 \begin_inset Flex Code
35673 \begin_layout Plain Layout
35680 \begin_inset Flex Code
35683 \begin_layout Plain Layout
35691 does not interact in any way with remote GIT repositories.
35692 It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
35693 If you use remote GIT repositories you need to do the
35694 \begin_inset Flex Code
35697 \begin_layout Plain Layout
35704 \begin_inset Flex Code
35707 \begin_layout Plain Layout
35713 operations with your favourite GIT client.
35716 \begin_layout Subsubsection
35722 \begin_layout Standard
35723 If your document is not under revision control,
35724 this is the only item shown in the menu.
35725 And if it is under revision control,
35730 item is not visible.
35733 \begin_layout Standard
35734 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
35739 This means you have to checkout the archive by yourself.
35742 \begin_layout Standard
35743 Then you are asked interactively to supply an initial description of the document.
35744 Don't forget that registered file is not yet committed.
35747 \begin_layout Standard
35748 GIT command that is run:
35752 \begin_inset Quotes qld
35756 \begin_inset Quotes qld
35762 \begin_layout Standard
35767 to understand the switches.
35770 \begin_layout Subsubsection
35776 \begin_layout Standard
35777 When you are finished editing a file,
35778 you commit your changes.
35780 you are asked for a description of the changes.
35781 After that changes are committed.
35784 \begin_layout Standard
35788 git commit -q -m"<description>" <file-name>
35791 \begin_layout Subsubsection
35794 Revert To Repository Version
35797 \begin_layout Standard
35798 This will discard all changes made to the document since the last check in.
35799 You get a warning before changes are discarded.
35802 \begin_layout Standard
35807 \begin_inset Quotes qld
35811 \begin_inset Quotes qld
35817 \begin_layout Subsubsection
35823 \begin_layout Standard
35824 This will rename the current document including the version history.
35825 It requires a clean document without any changes since the last checkin.
35826 You are asked for a file name and a description of the rename operation.
35827 After that the document is renamed,
35828 both locally and in the repository.
35829 If the parent directories of the new and old file names differ,
35830 all relative paths of included files are adjusted (like in
35832 File\SpecialChar menuseparator
35838 the document is reloaded using the new name.
35841 \begin_layout Labeling
35842 \labelwidthstring 00.00.0000
35844 \begin_inset space ~
35849 \begin_inset space ~
35853 \begin_inset Newline newline
35857 \begin_inset Flex Code
35860 \begin_layout Plain Layout
35864 \begin_inset Quotes qld
35868 \begin_inset Quotes qld
35872 \begin_inset Quotes qld
35876 \begin_inset Quotes qld
35885 \begin_inset Newline newline
35889 \begin_inset Flex Code
35892 \begin_layout Plain Layout
35901 \begin_layout Subsubsection
35907 \begin_layout Standard
35908 This shows the complete history of the GIT document.
35912 \begin_inset Quotes qld
35916 \begin_inset Quotes qld
35921 is shown in a browser.
35924 \begin_layout Subsubsection
35928 \begin_layout Standard
35930 supports GIT hash number of the last commit to the file,
35932 \change_inserted 1119979965 1564297456
35933 its abbreviated form,
35937 date and time of last commit.
35938 All those are extracted from
35940 git log -n 1 --pretty=format:%H%n
35941 \change_inserted 1119979965 1564297427
35947 Tree version information is obtained via
35949 git describe --abbrev --dirty --long
35953 \begin_inset CommandInset ref
35955 reference "subsec:VCS-Revision-Information"
35963 \begin_layout Subsection
35967 \begin_layout Standard
35968 With the recent addition of the
35969 \begin_inset Flex Code
35972 \begin_layout Plain Layout
35978 function \SpecialChar LyX
35979 power users are allowed to create their own commands for revision control.
35982 \begin_layout Standard
35983 As an example you can see how two TortoiseSVN commands could be integrated directly:
35986 \begin_layout Description
35989 \begin_inset Flex Code
35992 \begin_layout Plain Layout
35993 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
36001 \begin_layout Description
36004 \begin_inset Flex Code
36007 \begin_layout Plain Layout
36008 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
36016 \begin_layout Subsection
36017 Version control and Document comparison
36020 \begin_layout Standard
36021 One of the typical uses of version control is to inspect the changes between revisions,
36022 usually by creating
36023 \begin_inset Flex Code
36026 \begin_layout Plain Layout
36033 While this is useful for plain text files,
36034 it is much less useful in the case of \SpecialChar LyX
36036 which have more a complicated structure.
36037 Hence we provide binding to the Document comparison feature.
36038 There are two ways of calling this feature – either by direct call of
36039 \begin_inset Flex Code
36042 \begin_layout Plain Layout
36049 function (for details see \SpecialChar LyX
36050 functions manual) or by the toolbar icon
36064 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 '
36065 \begin_inset Flex Noun
36068 \begin_layout Plain Layout
36074 ' revisions back means comparison of the edited file with last commited revision).
36078 \begin_layout Standard
36079 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,
36080 numbers always point to the last number in RCS revision number,
36083 We don't currently support GIT addressing of revisions,
36084 one can just compare edited document with its revision X steps backs,
36085 where X is addressed as
36086 \begin_inset Flex Code
36089 \begin_layout Plain Layout
36098 \begin_layout Section
36100 \change_inserted 564990737 1672161575
36101 \begin_inset CommandInset label
36103 name "sec:Literate-Programming"
36109 Literate Programming
36112 \begin_layout Standard
36117 (kayvan@sylvan.com)
36122 original documentation written by
36124 Edmar Wienskoski Jr.
36127 (edmar-w-jr@technologist.com)
36130 \begin_layout Subsection
36134 \begin_layout Standard
36135 The main purpose of this documentation is to show you how to use \SpecialChar LyX
36136 for literate programming,
36137 where it is assumed that you are familiar with this programming technique,
36139 \begin_inset Quotes eld
36143 \begin_inset Quotes erd
36147 \begin_inset Quotes eld
36151 \begin_inset Quotes erd
36155 If that is not the case,
36156 please follow the web links provided in the following sections.
36157 There is a lot of good documentation out there covering old development history to the latest tools tips.
36160 \begin_layout Standard
36161 It is also assumed that you are familiar with \SpecialChar LyX
36162 itself to a point that you are comfortable changing your \SpecialChar LyX
36164 and X resources file.
36165 If that is not the case please refer to other \SpecialChar LyX
36166 documentation to cover your specific needs.
36169 \begin_layout Subsection
36170 Literate Programming
36173 \begin_layout Standard
36174 From the Literate Programming FAQ:
36178 \begin_layout Quotation
36179 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
36181 literate programs should be enjoyable reading,
36184 I couldn't resist!) In general,
36185 literate programs combine source and documentation in a single file.
36186 Literate programming tools then parse the file to produce either readable documentation or compilable source.
36187 The WEB style of literate programming was created by D.
36188 \begin_inset space \thinspace{}
36192 Knuth during the development of his \SpecialChar TeX
36193 typesetting software.
36197 \begin_layout Standard
36198 Another excerpt says:
36201 \begin_layout Quotation
36204 How is literate programming different from verbose commenting?
36207 \begin_layout Quotation
36208 There are three distinguishing characteristics.
36209 In order of importance,
36215 \begin_layout Itemize
36216 flexible order of elaboration
36219 \begin_layout Itemize
36220 automatic support for browsing
36223 \begin_layout Itemize
36224 typeset documentation,
36225 especially diagrams and mathematics
36229 \begin_layout Standard
36230 Now that I sparked your curiosity,
36231 take a look in the references.
36234 \begin_layout Subsubsection
36238 \begin_layout Standard
36239 The complete Literate Programming FAQ can be found at:
36242 \begin_layout Quote
36243 Literate Programming FAQ
36244 \begin_inset Flex URL
36247 \begin_layout Plain Layout
36249 http://www.literateprogramming.com/lpfaq.pdf
36257 \begin_layout Standard
36258 The FAQ lists 23 (twenty three!) different literate programming tools.
36259 Where some are specialized or
36260 \begin_inset Quotes eld
36264 \begin_inset Quotes erd
36267 for particular programming languages,
36268 while other have general scope.
36273 for my own use for several reasons:
36276 \begin_layout Itemize
36277 It can generate the documentation either in \SpecialChar LaTeX
36281 \begin_layout Itemize
36282 It has a open architecture,
36284 \begin_inset space \thinspace{}
36288 \begin_inset space \space{}
36291 it is easy to plug in new filters
36295 \begin_layout Plain Layout
36300 are programs that read a given data stream and output a manipulated data stream.
36302 a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
36308 and to perform special processing that you may need.
36312 \begin_layout Itemize
36313 There is a good selection of filters available already (the HTML is one of them).
36316 \begin_layout Itemize
36320 \begin_layout Standard
36321 The Noweb web page can be found at:
36325 \begin_layout Quote
36327 \begin_inset Flex URL
36330 \begin_layout Plain Layout
36332 https://www.cs.tufts.edu/~nr/noweb/
36340 \begin_layout Standard
36341 Starting from there you can reach many other interesting links and even some literate program examples.
36344 \begin_layout Subsection
36346 and Literate Programming with Noweb
36349 \begin_layout Standard
36350 The \SpecialChar LyX
36351 support for Literate Programming is provided by using the generic \SpecialChar LyX
36352 converters mechanism.
36353 This support is provided in a
36354 \begin_inset Quotes eld
36358 \begin_inset Quotes erd
36363 \begin_inset space \thinspace{}
36367 \begin_inset space \space{}
36370 you will be able to use this new \SpecialChar LyX
36371 feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
36375 \begin_layout Subsubsection
36376 Generating documents and code (weaving and tangling)
36379 \begin_layout Paragraph
36380 Using the noweb module
36383 \begin_layout Standard
36384 If you have installed Noweb and \SpecialChar LyX
36386 whenever you open a new document,
36387 after you have chosen its document class,
36390 Document\SpecialChar menuseparator
36394 \begin_inset Quotes eld
36398 \begin_inset Quotes erd
36402 If Noweb is correctly installed,
36403 when you click on the
36404 \begin_inset Quotes eld
36408 \begin_inset Quotes erd
36413 \begin_inset Quotes eld
36417 \begin_inset Quotes erd
36420 module in the available list and you can add it to your document.
36423 \begin_layout Paragraph
36427 \begin_layout Standard
36429 enables you to write code with a custom inset named
36430 \begin_inset Flex Noun
36433 \begin_layout Plain Layout
36440 Noweb delimits chunks like this:
36443 \begin_layout LyX-Code
36447 \begin_layout LyX-Code
36451 \begin_layout LyX-Code
36455 \begin_layout LyX-Code
36459 \begin_layout LyX-Code
36463 \begin_layout Standard
36464 The problem is that whatever is written in between the << and the
36468 must be taken literally,
36470 \begin_inset space \thinspace{}
36474 \begin_inset space \space{}
36478 should be prevented from making any special interpretation of what has been written.
36479 This is also handled by
36480 \begin_inset Flex Noun
36483 \begin_layout Plain Layout
36490 that works like a normal text inset but has a free spacing capability.
36493 \begin_layout Standard
36495 you can also use the
36496 \begin_inset Quotes eld
36500 \begin_inset Quotes erd
36503 construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
36506 \begin_layout LyX-Code
36510 \begin_layout LyX-Code
36511 def some_function(args):
36514 \begin_layout LyX-Code
36515 "This is the doc string for this function."
36518 \begin_layout LyX-Code
36524 \begin_layout LyX-Code
36525 @ %def some_function
36528 \begin_layout Standard
36529 For an example of this usage and the resulting cross-reference output,
36530 look at the Literate python program in
36532 LIBDIR/examples/listerrors.lyx
36534 which should make this all clear.
36537 \begin_layout Paragraph
36538 Generating the documentation
36541 \begin_layout Standard
36542 At this point you already have a new document file with a proper document class,
36543 and with some code and text on it.
36545 The answer is simple,
36548 View\SpecialChar menuseparator
36553 Just like you would do for a plain document.
36554 No special procedure is required.
36557 \begin_layout Standard
36558 To help orientate you,
36559 I will now explain what happens inside \SpecialChar LyX
36563 \begin_layout Enumerate
36566 Update\SpecialChar menuseparator
36569 menu option is chosen,
36570 a \SpecialChar LaTeX
36576 \begin_layout Standard
36577 If the document is of any literate class the generated file will be named with an extension name defined by the
36578 \begin_inset Quotes eld
36582 \begin_inset Quotes erd
36585 format (defined in the Preferences panel),
36586 otherwise the file will have the usual
36594 \begin_layout Enumerate
36595 Note that the only difference so far is in the name of the file,
36596 no special processing is required by \SpecialChar LyX
36598 Given that you formatted the code using the
36599 \begin_inset Flex Noun
36602 \begin_layout Plain Layout
36610 takes care of the business.
36613 \begin_layout Enumerate
36614 If the document is of any literate class \SpecialChar LyX
36615 will then use the internal \SpecialChar LyX
36616 to Noweb converter,
36617 followed by the Noweb to \SpecialChar LaTeX
36622 \begin_layout Plain Layout
36623 The converters are defined in the
36625 Tools\SpecialChar menuseparator
36630 \begin_inset Quotes eld
36634 \begin_inset Quotes erd
36646 manual for general information about converters.
36651 to generate the \SpecialChar LaTeX
36656 \begin_layout Standard
36657 Otherwise it will just skip this step.
36661 \begin_layout Enumerate
36664 is invoked and the regular post processing continues as in a plain document.
36667 \begin_layout Standard
36668 Independence from a particular
36669 \begin_inset Quotes eld
36673 \begin_inset Quotes erd
36676 is easily achieved by changing the commands that are run by the various converters.
36679 \begin_layout Paragraph
36680 Generating the code
36683 \begin_layout Standard
36684 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
36685 a \SpecialChar LaTeX
36686 file is generated just like step 1 above.
36694 This converter needs to be defined by the user and is not installed by default,
36695 though the Program format is.
36696 This converter (like any other converter) will have two parts:
36699 \begin_layout Enumerate
36700 The converter program itself.
36701 This program performs the conversion from the one format to the other (in this case,
36702 from the Noweb format to the Program pseudo-format).
36705 \begin_layout Enumerate
36706 The error log parser.
36707 This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
36709 This makes it possible for \SpecialChar LyX
36710 to place error boxes in the right places in the file buffer.
36713 \begin_layout Standard
36716 \begin_inset Quotes eld
36720 \begin_inset Quotes erd
36727 \begin_layout LyX-Code
36735 \begin_layout Standard
36736 This basically means that \SpecialChar LyX
36738 \begin_inset Quotes eld
36742 \begin_inset Quotes erd
36745 (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
36746 temp directory) and the directory path of the original \SpecialChar LyX
36751 \begin_layout Standard
36752 This is an implementation of
36753 \begin_inset Quotes eld
36757 \begin_inset Quotes erd
36760 that you can place in a directory on your path:
36763 \begin_layout LyX-Code
36769 \begin_layout LyX-Code
36775 \begin_layout LyX-Code
36778 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
36781 \begin_layout Standard
36782 The next part of the converter setting is the
36783 \begin_inset Quotes eld
36787 \begin_inset Quotes erd
36790 which is to be set to
36793 \begin_layout LyX-Code
36796 parselog=$$s/scripts/listerrors
36799 \begin_layout Standard
36800 This will run any errors that are generated by the
36801 \begin_inset Quotes eld
36805 \begin_inset Quotes erd
36808 process through the
36809 \begin_inset Quotes eld
36813 \begin_inset Quotes erd
36819 \begin_layout Standard
36820 The build will normally take place in \SpecialChar LyX
36821 's temporary directory,
36822 so the files produced by the conversion will be in that directory.
36824 will copy out what it regards as the `main' file,
36829 conversion may produce several files,
36830 and so most of these would then be deleted when \SpecialChar LyX
36832 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.
36835 \begin_layout Paragraph
36836 Build instructions in the document
36839 \begin_layout Standard
36840 The last piece of the integration between \SpecialChar LyX
36842 \begin_inset Quotes eld
36846 \begin_inset Quotes erd
36851 the instructions for building your program should be embedded in a chunk of its own.
36853 \begin_inset Quotes eld
36857 \begin_inset Quotes erd
36860 above uses the notangle command to look for this chunk (called
36861 \begin_inset Quotes eld
36865 \begin_inset Quotes erd
36868 ) and runs its contents through
36869 \begin_inset Quotes eld
36873 \begin_inset Quotes erd
36879 \begin_layout Standard
36881 such a chunk would look something like this:
36884 \begin_layout LyX-Code
36888 \begin_layout LyX-Code
36890 \begin_inset Newline newline
36893 if [ -z "${NOWEB_SOURCE}" ]
36894 \begin_inset Newline newline
36900 \begin_layout LyX-Code
36901 NOWEB_SOURCE=myfile.nw
36902 \begin_inset Newline newline
36906 \begin_inset Newline newline
36910 code to extract files ...
36911 use NOWEB_OUTPUT_DIR here ...]
36912 \begin_inset Newline newline
36916 code to compile files ...]
36917 \begin_inset Newline newline
36923 \begin_layout Standard
36925 \change_deleted 564990737 1672161716
36928 LIBDIR/examples/listerrors.lyx
36932 LIBDIR/examples/Literate.lyx
36933 \change_inserted 564990737 1672161716
36937 File\SpecialChar menuseparator
36938 Open Example\SpecialChar menuseparator
36939 Modules\SpecialChar menuseparator
36945 \change_deleted 564990737 1672161729
36949 \begin_inset Quotes eld
36953 \begin_inset Quotes erd
36956 program for some illustrations of how all of these pieces go together or in
36957 \change_deleted 564990737 1672161756
36960 LIBDIR/examples/noweb2lyx.lyx
36961 \change_inserted 564990737 1672161756
36965 File\SpecialChar menuseparator
36966 Open Example\SpecialChar menuseparator
36967 Modules\SpecialChar menuseparator
36968 Noweb2\SpecialChar LyX
36979 \change_deleted 564990737 1672161767
36982 files show off the language-indepence of the \SpecialChar LyX
36983 literate programming support since they are written in Python
36984 \change_deleted 564990737 1672161782
36988 and Perl respectively.
36991 \begin_layout Subsubsection
36992 Configuring \SpecialChar LyX
36996 \begin_layout Standard
36997 All the Literate Programming support is configured by the
36999 Tools\SpecialChar menuseparator
37003 \begin_inset Quotes eld
37007 \begin_inset Quotes erd
37011 The important parts are:
37014 \begin_layout Description
37016 \begin_inset space ~
37020 \begin_inset Quotes eld
37024 \begin_inset Quotes erd
37028 \begin_inset space ~
37031 format Set up via the File Formats tab,
37032 this is where the Noweb-specific pieces are set up.
37042 the file extension is set to
37047 This tells \SpecialChar LyX
37048 to create a file with a
37052 extension in the first step of the conversion process.
37055 \begin_layout Description
37057 \begin_inset space ~
37065 \begin_inset space ~
37068 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).
37071 \begin_layout Description
37081 This converter performs the
37082 \begin_inset Quotes eld
37086 \begin_inset Quotes erd
37089 of the literate document.
37092 \begin_inset Quotes eld
37097 noweave -delay -index $$i > $$o
37100 \begin_inset Quotes erd
37106 \begin_layout Description
37116 \begin_inset Quotes eld
37120 \begin_inset Quotes erd
37125 the Converter is set to
37126 \begin_inset Quotes eld
37134 \begin_inset Quotes erd
37139 \begin_inset Newline newline
37143 \begin_inset Quotes eld
37148 parselog=$$s/scripts/listerrors
37151 \begin_inset Quotes erd
37157 \begin_layout Subsubsection
37161 \begin_layout Standard
37162 There is also a new function implemented in the \SpecialChar LyX
37165 \begin_inset Quotes eld
37168 server-goto-file-row" function,
37169 to be used with ddd/gdb or other debugger.
37173 \begin_layout Standard
37174 When debugging code with ddd/gdb,
37175 it is possible to invoke a text editor at the current execution position with a single key stroke.
37176 The default ddd configuration for that is shift-ctrl-V.
37177 It happens that you can define the editor command line invocation in ddd by accessing the
37179 Edit\SpecialChar menuseparator
37180 Preferences\SpecialChar menuseparator
37183 dialog and changing the "Edit Sources" entry.
37186 \begin_layout Standard
37187 I take advantage of the newly created \SpecialChar LyX
37188 server function and this ddd feature,
37190 \begin_inset Quotes eld
37194 \begin_inset Quotes erd
37200 \begin_layout LyX-Code
37201 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
37204 \begin_layout Standard
37206 whenever you are using ddd and find a point in the program that you want to edit,
37207 you just press shift-ctrl-V (in the ddd window),
37208 and ddd will forward this information to \SpecialChar LyX
37209 through the \SpecialChar LyX
37210 server and then the \SpecialChar LyX
37211 window will show the same file with the cursor at the same position ddd was pointing to.
37212 No more guessing or long scrolling to locate a point in the program back from debugging !
37215 \begin_layout Standard
37216 Note however that you must enable the \SpecialChar LyX
37217 server to get this feature working (it is disabled by default).
37219 \begin_inset space ~
37223 \begin_inset CommandInset ref
37225 reference "sec:Starting-the-Server"
37230 explains how to do that.
37233 \begin_layout Subsubsection
37237 \begin_layout Standard
37238 There are six new buttons that can be added to your \SpecialChar LyX
37240 Four of these buttons are short cuts to layout styles:
37263 one for the custom inset
37268 The last one is a short cut to the
37269 \begin_inset Quotes eld
37273 \begin_inset Quotes erd
37280 \begin_layout Standard
37282 has a range of buttons that are available for tool bar customization.
37283 In my toolbar I like to combine the six short cuts above with two more:
37288 \SpecialChar menuseparator
37293 \SpecialChar menuseparator
37300 Document\SpecialChar menuseparator
37301 View\SpecialChar menuseparator
37305 Here is how it looks like:
37308 \begin_layout LyX-Code
37312 \begin_layout LyX-Code
37316 \begin_layout LyX-Code
37317 Icon "layout Standard"
37320 \begin_layout LyX-Code
37321 Icon "layout Section"
37324 \begin_layout LyX-Code
37325 Icon "layout \SpecialChar LaTeX
37329 \begin_layout LyX-Code
37330 Icon "layout \SpecialChar LyX
37334 \begin_layout LyX-Code
37335 Icon "flex.insert Chunk"
37338 \begin_layout LyX-Code
37342 \begin_layout LyX-Code
37346 \begin_layout LyX-Code
37347 Icon "buffer-typeset"
37350 \begin_layout LyX-Code
37351 Icon "build-program"
37354 \begin_layout LyX-Code
37358 \begin_layout LyX-Code
37362 \begin_layout LyX-Code
37366 \begin_layout LyX-Code
37370 \begin_layout LyX-Code
37374 \begin_layout Subsubsection
37375 Colors customization
37378 \begin_layout Standard
37379 There are a number of colors in \SpecialChar LyX
37380 that can be customized in
37385 One of the things that bothers people is the \SpecialChar LaTeX
37387 The default color is red,
37388 since the chunks uses \SpecialChar LaTeX
37390 and there is a lot of chunks in literate documents,
37391 you may get tired of seeing everything in red.
37392 You can change it by going to the tabs
37402 \begin_layout Standard
37403 The next thing is the visible presence of the newline character in the screen.
37404 You can choose the color of this particular character and make it blend in the background.
37405 I recommend you choosing a color that is close to the background but not equal,
37406 that way you still can see it is there,
37407 but it is not bothering you anymore.
37410 \begin_layout Subsection
37415 \begin_layout Standard
37425 \change_inserted 564990737 1672161863
37428 Help\SpecialChar menuseparator
37429 Specific Manuals\SpecialChar menuseparator
37435 \change_deleted 564990737 1671643409
37441 \change_inserted 564990737 1672161856
37444 File\SpecialChar menuseparator
37445 Open Example\SpecialChar menuseparator
37446 Modules\SpecialChar menuseparator
37452 \change_deleted 564990737 1671643461
37453 the Sweave manual (menu
37455 Help\SpecialChar menuseparator
37459 \change_inserted 564990737 1672161856
37462 Help\SpecialChar menuseparator
37463 Specific Manuals\SpecialChar menuseparator
37465 \change_deleted 564990737 1672161921
37470 \change_inserted 564990737 1672161917
37473 File\SpecialChar menuseparator
37474 Open Example\SpecialChar menuseparator
37475 Modules\SpecialChar menuseparator
37479 \change_deleted 564990737 1672742969
37483 \begin_layout Standard
37485 \change_deleted 564990737 1671355343
37489 \begin_layout Standard
37491 \change_deleted 564990737 1671355343
37492 You can do everything with \SpecialChar LyX
37493 that you can do with \SpecialChar LaTeX
37497 cannot support every \SpecialChar LaTeX
37499 But you can always use \SpecialChar TeX
37501 This chapter shows you some more special things you might want to use.
37502 For other special things you can do with figures,
37509 \begin_inset space ~