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
2812 originally offered four standard document classes,
2816 but individuals and organizations,
2817 most notably the American Mathematical Society in the early days,
2818 have made many contributions to extending the range of document classes.
2819 In this chapter we summarize the main externally maintained classes,
2820 some of which are marked “Unavailable:” in the pull-down
2823 \begin_inset space ~
2837 ocument\SpecialChar menuseparator
2842 ettings\SpecialChar menuseparator
2844 \begin_inset space ~
2849 dialog and which you will need to install as described in the
2851 Installing New Document Classes
2857 manual if you want to use them.
2861 \begin_layout Section
2863 \change_inserted 564990737 1670439533
2864 \begin_inset CommandInset label
2866 name "sec:Collections"
2873 \begin_layout Subsection
2875 \change_inserted 564990737 1672345298
2878 \begin_inset CommandInset label
2880 name "subsec:AMS-LaTeX-(American-Mathematical"
2884 AMS-\SpecialChar LaTeX
2885 (American Mathematical Society)
2888 \begin_layout Standard
2890 \change_inserted 564990737 1672345298
2893 The \SpecialChar LyX
2894 supported document classes
2902 are maintained by the Society;
2903 use of their features is described in the Math manual and on their website
2904 \begin_inset Flex URL
2907 \begin_layout Plain Layout
2909 \change_inserted 564990737 1672345298
2911 http://www.ams.org/publications/authors/tex/amslatex
2919 The following summary was originally provided by
2927 and the \SpecialChar LyX
2931 \change_deleted 564990737 1672345297
2935 AMS \SpecialChar LaTeX
2939 \begin_layout Standard
2941 \change_deleted 564990737 1672345297
2949 Richard Kimberly Heck
2954 \begin_layout Standard
2955 \begin_inset VSpace bigskip
2961 \begin_layout Standard
2963 The AMS \SpecialChar LaTeX
2964 layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
2965 The layouts are not tailored to a specific journal,
2967 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
2969 That documentation is available on the Web at
2970 \begin_inset Flex URL
2973 \begin_layout Plain Layout
2981 \begin_inset Flex URL
2984 \begin_layout Plain Layout
2986 ftp://ftp.ams.org/pub/tex/amslatex/
2992 These layouts are appropriate,
2994 for any mathematical writing.
2998 \begin_layout Standard
2999 There are two basic AMS \SpecialChar LaTeX
3004 \begin_layout Itemize
3006 The standard AMS article format
3007 \change_inserted 564990737 1672345333
3013 File\SpecialChar menuseparator
3014 Open Example\SpecialChar menuseparator
3015 Articles\SpecialChar menuseparator
3016 American Mathematical Society (AMS)
3024 \begin_layout Itemize
3026 the standard AMS book (really,
3028 \change_inserted 564990737 1672345366
3034 File\SpecialChar menuseparator
3035 Open Example\SpecialChar menuseparator
3036 Books\SpecialChar menuseparator
3037 American Mathematical Society (AMS)
3043 \change_inserted 564990737 1672345369
3047 \begin_layout Itemize
3049 \change_inserted 564990737 1672345383
3056 the standard AMS proceedings format.
3059 \begin_layout Standard
3061 \change_inserted 564990737 1672345383
3065 only supports the first two natively;
3068 Installing New Document Classes
3074 manual if you want to use
3081 \begin_layout Standard
3082 The layouts themselves contain only the minimum necessary to use the AMS classes.
3085 contain any of the `theorem' environments used for setting theorems,
3088 These are contained,
3091 \change_deleted 564990737 1672345416
3093 \begin_inset Flex Code
3096 \begin_layout Plain Layout
3103 \change_inserted 564990737 1672345416
3113 which is loaded by default when you select one of the AMS classes.
3114 (It can also be used with other classes and can be removed,
3115 if you would rather use something else.) Less commonly used environments are in the
3116 \change_deleted 564990737 1672345436
3118 \begin_inset Flex Code
3121 \begin_layout Plain Layout
3122 Theorems (AMS-Extended)
3128 \change_inserted 564990737 1672345436
3133 AMS Theorems (Extended)
3139 which must be loaded manually.
3142 \begin_layout Standard
3144 theorems and the like are numbered consecutively throughout the document,
3145 but this may be modified by loading the module
3146 \change_deleted 564990737 1672345461
3148 \begin_inset Flex Code
3151 \begin_layout Plain Layout
3152 Theorems (Order by Section)
3158 \change_inserted 564990737 1672345461
3162 Standard Theorems (Numbered by Section)
3169 \begin_inset Flex Code
3172 \begin_layout Plain Layout
3180 \change_deleted 564990737 1672345479
3182 \begin_inset Flex Code
3185 \begin_layout Plain Layout
3186 Theorems (Order by Chapter)
3192 \change_inserted 564990737 1672345480
3196 Standard Theorems (Numbered by Chapter)
3202 These will number the results as
3203 \begin_inset Formula $n.m$
3207 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).
3208 Many environments are also available unnumbered.
3209 These are indicated by an asterisk at the end.
3210 If you happen to want
3216 \change_deleted 564990737 1672345498
3218 \begin_inset Flex Code
3221 \begin_layout Plain Layout
3228 \change_inserted 564990737 1672345498
3232 Standard Theorems (Unnumbered)
3237 provides that option.
3240 \begin_layout Standard
3241 Note that these modules do not
3245 to be used with the AMS classes.
3246 It is perfectly possible to use the
3247 \change_deleted 564990737 1672345520
3249 \begin_inset Flex Code
3252 \begin_layout Plain Layout
3259 \change_inserted 564990737 1672345520
3269 and the others mentioned,
3272 \begin_inset Flex Code
3275 \begin_layout Plain Layout
3283 \begin_inset Flex Code
3286 \begin_layout Plain Layout
3294 \begin_inset Flex Code
3297 \begin_layout Plain Layout
3307 \begin_layout Subsubsection
3308 What these layouts provide
3311 \begin_layout Standard
3312 There is a long list of included environments provided by these layouts.
3313 In AMS-\SpecialChar LaTeX
3317 an opportunity to define an unlimited variety of `theorem' environments.
3319 the AMS recommends the environments that are available in \SpecialChar LyX
3324 \begin_layout Standard
3325 The following environments—
3326 as well as the standard environments,
3328 \begin_inset Flex Noun
3331 \begin_layout Plain Layout
3339 \begin_inset Flex Noun
3342 \begin_layout Plain Layout
3350 \begin_inset Flex Noun
3353 \begin_layout Plain Layout
3361 \begin_inset Flex Noun
3364 \begin_layout Plain Layout
3372 \begin_inset Flex Noun
3375 \begin_layout Plain Layout
3383 \begin_inset Flex Code
3386 \begin_layout Plain Layout
3393 \begin_inset Flex Code
3396 \begin_layout Plain Layout
3405 \begin_layout Description
3406 Address This should be the author's permanent address.
3409 \begin_layout Description
3411 \begin_inset space ~
3414 Address This should be the author's temporary address at the time of submission,
3415 if different from the Address.
3418 \begin_layout Description
3419 Email Author's e-mail address
3422 \begin_layout Description
3423 URL Author's Web address,
3427 \begin_layout Description
3428 Keywords Key words or phrases used to identify specific topics discussed in the paper.
3431 \begin_layout Description
3432 Subjectclass These refer to the AMS Subject Classifications,
3433 published and described in
3435 Mathematical Reviews
3438 These are also available online at the AMS cites listed above.
3441 \begin_layout Description
3445 \begin_layout Description
3449 \begin_layout Description
3453 \begin_layout Standard
3454 The following environments are provided by both the
3455 \change_deleted 564990737 1672345566
3457 \begin_inset Flex Code
3460 \begin_layout Plain Layout
3467 \change_inserted 564990737 1672345566
3477 \change_deleted 564990737 1672345580
3479 \begin_inset Flex Code
3482 \begin_layout Plain Layout
3489 \change_inserted 564990737 1672345580
3499 in the latter case in both starred (unnumbered) and unstarred (numbered) versions.
3500 These same environments are provided only in the starred versions by the
3501 \change_deleted 564990737 1672345596
3503 \begin_inset Flex Code
3506 \begin_layout Plain Layout
3513 \change_inserted 564990737 1672345596
3525 \begin_layout Theorem
3526 This is typically used for the statements of major results.
3530 \begin_layout Corollary*
3531 This is used for statements which follow fairly directly from previous statements.
3533 these can be major results.
3538 These are smaller results needed to prove other statements.
3541 \begin_layout Proposition
3542 These are less major results which (hopefully) add to the general theory being discussed.
3545 \begin_layout Conjecture
3546 These are statements provided without justification,
3547 which the author does not know how to prove,
3548 but which seem to be true (to the author,
3552 \begin_layout Definition*
3553 Guess what this is for.
3554 The font is different for this environment than for the previous ones.
3558 \begin_layout Example*
3559 Used for examples illustrating proven results.
3562 \begin_layout Problem
3563 It's not really known what this is for.
3564 You should figure it out.
3567 \begin_layout Exercise*
3568 Write a description for this one.
3571 \begin_layout Remark
3572 This environment is also a type of theorem,
3573 usually a lesser sort of observation.
3576 \begin_layout Claim*
3577 Often used in the course of giving a proof of a larger result.
3582 these are used to break up long arguments,
3583 using specific instances of some condition.
3588 The numbering scheme for cases is on its own,
3589 not together with other numbered statements.
3594 At the end of this environment,
3595 a QED symbol (usually a square,
3596 but it can vary with different styles) is placed.
3597 If you want to have other environments within this one—
3600 and have the QED symbol appear only after them,
3601 then the other environments need to be nested within the proof environment.
3604 Nesting Environments
3610 for information on nesting.
3615 \change_inserted 564990737 1672345651
3616 Used in a way similar to Proposition,
3617 though perhaps lower on the scale.
3620 \begin_layout Standard
3621 And these environments are provided by
3622 \change_deleted 564990737 1672345684
3624 \begin_inset Flex Code
3627 \begin_layout Plain Layout
3628 Theorems (AMS-Extended)
3634 \change_inserted 564990737 1672345689
3638 AMS Theorems (Extended
3646 \begin_layout Criterion*
3647 A required condition.
3650 \begin_layout Algorithm*
3651 A general procedure to be used.
3654 \begin_layout Axiom*
3655 This is a property or statement taken as true within the system being discussed.
3658 \begin_layout Condition*
3659 Sometimes used to state a condition assumed within the present context of discussion.
3663 Similar to a Remark.
3666 \begin_layout Notation*
3667 Used for the explanation of,
3672 \begin_layout Summary
3673 Do we really need to tell you?
3677 \begin_layout Acknowledgement*
3681 \begin_layout Conclusion*
3682 Sometimes used at the end of a long train of argument.
3683 \change_deleted 564990737 1672345729
3689 \change_deleted 564990737 1672345638
3690 Used in a way similar to Proposition,
3691 though perhaps lower on the scale.
3692 \change_inserted 564990737 1672345720
3696 \begin_layout Assumption*
3698 \change_inserted 564990737 1672345721
3704 \begin_layout Question*
3706 \change_inserted 564990737 1672345721
3712 \begin_layout Standard
3714 \change_inserted 564990737 1672345721
3717 There are ten more Maths modules available including several offering options ordered on
3719 (Numbered by Type \SpecialChar ldots
3727 \begin_layout Standard
3729 the AMS classes automatically provide the AMS \SpecialChar LaTeX
3730 and AMS fonts packages.
3731 They need to be available on your system in order to use these environments.
3734 \begin_layout Subsection
3736 \change_inserted 564990737 1671383236
3739 \begin_inset CommandInset label
3741 name "subsec:Extra-font-sizes"
3748 \begin_layout Standard
3750 \change_inserted 564990737 1671383236
3753 The “Extra font sizes” collection provides the document classes
3756 \begin_inset space \thinspace{}
3759 (with extra font sizes)
3765 \begin_inset space \thinspace{}
3768 (with extra font sizes)
3774 \begin_inset space \thinspace{}
3777 (with extra font sizes)
3782 \begin_inset space \thinspace{}
3785 (with extra font sizes)
3805 document classes respectively but offer the additional
3811 \begin_inset space ~
3824 ocument\SpecialChar menuseparator
3829 ettings\SpecialChar menuseparator
3835 \begin_layout Subsection
3837 \change_inserted 564990737 1671383236
3843 \begin_layout Standard
3845 \change_inserted 564990737 1671383236
3848 The document classes
3851 \begin_inset space \thinspace{}
3859 \begin_inset space \thinspace{}
3874 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3878 \begin_layout Subsection
3880 \change_inserted 564990737 1671383236
3883 \begin_inset CommandInset label
3885 name "subsec:Japanese"
3892 \begin_layout Standard
3894 \change_inserted 564990737 1671383236
3897 The document classes
3900 \begin_inset space \thinspace{}
3909 \begin_inset space \thinspace{}
3912 (Japanese Standard Class Vertical Writing)
3918 \begin_inset space \thinspace{}
3921 (Japanese Standard Class)
3927 \begin_inset space \thinspace{}
3936 \begin_inset space \thinspace{}
3939 (Japanese Standard Class Vertical Writing)
3945 \begin_inset space \thinspace{}
3948 (Japanese Standard Class)
3954 \begin_inset space \thinspace{}
3957 (Japanese Vertical Writing)
3962 \begin_inset space \thinspace{}
3965 (Japanese Standard Class)
3967 provide document classes for the Japanese language.
3970 \begin_layout Subsection
3972 \change_inserted 564990737 1672429136
3975 \begin_inset CommandInset label
3977 name "subsec:KOMA-Script"
3984 \begin_layout Standard
3986 \change_inserted 564990737 1672429136
3998 and the \SpecialChar LyX
4000 \change_deleted 564990737 1672429136
4006 \begin_layout Standard
4008 \change_deleted 564990737 1672429136
4016 \begin_layout Subsubsection
4018 \change_inserted 564990737 1672429161
4022 \begin_layout Standard
4024 \change_inserted 564990737 1672429162
4027 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
4028 it was formally launched with the addition of a letter class in 1994.
4030 a second letter class has been added.
4031 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.
4037 \begin_layout Standard
4038 The \SpecialChar LyX
4041 article (koma-script)
4046 report (koma-script)
4066 correspond to the \SpecialChar LaTeX
4088 \begin_inset space ~
4091 of the Koma-Script family.
4092 They are replacements for the standard document classes
4112 and fit better to European typography conventions in a number of points.
4115 \begin_layout Itemize
4117 \change_deleted 564990737 1672429262
4118 Standard character size is
4119 \change_inserted 564990737 1672429263
4122 The base character sizes when you select a KOMA-Script class are
4128 article (koma-script)
4133 report (koma-script)
4139 \change_deleted 564990737 1672429267
4147 letter (koma-script)
4152 \begin_layout Itemize
4154 labels of the description environment,
4155 and a number of elements of the
4157 letter (koma-script)
4159 document class are set in a bold sans serif font.
4163 \begin_layout Plain Layout
4164 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
4165 especially in the appearance of headings.
4167 the ec bold sans serif fonts look a bit thin.
4168 Here the \SpecialChar LaTeX
4177 helps to produce the
4178 \begin_inset Quotes eld
4182 \begin_inset Quotes erd
4185 appearance when using the ec fonts.
4190 The numbering of chapter headings is made in the same way as the numbering of section headings,
4191 that is without the extra line
4192 \begin_inset Quotes eld
4195 Chapter\SpecialChar ldots
4197 \begin_inset Quotes erd
4202 the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
4203 to be entered in the field
4206 \begin_inset space ~
4213 Layout\SpecialChar menuseparator
4220 \begin_layout Itemize
4222 \change_deleted 564990737 1672429310
4223 The main means in the Koma-Script document classes to design the type area are the options
4231 (in \SpecialChar LyX
4232 to be entered in the extra class options field in the dialog
4234 Document\SpecialChar menuseparator
4238 They make a clearer modification of page margins possible as do the options of the dialog
4240 Document\SpecialChar menuseparator
4245 \change_inserted 564990737 1672429310
4248 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.
4249 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.
4250 You can change the sizes of the margins by changing the factor by which the page is divided into strips;
4251 the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
4256 \begin_layout Standard
4258 \change_inserted 564990737 1672429310
4261 Whatever the factor,
4262 two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
4263 leaving a text area occupying around half the page.
4264 Since most two-sided documents have a binding,
4265 this can make the inner margins appear too narrow;
4266 so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
4270 \begin_layout Standard
4272 \change_inserted 564990737 1672429310
4275 The main means in the Koma-Script document classes to design the type area are the options
4285 Document\SpecialChar menuseparator
4286 Settings\SpecialChar menuseparator
4287 Document Class\SpecialChar menuseparator
4288 Class Options\SpecialChar menuseparator
4295 \begin_layout Standard
4297 \change_inserted 564990737 1672429310
4301 the binding correction is 7.5mm which is added in the form
4308 \begin_inset space ~
4311 options\SpecialChar menuseparator
4319 To change the factor to 11,
4325 to the comma separated list of entries in the
4336 \begin_inset space ~
4342 If you want the default value of this factor for a page size other than A4,
4350 \begin_layout Standard
4352 \change_inserted 564990737 1672429310
4355 To use the circle method of calculating the page layout,
4366 \begin_layout Itemize
4367 The \SpecialChar LaTeX
4368 document classes of the Koma-Script family define a number of additional commands.
4369 Those part of it which makes sense in \SpecialChar LyX
4370 is implemented in corresponding paragraph types.
4373 \begin_layout Standard
4374 Detailed descriptions of the \SpecialChar LaTeX
4375 document classes of the Koma-Script family can be found in the Koma-Script documentation
4386 \begin_layout Subsubsection
4388 \change_inserted 564990737 1672429358
4392 \begin_inset CommandInset label
4394 name "subsec:article-(KOMA-Script),-report"
4400 article (KOMA-Script),
4401 report (KOMA-Script),
4402 and book (KOMA-Script)
4403 \change_deleted 564990737 1672429367
4406 article (koma-script),
4407 report (koma-script),
4408 and book (koma-script)
4413 \begin_layout Standard
4414 The document classes
4416 article (koma-script)
4421 report (koma-script)
4432 are implemented in the layout files
4448 They contain all the paragraph types of the corresponding standard document classes
4465 with the exception of the \SpecialChar LyX
4471 which is replaced by the new
4475 -type having the same functionality.
4480 -Type there is a number of new paragraph types added.
4487 letter (koma-script)
4492 \begin_layout Itemize
4515 additionally inserting an entry in the table of contents.
4524 are not contained in
4526 article (koma-script)
4531 \begin_layout Itemize
4552 additionally clearing running heads.
4559 article (koma-script)
4565 \begin_layout Plain Layout
4578 report (koma-script)
4581 but since this is identical to
4586 is has not been implemented in \SpecialChar LyX
4595 \begin_layout Itemize
4601 generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
4604 \begin_layout Itemize
4613 are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
4614 you might want to place table captions always above the table).
4615 You can also use the class option
4633 You need at least Koma-Script version 2.8q to use this.
4636 \begin_layout Itemize
4642 can be used to set a bonmot,
4644 \begin_inset space \thinspace{}
4648 \begin_inset space \space{}
4651 at the beginning of a chapter.
4652 If you use the optional argument (
4654 Insert\SpecialChar menuseparator
4656 \begin_inset space ~
4662 you can insert the dictum's author there.
4663 Dictum and author are separated by a line.
4664 You need at least Koma-Script version 2.8q to use this.
4671 article (koma-script)
4676 \begin_layout Standard
4677 The following types,
4678 together with the standard types
4693 form the title area of the document.
4694 They must be entered ahead of the first
4695 \begin_inset Quotes eld
4699 \begin_inset Quotes erd
4706 \begin_layout Plain Layout
4707 The corresponding \SpecialChar LaTeX
4708 commands must appear before the
4719 When such a type is used more than once,
4720 the latter usage overwrites the former one,
4722 for every type only the latest usage is valid.
4723 The order of the different types however has,
4739 no effect on the appearance of the produced document.
4742 \begin_layout Itemize
4748 produces a centered paragraph above the ordinary title (
4762 ) for the subject of the document.
4765 \begin_layout Itemize
4771 produces a centered paragraph below the ordinary title (
4785 ) for the publishers' name.
4788 \begin_layout Itemize
4796 report (koma-script)
4802 produces a centered paragraph on its own page behind the title page,
4805 article (koma-script)
4807 produces a centered paragraph below the ordinary title (
4829 \begin_layout Itemize
4835 produces a left aligned paragraph above the ordinary title (
4854 ) for a document`s head.
4857 \begin_layout Itemize
4863 produces in a double-sided print in
4865 report (koma-script)
4871 a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
4873 article (koma-script)
4878 \begin_layout Itemize
4884 produces in a double-sided print in
4886 report (koma-script)
4892 a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
4894 article (koma-script)
4899 \begin_layout Itemize
4906 \begin_inset Quotes eld
4910 \begin_inset Quotes erd
4913 page ahead of the actual document containing a paragraph without special formatting.
4916 \begin_layout Standard
4918 \change_inserted 564990737 1672429680
4921 KOMA-Script offers a wide range of
4928 \begin_inset space ~
4938 ocument\SpecialChar menuseparator
4943 ettings\SpecialChar menuseparator
4945 \begin_inset space ~
4950 dialog which you can apply to the whole document,
4954 \begin_layout Description
4956 \change_inserted 564990737 1672429680
4964 which produces a PDF with a small black box at the end any line in which a formatting error occurs;
4965 the default setting is
4970 \begin_layout Description
4972 \change_inserted 564990737 1672429680
4980 which may take the values
4994 the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
4997 \begin_layout Description
4999 \change_inserted 564990737 1672429680
5007 which may take the values
5021 the first leaves it up to KOMA-Script to add periods after chapter,
5024 the second forces the addition of periods and third suppresses them
5027 \begin_layout Standard
5029 \change_inserted 564990737 1672429680
5032 and the math options:
5035 \begin_layout Description
5037 \change_inserted 564990737 1672429680
5045 which causes equations to be numbered on the left rather than on the right,
5049 \begin_layout Description
5051 \change_inserted 564990737 1672429680
5059 which causes equations to be left justified rather than centered.
5062 \begin_layout Standard
5064 \change_inserted 564990737 1672429680
5067 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
5068 commands and packages;
5070 if you want your captions in bold add
5073 \begin_layout Standard
5075 \change_inserted 564990737 1672429680
5081 setkomafont{captionlabel}{
5086 \begin_layout Standard
5088 \change_inserted 564990737 1672429680
5096 ocument\SpecialChar menuseparator
5103 \SpecialChar menuseparator
5108 \begin_inset space ~
5113 ) and the problem is solved.
5116 \begin_layout Standard
5118 \change_inserted 564990737 1672429680
5121 If you are writing a book,
5122 it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
5123 If you use the Chapter* environment,
5124 your Foreword and Preface will not appear in the Table of Contents;
5125 to make them to appear in the Table of contents,
5126 you need to use Chapter environments and add the \SpecialChar TeX
5130 \begin_layout Standard
5132 \change_inserted 564990737 1672429680
5141 \begin_layout Standard
5143 \change_inserted 564990737 1672429680
5146 at the very start of the book (not in the \SpecialChar LaTeX
5150 \begin_layout Standard
5152 \change_inserted 564990737 1672429680
5161 \begin_layout Standard
5163 \change_inserted 564990737 1672429680
5166 before the first chapter of the body of the text.
5167 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
5172 \begin_layout Plain Layout
5174 \change_inserted 564990737 1672429680
5177 Appendices are normally “numbered” with letters.
5182 If you use the Chapter* environment,
5183 they will not appear in the Table of Contents;
5184 so add the \SpecialChar TeX
5188 \begin_layout Standard
5190 \change_inserted 564990737 1672429680
5199 \begin_layout Standard
5201 \change_inserted 564990737 1672429682
5204 before the first of these headings and use the Chapter environment.
5205 These commands will have no effect on the numbering in \SpecialChar LyX
5207 only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
5210 \begin_layout Standard
5211 The layout files for the document classes
5213 article (koma-script)
5218 report (koma-script)
5230 This is thought of as a place to define your own types.
5235 in your personal layout directory and edit the file!
5236 \change_deleted 564990737 1672430255
5240 \begin_layout Standard
5242 \change_deleted 564990737 1672430255
5243 letter (koma-script)
5246 \begin_layout Description
5248 \change_deleted 564990737 1672429749
5250 This section discusses the obsolete
5252 KOMA-Script-Letter (v.
5253 \begin_inset space ~
5259 which is not even included anymore in recent KOMA releases.
5260 Please refer to the next section for the current KOMA-Script-Letter class (v.
5261 \begin_inset space ~
5267 \begin_layout Standard
5270 \change_deleted 564990737 1672429749
5273 letter (koma-script)
5275 is implemented in the layout file
5280 It contains all the paragraph types of the corresponding standard document class
5286 with the exception of the \SpecialChar LyX
5301 which is replaced by the new
5308 in contrast to the standard document class,
5331 there are a number of new letter specific types.
5334 \begin_layout Standard
5336 \change_deleted 564990737 1672429749
5337 The appearance of the letter produced by this document class can be controlled by a number of \SpecialChar LaTeX
5339 which you can put in the \SpecialChar LaTeX
5344 \begin_layout Plain Layout
5346 the standard appearance of the letter`s heading,
5347 consisting of name and address,
5348 is quite self-willed.
5350 \begin_inset Quotes eld
5354 \begin_inset Quotes erd
5357 heading is produced by the following \SpecialChar LaTeX
5358 commands in the preamble:
5361 \begin_layout LyX-Code
5371 \begin_layout LyX-Code
5387 \begin_layout LyX-Code
5397 \begin_layout LyX-Code
5417 A detailed German description of such \SpecialChar LaTeX
5418 commands can be found in the Koma-Script documentation
5424 the letter's author can produce his personal letter layout.
5427 \begin_layout Standard
5429 \change_deleted 564990737 1672429749
5438 define the beginning of the letter and must be used in every letter.
5439 To emphasize them in the \SpecialChar LyX
5441 they are marked with the letter
5451 \begin_inset space ~
5455 It is possible to write any number of letters in one file.
5460 type produces a new letter using the same addressee and a
5464 type produces a new addressee.
5484 are ordinary paragraph types and can also be used several times in one and the same letter.
5487 \begin_layout Itemize
5489 \change_deleted 564990737 1672429749
5495 produces a paragraph for the addressee and implicitly defines the beginning of the letter.
5498 \begin_layout Itemize
5500 \change_deleted 564990737 1672429749
5506 produces a paragraph for the form of address and implicitly produces a new letter.
5509 \begin_layout Itemize
5511 \change_deleted 564990737 1672429749
5517 produces a paragraph for a close.
5520 \begin_layout Itemize
5522 \change_deleted 564990737 1672429749
5528 produces a paragraph for a postscript.
5531 \begin_layout Itemize
5533 \change_deleted 564990737 1672429749
5539 produces a paragraph for a distribution list.
5542 \begin_layout Itemize
5544 \change_deleted 564990737 1672429749
5550 produces a paragraph for enclosures.
5553 \begin_layout Standard
5555 \change_deleted 564990737 1672429749
5605 are input types provided with a label to enter information,
5606 which will be processed by the document class.
5610 \begin_layout Plain Layout
5611 It could be seen as a matter of inconsequence,
5620 described above are not such input types as well.
5621 Because of the special meaning of those types,
5623 I have implemented them as ordinary paragraph types with a one letter mark in the left margin.
5625 it would affect my feeling of symmetry,
5634 type had such a serious different appearance.
5639 The types must be used ahead of the corresponding
5646 \begin_layout Standard
5648 \change_deleted 564990737 1672429749
5649 An implementation of these types in a WYSIWYG fashion does not seem to make sense,
5650 because the real appearance of the produced letter does not only depend on the usage of the particular type,
5651 but also on other factors.
5653 a signature entered in the
5657 type will in the standard behavior appear in the produced letter only,
5658 when in the same letter also a
5663 The entered value of the
5667 type will in the standard behavior not appear in the produced letter at all.
5668 The possibility to design the letter`s heading freely is already indicated in a footnote above.
5671 \begin_layout Standard
5673 \change_deleted 564990737 1672429749
5674 The input types can also be used as empty paragraphs.
5676 \begin_inset space \thinspace{}
5680 \begin_inset space \space{}
5692 type is not used at all,
5693 in the standard behavior the value of the
5697 type is used as signature,
5703 no signature value is defined.
5706 \begin_layout Standard
5708 \change_deleted 564990737 1672429749
5709 By using the input types it is possible to write a letter template,
5710 containing filled input types with your personal dates (name,
5712 etc.) and empty input types for other dates you want to enter.
5715 \begin_layout Itemize
5717 \change_deleted 564990737 1672429749
5724 in the standard behavior appears as a centered paragraph in small caps in the letter`s heading.
5727 \begin_layout Itemize
5729 \change_deleted 564990737 1672429749
5736 in the standard behavior appears below the
5750 type appears instead.
5753 \begin_layout Itemize
5755 \change_deleted 564990737 1672429749
5762 in the standard behavior appears in a centered paragraph in the letter`s heading below the sender's name.
5765 \begin_layout Itemize
5767 \change_deleted 564990737 1672429749
5773 sender's telephone number,
5774 in the standard behavior only sets the \SpecialChar LaTeX
5784 \begin_layout Itemize
5786 \change_deleted 564990737 1672429749
5792 place of the letter`s making.
5795 \begin_layout Itemize
5797 \change_deleted 564990737 1672429749
5803 date of the letter`s making.
5813 in the standard behavior,
5814 produce the place and the date in a right-aligned line below the addressee's field.
5820 neither place nor date appear,
5821 independent of the value of the
5831 the date of the letter `s production is used.
5834 \begin_layout Itemize
5836 \change_deleted 564990737 1672429749
5842 sender`s back address,
5843 in the standard behavior appears above the addressee's field in a small sans serif font.
5846 \begin_layout Itemize
5848 \change_deleted 564990737 1672429749
5854 special mail information,
5855 in the standard behavior appears underlined above the addressee's field below the back address.
5858 \begin_layout Itemize
5860 \change_deleted 564990737 1672429749
5866 additional information,
5867 in the standard behavior appears on right side below the addressee`s field.
5870 \begin_layout Itemize
5872 \change_deleted 564990737 1672429749
5879 in the standard behavior appears in a big,
5881 sans serif font above the subject.
5884 \begin_layout Itemize
5886 \change_deleted 564990737 1672429749
5892 the letter's subject,
5893 in the standard behavior appears in a bold font above the
5900 \begin_layout Standard
5902 \change_deleted 564990737 1672429749
5927 produce a business letter like line above the
5931 line containing the fields
5932 \begin_inset Quotes eld
5936 \begin_inset Quotes erd
5941 \begin_inset Quotes eld
5945 \begin_inset Quotes erd
5950 \begin_inset Quotes eld
5954 \begin_inset Quotes erd
5959 \begin_inset Quotes eld
5963 \begin_inset Quotes erd
5968 \begin_inset Quotes eld
5972 \begin_inset Quotes erd
5977 \begin_inset Quotes eld
5981 \begin_inset Quotes erd
5992 \begin_inset Quotes eld
5995 business letter types
5996 \begin_inset Quotes erd
6004 type however does not appear,
6005 but only the \SpecialChar LaTeX
6013 The ordinary output of place and date in a right-aligned line below the addressee`s field is suppressed.
6014 The types are implemented as input types provided with a label and must be used ahead of the corresponding
6021 \begin_layout Itemize
6023 \change_deleted 564990737 1672429749
6032 \begin_layout Itemize
6034 \change_deleted 564990737 1672429749
6043 \begin_layout Itemize
6045 \change_deleted 564990737 1672429749
6054 \begin_layout Itemize
6056 \change_deleted 564990737 1672429749
6065 \begin_layout Itemize
6067 \change_deleted 564990737 1672429749
6078 \begin_layout Subsubsection
6080 \change_deleted 564990737 1672429773
6081 The new letter class:
6082 letter (koma-script v.2)
6083 \change_inserted 564990737 1672429774
6087 \begin_inset CommandInset label
6089 name "subsec:The-new-letter"
6093 The new letter class:
6094 letter (KOMA-Script v.2)
6099 \begin_layout Standard
6105 \begin_layout Standard
6106 \begin_inset VSpace medskip
6112 \begin_layout Standard
6114 Koma-Script version 2.8 has introduced a new letter class
6118 which supersedes the now unsupported
6124 on the \SpecialChar LaTeX
6126 a completely new interface and is not compatible with the old class.
6130 though it is recommended you use the new class.
6133 \begin_layout Standard
6134 This class covers the same functionality as
6136 letter (koma-script),
6144 (receiver's address,
6164 will start a new letter (i.
6165 \begin_inset space \thinspace{}
6169 \begin_inset space \space{}
6172 you can write several letters per document).
6173 New elements are sender's
6192 and the possibility to use a
6198 Insert\SpecialChar menuseparator
6204 \begin_layout Standard
6205 The biggest improvement is,
6207 that the letter's layout is configurable to meet almost any needs.
6208 This can be done via the preamble or with a special style file (Letter Class Option,
6214 that will be read in as a class option.
6218 \begin_layout Plain Layout
6219 The KOMA package comes with some default
6230 file that follows german typesetting rules,
6235 that provides the default layout of the old
6240 The latter can be loaded with the class option
6247 Layout\SpecialChar menuseparator
6248 Document\SpecialChar menuseparator
6257 \change_deleted 564990737 1671617922
6265 \change_deleted 564990737 1671617938
6266 that is included in \SpecialChar LyX
6268 \change_inserted 564990737 1671617997
6275 ile\SpecialChar menuseparator
6277 \begin_inset space ~
6285 \begin_inset space ~
6288 Template\SpecialChar menuseparator
6291 \SpecialChar menuseparator
6292 KOMA-Script Letter (V.2)
6297 A detailed description is to be found in the Koma-Script documentation (
6304 \begin_layout Subsubsection
6308 \begin_layout Standard
6309 Visualizing the Koma-Script document classes in \SpecialChar LyX
6311 the \SpecialChar LyX
6312 internals cause some problems.
6315 \begin_layout Itemize
6316 The chapter number of a
6320 type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
6321 The cause for that is the \SpecialChar LyX
6322 internal behavior for the labeltype
6329 \begin_layout Itemize
6330 The headings of the types
6339 \begin_inset Quotes eld
6343 \begin_inset Quotes erd
6348 but not in the \SpecialChar LyX
6351 Document\SpecialChar menuseparator
6353 \begin_inset space ~
6357 \begin_inset space ~
6365 \begin_layout Itemize
6370 document class appear in a skip separation mode,
6372 This is the standard behavior,
6373 no special \SpecialChar LaTeX
6374 commands are needed for that.
6377 Document\SpecialChar menuseparator
6380 dialog the corresponding radio button indicates
6389 value always has the effect that extra \SpecialChar LaTeX
6390 commands are inserted in the document to produce the gap,
6391 which is not what is wanted in this case.
6394 \begin_layout Subsection
6396 \change_inserted 564990737 1672743555
6397 \begin_inset CommandInset label
6399 name "subsec:Polish-M.W.collection"
6404 \begin_inset space \thinspace{}
6408 \begin_inset space \space{}
6412 \change_deleted 564990737 1670924933
6414 book (mwbk) and report (mwrep)
6415 \begin_inset Argument status
6418 \begin_layout Plain Layout
6433 \begin_layout Standard
6439 \begin_layout Standard
6440 The \SpecialChar LyX
6458 correspond to the \SpecialChar LaTeX
6474 They are replacements for the standard document classes
6489 and fit better to Polish typography conventions in a number of points.
6493 \begin_layout Standard
6497 \begin_layout Itemize
6498 Unnumbered titles (with star,
6500 \begin_inset space \thinspace{}
6504 \begin_inset space \space{}
6511 ) are added into table of contents,
6514 \begin_layout Itemize
6515 Additional page styles:
6519 \begin_layout Description
6520 uheadings header with separated lines,
6523 \begin_layout Description
6524 myheadings custom header,
6525 contents headers via commands:
6541 \begin_layout Description
6542 myuheadings custom header with separated lines,
6545 \begin_layout Description
6546 outer page number is placed on outer side of page
6550 \begin_layout Itemize
6555 \begin_layout Description
6556 rmheadings serif titles —
6560 \begin_layout Description
6561 sfheadings sansserif titles,
6564 \begin_layout Description
6565 authortitle on title page first placed is author next title —
6569 \begin_layout Description
6570 titleauthor on title page first placed is title next author,
6573 \begin_layout Description
6574 withmarginpar reserve place on page for margins.
6578 \begin_layout Subsection
6580 \change_inserted 564990737 1672652245
6586 \begin_layout Standard
6588 \change_inserted 564990737 1672652245
6591 The document classes
6594 \begin_inset space \thinspace{}
6602 \begin_inset space \thinspace{}
6616 Detailed information about these document classes can be found in
6618 File\SpecialChar menuseparator
6619 Open Example\SpecialChar menuseparator
6620 Books\SpecialChar menuseparator
6625 File\SpecialChar menuseparator
6626 Open Example\SpecialChar menuseparator
6627 Handouts\SpecialChar menuseparator
6633 \begin_layout Section
6635 \change_inserted 564990737 1670439534
6639 \begin_layout Standard
6641 \change_inserted 564990737 1670794710
6642 See also the document classes in the Collections (section
6643 \begin_inset space ~
6647 \begin_inset CommandInset ref
6649 reference "sec:Collections"
6657 \begin_layout Subsection
6659 \change_inserted 564990737 1670794716
6665 \begin_layout Standard
6667 \change_inserted 564990737 1670794716
6675 updated by the \SpecialChar LyX
6679 \begin_layout Subsubsection
6681 \change_inserted 564990737 1670794716
6687 \begin_layout Standard
6689 \change_inserted 564990737 1670794716
6692 This section describes how \SpecialChar LyX
6693 can be used to write articles for submission to the scientific journal
6695 Astronomy and Astrophysics
6698 \begin_inset CommandInset href
6701 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6706 ) using Version 9.1 of the document class
6711 information about it is available at
6712 \begin_inset Flex URL
6715 \begin_layout Plain Layout
6717 \change_inserted 564990737 1670794716
6719 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
6729 \begin_layout Standard
6731 \change_inserted 564990737 1670794716
6734 A manual comes together with the package and should be consulted before installing this document class as described in the
6736 Installing New Document Classe
6746 \begin_layout Standard
6748 \change_inserted 564990737 1670794716
6751 \begin_inset Note Greyedout
6754 \begin_layout Plain Layout
6756 \change_inserted 564990737 1670794716
6759 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
6761 That change also involved some slight changes to the style files,
6762 namely the removal of the thesaurus command.
6763 If you have an older version installed,
6765 For information about compatibility with the old (version 4) layout,
6766 please refer to the comments in
6769 Dir/layouts/aapaper.layout
6779 \begin_layout Subsubsection
6781 \change_inserted 564990737 1670794716
6787 \begin_layout Standard
6789 \change_inserted 564990737 1671617129
6792 It is recommended you start from the template in the menu
6797 ile\SpecialChar menuseparator
6799 \begin_inset space ~
6807 \begin_inset space ~
6812 \SpecialChar menuseparator
6813 Articles\SpecialChar menuseparator
6814 Astronomy & Astrophysics
6818 If you are not using the template,
6819 note the following settings:
6822 \begin_layout Itemize
6824 \change_inserted 564990737 1670794716
6836 ocument\SpecialChar menuseparator
6841 ettings\SpecialChar menuseparator
6843 \begin_inset space ~
6849 that one was obvious).
6852 \begin_layout Itemize
6854 \change_inserted 564990737 1670794716
6860 \begin_inset space ~
6872 \begin_inset space ~
6883 The whole layout is done by the macros,
6884 you shouldn't change anything.
6887 \begin_layout Subsubsection
6889 \change_inserted 564990737 1670794716
6895 \begin_layout Standard
6897 \change_inserted 564990737 1670794716
6900 First thing to enter is the header information.
6901 It consists of five entries,
6902 of which one is optional.
6906 \begin_layout Itemize
6908 \change_inserted 564990737 1670794716
6918 \begin_layout Itemize
6920 \change_inserted 564990737 1670794716
6930 \begin_layout Itemize
6932 \change_inserted 564990737 1670794716
6942 \begin_layout Itemize
6944 \change_inserted 564990737 1670794716
6954 \begin_layout Itemize
6956 \change_inserted 564990737 1670794716
6971 \begin_layout Standard
6973 \change_inserted 564990737 1670794716
6976 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
6977 just to get the best optics and meets the layout of the real document.
6980 \begin_layout Standard
6982 \change_inserted 564990737 1670794716
6985 If you want to place footnotes in the header block,
6987 \begin_inset space \thinspace{}
6991 \begin_inset space \space{}
6994 to state your present address,
6995 just use the standard footnote via the menu
7000 nsert\SpecialChar menuseparator
7009 will automagically use the term
7018 \begin_layout Standard
7020 \change_inserted 564990737 1670794716
7023 In addition to these topics,
7024 the macros use three additional \SpecialChar LaTeX
7025 commands that have no counterpart in \SpecialChar LyX
7029 \begin_layout Itemize
7031 \change_inserted 564990737 1670794716
7039 to separate different names for more than one author and institute,
7043 \begin_layout Itemize
7045 \change_inserted 564990737 1670794716
7053 to mark corresponding author/institute pairs.
7054 The institutes are numbered sequentially as they appear in the
7059 so you have to put a marker to each author.
7062 \begin_layout Itemize
7064 \change_inserted 564990737 1670794716
7072 to supply an email address for fast contact.
7075 \begin_layout Standard
7077 \change_inserted 564990737 1671642374
7081 the appropriate command has to be entered as \SpecialChar TeX
7082 code in \SpecialChar LyX
7084 See the examples in the template and in
7087 File\SpecialChar menuseparator
7088 Open Example\SpecialChar menuseparator
7089 Articles\SpecialChar menuseparator
7090 Astronomy & Astrophysics
7098 \begin_layout Subsubsection
7100 \change_inserted 564990737 1670794716
7106 \begin_layout Standard
7108 \change_inserted 564990737 1670794716
7111 The abstract should immediately follow the header block and must contain five tokens:
7121 \begin_layout Enumerate
7123 \change_inserted 564990737 1670794716
7129 (optional) {} leave it empty if necessary
7132 \begin_layout Enumerate
7134 \change_inserted 564990737 1670794716
7143 \begin_layout Enumerate
7145 \change_inserted 564990737 1670794716
7154 \begin_layout Enumerate
7156 \change_inserted 564990737 1670794716
7165 \begin_layout Enumerate
7167 \change_inserted 564990737 1670794716
7173 (optional) {} leave it empty if necessary
7176 \begin_layout Standard
7178 \change_inserted 564990737 1670794716
7182 This structure not shown in
7189 \begin_layout Subsubsection
7191 \change_inserted 564990737 1670794716
7194 Supported environments
7197 \begin_layout Standard
7199 \change_inserted 564990737 1670794716
7202 The A&A paper layout supports the following environments for structuring your text:
7205 \begin_layout Itemize
7207 \change_inserted 564990737 1670794716
7214 \begin_layout Itemize
7216 \change_inserted 564990737 1670794716
7223 \begin_layout Itemize
7225 \change_inserted 564990737 1670794716
7232 \begin_layout Itemize
7234 \change_inserted 564990737 1670794716
7241 \begin_layout Itemize
7243 \change_inserted 564990737 1670794716
7250 \begin_layout Itemize
7252 \change_inserted 564990737 1670794716
7259 \begin_layout Itemize
7261 \change_inserted 564990737 1670794716
7268 \begin_layout Itemize
7270 \change_inserted 564990737 1670794716
7277 \begin_layout Itemize
7279 \change_inserted 564990737 1670794716
7286 \begin_layout Itemize
7288 \change_inserted 564990737 1670794716
7295 \begin_layout Itemize
7297 \change_inserted 564990737 1670794716
7304 \begin_layout Itemize
7306 \change_inserted 564990737 1670794716
7314 \begin_layout Subsubsection
7316 \change_inserted 564990737 1670794716
7319 Commands not supported by \SpecialChar LyX
7323 \begin_layout Standard
7325 \change_inserted 564990737 1670794716
7328 Some commands are not yet supported by the
7332 layout for \SpecialChar LyX
7334 Some have already been mentioned.
7335 For the sake of completeness,
7336 they are listed all together here:
7339 \begin_layout Itemize
7341 \change_inserted 564990737 1670794716
7350 \begin_layout Itemize
7352 \change_inserted 564990737 1670794716
7361 \begin_layout Itemize
7363 \change_inserted 564990737 1670794716
7372 \begin_layout Itemize
7374 \change_inserted 564990737 1670794716
7383 \begin_layout Itemize
7385 \change_inserted 564990737 1670794716
7394 \begin_layout Standard
7396 \change_inserted 564990737 1670794716
7399 If you want to use any of these commands,
7400 you have to enter them yourself.
7403 Do not forget to use
7409 nsert\SpecialChar menuseparator
7412 \begin_inset space ~
7421 \begin_layout Subsubsection
7423 \change_inserted 564990737 1670794716
7426 Figure and Table Floats
7429 \begin_layout Standard
7431 \change_inserted 564990737 1670794716
7435 provides support for the necessary float environments
7446 therefore we won't tell much about it here.
7450 \begin_inset space ~
7456 Just remember that tables should be left-aligned.
7458 select the table and change the alignment in
7463 dit\SpecialChar menuseparator
7469 \begin_inset space ~
7475 \begin_layout Standard
7477 \change_inserted 564990737 1670794716
7480 There is only one special thing:
7481 the figures with a caption beside the figure.
7482 To create such a figure,
7483 you have to do the following:
7486 \begin_layout Enumerate
7488 \change_inserted 564990737 1670794716
7491 Create a wide figure float:
7497 nsert\SpecialChar menuseparator
7502 t\SpecialChar menuseparator
7507 from within the float,
7513 dit\SpecialChar menuseparator
7519 \begin_inset space ~
7530 \begin_inset space ~
7542 \begin_layout Enumerate
7544 \change_inserted 564990737 1670794716
7547 Enter your caption text.
7550 \begin_layout Enumerate
7552 \change_inserted 564990737 1670794716
7559 to move the cursor above the caption.
7562 \begin_layout Enumerate
7564 \change_inserted 564990737 1670794716
7570 \begin_layout Enumerate
7572 \change_inserted 564990737 1670794716
7575 Position the cursor after the figure and insert a horizontal fill by using the menu:
7581 nsert\SpecialChar menuseparator
7586 rmatting\SpecialChar menuseparator
7592 \begin_inset space ~
7601 dialog and select the
7615 \begin_layout Enumerate
7617 \change_inserted 564990737 1670794716
7620 Switch to \SpecialChar LaTeX
7625 \begin_inset space ~
7633 \begin_layout Enumerate
7635 \change_inserted 564990737 1670794716
7646 Do not close the brace!
7649 \begin_layout Enumerate
7651 \change_inserted 564990737 1670794716
7654 Position the cursor behind the caption text,
7655 switch to \SpecialChar LaTeX
7656 mode and insert the closing brace:
7660 \begin_inset space ~
7672 \begin_layout Standard
7674 \change_inserted 564990737 1671642458
7678 refer to the figures in the file in
7681 File\SpecialChar menuseparator
7682 Open Example\SpecialChar menuseparator
7683 Articles\SpecialChar menuseparator
7684 Astronomy & Astrophysics
7690 \begin_layout Subsubsection
7692 \change_inserted 564990737 1670794716
7698 \begin_layout Standard
7700 \change_inserted 564990737 1670794716
7704 the paper has to be formatted in a special double-spacing layout.
7706 you have to add the option
7717 \begin_inset space ~
7727 ocument\SpecialChar menuseparator
7732 ettings\SpecialChar menuseparator
7734 \begin_inset space ~
7743 \begin_layout Subsubsection
7745 \change_inserted 564990737 1670794716
7751 \begin_layout Standard
7753 \change_inserted 564990737 1671642520
7759 File\SpecialChar menuseparator
7760 Open Example\SpecialChar menuseparator
7761 Articles\SpecialChar menuseparator
7762 Astronomy & Astrophysics
7765 was written with \SpecialChar LyX
7767 It is the example paper from the original macro package,
7773 \begin_inset CommandInset href
7776 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
7782 but translated to \SpecialChar LyX
7783 using the older unstructured abstract type.
7784 Use it for inspiration,
7785 and compare the \SpecialChar LaTeX
7790 with the \SpecialChar LyX
7794 \begin_layout Subsection
7799 \begin_layout Standard
7805 \begin_layout Subsubsection
7809 \begin_layout Standard
7811 is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
7812 the Astrophysical Journal (including the Letters and Supplement),
7813 the Astronomical Journal,
7814 and the Publications of the Astronomical Society of the Pacific.
7816 has proven to be an excellent tool for generating these documents,
7817 especially given its equation,
7819 and figure handling capabilities.
7821 requires version 5.0 (or higher) of these macros;
7823 which is the version described here,
7825 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
7826 2.09 and are fundamentally incompatible with \SpecialChar LyX
7828 The AAS\SpecialChar TeX
7829 package may be downloaded from the AAS\SpecialChar TeX
7833 \begin_layout Standard
7834 \begin_inset VSpace medskip
7840 \begin_layout Standard
7842 \begin_inset Flex URL
7845 \begin_layout Plain Layout
7847 https://aas.org/aastex/aastex-downloads
7855 \begin_layout Standard
7856 \begin_inset VSpace medskip
7862 \begin_layout Standard
7863 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
7866 will not reduce the need to figure out all the AAS\SpecialChar TeX
7868 it will only reduce the drudgery of typing everything in.
7869 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
7870 document conforms completely to the requirements of the journal to which you are submitting your paper.
7873 \begin_layout Subsubsection
7874 Starting a New Paper
7877 \begin_layout Standard
7878 I strongly suggest that you start with the AAS\SpecialChar TeX
7882 File\SpecialChar menuseparator
7888 \change_inserted 564990737 1671617265
7889 \SpecialChar menuseparator
7890 Articles\SpecialChar menuseparator
7891 American Astronomical Society
7892 \change_deleted 564990737 1671617310
7896 enter the new file name,
7904 This will show the most common fields found in a manuscript.
7905 Simply overwrite the existing text (including the brackets,
7910 ) with the correct information.
7911 Many of the AAS\SpecialChar TeX
7912 commands and environments can be implemented directly in \SpecialChar LyX
7915 For commands such as these,
7916 the \SpecialChar LaTeX
7917 code must be entered directly and marked as such.
7918 Such commands are referred to as \SpecialChar TeX
7921 I tried to minimize the amount of \SpecialChar TeX
7922 code needed in an AAS\SpecialChar TeX
7926 \begin_layout Subsubsection
7927 Finishing Your Paper
7930 \begin_layout Standard
7931 When the paper is finished to your satisfaction and previews/prints correctly,
7933 \begin_inset Quotes eld
7937 \begin_inset Quotes erd
7940 actions which need to be done before you submit it to the journals.
7944 \begin_layout Enumerate
7945 Export your paper as a \SpecialChar LaTeX
7948 File\SpecialChar menuseparator
7949 Export\SpecialChar menuseparator
7957 \begin_layout Enumerate
7962 file with your favorite text editor
7966 \begin_layout Enumerate
7967 remove the comment lines before the
7976 \begin_layout Enumerate
7981 usepackage...{fontenc}
7983 line if it appears (usually just after
7999 \begin_layout Enumerate
8000 remove everything between (and including) the
8013 except for any commands you specifically put into the \SpecialChar LaTeX
8014 preamble (which should appear immediately after the
8015 \begin_inset Quotes eld
8018 User specified \SpecialChar LaTeX
8020 \begin_inset Quotes erd
8031 \begin_layout Enumerate
8032 Run the resulting file through \SpecialChar LaTeX
8033 to make sure it still processes correctly.
8036 \begin_layout Enumerate
8037 Reread the journal requirements to make sure your filenames and formats are correct.
8040 \begin_layout Enumerate
8044 \begin_layout Subsubsection
8045 Comments On Specific Commands
8048 \begin_layout Standard
8049 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8051 the AAS\SpecialChar TeX
8056 ) gives a good description of each.
8057 Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
8058 So let's begin \SpecialChar ldots
8062 \begin_layout Paragraph
8063 Things that work as expected
8066 \begin_layout Standard
8067 Because they work as you might expect,
8068 I simply list them and the section they are found in:
8185 begin{thebibliography}
8195 all the cite commands and their variations (2.13.2),
8196 the generic graphicx figure commands (2.14.1),
8225 amongst other places),
8256 \begin_layout Standard
8257 The following style options also work correctly:
8283 Simply put them in the
8289 Layout\SpecialChar menuseparator
8295 \begin_layout Paragraph
8297 but require more comment
8300 \begin_layout Standard
8301 The following items work,
8302 but require a little more discussion:
8305 \begin_layout Itemize
8306 These items are reserved for use by the journal editors,
8307 but you can put them into the \SpecialChar LaTeX
8308 preamble if you feel compelled to do so:
8346 \begin_layout Itemize
8347 These items may be placed in the \SpecialChar LaTeX
8349 and are included as blanks in the template file:
8373 \begin_layout Itemize
8380 (2.3) – can only be used
8381 \begin_inset Quotes eld
8385 \begin_inset Quotes erd
8389 not in the middle of a paragraph.
8390 Use \SpecialChar TeX
8391 code if you need to embed it.
8394 \begin_layout Itemize
8401 (2.3) – will have extra {} after it.
8402 This should not cause an error.
8405 \begin_layout Itemize
8412 (2.6) – can only be used
8413 \begin_inset Quotes eld
8417 \begin_inset Quotes erd
8421 not in the middle of a paragraph.
8422 Use \SpecialChar TeX
8423 code if you need to embed it.
8426 \begin_layout Itemize
8433 (2.8) – can't insert a cross-reference tag,
8434 you must type the tag name by hand
8437 \begin_layout Itemize
8451 \begin_layout Itemize
8458 (2.9) – will have extra {} after it.
8459 This should not cause an error.
8462 \begin_layout Itemize
8469 (2.11) – will have extra {} after it.
8470 This should not cause an error.
8473 \begin_layout Itemize
8480 (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
8482 Insert\SpecialChar menuseparator
8487 \begin_inset Quotes eld
8491 \begin_inset Quotes erd
8494 inserts an optional argument of the type needed by
8501 Hopefully it will be renamed someday.
8504 \begin_layout Itemize
8517 for the catalog ID optional parameter
8520 \begin_layout Itemize
8533 for the catalog ID optional parameter
8536 \begin_layout Paragraph
8537 Things not implemented,
8538 use \SpecialChar TeX
8542 \begin_layout Standard
8554 setcounter{equation}
8557 Journal name abbreviations (2.13.4),
8600 insert it as the first element in the lefthand cell after where you want it.
8601 Don't use any of \SpecialChar LyX
8602 's rules in the table),
8677 \begin_layout Paragraph
8678 Things that cannot be implemented
8681 \begin_layout Standard
8683 at least in any meaningful sort of way,
8684 so I suggest ignoring them.
8685 They are the references environment (2.13.3),
8686 and the deluxetable environment (2.15).
8688 really need to use deluxetable,
8689 I suggest editing it in a separate file with a text editor,
8692 Insert\SpecialChar menuseparator
8694 \begin_inset space ~
8699 to include it in your \SpecialChar LyX
8702 \change_deleted 564990737 1671642564
8708 \change_inserted 564990737 1671642618
8712 File\SpecialChar menuseparator
8713 Open Example\SpecialChar menuseparator
8714 Articles\SpecialChar menuseparator
8715 American Astronomical Society
8721 \change_inserted 564990737 1671642621
8727 \begin_layout Subsubsection
8731 and Other Ruminations
8734 \begin_layout Paragraph
8735 Getting \SpecialChar LyX
8736 and AAS\SpecialChar TeX
8740 \begin_layout Standard
8741 It can be a bit tricky to get \SpecialChar LyX
8742 to recognize a new layout and document class.
8743 When all else fails,
8747 \begin_layout Enumerate
8748 Make certain that \SpecialChar LaTeX
8749 can find AAS\SpecialChar TeX
8751 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
8752 distribution into a directory completely unrelated to \SpecialChar LaTeX
8753 or AAS\SpecialChar TeX
8754 and run \SpecialChar LaTeX
8762 \begin_layout Enumerate
8767 appears in \SpecialChar LyX
8775 \begin_layout Enumerate
8778 Tools\SpecialChar menuseparator
8783 then restart \SpecialChar LyX
8787 \begin_layout Enumerate
8788 Open a regular new file,
8789 not from a template.
8790 Does AAS\SpecialChar TeX
8791 appear in the class list in
8793 Document\SpecialChar menuseparator
8799 \begin_layout Standard
8800 If you get a warning from an existing AAS\SpecialChar TeX
8801 document about not being able to find the AAS\SpecialChar TeX
8802 layout or a message about
8803 \begin_inset Quotes eld
8806 You should not mix title layouts with normal ones
8807 \begin_inset Quotes erd
8811 things haven't been installed correctly.
8814 \begin_layout Paragraph
8816 error processing a table
8819 \begin_layout Standard
8823 attempts to center the table caption/title.
8824 This seems to produce a bad interaction in AAS\SpecialChar TeX
8825 so you should click somewhere in the caption/title,
8828 Edit\SpecialChar menuseparator
8830 \begin_inset space ~
8845 This took care of it for me.
8848 \begin_layout Paragraph
8852 \begin_layout Standard
8854 1) I have noticed some funny spacing in the reference entries in the text.
8855 When you enter the bibliography item data,
8860 space between the last author and the parenthesis setting off the year;
8864 \begin_inset space \thinspace{}
8868 \begin_inset space \space{}
8883 2) Entering the references at all is not obvious.
8884 The easiest thing is to start typing your first reference at the end of the document,
8885 then mark it as type
8890 That will put a small gray box in front of what you just typed.
8891 Click on the box to fill in the rest of the information.
8893 go to the end of an existing reference and press return.
8894 That will create a new line with its own box,
8898 \begin_layout Paragraph
8902 \begin_layout Standard
8903 Even though AAS\SpecialChar TeX
8904 provides its own figure commands (
8912 I much prefer \SpecialChar LaTeX
8913 's standard figure commands (with the default graphicx).
8922 \begin_inset space ~
8925 commands as \SpecialChar TeX
8926 code into a Figure Float box if you desire,
8927 but I never have much luck getting the layout right.
8928 With the standard graphics,
8934 usepackage{graphicx}
8936 command into the \SpecialChar LaTeX
8937 preamble and handle the figures in the standard \SpecialChar LaTeX2e
8939 interspersing the figures in the text.
8940 I believe ApJ accepts figures exactly this way now;
8941 AJ might still use the
8942 \begin_inset Quotes eld
8945 stack everything at the end
8946 \begin_inset Quotes erd
8952 \begin_layout Paragraph
8953 Things I could have done,
8957 \begin_layout Standard
8959 \begin_inset Quotes eld
8963 \begin_inset Quotes erd
8966 things I could have implemented,
8969 I saw no point in double-spacing the text in the \SpecialChar LyX
8971 even though it is double-spaced in the paper manuscript.
8973 I chose not to make separate layouts for the preprint and preprint2 styles.
8974 Since I assume you will spend most of your time in the plain manuscript mode anyway,
8975 I decided not to chew up more disk space with this.
8979 \begin_layout Subsubsection
8983 \begin_layout Standard
8984 Your mileage may vary.
8985 I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
8987 the last 2% was the \SpecialChar LaTeX
8988 post-processing and a few cleanups.
8989 I have had no trouble with the submission process,
8990 and I'm sure the journals were never aware that there might be a difference.
8992 go forth and publish!
8995 \begin_layout Subsection
8997 \change_inserted 564990737 1671442131
9003 \begin_layout Standard
9005 \change_inserted 564990737 1671642768
9011 \begin_inset space \thinspace{}
9020 document class together with the style
9024 to facilitate the description of chess games.
9028 File\SpecialChar menuseparator
9031 \SpecialChar menuseparator
9032 Articles\SpecialChar menuseparator
9051 \begin_layout Subsection
9053 \change_inserted 564990737 1671042028
9059 \begin_layout Standard
9061 \change_inserted 564990737 1671617396
9067 \begin_inset space \thinspace{}
9077 This provides the following additional environments:
9081 \begin_inset space ~
9090 \begin_inset space ~
9099 \begin_inset space ~
9119 A template is available in the menu
9124 ile\SpecialChar menuseparator
9126 \begin_inset space ~
9134 \begin_inset space ~
9139 \SpecialChar menuseparator
9140 Articles\SpecialChar menuseparator
9145 It has been customized with further environments and contains all the information you may need.
9147 the documentation is also available from
9148 \begin_inset CommandInset href
9151 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
9159 \begin_layout Subsection
9161 \change_inserted 564990737 1671042046
9167 \begin_layout Standard
9169 \change_inserted 564990737 1671042046
9175 \begin_inset space \thinspace{}
9180 provides an alternative to the
9185 It provides similar functionality,
9186 but you might prefer this layout with sans serif sections,
9191 \begin_layout Subsection
9196 \begin_layout Standard
9202 \begin_layout Standard
9203 \begin_inset VSpace bigskip
9209 \begin_layout Standard
9214 \begin_inset space ~
9219 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
9221 \begin_inset Formula $\beta$
9228 \begin_layout Standard
9235 which works with Rev\SpecialChar TeX
9238 v3.1 is basically obsolete,
9239 as it works with \SpecialChar LaTeX
9241 That means that it doesn't interact very well with \SpecialChar LyX
9243 which requires \SpecialChar LaTeX2e
9245 although it has been kludged to work.
9246 Since Rev\SpecialChar TeX
9247 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
9254 \begin_inset space ~
9259 textclass should also be pretty easy to use.
9262 \begin_layout Standard
9263 These documents are supposed to be used in
9267 to the Rev\SpecialChar TeX
9269 so we don't describe any of the special Rev\SpecialChar TeX
9271 and assume you'll know what to put in the preamble if necessary.
9274 \begin_layout Subsubsection
9278 \begin_layout Standard
9279 All you need to do is install Rev\SpecialChar TeX
9281 as described in the package's README file.
9282 The package can be found at The Rev\SpecialChar TeX
9284 \begin_inset Flex URL
9287 \begin_layout Plain Layout
9289 http://publish.aps.org/revtex4/
9295 Install it somewhere that \SpecialChar LaTeX
9297 Test it by trying to \SpecialChar LaTeX
9298 a short Rev\SpecialChar TeX
9299 4 document in some random directory (i.
9300 \begin_inset space \thinspace{}
9304 \begin_inset space \space{}
9307 not the directory where you installed the class file.) Then,
9308 if you reconfigure \SpecialChar LyX
9310 it will find the class file and let you use the Rev\SpecialChar TeX
9314 \begin_layout Standard
9315 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
9324 \begin_inset space ~
9330 found in the templates directory.
9333 \begin_layout Subsubsection
9337 \begin_layout Standard
9338 Optional arguments to
9346 \begin_inset Quotes eld
9350 \begin_inset Quotes erd
9354 \begin_inset Quotes eld
9358 \begin_inset Quotes erd
9365 \begin_inset space ~
9373 \begin_inset space ~
9380 Remember that in Rev\SpecialChar TeX
9382 at least one optional argument is required!
9386 \begin_layout Standard
9387 Other preamble matter,
9395 \begin_inset space ~
9402 \begin_inset space ~
9411 \begin_layout Subsubsection
9415 \begin_layout Standard
9416 The layouts basically correspond to the commands in Rev\SpecialChar TeX
9419 the Email layout corresponds to
9426 Note that (at least as of Rev\SpecialChar TeX
9436 layouts are exactly equivalent,
9437 so you shouldn't need to use both.
9441 \begin_layout Plain Layout
9442 In case you're curious,
9443 both were included so that
9447 would be able to translate both
9467 \begin_layout Subsubsection
9471 \begin_layout Standard
9472 There are a couple of important unique aspects of Rev\SpecialChar TeX
9473 4 which might cause bugs that will be even more confusing in \SpecialChar LyX
9477 \begin_layout Standard
9478 In Rev\SpecialChar TeX
9497 The \SpecialChar LyX
9498 equivalent is that there is a separate Thanks layout.
9503 write footnotes in the
9508 or weird things may happen.
9509 See the Rev\SpecialChar TeX
9510 4 documentation for more details.
9513 \begin_layout Standard
9518 \begin_inset space ~
9527 \begin_inset space ~
9537 layouts must be placed
9545 layout and the corresponding
9563 the \SpecialChar LaTeX
9567 \begin_layout Subsection
9569 \change_inserted 564990737 1671042072
9575 \begin_layout Standard
9577 \change_inserted 564990737 1671042072
9584 classes were replaced in 2013 with a completely new
9589 This package provides a \SpecialChar LaTeX
9590 class and templates for books to be published at Springer Gabler Research,
9591 Springer Vieweg Research,
9592 Springer Spektrum Research,
9593 Springer VS Research,
9594 or Springer VS Forschung.
9595 The documentation is available in German from
9596 \begin_inset CommandInset href
9599 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
9607 \begin_layout Section
9609 \change_inserted 564990737 1670439560
9613 \begin_layout Standard
9615 \change_inserted 564990737 1670439581
9616 See also the document classes in the Collections (section
9617 \begin_inset space ~
9621 \begin_inset CommandInset ref
9623 reference "sec:Collections"
9631 \begin_layout Subsection
9635 \begin_layout Standard
9641 \begin_layout Subsubsection
9645 \begin_layout Standard
9646 Memoir is a very powerful and constantly evolving class.
9647 It has been designed with regard to fictional and non-fictional literature.
9648 Its aim is to let the user have maximum control over the typesetting of his document.
9649 Memoir is based on the standard book class,
9650 but it can also emulate the article class (see below).
9653 \begin_layout Standard
9655 the developer of Memoir,
9656 is known as the author of lots of useful packages in the \SpecialChar LaTeX
9658 Most of them have been merged with Memoir.
9660 it is much easier to layout the table of contents,
9662 chapter designs and such.
9666 does not support all of these goodies natively.
9667 Some of them might be added to forthcoming releases
9671 \begin_layout Plain Layout
9672 You are invited to send suggestions to
9673 \begin_inset Flex URL
9676 \begin_layout Plain Layout
9678 lyx-devel@lists.lyx.org
9689 lots will probably never be supported,
9690 due to the limitations of \SpecialChar LyX
9692 Of course you can still use all features with the help of some native \SpecialChar LaTeX
9693 commands (\SpecialChar TeX
9698 \begin_layout Plain Layout
9703 \begin_layout Plain Layout
9713 \begin_inset space ~
9717 \begin_inset CommandInset ref
9719 reference "sec:Inserting-TeX-Code"
9731 we can only list those features that are natively supported by \SpecialChar LyX
9733 For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
9737 \begin_layout Plain Layout
9742 \begin_layout Plain Layout
9752 \begin_inset Flex URL
9755 \begin_layout Plain Layout
9757 CTAN:/macros/latex/memoir/memman.pdf
9768 which is not only a user guide for the class,
9769 but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
9772 \begin_layout Subsubsection
9773 Basic features and restrictions
9776 \begin_layout Standard
9777 Memoir supports basically all features of the standard book classes.
9784 \begin_layout Description
9786 \begin_inset space ~
9790 Memoir has a broader range of font sizes:
9799 \begin_layout Description
9801 \begin_inset space ~
9805 The fancy page style is not supported,
9806 due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
9807 which confuses \SpecialChar LaTeX
9810 Memoir comes with a number of its own page styles (see
9812 Document\SpecialChar menuseparator
9813 Settings\SpecialChar menuseparator
9815 \begin_inset space ~
9821 If you want to use these for the chapter pages,
9822 you have to use the command
9828 in the main text or in preamble (e.
9829 \begin_inset space \thinspace{}
9833 \begin_inset space \space{}
9840 chapterstyle{companion}
9845 \begin_layout Description
9847 Sectionings (chapter,
9849 subsection etc.) come with an optional argument in the standard classes.
9851 you can specify an alternative version of the title for the table of contents and the headers (for instance,
9852 if the title is too long).
9857 Insert\SpecialChar menuseparator
9859 \begin_inset space ~
9864 at the beginning of a chapter/section.
9865 Memoir features a second optional argument and thus separates the table of contents from the header.
9866 You can define three variants of a title with this:
9867 one for the main text,
9868 one for the table of contents,
9869 and one for the headers.
9871 makes these available in form of specific
9882 \begin_layout Description
9884 In the standard classes (and in many other classes),
9885 the table of contents,
9886 the list of figures and the list of table start a new page automatically.
9887 Memoir does not follow this route.
9888 You have to insert a page break yourself,
9889 if you want to have one.
9892 \begin_layout Description
9894 For some unknown reason,
9895 Memoir uses pagination on the title page (in the standard classes,
9897 \begin_inset Quotes eld
9901 \begin_inset Quotes erd
9905 If you want an empty title page,
9910 aliaspagestyle{title}{empty}
9915 \begin_layout Description
9917 With the class option
9923 Document\SpecialChar menuseparator
9924 Settings\SpecialChar menuseparator
9925 Class Settings\SpecialChar menuseparator
9927 \begin_inset space ~
9933 you can emulate article style.
9935 counters (footnotes,
9937 tables etc.) will not be reset on new chapters,
9938 chapters don't start a new page (but are—
9940 \begin_inset Quotes eld
9944 \begin_inset Quotes erd
9955 \begin_layout Description
9958 Memoir does not allow the use of the deprecated font commands,
9959 which have been used in the old \SpecialChar LaTeX
9961 \begin_inset space \thinspace{}
9965 \begin_inset space \space{}
9982 It produces an error and stops \SpecialChar LaTeX
9983 whenever such a command appears.
9988 reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
9990 Since a lot of packages and particularly Bib\SpecialChar TeX
9991 style files are still using those commands,
9992 we have decided to use this option by default.
9995 \begin_layout Subsubsection
9999 \begin_layout Standard
10000 We will only describe the features supported by \SpecialChar LyX
10001 (which is not much currently).
10002 Please consult the Memoir manual
10006 \begin_layout Plain Layout
10011 \begin_layout Plain Layout
10021 \begin_inset Flex URL
10024 \begin_layout Plain Layout
10026 CTAN:/macros/latex/memoir/memman.pdf
10039 \begin_layout Description
10041 You may wonder why an abstract is an extra feature.
10043 it is in book class.
10044 Usually books don't have abstracts.
10048 You can use it wherever and how often you like.
10051 \begin_layout Description
10053 You may know this older typesetting style:
10054 The contents of a chapter are summarized below the title and also in the table of contents (e.
10055 \begin_inset space \thinspace{}
10059 \begin_inset space \space{}
10064 Our hero arrives in Troia;
10065 he loses some friends;
10069 Chapterprecis does exactly this.
10070 It is therefore only sensible below a chapter.
10073 \begin_layout Description
10075 An epigraph is a smart slogan or motto at the beginning of a chapter.
10076 The epigraph environment provides an elegant way of typesetting such a motto.
10077 The motto itself (text) and its (optional) author (source) are divided by a short line.
10078 The author (source) can be inserted via
10080 Insert\SpecialChar menuseparator
10087 \begin_layout Description
10089 Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
10091 can only support a few of them.
10093 which is a centered title for poems,
10094 which will also be added to the table of contents (verse is the standard environment for poems.
10095 Memoir has some enhanced versions of verse,
10096 but you need to use \SpecialChar TeX
10098 because they have to be nested inside regular verse environments,
10099 which is not possible with \SpecialChar LyX
10103 \begin_layout Description
10106 but it adds no entry to the table of contents.
10109 \begin_layout Subsection
10111 \change_inserted 564990737 1671442175
10117 \begin_layout Standard
10119 \change_inserted 564990737 1671442175
10129 \begin_inset space \thinspace{}
10134 document class but adds two environments:
10137 \begin_layout Description
10139 \change_inserted 564990737 1671442175
10142 Recipe a numbered section environment at the
10146 level which generates a bold centered heading above a double horizontal rule
10149 \begin_layout Description
10151 \change_inserted 564990737 1671442175
10164 are what are being described and the environment ends with a horizontal rule.
10167 \begin_layout Standard
10169 \change_inserted 564990737 1671642866
10173 File\SpecialChar menuseparator
10174 Open Example\SpecialChar menuseparator
10175 Books\SpecialChar menuseparator
10179 illustrates its use.
10182 \begin_layout Standard
10184 \change_inserted 564990737 1671442175
10187 It is designed for typesetting one or two recipes per page,
10188 with dimensions of 5.5
10189 \begin_inset Quotes qrd
10193 \begin_inset Quotes qrd
10197 The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient,
10198 and the pages can be joined together or printed 2 per page to normal letterpaper easily.
10199 The size was chosen to work in half-page 3-ring binder cover sheets,
10200 because un-laminated paper just doesn't last in the kitchen.
10203 \begin_layout Standard
10205 \change_inserted 564990737 1671442175
10208 The half-letter pages can be printed two per page using your printer driver,
10209 or bound together using
10211 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
10221 is the compiled version of your recipes.
10224 \begin_layout Section
10226 \change_inserted 564990737 1671442207
10230 \begin_layout Subsection
10232 \change_inserted 564990737 1671442208
10238 \begin_layout Standard
10240 \change_inserted 564990737 1671642942
10246 \begin_inset space \space{}
10250 \begin_inset space \thinspace{}
10260 an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
10264 File\SpecialChar menuseparator
10265 Open Example\SpecialChar menuseparator
10266 Curricula Vitae\SpecialChar menuseparator
10270 offers guidance on its use.
10271 Its documentation is available from
10272 \begin_inset CommandInset href
10275 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
10283 \begin_layout Subsection
10285 \change_inserted 564990737 1671442208
10291 \begin_layout Standard
10293 \change_inserted 564990737 1671642984
10299 \begin_inset space \space{}
10303 \begin_inset space \thinspace{}
10313 an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
10317 File\SpecialChar menuseparator
10318 Open Example\SpecialChar menuseparator
10319 Curricula Vitae\SpecialChar menuseparator
10323 offers guidance on its use.
10324 Its documentation is available from
10325 \begin_inset CommandInset href
10328 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
10336 \begin_layout Subsection
10338 \change_inserted 564990737 1671442208
10344 \begin_layout Standard
10346 \change_inserted 564990737 1671643003
10352 \begin_inset space \space{}
10356 \begin_inset space \thinspace{}
10366 This allows the creation of customizable CVs.
10370 File\SpecialChar menuseparator
10371 Open Example\SpecialChar menuseparator
10372 Curricula Vitae\SpecialChar menuseparator
10376 offers guidance on its use.
10377 Its documentation is available from
10378 \begin_inset CommandInset href
10381 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
10389 \begin_layout Subsection
10391 \change_inserted 564990737 1671442208
10397 \begin_layout Standard
10399 \change_inserted 564990737 1671643024
10405 \begin_inset space \space{}
10409 \begin_inset space \thinspace{}
10419 originally developed for use with \SpecialChar LyX
10424 File\SpecialChar menuseparator
10425 Open Example\SpecialChar menuseparator
10426 Curricula Vitae\SpecialChar menuseparator
10430 offers guidance on its use.
10431 Its documentation is available from
10432 \begin_inset CommandInset href
10435 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
10443 \begin_layout Section
10445 \change_inserted 564990737 1672652454
10449 \begin_layout Standard
10451 \change_inserted 564990737 1672652455
10457 \begin_inset space \space{}
10463 \begin_inset space ~
10467 \begin_inset CommandInset ref
10469 reference "subsec:The-new-letter"
10477 \begin_inset space \space{}
10480 (with extra font sizes)
10483 \begin_inset space ~
10487 \begin_inset CommandInset ref
10489 reference "subsec:Extra-font-sizes"
10494 ) document classes .
10497 \begin_layout Subsection
10499 \change_inserted 564990737 1671041970
10505 \begin_layout Standard
10507 \change_inserted 564990737 1671617528
10518 document class for writing letters according to the
10520 Deutsches Institut für Normung
10523 The file in the menu
10528 ile\SpecialChar menuseparator
10530 \begin_inset space ~
10538 \begin_inset space ~
10541 Template\SpecialChar menuseparator
10542 Letters\SpecialChar menuseparator
10545 offers guidance on its use.
10546 The documentation is available from
10547 \begin_inset CommandInset href
10550 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
10558 \begin_layout Subsection
10560 \change_inserted 564990737 1672652499
10566 \begin_layout Standard
10568 \change_inserted 564990737 1672652499
10574 \begin_inset space \space{}
10583 document class for writing letters according to French conventions.
10584 The file in the menu
10589 ile\SpecialChar menuseparator
10591 \begin_inset space ~
10599 \begin_inset space ~
10602 Template\SpecialChar menuseparator
10603 Letters\SpecialChar menuseparator
10605 \begin_inset space \space{}
10610 offers guidance on its use.
10613 \begin_layout Subsection
10615 \change_inserted 564990737 1672652499
10621 \begin_layout Standard
10623 \change_inserted 564990737 1672652499
10629 \begin_inset space \thinspace{}
10638 document class for writing letters in German.
10639 The file in the menu
10644 ile\SpecialChar menuseparator
10646 \begin_inset space ~
10654 \begin_inset space ~
10657 Template\SpecialChar menuseparator
10658 Letters\SpecialChar menuseparator
10660 \begin_inset space \thinspace{}
10665 offers guidance on its use.
10666 The documentation is available from
10667 \begin_inset CommandInset href
10670 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
10678 \begin_layout Subsection
10680 \change_inserted 564990737 1671458835
10686 \begin_layout Standard
10688 \change_inserted 564990737 1671617591
10699 document class for English letters and to create mailing labels.
10700 The file in the menu
10705 ile\SpecialChar menuseparator
10707 \begin_inset space ~
10715 \begin_inset space ~
10718 Template\SpecialChar menuseparator
10719 Letters\SpecialChar menuseparator
10720 Letter (Standard Class)
10722 offers guidance on its use.
10725 \begin_layout Subsection
10727 \change_inserted 564990737 1672652527
10733 \begin_layout Standard
10735 \change_inserted 564990737 1672652527
10741 \begin_inset space \space{}
10750 document class for writing letters,
10751 faxes and envelopes in French.
10752 The file in the menu
10757 ile\SpecialChar menuseparator
10759 \begin_inset space ~
10767 \begin_inset space ~
10770 Template\SpecialChar menuseparator
10771 Letters\SpecialChar menuseparator
10773 \begin_inset space \space{}
10778 offers guidance on its use.
10779 The documentation is available from
10780 \begin_inset CommandInset href
10783 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
10791 \begin_layout Section
10793 \change_inserted 564990737 1670439660
10797 \begin_layout Subsection
10799 \change_inserted 564990737 1671458922
10805 \begin_layout Standard
10807 \change_inserted 564990737 1671617655
10813 \begin_inset space \thinspace{}
10822 document class for creating presentations.
10823 The file in the menu
10828 ile\SpecialChar menuseparator
10830 \begin_inset space ~
10838 \begin_inset space ~
10841 Template\SpecialChar menuseparator
10842 Presentations\SpecialChar menuseparator
10845 offers guidance on its use.
10846 The documentation is available from
10847 \begin_inset CommandInset href
10850 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
10858 \begin_layout Subsection
10861 Foil\SpecialChar TeX
10865 \begin_inset CommandInset label
10874 \begin_layout Standard
10876 \change_inserted 564990737 1672743383
10884 updated by the \SpecialChar LyX
10888 \begin_layout Subsubsection
10890 \change_inserted 564990737 1672743383
10896 \begin_layout Standard
10898 \change_inserted 564990737 1672743396
10904 \begin_inset space \thinspace{}
10907 (Foil\SpecialChar TeX
10914 document class to make slides for overhead projectors.
10915 There are two document classes that can do this:
10919 \begin_inset space \thinspace{}
10924 document class (section
10925 \begin_inset space ~
10929 \begin_inset CommandInset ref
10931 reference "sec:slitex"
10941 Foil\SpecialChar TeX
10945 As of 2023 the former has continued to be maintained whereas
10947 Foil\SpecialChar TeX
10950 has not been maintained since 2008.
10951 This section documents the latter.
10952 If your machine doesn’t have the
10955 \begin_inset space \thinspace{}
10958 (Foil\SpecialChar TeX
10961 document class installed,
10962 you’ll probably have to use the
10965 \begin_inset space \thinspace{}
10971 If you want to install the
10976 it is available from
10977 \begin_inset CommandInset href
10980 target "https://www.ctan.org/pkg/foiltex"
10986 You should also read the
10988 Installing New Document Classes
10995 \change_deleted 564990737 1672743436
11003 \begin_layout Standard
11005 \change_deleted 564990737 1672743383
11009 \begin_layout Standard
11011 \change_deleted 564990737 1672743383
11012 This section describes how to use \SpecialChar LyX
11013 to make slides for overhead projectors.
11014 There are two document classes that can do this:
11015 the default slides class and the
11017 Foil\SpecialChar TeX
11021 This section documents the latter.
11024 \begin_layout Standard
11026 \change_deleted 564990737 1672743383
11027 I'm going to say this again,
11029 so that there's no misunderstanding:
11032 \begin_layout Standard
11034 \change_deleted 564990737 1672743383
11035 \begin_inset VSpace bigskip
11041 \begin_layout Standard
11044 \change_deleted 564990737 1672743383
11047 This section documents the class
11048 \begin_inset Quotes eld
11056 \begin_inset Quotes erd
11064 \begin_layout Standard
11066 \change_deleted 564990737 1672743383
11067 \begin_inset VSpace bigskip
11073 \begin_layout Standard
11075 \change_deleted 564990737 1672743383
11076 If you're looking for the documentation for
11077 \begin_inset Quotes eld
11085 \begin_inset Quotes erd
11090 \begin_inset space ~
11094 \begin_inset CommandInset ref
11096 reference "sec:slitex"
11102 If your machine doesn't have the
11111 you'll probably have to use the default
11116 which isn't quite as good as
11121 \begin_layout Standard
11123 \change_deleted 564990737 1672743383
11128 class is designed for use with version
11129 \begin_inset space ~
11137 class file which is now an integral part of \SpecialChar LaTeX2e
11143 \begin_layout Subsubsection
11147 \begin_layout Standard
11149 to use this document class,
11161 \begin_inset space ~
11167 There are some settings in the
11170 \begin_inset space ~
11175 dialog that you should know about that are specific to this class:
11178 \begin_layout Itemize
11179 Don't change the options
11190 \begin_inset space ~
11196 They're ignored by the
11203 \begin_layout Itemize
11204 The default font size is 20
11205 \begin_inset space \thinspace{}
11208 pt with the other options being 17
11209 \begin_inset space \thinspace{}
11214 \begin_inset space \thinspace{}
11218 \begin_inset space \thinspace{}
11224 \begin_layout Itemize
11225 The default font is
11233 but all math equations are still typeset in the usual roman font.
11236 \begin_layout Itemize
11239 Foil\SpecialChar TeX
11242 supports A4 and Letter paper sizes as well as a special size for working with 35
11243 \begin_inset space \thinspace{}
11247 It doesn't support A5,
11249 legal or executive paper sizes.
11252 \begin_layout Itemize
11253 Don't bother changing the
11257 settings because they are ignored anyway.
11258 All floats appear where they are defined in the text.
11261 \begin_layout Itemize
11266 setting behaves a bit differently for this class.
11269 Foil\SpecialChar TeX
11272 provides extensive footer and header capabilities including a user-defined logo.
11274 \begin_inset space ~
11278 \begin_inset CommandInset ref
11280 reference "sec:foilfoot"
11286 The title page is treated differently to all other pages in the document and is
11294 has the logo centered at the bottom of the page (if one is defined).
11295 The possible page style choices and what they do are as follows:
11299 \begin_layout Labeling
11300 \labelwidthstring MMMMMMM
11307 The final output contains no page numbers,
11308 or other headers or footers (except footnotes of course).
11312 \begin_layout Labeling
11313 \labelwidthstring MMMMMMM
11320 The final output contains page numbers centered at the bottom of the page.
11321 No other headings or footers (other than footnotes).
11324 \begin_layout Labeling
11325 \labelwidthstring MMMMMMM
11330 Page numbers in lower right corner.
11331 Additional headers and footers are also shown.
11332 This is also the default.
11335 \begin_layout Labeling
11336 \labelwidthstring MMMMMMM
11341 Gives you access to the
11345 package although its use with
11347 Foil\SpecialChar TeX
11350 is discouraged by the writer of the
11352 Foil\SpecialChar TeX
11355 package because of some potential page layout clashes.
11359 \begin_layout Paragraph
11363 \begin_layout Standard
11364 The following options may be used in the extra class options in the
11366 Document\SpecialChar menuseparator
11372 \begin_layout Labeling
11373 \labelwidthstring MMMMMMx
11378 This sets up the page layout for 7.33
11379 \begin_inset space \thinspace{}
11383 \begin_inset space \thinspace{}
11387 which is about the same aspect ratio as a 35
11388 \begin_inset space \thinspace{}
11392 making it a bit easier to work with this medium.
11395 \begin_layout Labeling
11396 \labelwidthstring MMMMMMx
11401 Places a rule across the page below the header on every page except the title page.
11404 \begin_layout Labeling
11405 \labelwidthstring MMMMMMx
11410 Places a rule across the page above the footer on every page except the title page.
11413 \begin_layout Labeling
11414 \labelwidthstring MMMMMMx
11419 This is automatically set each time you create a new
11426 Foil\SpecialChar TeX
11429 to use the dvips driver to rotate those pages that are set as landscape foils.
11432 \begin_layout Labeling
11433 \labelwidthstring MMMMMMx
11438 Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
11439 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.
11440 Note that this option effectively reverses the roles of the
11448 environments (don't worry these are described in the next section).
11451 \begin_layout Labeling
11452 \labelwidthstring MMMMMMx
11457 Equation numbers on the left.
11460 \begin_layout Labeling
11461 \labelwidthstring MMMMMMx
11466 Flush-left equations.
11469 \begin_layout Subsubsection
11470 Supported Environments
11473 \begin_layout Standard
11474 Most of the environments commonly supported in other classes are also supported by the
11479 There are several additional environments provided by
11481 Foil\SpecialChar TeX
11484 as well as a couple added by \SpecialChar LyX
11486 The following environments are shared with other classes:
11489 \begin_layout Standard
11490 \begin_inset Flex Multiple Columns
11493 \begin_layout Itemize
11499 \begin_layout Itemize
11505 \begin_layout Itemize
11511 \begin_layout Itemize
11517 \begin_layout Itemize
11523 \begin_layout Itemize
11530 \begin_layout Itemize
11536 \begin_layout Itemize
11542 \begin_layout Itemize
11548 \begin_layout Itemize
11554 \begin_layout Itemize
11560 \begin_layout Itemize
11566 \begin_layout Itemize
11572 \begin_layout Itemize
11578 \begin_layout Itemize
11589 \begin_layout Standard
11591 all the major environments apart from the sectioning environments.
11592 Since foils are essentially self-contained sections,
11593 with a title and body,
11596 Foil\SpecialChar TeX
11599 provides specific commands for starting new foils and these are:
11602 \begin_layout Itemize
11608 \begin_layout Itemize
11614 \begin_layout Standard
11616 also provides slightly modified versions of these two environments called:
11619 \begin_layout Itemize
11625 \begin_layout Itemize
11628 ShortRotatefoilhead
11631 \begin_layout Standard
11632 and the differences will be explained in the next section.
11635 \begin_layout Standard
11636 Since foils are often used in presenting ideas or new theorems and such
11638 Foil\SpecialChar TeX
11641 also provides a comprehensive box of goodies for presenting them:
11644 \begin_layout Standard
11645 \begin_inset Flex Multiple Columns
11648 \begin_layout Itemize
11654 \begin_layout Itemize
11660 \begin_layout Itemize
11666 \begin_layout Itemize
11672 \begin_layout Itemize
11678 \begin_layout Itemize
11684 \begin_layout Itemize
11690 \begin_layout Itemize
11696 \begin_layout Itemize
11702 \begin_layout Itemize
11708 \begin_layout Itemize
11719 \begin_layout Standard
11720 The starred versions are unnumbered while the unstarred versions are numbered.
11721 There are also two list environments added by \SpecialChar LyX
11725 \begin_layout Itemize
11731 \begin_layout Itemize
11737 \begin_layout Standard
11740 Foil\SpecialChar TeX
11743 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.
11744 If you want to change these settings in your document the best place to do so is at the very top of a foil,
11746 \begin_inset space \thinspace{}
11752 \begin_inset space \space{}
11757 straight after the foilhead.
11760 \begin_layout Standard
11762 the following command styles are provided [
11769 \begin_layout Standard
11770 \begin_inset Flex Multiple Columns
11773 \begin_layout Itemize
11777 \begin_inset space ~
11783 \begin_layout Itemize
11789 \begin_layout Itemize
11793 \begin_inset space ~
11799 \begin_layout Itemize
11803 \begin_inset space ~
11809 \begin_layout Itemize
11813 \begin_inset space ~
11820 \begin_layout Plain Layout
11821 \begin_inset space ~
11833 \begin_layout Standard
11834 There are also a few commands provided by
11836 Foil\SpecialChar TeX
11839 that aren't directly supported by \SpecialChar LyX
11840 but I'll tell you what they do and how to use them in section
11841 \begin_inset space ~
11845 \begin_inset CommandInset ref
11847 reference "sec:unsuppfoils"
11855 \begin_layout Subsubsection
11856 Building a Set of Foils
11859 \begin_layout Standard
11860 This section will give a simple introduction to using the different environments to build a set of foils.
11861 If you want to see an example set of foils,
11863 \change_deleted 564990737 1671643085
11868 file you find in \SpecialChar LyX
11874 \change_inserted 564990737 1671643099
11878 File\SpecialChar menuseparator
11881 \SpecialChar menuseparator
11882 Presentations\SpecialChar menuseparator
11890 \begin_layout Paragraph
11891 Give It a Title Page
11894 \begin_layout Standard
11895 Unlike other classes that provide
11918 creates the title on a page of its own.
11919 If you leave out the
11923 environment \SpecialChar LaTeX
11924 will substitute the current date (every time you regenerate the output).
11927 \begin_layout Paragraph
11931 \begin_layout Standard
11932 As I mentioned earlier,
11933 there are four ways of starting a new foil.
11934 For portrait foils you should use
11943 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.
11946 \begin_layout Standard
11947 Landscape foils are generated using the
11953 ShortRotatefoilhead
11956 Again the only difference is the spacing between foilhead and body.
11957 Both of the short versions have 0.5
11958 \begin_inset space ~
11961 inches less separation between the foilhead and the body.
11965 \begin_layout Standard
11966 One problem with the support for landscape foils is the requirement that you have to use the
11970 driver to generate the PostScript output otherwise the foils won't be rotated.
11971 It is possible to get landscape foils even if you haven't got the
11975 driver provided you can feed your foils sideways through your printer ;-)
11978 \begin_layout Paragraph
11984 \begin_layout Standard
11985 You can't have two of the same type of these environments directly following each other.
11986 If you use a normal paragraph break,
11988 you will just be extending the previous environment as if you had merged the two environments together.
11990 you need to insert a so-called separator.
11991 Please refer to the section entitled
12002 \begin_layout Paragraph
12006 \begin_layout Standard
12007 You get all the commonly supported list styles found in other classes as well as two new ones.
12008 I'll only describe the new ones here.
12009 If you want to find out more about the other list environments check out the
12014 If you intend to use itemized lists you might also want to read about the
12017 \begin_inset space ~
12021 \begin_inset space ~
12026 dialog described above in section
12027 \begin_inset space ~
12031 \change_inserted 564990737 1671355684
12033 \begin_inset CommandInset ref
12035 reference "chap:bullets"
12041 \change_deleted 564990737 1671355684
12043 \begin_inset CommandInset ref
12045 reference "sec:bullet"
12055 \begin_layout Standard
12056 The two new list styles,
12066 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.
12067 These lists are in fact dedicated variants of the
12072 They do however require that you have the
12076 packages installed.
12079 \begin_layout Paragraph
12083 \begin_layout Standard
12086 Foil\SpecialChar TeX
12089 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.
12090 In fact if you change the float placement settings they are simply ignored.
12093 \begin_layout Paragraph
12094 Page Headers and Footers
12095 \begin_inset CommandInset label
12097 name "sec:foilfoot"
12104 \begin_layout Standard
12108 \begin_inset space ~
12117 are two commands used to control the left-footer text string.
12118 The first is meant to allow you to include a graphic logo on your foils and defaults to
12119 \begin_inset Quotes eld
12124 Foil\SpecialChar TeX
12128 \begin_inset Quotes erd
12132 While the second is meant to provide a classification for the audience,
12136 \begin_inset space \thinspace{}
12142 \begin_inset space \space{}
12146 It is empty by default.
12149 \begin_layout Standard
12150 The remaining page corners can be filled by
12153 \begin_inset space ~
12158 (which defaults to page numbers),
12162 \begin_inset space ~
12170 \begin_inset space ~
12178 \begin_layout Subsubsection
12181 Foil\SpecialChar TeX
12185 \begin_inset CommandInset label
12187 name "sec:unsuppfoils"
12194 \begin_layout Standard
12195 All the commands mentioned below need to be set in a
12205 within another environment.
12208 \begin_layout Paragraph
12212 \begin_layout Standard
12213 All lengths are adjusted using the
12236 should be replaced by the name given to the length you want to change and
12240 is the length value.
12241 All lengths should be specified in units of length such as inches (
12254 ) or relative to some document or font-based length such as
12264 \begin_layout Standard
12265 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
12278 \begin_inset space \space{}
12281 in closer to their bodies put the following in the preamble:
12288 foilheadskip}{-0.5in}
12291 \begin_layout Standard
12292 The spacings around floats can be adjusted by setting these lengths:
12295 \begin_layout Labeling
12296 \labelwidthstring MMMMMMMMMMM
12303 Separation between the text and the top of the float
12306 \begin_layout Labeling
12307 \labelwidthstring MMMMMMMMMMM
12314 Separation between the float and the caption
12317 \begin_layout Labeling
12318 \labelwidthstring MMMMMMMMMMM
12325 Separation between the caption and the following text
12328 \begin_layout Labeling
12329 \labelwidthstring MMMMMMMMMMM
12336 You can make the captions narrower than the surrounding text by adjusting this length.
12337 Best done relative to
12346 \begin_layout Standard
12347 There are also several title page related lengths that you may find useful if you have a long title or several authors:
12350 \begin_layout Labeling
12351 \labelwidthstring MMMMMMMMMMM
12358 Separation from headers to
12363 \begin_layout Labeling
12364 \labelwidthstring MMMMMMMMMMM
12382 \begin_layout Labeling
12383 \labelwidthstring MMMMMMMMMMM
12397 \begin_layout Labeling
12398 \labelwidthstring MMMMMMMMMMM
12414 \begin_layout Labeling
12415 \labelwidthstring MMMMMMMMMMM
12431 \begin_layout Standard
12432 The last length related command affects all the list environments.
12443 a list environment then all the vertical spacing between the list items is removed.
12444 Note that this is a command not a length so it doesn't require
12450 like the stuff mentioned above.
12453 \begin_layout Paragraph
12454 Headers and Footers
12457 \begin_layout Standard
12470 commands control whether the logo in the
12474 definition appear on a given page.
12481 in the preamble then none of the foils will have the logo on them.
12482 If you don't want the logo on a particular page place the
12488 directly after the foilhead of that page and the
12494 directly after the next foilhead.
12497 \begin_layout Standard
12498 If you decide to use the
12502 page style setting in the
12505 \begin_inset space ~
12510 dialog you should probably add
12520 to your preamble so headers and footers on landscape pages are correctly placed when rotated.
12521 This is due to some clashes between the page layouts provided by the
12532 \begin_layout Subsection
12534 \change_inserted 564990737 1671459032
12540 \begin_layout Standard
12542 \change_inserted 564990737 1671643165
12548 \begin_inset space \thinspace{}
12557 document class for creating presentations.
12561 File\SpecialChar menuseparator
12562 Open Example\SpecialChar menuseparator
12563 Presentations\SpecialChar menuseparator
12567 offers guidance on its use.
12568 The documentation is available from
12569 \begin_inset CommandInset href
12572 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
12580 \begin_layout Subsection
12582 \change_inserted 564990737 1671459032
12585 \begin_inset CommandInset label
12587 name "subsec:Seminar"
12596 \begin_layout Standard
12598 \change_inserted 564990737 1671643194
12604 \begin_inset space \thinspace{}
12613 document class for creating presentations.
12617 File\SpecialChar menuseparator
12618 Open Example\SpecialChar menuseparator
12619 Presentations\SpecialChar menuseparator
12623 offers guidance on its use.
12624 The documentation is available from
12625 \begin_inset CommandInset href
12628 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
12636 \begin_layout Subsection
12639 Sli\SpecialChar TeX
12643 \begin_inset CommandInset label
12652 \begin_layout Standard
12654 \change_inserted 564990737 1672743492
12662 updated by the \SpecialChar LyX
12666 \begin_layout Subsubsection
12668 \change_inserted 564990737 1672743492
12674 \begin_layout Standard
12676 \change_inserted 564990737 1672743492
12679 This section describes how to use \SpecialChar LyX
12680 to make slides for overhead projectors.
12681 There are two document classes that can do this:
12685 \begin_inset space \thinspace{}
12690 document class and the
12693 \begin_inset space \thinspace{}
12696 (Foil\SpecialChar TeX
12700 This section documents the former.
12701 If you’re looking for the documentation for
12704 \begin_inset space \thinspace{}
12707 (Foil\SpecialChar TeX
12712 \begin_inset space ~
12716 \begin_inset CommandInset ref
12718 reference "sec:Foiltex"
12724 As of 2023 the former has continued to be maintained whereas
12726 Foil\SpecialChar TeX
12729 has not been maintained since 2008.
12731 \change_deleted 564990737 1672743492
12741 \begin_layout Standard
12743 \change_deleted 564990737 1672743492
12747 \begin_layout Standard
12749 \change_deleted 564990737 1672743492
12750 This section describes how to use \SpecialChar LyX
12751 to make slides for overhead projectors.
12752 There are two document classes that can do this:
12753 the default slides class and the
12755 Foil\SpecialChar TeX
12759 This section documents the former.
12762 \begin_layout Standard
12764 \change_deleted 564990737 1672743492
12765 I'm going to say this again,
12767 so that there's no misunderstanding:
12770 \begin_layout Standard
12772 \change_deleted 564990737 1672743492
12773 \begin_inset VSpace bigskip
12779 \begin_layout Standard
12782 \change_deleted 564990737 1672743492
12785 This section documents the class
12786 \begin_inset Quotes eld
12794 \begin_inset Quotes erd
12802 \begin_layout Standard
12804 \change_deleted 564990737 1672743492
12805 \begin_inset VSpace bigskip
12811 \begin_layout Standard
12813 \change_deleted 564990737 1672743492
12814 If you're looking for the documentation for
12815 \begin_inset Quotes eld
12820 slides (Foil\SpecialChar TeX
12824 \begin_inset Quotes erd
12829 \begin_inset space ~
12833 \begin_inset CommandInset ref
12835 reference "sec:foiltex"
12846 \begin_inset Quotes eld
12851 slides (Foil\SpecialChar TeX
12855 \begin_inset Quotes erd
12858 ] is actually somewhat better than the default
12866 \begin_layout Plain Layout
12868 or so I've been told repeatedly by its advocates.
12869 Having never used it,
12870 I have no idea if this claim is true or not.
12875 which this section documents.
12878 \begin_layout Standard
12880 \change_deleted 564990737 1672743492
12881 This class is the \SpecialChar LaTeX2e
12882 improvement of the old
12884 Sli\SpecialChar TeX
12888 Every \SpecialChar LaTeX2e
12889 distribution includes this class [which I'll just refer to as
12890 \begin_inset Quotes eld
12898 \begin_inset Quotes erd
12902 so you're bound to have it.
12903 As I noted earlier,
12904 there are other classes,
12910 which also produce slides for overhead projectors and do a better job at it.
12912 there are some things which
12916 can do which the others can't,
12917 such as generate overlays.
12918 Read on to learn more!
12923 \begin_layout Subsubsection
12925 \begin_inset CommandInset label
12927 name "sec:slidesetup"
12934 \begin_layout Standard
12936 to use this document class,
12938 \begin_inset Quotes eld
12946 \begin_inset Quotes erd
12949 from the class list in the
12951 Document\SpecialChar menuseparator
12955 There are some other special things you should know about this class:
12958 \begin_layout Itemize
12959 Don't bother changing the options
12964 They're not supported by the
12972 \begin_layout Itemize
12976 \begin_inset space ~
12981 behaves a bit differently for this class.
12982 The possible choices and what they do are as follows:
12986 \begin_layout Description
12991 The final output contains page numbers in the lower right corner.
12994 \begin_layout Description
13004 but also prints out any time markers you've put in.
13005 This is the default.
13008 \begin_layout Description
13013 The final output contains no page numbers,
13015 or alignment markers.
13019 \begin_layout Itemize
13024 class has an extra option:
13032 \begin_inset Quotes eld
13040 \begin_inset Quotes erd
13043 in the extra class options.
13047 \begin_layout Standard
13048 Using this options allows you to add time markers to
13054 \begin_inset space ~
13058 \begin_inset CommandInset ref
13060 reference "sec:slideNote"
13069 \begin_layout Standard
13070 You can also use the template file
13071 \change_deleted 564990737 1671617694
13073 \begin_inset Quotes eld
13081 \begin_inset Quotes erd
13086 to automatically set up a document to use the
13091 \change_deleted 564990737 1671617699
13096 File\SpecialChar menuseparator
13098 \begin_inset space ~
13102 \begin_inset space ~
13106 \change_inserted 564990737 1671617723
13107 \SpecialChar menuseparator
13108 Presentations\SpecialChar menuseparator
13113 to open your new document
13114 \change_deleted 564990737 1671617728
13118 The template file also contains some examples of the special paragraph environments used by this class.
13119 I'll describe those next.
13122 \begin_layout Subsubsection
13123 Paragraph Environments
13126 \begin_layout Paragraph
13127 Supported Environments
13130 \begin_layout Standard
13131 The first thing you'll notice when you start up a new
13135 document is the font size and type:
13136 it's the equivalent of the size
13137 \begin_inset Quotes eld
13145 \begin_inset Quotes erd
13151 \begin_inset space ~
13157 This is also what's used in the output.
13159 \begin_inset Quotes eld
13163 \begin_inset Quotes erd
13166 to remind you that this is a slide.
13167 Your final slides will use a larger font;
13169 you'll have less space.
13171 the larger default screen font isn't WYSIWYG,
13175 \begin_layout Standard
13176 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
13177 Most of the paragraph environments you're used to seeing are missing.
13178 There are also five new ones.
13183 class itself only supports certain paragraph environments:
13186 \begin_layout Itemize
13192 \begin_layout Itemize
13198 \begin_layout Itemize
13204 \begin_layout Itemize
13210 \begin_layout Itemize
13216 \begin_layout Itemize
13222 \begin_layout Itemize
13228 \begin_layout Itemize
13234 \begin_layout Itemize
13240 \begin_layout Itemize
13247 \begin_layout Standard
13248 All of the other standard environments,
13249 including the section-heading environments,
13257 \begin_layout Standard
13259 you'll notice the following new environments:
13262 \begin_layout Itemize
13268 \begin_layout Itemize
13274 \begin_layout Itemize
13280 \begin_layout Itemize
13286 \begin_layout Itemize
13292 \begin_layout Standard
13293 These five are kind of quirky,
13295 \begin_inset Quotes eld
13299 \begin_inset Quotes erd
13302 in \SpecialChar LyX
13306 doesn't permit you to nest any other paragraph environment into an empty environment.
13308 that's fine and dandy,
13309 but it means that you wouldn't be able to start a slide with anything except plain text.
13311 I've performed a little
13312 \begin_inset Quotes eld
13317 \begin_inset Quotes erd
13323 \begin_layout Paragraph
13324 Quirks of the New Environments
13325 \begin_inset CommandInset label
13327 name "sec:slideQuirk"
13334 \begin_layout Standard
13335 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
13337 As I just mentioned,
13339 forbids environments that begin with another environment.
13340 To get around this,
13345 environment isn't a paragraph environment as described in the
13353 \begin_layout Standard
13354 You should consider
13369 \begin_inset Quotes eld
13372 pseudo-environments.
13373 \begin_inset Quotes erd
13376 They look like a section heading or a
13377 \begin_inset Quotes eld
13385 \begin_inset Quotes erd
13388 but really begin a [and,
13390 end the previous] paragraph environment.
13401 \begin_inset Quotes eld
13405 \begin_inset Quotes erd
13408 These two perform some action.
13411 \begin_layout Standard
13412 A common feature of all five environments,
13437 is a rather long-ish label.
13438 The text following this label —
13439 ordinarily the contents of the paragraph environment —
13440 is utterly irrelevant for
13465 completely ignores it.
13467 you can leave these five environments completely empty.
13471 \begin_layout Standard
13476 to put any text after the rather long-ish label,
13478 This could be a short description of the contents of the
13485 enter your descriptive comment and hit
13489 as you normally would.
13492 \begin_layout Standard
13495 you don't want to enter any descriptive text,
13496 you'll hit another \SpecialChar LyX
13502 and will not let you start a new paragraph environment until you put something in the old one.
13507 \begin_layout Itemize
13508 Start entering the text that will
13539 \begin_layout Itemize
13540 Now move to the beginning of that paragraph.
13544 \begin_layout Itemize
13554 \begin_layout Itemize
13557 empty paragraph to a
13584 \begin_layout Standard
13585 Some future version of \SpecialChar LyX
13588 resolve this quirkiness\SpecialChar ldots
13592 \begin_layout Subsubsection
13593 Making a Presentation with
13607 \begin_layout Paragraph
13615 \begin_layout Standard
13616 If you're expecting this section to teach you how to actually make a presentation,
13617 you'll be sorely disappointed.
13619 I'll describe all of the ways the
13623 class can assist you in preparing the materials for a presentation.
13624 Filling in the contents,
13632 the \SpecialChar LyX
13636 \begin_layout Standard
13641 environment [in the manner described in section
13642 \begin_inset space ~
13646 \begin_inset CommandInset ref
13648 reference "sec:slideQuirk"
13653 ] tells \SpecialChar LyX
13654 to begin a new slide [duh].
13655 The label for this environment/
13656 \begin_inset Quotes erd
13660 \begin_inset Quotes erd
13664 \begin_inset Quotes eld
13668 \begin_inset Quotes erd
13672 followed by the label,
13674 \begin_inset Quotes eld
13678 \begin_inset Quotes erd
13682 Any text or paragraph environments that follow this one go on the new slide.
13686 \begin_layout Standard
13687 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
13688 (this can be specified in the
13695 once you finish entering the contents of one slide.
13696 If you've entered more text than can physically fit on a slide,
13697 the extra overflows onto a new slide.
13698 I don't recommend doing this,
13700 since the overflow slide won't have any page number on it.
13702 it may interfere with any
13706 you've made to accompany the oversized
13713 \begin_layout Standard
13722 environments work the same way as the
13727 They both create an
13728 \begin_inset Quotes eld
13732 \begin_inset Quotes erd
13735 followed by a label [
13736 \begin_inset Quotes eld
13740 \begin_inset Quotes erd
13744 \begin_inset Quotes eld
13748 \begin_inset Quotes erd
13753 The color is a stunning magenta instead of blue,
13755 \begin_inset Quotes eld
13759 \begin_inset Quotes erd
13762 will look different,
13763 in style and in length.
13764 The label fonts of all three also differ from one another.
13767 \begin_layout Standard
13773 if the contents of a
13781 exceed the physical size of a slide or sheet of paper,
13782 the extra will overflow onto a new sheet.
13784 you should avoid this.
13785 It defeats the whole purpose of
13796 \begin_layout Paragraph
13806 \begin_layout Standard
13811 is a slide that sits atop another slide.
13812 Perhaps you wish to discuss a figure on the main
13816 before displaying the text associated with it.
13817 One way to accomplish this is tape a flap of dark paper over the part of the
13821 you want to display later.
13824 if you wish to overlap one graph with another,
13826 You would then have to fumble while speaking to align the two separate,
13831 s to align the two graphs.
13836 environment in both cases makes life much easier.
13839 \begin_layout Standard
13844 receives the page number of its
13845 \begin_inset Quotes eld
13849 \begin_inset Quotes erd
13858 \begin_inset Quotes eld
13866 \begin_inset Quotes erd
13873 \begin_layout Plain Layout
13880 \begin_inset Quotes eld
13888 \begin_inset Quotes erd
13893 \begin_inset Quotes eld
13901 \begin_inset Quotes erd
13906 \begin_inset Quotes eld
13914 \begin_inset Quotes erd
13919 \begin_inset space ~
13922 appended to the page number of the parent
13933 you want the contents of both the
13941 to each fit on a single physical slide!
13942 You should probably consider an
13947 \begin_inset Quotes eld
13951 \begin_inset Quotes erd
13960 the \SpecialChar LyX
13965 class provides a visual cue for this:
13966 the label at the start of an
13970 is shorter than that at the start of a
13976 when you generate printable output,
13977 you'll find alignment markers in all four corners of both the
13981 page and its parent
13986 These will assist you in lining up the two physical slides.
13989 \begin_layout Standard
13990 The major problem in overlaying two slides is aligning the contents of the two transparencies.
13991 How much space should you leave for that graph on the second slide?
13993 what if you want a graph and a sentence on second slide,
13994 but there is text on the main transparency that goes in between them?
13995 You could try and insert vertical space of the right size.
13996 The better way is to use
14007 \begin_layout Standard
14008 As their names imply,
14017 are two command-like paragraph environments that make all subsequent text invisible and visible,
14020 \begin_inset space ~
14024 \begin_inset CommandInset ref
14026 reference "sec:slideQuirk"
14031 that you don't place anything
14035 these two environments,
14042 it inserts a centered,
14043 sky-blue label into the page reading
14044 \begin_inset Quotes eld
14047 <Invisible Text Follows>
14048 \begin_inset Quotes erd
14052 For paragraphs following this label,
14062 it doesn't matter which] where they would be contain instead blank space.
14066 \begin_layout Standard
14072 the corresponding centered label is
14073 \begin_inset Quotes eld
14076 <Visible Text Follows>
14077 \begin_inset Quotes erd
14081 Paragraphs following this label behave normally.
14082 Note that the beginning of a new
14096 automatically shuts off an
14101 It's therefore not necessary to use
14112 \begin_layout Standard
14114 it should be obvious how to create overlay transparencies using the proper combination of
14133 \begin_layout Enumerate
14139 including everything that will appear on it,
14140 whether on the main slide or on the
14147 \begin_layout Enumerate
14148 Before each figure or paragraph that will appear only on the
14163 environment after the
14170 \begin_layout Enumerate
14175 immediately following the
14182 \begin_layout Enumerate
14183 Copy the contents of this
14194 \begin_layout Enumerate
14211 \begin_layout Standard
14213 You've just made an
14220 \begin_layout Standard
14221 There's one problem with the way I've designed the \SpecialChar LyX
14227 you can't make text in the middle of a paragraph invisible,
14228 nor make text in the middle of an invisible paragraph visible again.
14229 To accomplish this feat,
14230 you'll need to use some inlined \SpecialChar LaTeX
14235 \begin_layout Plain Layout
14236 The commands of interest are:
14240 \begin_layout Itemize
14245 invisible \SpecialChar ldots
14249 \begin_layout Itemize
14254 visible \SpecialChar ldots
14258 \begin_layout Plain Layout
14260 and need to be marked as \SpecialChar TeX
14263 \begin_inset Quotes eld
14267 \begin_inset Quotes erd
14270 you wish to change goes in between the brackets [and after the
14283 If you don't know how to mark text as \SpecialChar TeX
14285 see the appropriate section of the
14297 \begin_layout Paragraph
14307 \begin_inset CommandInset label
14309 name "sec:slideNote"
14316 \begin_layout Standard
14326 is associated with a
14327 \begin_inset Quotes eld
14331 \begin_inset Quotes erd
14341 the \SpecialChar LyX
14346 class provides visual cues.
14351 is shorter than that of a
14355 [yet longer than that of an
14360 like the label of an
14364 is shockingly magenta.
14370 has the page number of its
14371 \begin_inset Quotes eld
14375 \begin_inset Quotes erd
14384 \begin_inset Quotes eld
14392 \begin_inset Quotes erd
14397 \begin_inset Quotes eld
14405 \begin_inset Quotes erd
14410 \begin_inset Quotes eld
14418 \begin_inset Quotes erd
14423 You can have multiple
14427 s associated with a single
14442 you'll probably want to break up long
14446 s so that they fit on a single sheet of paper.
14449 \begin_layout Standard
14455 it contains anything additional you might want to say about a
14460 It could also be used as a sheet of reminders for a particular
14465 In the case of the latter,
14466 you might want to make use of time markers.
14468 the \SpecialChar LyX
14474 \begin_inset Quotes eld
14478 \begin_inset Quotes erd
14481 support for time markers,
14484 Sli\SpecialChar TeX
14489 you'll have to resort to using the \SpecialChar LaTeX
14493 \begin_layout Standard
14494 To use time markers,
14495 you'll need to specify the extra class option
14496 \begin_inset Quotes eld
14504 \begin_inset Quotes erd
14508 \begin_inset space ~
14512 \begin_inset CommandInset ref
14514 reference "sec:slidesetup"
14520 This option turns on timing marks,
14521 which will appear in the lower-left-hand corner of every
14526 To set what appears in the time marker,
14527 you use the \SpecialChar LaTeX
14529 \begin_inset Quotes eld
14539 \begin_inset Quotes erd
14543 \begin_inset Quotes eld
14553 \begin_inset Quotes erd
14557 The arguments of both commands are time measured in seconds.
14559 \begin_inset Quotes eld
14569 \begin_inset Quotes erd
14572 sets the time marker to a given time.
14574 \begin_inset Quotes eld
14584 \begin_inset Quotes erd
14587 increments the time marker by the specified amount.
14588 Using time markers and
14593 you can remind yourself how much time to spend on a particular
14600 \begin_layout Standard
14601 There's one last feature to describe.
14603 you'd like to print out all of your
14611 s on transparencies while printing all of your
14629 with which it is associated.
14630 What's a person to do?
14633 \begin_layout Standard
14635 there are two \SpecialChar LaTeX
14636 commands that allow you to select what to print out.
14637 Both must be placed into the preamble of your document.
14639 \begin_inset Quotes eld
14651 \begin_inset Quotes erd
14654 will cause the output to contain only the
14665 \begin_inset Quotes eld
14677 \begin_inset Quotes erd
14680 prevents the output of anything but
14685 I'd advise placing both commands in the preamble and initially comment both out.
14686 You can then preview your entire presentation as you write.
14687 When you're done writing,
14688 you can then uncomment one of the two to select what you want to print.
14689 I like to uncomment
14690 \begin_inset Quotes eld
14702 \begin_inset Quotes erd
14706 print to a file with
14707 \begin_inset Quotes eld
14715 \begin_inset Quotes erd
14719 comment it back out,
14721 \begin_inset Quotes eld
14733 \begin_inset Quotes erd
14737 \begin_inset Quotes eld
14745 \begin_inset Quotes erd
14749 I can then send either file to a printer,
14750 loading transparencies or plain paper as appropriate.
14753 \begin_layout Standard
14754 You can also provide other arguments to the
14755 \begin_inset Quotes eld
14765 \begin_inset Quotes erd
14769 \begin_inset Quotes eld
14779 \begin_inset Quotes erd
14783 See a good \SpecialChar LaTeX
14787 \begin_layout Subsubsection
14792 Class Template File
14795 \begin_layout Standard
14796 I have also provided a template file
14797 \change_deleted 564990737 1671617750
14800 \begin_inset Quotes eld
14808 \begin_inset Quotes erd
14820 begin your new presentation with
14822 File\SpecialChar menuseparator
14824 \begin_inset space ~
14828 \begin_inset space ~
14832 \change_inserted 564990737 1671616988
14833 \SpecialChar menuseparator
14834 Presentations\SpecialChar menuseparator
14840 Your new \SpecialChar LyX
14841 presentation file will contain an example
14862 additionally contain an example of the use of
14872 the preamble will contain:
14875 \begin_layout LyX-Code
14876 % Uncomment to print out only slides and overlays
14879 \begin_layout LyX-Code
14883 \begin_layout LyX-Code
14889 \begin_inset Newline newline
14895 \begin_layout LyX-Code
14896 % Uncomment to print out only notes
14899 \begin_layout LyX-Code
14903 \begin_layout LyX-Code
14911 \begin_layout Standard
14913 I created this class to support the \SpecialChar LaTeX2e
14915 \begin_inset Quotes eld
14920 Sli\SpecialChar TeX
14924 \begin_inset Quotes erd
14928 one of the built-in \SpecialChar LaTeX2e
14930 Neither I nor the rest of the \SpecialChar LyX
14931 Team endorse or oppose the use of this built-in slide class.
14932 It's here if you want it or need it.
14933 There exist other \SpecialChar LaTeX2e
14934 classes for creating presentations,
14940 \begin_inset space ~
14944 \begin_inset CommandInset ref
14946 reference "sec:foiltex"
14952 \begin_inset Quotes eld
14960 \begin_inset Quotes erd
14963 package [present on some \SpecialChar TeX
14965 The latter is not yet supported under \SpecialChar LyX
14970 \begin_layout Plain Layout
14971 Perhaps you can take on the task\SpecialChar ldots
14977 I know nothing about these other classes.
14978 Try them out to see what sort of alternative they provide.
14981 \begin_layout Section
14983 \change_inserted 564990737 1670439661
14987 \begin_layout Subsection
14989 \change_inserted 564990737 1670439661
14993 \begin_layout Standard
14995 \change_inserted 564990737 1670439661
15004 document class for preparing reports.
15010 this provides parts,
15011 chapters and sections but does not provide the paragraph styles needed for a book;
15017 it provides the abstract paragraph style.
15019 it does not start a new chapter on the right hand page.
15022 \begin_layout Standard
15024 \change_inserted 564990737 1672743528
15029 document classes are described in the Collections (section
15030 \begin_inset space ~
15034 \begin_inset CommandInset ref
15036 reference "sec:Collections"
15044 \begin_layout Standard
15046 \change_inserted 564990737 1672743530
15052 \begin_inset space \thinspace{}
15055 (Japanese in vertical writing)
15060 \begin_inset space \thinspace{}
15067 \begin_inset space ~
15071 \begin_inset CommandInset ref
15073 reference "subsec:Japanese"
15081 \begin_layout Standard
15083 \change_inserted 564990737 1672743530
15089 \begin_inset space \thinspace{}
15096 \begin_inset space ~
15100 \begin_inset CommandInset ref
15102 reference "subsec:KOMA-Script"
15110 \begin_layout Standard
15112 \change_inserted 564990737 1672743530
15118 \begin_inset space \thinspace{}
15121 (with extra font sizes)
15125 \begin_inset space ~
15129 \begin_inset CommandInset ref
15131 reference "subsec:Extra-font-sizes"
15139 \begin_layout Standard
15141 \change_inserted 564990737 1672743569
15147 \begin_inset space \thinspace{}
15150 (Polish version by M.
15151 \begin_inset space \thinspace{}
15158 \begin_inset space ~
15162 \begin_inset CommandInset ref
15164 reference "subsec:Polish-M.W.collection"
15175 \begin_layout Section
15177 \change_inserted 564990737 1670439674
15181 \begin_layout Subsection
15185 \begin_layout Standard
15191 \begin_layout Subsubsection
15195 \begin_layout Standard
15196 Broadway is for writing plays.
15197 The format is more decorative than Hollywood,
15198 and much less standardized.
15199 This format should be suitable for workshops.
15202 \begin_layout Subsubsection
15206 \begin_layout Standard
15207 The same as in Hollywood.
15210 \begin_layout Subsubsection
15214 \begin_layout Standard
15219 names as labels then cross-reference the label to insert the name.
15220 The cross-reference dialog will show the current cast of characters.
15223 \begin_layout Subsubsection
15224 Paper size and Margins
15227 \begin_layout Standard
15235 \begin_layout Subsubsection
15239 \begin_layout Standard
15240 The following environments are available.
15241 You can use broadway.bind to get the bind keys shown at the right.
15244 \begin_layout Itemize
15248 \begin_inset Newline newline
15253 You should not have to use this,
15254 but it is here for anything that does not fit otherwise.
15257 \begin_layout Itemize
15261 \begin_inset space \hfill{}
15265 \begin_inset Newline newline
15270 Used to describe stage setting and the action.
15271 First use of speaker names in all CAPs.
15274 \begin_layout Itemize
15278 \begin_inset space \hfill{}
15282 \begin_inset Newline newline
15287 Automatically numbered.
15288 On screen it will be arabic,
15289 but will print as Roman.
15292 \begin_layout Itemize
15296 \begin_inset space \hfill{}
15300 \begin_inset Newline newline
15310 It is just centered text.
15313 \begin_layout Itemize
15317 \begin_inset space \hfill{}
15321 \begin_inset Newline newline
15326 Not automatically numbered.
15327 You supply the number.
15328 This is because I couldn't figure out how.
15331 \begin_layout Itemize
15335 \begin_inset space \hfill{}
15339 \begin_inset Newline newline
15344 A special case of Narrative to describe the setting and action as the curtain rises.
15347 \begin_layout Itemize
15351 \begin_inset space \hfill{}
15355 \begin_inset Newline newline
15360 The speaker's (actor's) title,
15361 centered in all CAPS.
15364 \begin_layout Itemize
15368 \begin_inset space \hfill{}
15372 \begin_inset Newline newline
15377 Instructions to the speaker.
15378 The parentheses are automatically inserted.
15379 The ( will appear on screen,
15380 but both will be in the printed play.
15381 This environment is only used within
15388 \begin_layout Itemize
15392 \begin_inset space \hfill{}
15396 \begin_inset Newline newline
15401 What the Speaker says.
15404 \begin_layout Itemize
15408 \begin_inset space \hfill{}
15412 \begin_inset Newline newline
15417 The curtain comes down.
15420 \begin_layout Itemize
15424 \begin_inset space \hfill{}
15430 \begin_layout Itemize
15434 \begin_inset space \hfill{}
15440 \begin_layout Itemize
15444 \begin_inset space \hfill{}
15450 \begin_layout Standard
15454 \begin_layout Subsection
15455 Hollywood (Hollywood spec scripts)
15458 \begin_layout Standard
15464 \begin_layout Subsubsection
15468 \begin_layout Standard
15469 Getting the format of a Hollywood script right is a
15470 \begin_inset Quotes eld
15474 \begin_inset Quotes erd
15477 It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
15478 Each page of a script should be one minute of film.
15479 Nothing goes in a script that you cannot see or hear on screen.
15480 The courier 12 pt font should be used throughout.
15484 \begin_layout Subsubsection
15488 \begin_layout Standard
15489 Speakers' lines should NEVER break in mid-sentence.
15490 If a speaker's lines continue over a page break,
15495 title followed by (Cont'd).
15498 \begin_layout Subsubsection
15502 \begin_layout Standard
15507 names as labels then cross-reference the label to insert the name.
15508 The cross-reference dialog will show the current cast of characters.
15509 You can use this to insert the speaker name in narratives also.
15512 \begin_layout Subsubsection
15513 Paper size and Margins
15516 \begin_layout Standard
15524 \begin_layout Subsubsection
15528 \begin_layout Standard
15529 The following environments are available.
15530 You can use hollywood.bind to get the bind keys shown at the right.
15533 \begin_layout Itemize
15537 \begin_inset Newline newline
15542 Used where nothing else works.
15546 \begin_layout Itemize
15552 \begin_inset space \hfill{}
15560 \begin_inset Newline newline
15563 Usually followed by something like
15564 \begin_inset Quotes eld
15567 on Sally waking up.
15568 \begin_inset Quotes erd
15574 \begin_layout Itemize
15578 \begin_inset space \hfill{}
15582 \begin_inset Newline newline
15587 Introduces a new INTERIOR camera set-up.
15588 Always followed by DAY or NIGHT,
15589 or something similar to define the lighting required.
15590 Everthing on this line in CAPS.
15593 \begin_layout Itemize
15597 \begin_inset space \hfill{}
15601 \begin_inset Newline newline
15606 Introduces a new EXTERIOR camera set-up.
15607 Everthing on this line in CAPS.
15610 \begin_layout Itemize
15614 \begin_inset space \hfill{}
15618 \begin_inset Newline newline
15623 The character speaking.
15626 \begin_layout Itemize
15630 \begin_inset space \hfill{}
15634 \begin_inset Newline newline
15639 Instructions to the speaker.
15640 The () are automatically inserted.
15643 \begin_layout Itemize
15647 \begin_inset space \hfill{}
15651 \begin_inset Newline newline
15663 \begin_layout Itemize
15667 \begin_inset space \hfill{}
15671 \begin_inset Newline newline
15676 Camera movement instruction.
15678 \begin_inset space \thinspace{}
15682 \begin_inset space \space{}
15688 \begin_layout Itemize
15692 \begin_inset space \hfill{}
15698 \begin_layout Itemize
15702 \begin_inset space \hfill{}
15708 \begin_layout Itemize
15712 \begin_inset space \hfill{}
15718 \begin_layout Itemize
15722 \begin_inset space \hfill{}
15728 \begin_layout Subsubsection
15732 \begin_layout Itemize
15737 \begin_layout Itemize
15742 \begin_layout Itemize
15744 \begin_inset space \thinspace{}
15752 \begin_layout Itemize
15758 \begin_layout Itemize
15763 \begin_layout Itemize
15768 \begin_layout Chapter
15770 \change_inserted 564990737 1671185876
15774 \begin_layout Section
15776 \change_inserted 564990737 1671716212
15779 Academic Field Specifics
15782 \begin_layout Subsection
15784 \change_inserted 564990737 1671716212
15788 Hazard and Precautionary Statements
15791 \begin_layout Standard
15793 \change_inserted 564990737 1671716212
15796 This module provides two insets to typeset numbers and phrases of chemical hazard and precautionary statements.
15797 For a description see
15800 File\SpecialChar menuseparator
15801 Open Example\SpecialChar menuseparator
15802 Modules\SpecialChar menuseparator
15803 Hazard and Precautionary Statements
15807 Help\SpecialChar menuseparator
15808 Specific Manuals\SpecialChar menuseparator
15809 Hazard and Precautionary Statements
15815 \begin_layout Subsection
15817 \change_inserted 564990737 1671716212
15822 Risk and Safety Statements
15825 \begin_layout Standard
15827 \change_inserted 564990737 1671716212
15830 This module provides two insets,
15840 accessible via the menu
15845 nsert\SpecialChar menuseparator
15847 \begin_inset space ~
15852 and an environment to typeset numbers and phrases of chemical risk and safety statements.
15855 \begin_layout Subsection
15857 \change_inserted 564990737 1671716212
15863 \begin_layout Standard
15865 \change_inserted 564990737 1671716212
15868 This module uses the
15872 package to add environments useful for linguistics (numbered examples,
15876 You can obtain information about this module in
15881 elp\SpecialChar menuseparator
15887 \begin_inset space ~
15890 Manuals\SpecialChar menuseparator
15900 File\SpecialChar menuseparator
15901 Open Example\SpecialChar menuseparator
15904 Modules\SpecialChar menuseparator
15910 \begin_layout Section
15912 \change_inserted 564990737 1671788778
15918 \begin_layout Subsection
15920 \change_inserted 564990737 1671788778
15926 \begin_layout Standard
15928 \change_inserted 564990737 1671788778
15931 This module supports the Braille writing system.
15932 It requires the \SpecialChar LaTeX
15938 This and its documentation can be obtained from
15939 \begin_inset CommandInset href
15942 target "https://www.ctan.org/pkg/braille"
15948 You do not have to reconfigure your system after installing it.
15954 elp\SpecialChar menuseparator
15960 \begin_inset space ~
15963 Manuals\SpecialChar menuseparator
15972 File\SpecialChar menuseparator
15973 Open Example\SpecialChar menuseparator
15974 Modules\SpecialChar menuseparator
15980 \begin_layout Section
15982 \change_inserted 564990737 1671788778
15985 Annotation & Revision
15988 \begin_layout Subsection
15990 \change_inserted 564990737 1671788778
15996 \begin_layout Standard
15998 \change_inserted 564990737 1671788778
16001 This module provides “FiXme” (marginal) annotations for document revision purposes.
16002 A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
16003 The annotations are customizable via the LaTeX preamble.
16004 See the FiXme documentation which can be obtained from
16005 \begin_inset CommandInset href
16008 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
16017 \begin_layout Paragraph
16019 \change_inserted 564990737 1671788778
16025 \begin_layout Standard
16027 \change_inserted 564990737 1671788778
16031 the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
16033 Document\SpecialChar menuseparator
16034 Settings\SpecialChar menuseparator
16035 Document Class\SpecialChar menuseparator
16036 Class Options\SpecialChar menuseparator
16040 To display them always,
16049 Document\SpecialChar menuseparator
16050 Settings\SpecialChar menuseparator
16058 \begin_layout Subsection
16060 \change_inserted 564990737 1671788778
16066 \begin_layout Standard
16068 \change_inserted 564990737 1671788778
16071 This module provides various kinds of annotations for PDF output.
16074 Help\SpecialChar menuseparator
16075 Specific Manuals\SpecialChar menuseparator
16076 PDF comments and File\SpecialChar menuseparator
16077 Open Example\SpecialChar menuseparator
16078 Modules\SpecialChar menuseparator
16084 \begin_layout Subsection
16086 \change_inserted 564990737 1671788778
16093 \begin_layout Standard
16095 \change_inserted 564990737 1671788778
16098 This module provides fields and buttons for PDF forms.
16100 \begin_inset CommandInset href
16102 name "hyperref documentation"
16103 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
16111 Help\SpecialChar menuseparator
16112 Specific Manuals\SpecialChar menuseparator
16113 PDF forms and File\SpecialChar menuseparator
16114 Open Example\SpecialChar menuseparator
16115 Modules\SpecialChar menuseparator
16121 \begin_layout Subsection
16123 \change_inserted 564990737 1671788778
16130 \begin_layout Standard
16132 \change_inserted 564990737 1671788778
16135 This module defines an inset to typeset reading aids (ruby,
16136 furigana) to Chinese characters.
16137 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on the TeX engine) or a fallback definition.
16141 \begin_layout Subsection
16143 \change_inserted 564990737 1671788778
16150 \begin_layout Standard
16152 \change_inserted 564990737 1671788778
16155 This module provides custom insets to insert TODO items in your document.
16156 In order to generate a “List of TODOs,” the module provides a paragraph style.
16157 Inserting “final” in
16159 Document\SpecialChar menuseparator
16160 Settings\SpecialChar menuseparator
16161 Document Class\SpecialChar menuseparator
16162 Class Options\SpecialChar menuseparator
16165 ) suppresses the output of TODO notes.
16167 \begin_inset CommandInset href
16169 name "todonotes documentation"
16170 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
16178 \begin_layout Section
16180 \change_inserted 564990737 1671829045
16186 \begin_layout Subsection
16188 \change_inserted 564990737 1671829045
16191 APA Style with NatBib
16194 \begin_layout Standard
16196 \change_inserted 564990737 1671829045
16199 This module adds support for using natbib together with apacite (the bibliography style need not be apacite —
16200 it could be apacite,
16202 or any bibliography that works with both the natbib and apacite packages.)
16205 \begin_layout Section
16207 \change_inserted 564990737 1671829045
16213 \begin_layout Subsection
16215 \change_inserted 564990737 1671829045
16218 Fancy Colored Boxes
16221 \begin_layout Standard
16223 \change_inserted 564990737 1671829045
16226 This module adds ten custom insets that support colored boxes via the tcolorbox package.
16229 Help\SpecialChar menuseparator
16230 Specific Manuals\SpecialChar menuseparator
16236 File\SpecialChar menuseparator
16237 Open Example\SpecialChar menuseparator
16238 Modules\SpecialChar menuseparator
16242 \begin_inset CommandInset href
16244 name "tcolorbox documentation"
16245 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
16254 \begin_layout Subsection
16256 \change_inserted 564990737 1671829045
16262 \begin_layout Standard
16264 \change_inserted 564990737 1671829045
16267 This provides the custom insets
16285 to scale and rotate its content.
16288 \begin_layout Standard
16290 \change_inserted 564990737 1671829045
16296 is a simple way of reversing text without any other enhancement:
16299 \begin_layout Standard
16301 \change_inserted 564990737 1671829045
16304 \begin_inset Flex Reflectbox
16307 \begin_layout Plain Layout
16309 \change_inserted 564990737 1671829045
16312 Great Western Railway
16322 \begin_layout Standard
16324 \change_inserted 564990737 1671829045
16327 (You will need to use Ctrl-R to see any of these examples.)
16330 \begin_layout Standard
16332 \change_inserted 564990737 1671829045
16338 allows you to specify the dimensions of the text or image;
16339 permissible units are em,
16361 it scales by the width factor:
16364 \begin_layout Standard
16366 \change_inserted 564990737 1671829045
16369 \begin_inset Flex Resizebox
16372 \begin_layout Plain Layout
16374 \change_inserted 564990737 1671829045
16377 \begin_inset Argument 1
16380 \begin_layout Plain Layout
16382 \change_inserted 564990737 1671829045
16393 \begin_inset Argument 2
16396 \begin_layout Plain Layout
16398 \change_inserted 564990737 1671829045
16408 Great Western Railway
16418 \begin_layout Standard
16420 \change_inserted 564990737 1671829045
16426 allows you to rotate text around the reference point of the box.
16427 If you wish to rotate the box around a different origin,
16428 place the cursor inside the box and select Insert\SpecialChar menuseparator
16458 or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
16462 \begin_layout Standard
16464 \change_inserted 564990737 1671829045
16467 \begin_inset Flex Rotatebox
16470 \begin_layout Plain Layout
16472 \change_inserted 564990737 1671829045
16475 \begin_inset Argument 1
16478 \begin_layout Plain Layout
16480 \change_inserted 564990737 1671829045
16491 \begin_inset Argument 2
16494 \begin_layout Plain Layout
16496 \change_inserted 564990737 1671829045
16506 Great Western Railway
16516 \begin_layout Standard
16518 \change_inserted 564990737 1671829045
16521 You can combine boxes as in:
16524 \begin_layout Standard
16526 \change_inserted 564990737 1671829045
16529 \begin_inset Flex Rotatebox
16532 \begin_layout Plain Layout
16534 \change_inserted 564990737 1671829045
16537 \begin_inset Argument 1
16540 \begin_layout Plain Layout
16542 \change_inserted 564990737 1671829045
16553 \begin_inset Argument 2
16556 \begin_layout Plain Layout
16558 \change_inserted 564990737 1671829045
16569 \begin_inset Flex Resizebox
16572 \begin_layout Plain Layout
16574 \change_inserted 564990737 1671829045
16577 \begin_inset Argument 1
16580 \begin_layout Plain Layout
16582 \change_inserted 564990737 1671829045
16593 \begin_inset Argument 2
16596 \begin_layout Plain Layout
16598 \change_inserted 564990737 1671829045
16609 \begin_inset Flex Reflectbox
16612 \begin_layout Plain Layout
16614 \change_inserted 564990737 1671829045
16617 Great Western Railway
16641 \begin_layout Standard
16643 \change_inserted 564990737 1671829045
16650 select Insert\SpecialChar menuseparator
16651 V-Factor to add a vertical factor.
16652 If the vertical factor is omitted,
16653 the horizontal is used.
16654 Adding different horizontal and vertical values creates distortion as in
16657 \begin_layout Standard
16659 \change_inserted 564990737 1671829045
16663 \begin_inset Flex Scalebox
16666 \begin_layout Plain Layout
16668 \change_inserted 564990737 1671829045
16671 \begin_inset Argument 1
16674 \begin_layout Plain Layout
16676 \change_inserted 564990737 1671829045
16687 \begin_inset Argument 2
16690 \begin_layout Plain Layout
16692 \change_inserted 564990737 1671829045
16704 Great Western Railway
16714 \begin_layout Standard
16716 \change_inserted 564990737 1671829045
16719 A negative horizontal value reverses the text and a negative vertical value inverts it so that you get
16722 \begin_layout Standard
16724 \change_inserted 564990737 1671829045
16727 \begin_inset Flex Scalebox
16730 \begin_layout Plain Layout
16732 \change_inserted 564990737 1671829045
16735 \begin_inset Argument 1
16738 \begin_layout Plain Layout
16740 \change_inserted 564990737 1671829045
16751 \begin_inset Argument 2
16754 \begin_layout Plain Layout
16756 \change_inserted 564990737 1671829045
16766 Great Western Railway
16774 \begin_inset Flex Scalebox
16777 \begin_layout Plain Layout
16779 \change_inserted 564990737 1671829045
16782 \begin_inset Argument 1
16785 \begin_layout Plain Layout
16787 \change_inserted 564990737 1671829045
16798 \begin_inset Argument 2
16801 \begin_layout Plain Layout
16803 \change_inserted 564990737 1671829045
16813 Great Western Railway
16823 \begin_layout Subsection
16825 \change_inserted 564990737 1671884699
16831 \begin_layout Standard
16833 \change_inserted 564990737 1671884699
16836 This module defines Boxes with section header.
16837 It is mainly intended for the SciPoster Document class.
16841 \begin_layout Subsection
16843 \change_inserted 564990737 1671884699
16846 Variable-width Minipages
16849 \begin_layout Standard
16851 \change_inserted 564990737 1671884699
16857 \begin_inset space \thinspace{}
16864 Insert\SpecialChar menuseparator
16876 package provides a variable-width minipage,
16877 whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
16878 The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
16880 Insert\SpecialChar menuseparator
16882 \begin_inset space \thinspace{}
16893 Insert\SpecialChar menuseparator
16895 \begin_inset space \thinspace{}
16909 File\SpecialChar menuseparator
16910 Open Example\SpecialChar menuseparator
16911 Variable-width Minipages
16917 \begin_layout Section
16919 \change_inserted 564990737 1671884699
16925 \begin_layout Subsection
16927 \change_inserted 564990737 1671884699
16930 Fix Computer Modern Fonts
16933 \begin_layout Standard
16935 \change_inserted 564990737 1671884699
16938 This module uses the
16942 package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
16944 \begin_inset CommandInset href
16946 name "fix-cm documentation"
16947 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
16956 \begin_layout Subsection
16958 \change_inserted 564990737 1671884699
16962 Kernel Fixes (Obsolete)
16965 \begin_layout Standard
16967 \change_inserted 564990737 1671884699
16970 This module loads the \SpecialChar LaTeX
16975 which contains some bug fixes for \SpecialChar LaTeX
16977 If you use this module your typeset document may look different when you process it,
16978 depending on the respective version of
16986 \begin_layout Paragraph
16988 \change_inserted 564990737 1671884699
16994 \begin_layout Standard
16996 \change_inserted 564990737 1671884699
16999 recent \SpecialChar LaTeX
17000 kernels (as of 2015/01/01) include the functionality of
17009 module is obsolete with newer \SpecialChar LaTeX
17014 \begin_layout Subsection
17016 \change_inserted 564990737 1671884699
17019 Minimalistic Insets
17022 \begin_layout Standard
17024 \change_inserted 564990737 1671884699
17027 This module redefines several insets (Index,
17029 URL) as being Minimalistic.
17032 \begin_layout Subsection
17034 \change_inserted 564990737 1671884699
17037 Title and Preamble Hacks
17040 \begin_layout Standard
17042 \change_inserted 564990737 1671884699
17045 This module provides two new paragraph styles:
17049 \begin_layout Enumerate
17051 \change_inserted 564990737 1671884699
17057 which puts whatever is entered into it into the preamble.
17060 to include preamble code in the body of a LyX document.
17064 \begin_layout Enumerate
17066 \change_inserted 564990737 1671884699
17072 which that will put its contents into the body of the LaTeX document,
17080 This is useful for making branches and notes in title-related material.
17082 if you put these in a Standard layout,
17083 this signals to LyX to output
17090 which may then come too early.)
17093 \begin_layout Section
17095 \change_inserted 564990737 1672081439
17101 \begin_layout Subsection
17103 \change_inserted 564990737 1672081439
17109 \begin_layout Standard
17111 \change_inserted 564990737 1672081439
17114 This module uses the
17118 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
17119 Use the Algorithm paragraph style to enter and indent the algorithm.
17121 \begin_inset CommandInset href
17123 name "algorithm2e documentation"
17124 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
17132 \begin_layout Subsection
17134 \change_inserted 564990737 1672081439
17137 Bilingual Captions AKA Multilingual Captions
17140 \begin_layout Standard
17142 \change_inserted 564990737 1672081439
17145 This module provides the paragraph style
17148 \begin_inset space ~
17153 with which to typeset multilingual captions.
17154 Within this paragraph style
17156 Insert\SpecialChar menuseparator
17159 allows you to enter the desired language using one of the babel names.
17162 File\SpecialChar menuseparator
17163 Open Example\SpecialChar menuseparator
17164 Multilingual Captions
17168 Help\SpecialChar menuseparator
17169 Specific Manuals\SpecialChar menuseparator
17170 Multilingual Captions
17172 further information on its use.
17175 \begin_layout Subsection
17177 \change_inserted 564990737 1672081439
17180 Number Figures by Section
17183 \begin_layout Standard
17185 \change_inserted 564990737 1672081439
17188 This module resets the figure number at section start and prepends the section number to the figure number,
17189 as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
17192 \begin_layout Subsection
17194 \change_inserted 564990737 1672081439
17197 Number Tables by Section
17200 \begin_layout Standard
17202 \change_inserted 564990737 1672081439
17205 This module resets the table number at section start and prepends the section number to the table number,
17206 as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
17209 \begin_layout Section
17211 \change_inserted 564990737 1672081439
17217 \begin_layout Subsection
17219 \change_inserted 564990737 1672081439
17225 \begin_layout Standard
17227 \change_inserted 564990737 1672081439
17230 This module adds an endnote inset,
17231 in addition to footnotes.
17237 which has some limitations but works with older LaTeX distributions as well.
17240 Insert\SpecialChar menuseparator
17241 Custom Inset\SpecialChar menuseparator
17244 to insert an endnote and
17246 Insert\SpecialChar menuseparator
17247 List/Contents/References\SpecialChar menuseparator
17250 to insert the endnotes list where you want the endnotes to appear.
17253 Help\SpecialChar menuseparator
17254 Embedded\SpecialChar menuseparator
17255 Objects\SpecialChar menuseparator
17256 Notes\SpecialChar menuseparator
17262 \begin_layout Subsection
17264 \change_inserted 564990737 1672081439
17267 Endnotes (Extended)
17270 \begin_layout Standard
17272 \change_inserted 564990737 1672081439
17275 This module adds an endnote inset,
17276 in addition to footnotes.
17281 package which is more powerful and customizable than the
17286 but requires a fairly modern LaTeX distribution (with LaTeX3).
17289 Insert\SpecialChar menuseparator
17290 Custom Inset\SpecialChar menuseparator
17293 to insert an endnote and
17295 Insert\SpecialChar menuseparator
17296 List/Contents/References\SpecialChar menuseparator
17299 to insert the endnotes list where you want the endnotes to appear.
17302 Help\SpecialChar menuseparator
17303 Embedded\SpecialChar menuseparator
17304 Objects\SpecialChar menuseparator
17305 Notes\SpecialChar menuseparator
17311 \begin_layout Subsection
17313 \change_inserted 564990737 1672081439
17316 Footnotes as Endnotes (Basic)
17319 \begin_layout Standard
17321 \change_inserted 564990737 1672081439
17324 This module sets all footnotes as endnotes.
17330 which has some limitations but works with older LaTeX distributions as well.
17333 Insert\SpecialChar menuseparator
17334 List/Contents/References\SpecialChar menuseparator
17337 to insert the endnotes list where you want the endnotes to appear.
17340 Help\SpecialChar menuseparator
17341 Embedded\SpecialChar menuseparator
17342 Objects\SpecialChar menuseparator
17343 Notes\SpecialChar menuseparator
17349 \begin_layout Subsection
17351 \change_inserted 564990737 1672081439
17354 Footnotes as Endnotes (Extended)
17357 \begin_layout Standard
17359 \change_inserted 564990737 1672081439
17362 This module sets all footnotes as endnotes.
17367 package which is more powerful and customizable than then
17372 but requires a fairly modern LaTeX distribution (with LaTeX3).
17375 Insert\SpecialChar menuseparator
17376 List/Contents/References\SpecialChar menuseparator
17379 to insert the endnotes list where you want the endnotes to appear.
17382 Help\SpecialChar menuseparator
17383 Embedded\SpecialChar menuseparator
17384 Objects\SpecialChar menuseparator
17385 Notes\SpecialChar menuseparator
17391 \begin_layout Section
17393 \change_inserted 564990737 1672081439
17400 \begin_layout Subsection
17402 \change_inserted 564990737 1672081439
17408 \begin_layout Standard
17410 \change_inserted 564990737 1672081439
17413 This module provides support for the
17417 package to print chess games.
17420 File\SpecialChar menuseparator
17421 Open Example\SpecialChar menuseparator
17422 Articles\SpecialChar menuseparator
17425 where you will find
17434 \begin_inset CommandInset href
17436 name "chessboard documentation"
17437 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
17445 \begin_layout Subsection
17447 \change_inserted 564990737 1672081439
17450 Lilypond Music Notation
17453 \begin_layout Standard
17455 \change_inserted 564990737 1672081439
17458 This module provides an inset via
17463 nsert\SpecialChar menuseparator
17464 Custom Inset\SpecialChar menuseparator
17467 in which to enter code for the LilyPond music editor.
17468 It will then be processed in the output.
17471 Help\SpecialChar menuseparator
17472 Specific Manuals\SpecialChar menuseparator
17477 File\SpecialChar menuseparator
17478 Open Example\SpecialChar menuseparator
17479 Modules\SpecialChar menuseparator
17483 It cannot be used if the modules
17486 \begin_inset space \thinspace{}
17494 \begin_layout Section
17496 \change_inserted 564990737 1672138150
17502 \begin_layout Subsection
17504 \change_inserted 564990737 1672138150
17508 \begin_inset CommandInset label
17510 name "subsec:Customizable-Lists"
17517 \begin_layout Standard
17519 \change_inserted 564990737 1672138150
17522 This module uses the
17526 package to enable the customization of various list environments.
17529 \begin_layout Subsubsection
17531 \change_inserted 564990737 1672138150
17534 Custom Enumerate Lists
17537 \begin_layout Standard
17540 \change_inserted 564990737 1672138150
17543 The default numbering of numbered lists can be changed by adding an optional argument (menu
17548 nsert\SpecialChar menuseparator
17555 ) to the first item of each level in the list.
17556 There you add the command
17559 \begin_layout Standard
17561 \change_inserted 564990737 1672138150
17570 \begin_layout Standard
17572 \change_inserted 564990737 1672138150
17575 in \SpecialChar TeX
17585 \begin_layout Standard
17587 \change_inserted 564990737 1672138150
17593 is the first level counter of the enumeration.
17594 To change the numbering for the list sublevels,
17599 ” in the command by the small Roman numeral of the level (
17621 \begin_layout Standard
17623 \change_inserted 564990737 1672138150
17632 outputs the counter as a small Roman numeral.
17633 For capital Roman numerals replace
17645 in the command above.
17646 For Arabic numerals use
17654 \begin_inset Quotes eld
17658 \begin_inset Quotes erd
17661 items with capital or small Latin letters use
17677 \begin_layout Standard
17680 \change_inserted 564990737 1672138150
17683 \begin_inset Note Greyedout
17686 \begin_layout Plain Layout
17688 \change_inserted 564990737 1672138150
17695 You can only number 26
17696 \begin_inset space ~
17699 items with Latin letters,
17700 because this numbering is limited to single letters.
17708 \begin_layout Standard
17710 \change_inserted 564990737 1672138150
17713 Here is a list with custom numbering:
17716 \begin_layout Enumerate
17718 \change_inserted 564990737 1672138150
17721 \begin_inset Argument 1
17724 \begin_layout Plain Layout
17726 \change_inserted 564990737 1672138150
17732 \begin_layout Plain Layout
17734 \change_inserted 564990737 1672138150
17755 \begin_inset Separator latexpar
17762 \begin_layout Enumerate
17764 \change_inserted 564990737 1672138150
17767 \begin_inset Argument 1
17770 \begin_layout Plain Layout
17772 \change_inserted 564990737 1672138150
17778 \begin_layout Plain Layout
17780 \change_inserted 564990737 1672138150
17801 \begin_layout Enumerate
17803 \change_inserted 564990737 1672138150
17807 \begin_inset Separator latexpar
17814 \begin_layout Enumerate
17816 \change_inserted 564990737 1672138150
17819 \begin_inset Argument 1
17822 \begin_layout Plain Layout
17824 \change_inserted 564990737 1672138150
17830 \begin_layout Plain Layout
17832 \change_inserted 564990737 1672138150
17851 \begin_inset Separator latexpar
17858 \begin_layout Enumerate
17860 \change_inserted 564990737 1672138150
17863 \begin_inset Argument 1
17866 \begin_layout Plain Layout
17868 \change_inserted 564990737 1672138150
17874 \begin_layout Plain Layout
17876 \change_inserted 564990737 1672138150
17900 \begin_layout Standard
17902 \change_inserted 564990737 1672138150
17905 For this list these commands were used:
17908 \begin_layout Standard
17911 \change_inserted 564990737 1672138150
17922 \begin_inset Newline newline
17930 \begin_inset Newline newline
17938 \begin_inset Newline newline
17948 \begin_layout Standard
17950 \change_inserted 564990737 1672138150
17959 makes the label emphasized and
17968 \begin_layout Standard
17970 \change_inserted 564990737 1672138150
17973 \begin_inset Note Greyedout
17976 \begin_layout Plain Layout
17978 \change_inserted 564990737 1672138150
17985 When you change the label of a list level,
17986 it will be used for all following lists until you change the definition.
17994 \begin_layout Standard
17996 \change_inserted 564990737 1672138150
18002 \begin_layout Plain Layout
18004 \change_inserted 564990737 1672138150
18022 \begin_layout Subsubsection
18024 \change_inserted 564990737 1672138150
18027 Numbered Paragraphs in Reports
18030 \begin_layout Enumerate
18032 \change_inserted 564990737 1672138213
18035 Official reports often include numbered paragraphs;
18036 you can achieve this with a variation on the approach outlined in the footnote
18037 \begin_inset space ~
18041 \begin_inset CommandInset ref
18043 reference "fn:If-you-really"
18056 in each command with
18063 \begin_layout Enumerate
18065 \change_inserted 564990737 1672138150
18068 These numbered paragraphs were generated by inserting the \SpecialChar TeX
18070 \begin_inset Separator latexpar
18077 \begin_layout Standard
18079 \change_inserted 564990737 1672138150
18094 \begin_layout Standard
18096 \change_inserted 564990737 1672138150
18099 before the start of the section;
18106 uses the \SpecialChar LaTeX
18107 section counter to generate the first part of the number.
18111 \begin_layout Enumerate
18113 \change_inserted 564990737 1672138150
18116 I have ignored the subsection heading in this example because,
18117 with paragraphs numbered in this way,
18118 subsections are less likely to be used.
18121 \begin_layout Subsubsection
18123 \change_inserted 564990737 1672138150
18126 Resumed Enumeration
18129 \begin_layout Standard
18131 \change_inserted 564990737 1672138150
18137 \begin_layout Plain Layout
18139 \change_inserted 564990737 1672138150
18155 \begin_layout Standard
18157 \change_inserted 564990737 1672138150
18160 Enumerations can be resumed after intermediate paragraphs:
18163 \begin_layout Enumerate
18165 \change_inserted 564990737 1672138150
18168 \begin_inset Argument 1
18171 \begin_layout Plain Layout
18173 \change_inserted 564990737 1672138150
18179 \begin_layout Plain Layout
18181 \change_inserted 564990737 1672138150
18198 \begin_inset Note Note
18201 \begin_layout Plain Layout
18203 \change_inserted 564990737 1672138150
18206 goes back to default numbering
18214 \begin_layout Enumerate
18216 \change_inserted 564990737 1672138150
18222 \begin_layout Standard
18224 \change_inserted 564990737 1672138150
18230 \begin_layout Enumerate-Resume
18232 \change_inserted 564990737 1672138150
18238 \begin_layout Standard
18240 \change_inserted 564990737 1672138150
18243 To resume an enumeration,
18249 Its numbering appears in blue within \SpecialChar LyX
18250 to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
18255 \begin_layout Standard
18257 \change_inserted 564990737 1672138150
18260 \begin_inset Note Greyedout
18263 \begin_layout Plain Layout
18265 \change_inserted 564990737 1672138150
18272 If there is no previous enumeration to resume,
18273 you will get a \SpecialChar LaTeX
18282 \begin_layout Standard
18284 \change_inserted 564990737 1672138150
18287 Perhaps you might want to resume the list with a different number from the next one.
18288 Or you want to start a new enumeration with a defined number.
18289 This is possible by adding an optional argument to the first list item of a normal enumeration.
18294 \begin_layout Standard
18296 \change_inserted 564990737 1672138150
18303 \begin_layout Standard
18305 \change_inserted 564990737 1672138150
18312 is the number with which you want to resume the list.
18316 \begin_layout Enumerate
18318 \change_inserted 564990737 1672138150
18324 \begin_layout Enumerate
18326 \change_inserted 564990737 1672138150
18332 \begin_layout Standard
18334 \change_inserted 564990737 1672138150
18337 Enumeration starting at a given value:
18340 \begin_layout Enumerate
18342 \change_inserted 564990737 1672138150
18345 \begin_inset Argument 1
18348 \begin_layout Plain Layout
18350 \change_inserted 564990737 1672138150
18356 \begin_layout Plain Layout
18358 \change_inserted 564990737 1672138150
18372 This enumeration starts at 4
18375 \begin_layout Subsubsection
18377 \change_inserted 564990737 1672138150
18381 \begin_inset Index idx
18386 \begin_layout Plain Layout
18388 \change_inserted 564990737 1672138150
18402 \begin_layout Standard
18404 \change_inserted 564990737 1672138150
18407 In some cases you might want less or more vertical space between the items of a list.
18408 For example if the default space is too much in your opinion in this case:
18411 \begin_layout Itemize
18413 \change_inserted 564990737 1672138150
18419 \begin_layout Itemize
18421 \change_inserted 564990737 1672138150
18424 with standard spacing
18427 \begin_layout Standard
18429 \change_inserted 564990737 1672138150
18432 You can decrease the space by adding an optional argument to the first item of the list.
18433 Add there the command
18437 to get no additional list space like in this example:
18440 \begin_layout Itemize
18442 \change_inserted 564990737 1672138150
18445 \begin_inset Argument 1
18448 \begin_layout Plain Layout
18450 \change_inserted 564990737 1672138150
18456 \begin_layout Plain Layout
18458 \change_inserted 564990737 1672138150
18475 \begin_layout Itemize
18477 \change_inserted 564990737 1672138150
18483 \begin_layout Itemize
18485 \change_inserted 564990737 1672138150
18491 \begin_layout Standard
18493 \change_inserted 564990737 1672138150
18496 To add space you can use several other commands provided by the
18501 \begin_inset Index idx
18506 \begin_layout Plain Layout
18508 \change_inserted 564990737 1672138150
18521 For more information see the
18522 \begin_inset CommandInset href
18524 name "enumitem documentation"
18525 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18533 \begin_layout Standard
18535 \change_inserted 564990737 1672138150
18538 There are also many commands available to change the horizontal spacing and indentation.
18539 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
18540 \begin_inset space \thinspace{}
18543 cm so that the number is in the page margin:
18546 \begin_layout Enumerate
18548 \change_inserted 564990737 1672138150
18551 \begin_inset Argument 1
18554 \begin_layout Plain Layout
18556 \change_inserted 564990737 1672138150
18562 \begin_layout Plain Layout
18564 \change_inserted 564990737 1672138150
18584 \begin_layout Enumerate
18586 \change_inserted 564990737 1672138150
18589 with negative indentation
18592 \begin_layout Subsubsection
18594 \change_inserted 564990737 1672138150
18597 Further Customization
18598 \begin_inset Index idx
18603 \begin_layout Plain Layout
18605 \change_inserted 564990737 1672138150
18619 \begin_layout Standard
18621 \change_inserted 564990737 1672138150
18624 You can also change the style of description lists.
18628 \begin_layout Standard
18630 \change_inserted 564990737 1672138150
18637 \begin_layout Standard
18639 \change_inserted 564990737 1672138150
18642 changes the description label font,
18646 \begin_layout Standard
18648 \change_inserted 564990737 1672138150
18658 \begin_layout Standard
18660 \change_inserted 564990737 1672138150
18663 sets the list style.
18666 \begin_layout Standard
18668 \change_inserted 564990737 1672138150
18671 An example where the command
18674 \begin_layout Standard
18676 \change_inserted 564990737 1672138150
18686 \begin_layout Standard
18688 \change_inserted 564990737 1672138150
18694 \begin_layout Description
18696 \change_inserted 564990737 1672138150
18700 \begin_inset space ~
18705 \begin_inset Argument 1
18708 \begin_layout Plain Layout
18710 \change_inserted 564990737 1672138150
18716 \begin_layout Plain Layout
18718 \change_inserted 564990737 1672138150
18737 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
18738 therefore ionizing them.
18741 \begin_layout Description
18743 \change_inserted 564990737 1672138150
18747 \begin_inset space ~
18751 In computer science,
18752 reference counting is a technique of storing the number of references,
18754 or handles to a resource such as an object,
18756 disk space or other resource.
18759 \begin_layout Standard
18761 \change_inserted 564990737 1672138150
18764 There are many more commands and features provided by the
18769 \begin_inset Index idx
18774 \begin_layout Plain Layout
18776 \change_inserted 564990737 1672138150
18789 For more information see the
18790 \begin_inset CommandInset href
18792 name "enumitem documentation"
18793 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18801 \begin_layout Subsection
18803 \change_inserted 564990737 1672138150
18810 \begin_layout Standard
18812 \change_inserted 564990737 1672138150
18815 This module uses the package
18819 to provide nine new list environments.
18820 Itemized and enumerated lists can be typeset within paragraphs,
18821 as paragraphs and in a compact version.
18822 Most environments have optional arguments to format the labels.
18824 the \SpecialChar LaTeX
18825 list environments itemize and enumerate are extended to use a similar optional argument.
18826 For further details see
18828 File\SpecialChar menuseparator
18829 Open Example\SpecialChar menuseparator
18830 Modules\SpecialChar menuseparator
18831 Paragraph Lists (paralist)
18836 Help\SpecialChar menuseparator
18837 Specific Manuals\SpecialChar menuseparator
18841 \begin_inset CommandInset href
18843 name "paralist documentation"
18844 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
18852 \begin_layout Section
18854 \change_inserted 564990737 1672161542
18857 Literate Programming
18860 \begin_layout Subsection
18862 \change_inserted 564990737 1672161542
18868 \begin_layout Standard
18870 \change_inserted 564990737 1672161542
18873 This module allows the use of Noweb as a literate programming tool.
18874 The files and the documentation for Noweb can be obtained from
18875 \begin_inset CommandInset href
18878 target "https://www.ctan.org/pkg/noweb"
18884 Literate programming is described in section
18885 \begin_inset space ~
18889 \begin_inset CommandInset ref
18891 reference "sec:Literate-Programming"
18896 and there are three example files:
18899 File\SpecialChar menuseparator
18900 Open Example\SpecialChar menuseparator
18901 Modules\SpecialChar menuseparator
18907 File\SpecialChar menuseparator
18908 Open Example\SpecialChar menuseparator
18909 Modules\SpecialChar menuseparator
18914 File\SpecialChar menuseparator
18915 Open Example\SpecialChar menuseparator
18916 Modules\SpecialChar menuseparator
18917 Noweb2\SpecialChar LyX
18923 \begin_layout Subsection
18925 \change_inserted 564990737 1672161542
18931 \begin_layout Standard
18933 \change_inserted 564990737 1672161542
18936 This module uses the
18946 \begin_inset Flex Code
18949 \begin_layout Plain Layout
18951 \change_inserted 564990737 1672161542
18961 package in R for dynamic report generation has to be installed for this module to work:
18963 \begin_inset Flex Code
18966 \begin_layout Plain Layout
18968 \change_inserted 564990737 1672161542
18971 install.packages(“knitr”)
18982 \begin_layout Paragraph
18984 \change_inserted 564990737 1672161542
18990 \begin_layout Standard
18992 \change_inserted 564990737 1672161542
18995 it depends on R >= 2.14.1.
18997 \begin_inset Flex URL
19000 \begin_layout Plain Layout
19002 \change_inserted 564990737 1672161542
19004 http://yihui.name/knitr
19015 \begin_layout Standard
19017 \change_inserted 564990737 1672161542
19024 also has to be installed.
19025 It cannot be used if the modules
19028 \begin_inset space ~
19040 Help\SpecialChar menuseparator
19041 Specific Manuals\SpecialChar menuseparator
19047 File\SpecialChar menuseparator
19048 Open Example\SpecialChar menuseparator
19049 Modules\SpecialChar menuseparator
19053 \begin_inset space ~
19057 \begin_inset CommandInset ref
19059 reference "sec:Literate-Programming"
19064 for information about literate programming.
19067 \begin_layout Subsection
19069 \change_inserted 564990737 1672161542
19075 \begin_layout Standard
19077 \change_inserted 564990737 1672161542
19080 This module allows the use of the statistical language S/R as a literate programming tool.
19091 \begin_inset CommandInset href
19094 target "https://www.ctan.org/pkg/includernw"
19100 \begin_inset CommandInset href
19103 target "https://www.ctan.org/pkg/fancyvrb"
19108 are available from CTAN.
19109 It cannot be used if the module
19112 \begin_inset space ~
19120 Help\SpecialChar menuseparator
19121 Specific Manuals\SpecialChar menuseparator
19127 File\SpecialChar menuseparator
19128 Open Example\SpecialChar menuseparator
19129 Modules\SpecialChar menuseparator
19133 \begin_inset space ~
19137 \begin_inset CommandInset ref
19139 reference "sec:Literate-Programming"
19144 for information about literate programming.
19147 \begin_layout Section
19149 \change_inserted 564990737 1672224959
19155 \begin_layout Subsection
19157 \change_inserted 564990737 1672224959
19163 \begin_layout Standard
19165 \change_inserted 564990737 1672224959
19168 This modules defines theorem environments and the proof environment using the extended AMS machinery.
19169 Both numbered and unnumbered types are provided.
19171 the theorems are numbered consecutively throughout the document.
19172 This can be changed by loading one of the
19174 AMS Theorems (Numbered by \SpecialChar ldots
19178 It cannot be used if the modules
19184 Standard Theorems (Unnumbered)
19189 \begin_layout Subsection
19191 \change_inserted 564990737 1672224959
19194 AMS Theorems (Extended)
19197 \begin_layout Standard
19199 \change_inserted 564990737 1672224959
19202 This module defines some additional theorem environments for use with the
19206 package (which must be loaded).
19207 It includes Criterion,
19218 Case and Question in both numbered and unnumbered forms.
19221 \begin_layout Subsection
19223 \change_inserted 564990737 1672224959
19226 AMS Theorems (Extended,
19227 Numbered by Type within Chapters)
19230 \begin_layout Standard
19232 \change_inserted 564990737 1672224959
19235 This module defines some additional theorem environments for use with the
19237 AMS Theorems (Numbered by Type within Chapters)
19239 package (which must be loaded).
19240 It includes Criterion,
19249 Assumption and Case in both numbered and unnumbered forms.
19252 AMS Theorems (Extended)
19255 the different theorem types provided here each have a separate counter,
19256 restarted with each new chapter (e.g.,
19263 axiom 2.1\SpecialChar ldots
19265 as opposed to criterion 1,
19271 \begin_layout Subsection
19273 \change_inserted 564990737 1672224959
19276 AMS Theorems (Extended,
19280 \begin_layout Standard
19282 \change_inserted 564990737 1672224959
19285 This module defines some additional theorem environments for use with the
19287 AMS Theorems (Numbered by Type)
19289 package (which must be loaded).
19290 It includes Criterion,
19299 Assumption and Case in both numbered and unnumbered forms.
19302 AMS Theorems (Extended)
19305 the different theorem types provided here each have a separate counter (e.g.,
19313 as opposed to criterion 1,
19321 \begin_layout Subsection
19323 \change_inserted 564990737 1672224959
19326 AMS Theorems (Numbered by Type within Chapters)
19329 \begin_layout Standard
19331 \change_inserted 564990737 1672224959
19334 This module defines theorem environments and the proof environment using the extended AMS machinery.
19335 Both numbered and unnumbered types are provided.
19341 the different theorem types provided here each have a separate counter (e.g.,
19350 as opposed to theorem 1,
19356 The numbering restarts for each chapter:
19360 It cannot be used if the modules
19372 Standard Theorems (Numbered by Type)
19376 Standard Theorems (Unnumbered)
19381 \begin_layout Subsection
19383 \change_inserted 564990737 1672224959
19386 AMS Theorems (Numbered by Type)
19389 \begin_layout Standard
19391 \change_inserted 564990737 1672224959
19394 This module defines theorem environments and the proof environment using the extended AMS machinery.
19395 Both numbered and unnumbered types are provided.
19401 the different theorem types provided here each have a separate counter (e.g.,
19410 as opposed to theorem 1,
19416 The numbering’s scope is the whole document.
19417 For chapter- and section-wide numbering,
19418 use one of the ‘within Sections’/‘within Chapters’ modules,
19420 It cannot be used if the modules
19432 Standard Theorems (Numbered by Type)
19436 Standard Theorems (Unnumbered)
19441 \begin_layout Subsection
19443 \change_inserted 564990737 1672224959
19446 Number Equations by Section
19449 \begin_layout Standard
19451 \change_inserted 564990737 1672224959
19454 This module resets the equation number at section start and prepends the section number to the equation number,
19458 \begin_layout Subsection
19460 \change_inserted 564990737 1672224959
19466 \begin_layout Standard
19468 \change_inserted 564990737 1672224959
19471 This module defines some theorem environments for use with non-AMS classes.
19473 the theorems are numbered consecutively throughout the document.
19474 This can be changed by loading one of the
19476 Standard Theorems (Numbered by \SpecialChar ldots
19480 It cannot be used if the modules
19486 Standard Theorems (Unnumbered)
19492 \begin_layout Subsection
19494 \change_inserted 564990737 1672224959
19497 Standard Theorems (Nameable)
19500 \begin_layout Standard
19502 \change_inserted 564990737 1672224959
19505 This module facilitates the use of named theorems.
19506 The name of the theorem goes into the “Additional Theorem Text” argument.
19510 \begin_layout Subsection
19512 \change_inserted 564990737 1672224959
19515 Standard Theorems (Numbered by Chapter)
19518 \begin_layout Standard
19520 \change_inserted 564990737 1672224959
19523 This module numbers theorems and the like by chapter (i.e.,
19524 the counter is reset at each chapter start).
19525 Use this module only with document classes that provide a chapter environment.
19535 It cannot be used if the module
19537 Standard Theorems (Numbered by Section)
19542 \begin_layout Subsection
19544 \change_inserted 564990737 1672224959
19547 Standard Theorems (Numbered by Section)
19550 \begin_layout Standard
19552 \change_inserted 564990737 1672224959
19555 This module numbers theorems and the like by section (i.e.,
19556 the counter is reset at each section start).
19566 It cannot be used if the module
19568 Standard Theorems (Numbered by Chapter)
19573 \begin_layout Subsection
19575 \change_inserted 564990737 1672224959
19578 Standard Theorems (Numbered by Type within Chapters)
19581 \begin_layout Standard
19583 \change_inserted 564990737 1672224959
19586 This module defines some theorem environments for use with non-AMS classes.
19596 the different theorem types provided here each have a separate counter (e.g.,
19605 as opposed to theorem 1,
19611 The numbering is reset at each chapter start.
19614 AMS Theorems (Numbered by Type)
19618 Standard Theorems (Numbered by Type)
19621 It cannot be used if any of the modules
19633 Standard Theorems (Unnumbered)
19638 Standard Theorems (Numbered by Sections)
19642 Standard Theorems (Numbered by Type within Sections)
19647 \begin_layout Subsection
19649 \change_inserted 564990737 1672224959
19652 Standard Theorems (Numbered by Type within Sections)
19655 \begin_layout Standard
19657 \change_inserted 564990737 1672224959
19660 This module defines some theorem environments for use with non-AMS classes.
19670 the different theorem types provided here each have a separate counter (e.g.,
19679 as opposed to theorem 1,
19685 The numbering is reset at each section start.
19688 AMS Theorems (Numbered by Type)
19692 Standard Theorems (Numbered by Type)
19695 It cannot be used if any of the modules
19707 Standard Theorems (Unnumbered)
19712 Standard Theorems (Numbered by Chapters)
19716 Standard Theorems (Numbered by Type within Chapters)
19721 \begin_layout Subsection
19723 \change_inserted 564990737 1672224959
19726 Standard Theorems (Numbered by Type)
19729 \begin_layout Standard
19731 \change_inserted 564990737 1672224959
19734 This module defines some theorem environments for use with non-AMS classes.
19744 the different theorem types provided here each have a separate counter (e.g.,
19753 as opposed to theorem 1,
19759 The numbering’s scope is the whole document.
19760 For chapter- and section-wide numbering,
19761 use one of the “within Chapters”/“within Sections” modules,
19763 It cannot be used if any of the modules
19775 Standard Theorems (Unnumbered)
19779 AMS Theorems (Numbered by Type)
19784 \begin_layout Subsection
19786 \change_inserted 564990737 1672224959
19789 Standard Theorems (Unnumbered)
19792 \begin_layout Standard
19794 \change_inserted 564990737 1672224959
19797 This module defines only unnumbered theorem environments and the proof environment,
19798 using the extended AMS machinery.
19799 It cannot be used if either of the modules
19810 \begin_layout Subsection
19812 \change_inserted 564990737 1672224959
19818 \begin_layout Standard
19820 \change_inserted 564990737 1672224959
19823 This module provides a straightforward way to segregate subequations in LyX.
19826 Help\SpecialChar menuseparator
19827 Math\SpecialChar menuseparator
19834 \begin_layout Section
19836 \change_inserted 564990737 1672236008
19842 \begin_layout Subsection
19844 \change_inserted 564990737 1672236008
19847 Custom Header/Footer Text
19850 \begin_layout Standard
19852 \change_inserted 564990737 1672236008
19855 This module requires the
19858 \begin_inset space ~
19872 ocument\SpecialChar menuseparator
19877 ettings\SpecialChar menuseparator
19879 \begin_inset space ~
19884 dialog to be set to
19889 It adds six environments to document classes which support the
19896 \begin_layout Itemize
19898 \change_inserted 564990737 1672236008
19905 \begin_layout Itemize
19907 \change_inserted 564990737 1672236008
19914 \begin_layout Itemize
19916 \change_inserted 564990737 1672236008
19923 \begin_layout Itemize
19925 \change_inserted 564990737 1672236008
19932 \begin_layout Itemize
19934 \change_inserted 564990737 1672236008
19941 \begin_layout Itemize
19943 \change_inserted 564990737 1672236008
19950 \begin_layout Subsubsection
19952 \change_inserted 564990737 1672236008
19955 Fancy Headers and Footers
19958 \begin_layout Standard
19960 \change_inserted 564990737 1672236008
19963 The default page layout is rather plain;
19965 \begin_inset Flex Code
19968 \begin_layout Plain Layout
19970 \change_inserted 564990737 1672236008
19981 all you get is a centered page number at the bottom of the page.
19982 This document uses KOMA-script’s book class;
19983 so it appears to be a bit fancier.
19987 \begin_inset space ~
20001 ocument\SpecialChar menuseparator
20006 ettings\SpecialChar menuseparator
20010 \begin_inset Quotes eld
20014 \begin_inset Quotes erd
20018 you will find that the page header is divided into three fields,
20019 not surprisingly labeled
20020 \begin_inset Quotes eld
20024 \begin_inset Quotes erd
20029 \begin_inset Quotes eld
20033 \begin_inset Quotes erd
20038 \begin_inset Quotes eld
20042 \begin_inset Quotes erd
20046 The footer is also divided into these three fields.
20047 The \SpecialChar LaTeX
20048 commands to set these fields in the simplest manner are
20077 Suppose you wish to put your name in the upper left hand corner of each page.
20078 Simply insert the following command in the preamble:
20082 \begin_layout Standard
20084 \change_inserted 564990737 1672236008
20101 \begin_layout Standard
20103 \change_inserted 564990737 1672236008
20106 You will now see your name in the upper left.
20107 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,
20109 \begin_inset space \thinspace{}
20115 \begin_layout Standard
20117 \change_inserted 564990737 1672236008
20126 \begin_layout Standard
20128 \change_inserted 564990737 1672236008
20133 an easier way to make simple changes.
20139 ocument\SpecialChar menuseparator
20144 ettings\SpecialChar menuseparator
20145 Modules\SpecialChar menuseparator
20146 Page Layout\SpecialChar menuseparator
20147 Custom Header/Footer Text
20150 you will find you have six new environments corresponding to the six fields described above.
20153 \begin_layout Standard
20155 \change_inserted 564990737 1672236008
20158 Let's get really fancy:
20159 lets put the section number with the word
20160 \begin_inset Quotes eld
20164 \begin_inset Quotes erd
20168 \begin_inset space \thinspace{}
20172 \begin_inset space \space{}
20175 Section 3) in the upper left,
20176 the page number (e.
20177 \begin_inset space \thinspace{}
20181 \begin_inset space \space{}
20184 Page 4) in the upper right,
20185 your name in the lower left,
20186 and the date in the lower right.
20187 Use your newly enabled environments to add these entries:
20190 \begin_layout Standard
20192 \change_inserted 564990737 1672236008
20195 \begin_inset VSpace defskip
20201 \begin_layout Standard
20203 \change_inserted 564990737 1672236008
20208 \begin_inset space ~
20226 \begin_layout Standard
20228 \change_inserted 564990737 1672236008
20235 \begin_layout Standard
20237 \change_inserted 564990737 1672236008
20253 \begin_layout Standard
20255 \change_inserted 564990737 1672236008
20266 \begin_layout Standard
20268 \change_inserted 564990737 1672236008
20275 \begin_layout Standard
20277 \change_inserted 564990737 1672236008
20293 \begin_layout Standard
20295 \change_inserted 564990737 1672236008
20298 \begin_inset VSpace defskip
20304 \begin_layout Standard
20306 \change_inserted 564990737 1672236008
20309 Make sure you enter the commands
20328 as \SpecialChar TeX
20346 access \SpecialChar LaTeX
20347 ’s section and page counters,
20348 and so print out the current section and page numbers.
20355 simply prints out today’s date.
20358 \begin_layout Standard
20360 \change_inserted 564990737 1672236008
20363 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
20364 If you don't want one of the rules,
20365 set its thickness to 0.
20366 The header rule has a default thickness of 0.4pt,
20367 the footer rule is 0pt.
20368 For this you will need to use \SpecialChar TeX
20372 \begin_layout Standard
20374 \change_inserted 564990737 1672236008
20382 headrulewidth}{0.4pt}
20387 \begin_layout Standard
20389 \change_inserted 564990737 1672236008
20397 footrulewidth}{0.4pt}
20399 to set the thicknesses.
20402 \begin_layout Standard
20404 \change_inserted 564990737 1672236008
20407 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
20412 thispagestyle{empty}
20419 thispagestyle{plain}
20426 thispagestyle{fancy}
20429 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
20432 title pages are marked as plain by default,
20433 while following pages are marked fancy when using the global fancy setting.
20437 \begin_layout Standard
20439 \change_inserted 564990737 1672236008
20442 If you want a header or footer to be on the outer side of a two sided document,
20443 you need to use something like:
20446 \begin_layout Standard
20448 \change_inserted 564990737 1672236008
20452 \begin_inset Flex Strong
20455 \begin_layout Plain Layout
20457 \change_inserted 564990737 1672236008
20474 \begin_layout Standard
20476 \change_inserted 564990737 1672236008
20480 \begin_inset Flex Strong
20483 \begin_layout Plain Layout
20485 \change_inserted 564990737 1672236008
20504 \begin_layout Standard
20506 \change_inserted 564990737 1672236008
20509 The first command clears all existing footers avoiding any conflicts with your new command.
20512 \begin_layout Standard
20514 \change_inserted 564990737 1672236008
20517 You can enter any of these commands,
20518 the simpler ones in any of your new environments,
20519 the more complex ones as \SpecialChar TeX
20521 at any point in your document and they will take effect on the next page.
20524 \begin_layout Standard
20526 \change_inserted 564990737 1672236008
20529 As a final example,
20530 it is possible to include an image in the header or footer.
20531 Suppose you want to put a company logo in the upper left hand corner.
20532 You might try something like
20535 \begin_layout Standard
20537 \change_inserted 564990737 1672236008
20547 includegraphics{logo.eps}}}
20550 \begin_layout Standard
20553 \change_inserted 564990737 1672236008
20556 (you may need to preface this with
20560 usepackage{graphics}
20562 if you don't include graphics elsewhere in your document).
20565 \begin_layout Standard
20567 \change_inserted 564990737 1672236008
20570 For more information on fancy headers,
20572 \begin_inset Flex Code
20575 \begin_layout Plain Layout
20577 \change_inserted 564990737 1672236008
20588 \begin_inset CommandInset href
20591 target "http://www.ctan.org/pkg/fancyhdr"
20600 \begin_layout Subsection
20602 \change_inserted 564990737 1672236008
20605 Landscape Document Parts
20608 \begin_layout Standard
20610 \change_inserted 564990737 1672236008
20613 This module outputs parts of the document in landscape mode using
20615 Insert\SpecialChar menuseparator
20616 Custom Insets\SpecialChar menuseparator
20621 Insert\SpecialChar menuseparator
20622 Custom Insets\SpecialChar menuseparator
20623 Landscape (Floating)
20628 \begin_layout Subsection
20630 \change_inserted 564990737 1672236008
20633 \begin_inset CommandInset label
20635 name "sec:Multiple-Columns"
20642 \begin_layout Standard
20644 \change_inserted 564990737 1672236008
20647 This module uses the
20652 \begin_inset Index idx
20657 \begin_layout Plain Layout
20659 \change_inserted 564990737 1672236008
20671 package and is independent of the option
20684 ocument\SpecialChar menuseparator
20689 ettings\SpecialChar menuseparator
20691 \begin_inset space ~
20697 If you want to have two columns for the whole document,
20698 you are recommended to use the
20707 For all other cases use this module.
20708 \change_deleted 564990737 1672236008
20711 Multiple Text Columns
20714 \begin_layout Standard
20716 \change_deleted 564990737 1672236008
20717 This feature is independent of the option
20719 Two-column document
20721 in the document settings under
20726 If you want to have 2
20727 \begin_inset space ~
20730 columns for the whole document,
20731 it is recommended to use the
20733 Two-column document
20736 For all other cases use this feature.
20739 \begin_layout Standard
20741 \change_deleted 564990737 1672236008
20742 To use multiple text columns in your document,
20743 you have to load the module
20749 Document\SpecialChar menuseparator
20750 Settings\SpecialChar menuseparator
20753 ) and must have the \SpecialChar LaTeX
20755 \begin_inset Flex Code
20758 \begin_layout Plain Layout
20769 \begin_layout Standard
20770 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
20771 Within the different columns you can use everything,
20772 with the limitation that for floats you need to
20773 \change_deleted 564990737 1672236179
20774 use the float option
20777 \change_inserted 564990737 1672236179
20787 \begin_inset space ~
20797 dit\SpecialChar menuseparator
20803 \begin_inset space ~
20814 \begin_layout Subsubsection
20818 \begin_layout Standard
20819 If you want to have 2
20820 \begin_inset space ~
20823 columns in your text,
20824 insert a multicolumn inset via the menu
20826 Insert\SpecialChar menuseparator
20828 \begin_inset space ~
20831 Insets\SpecialChar menuseparator
20833 \begin_inset space ~
20838 where the columns should start.
20839 Write all text that should be printed in 2
20840 \begin_inset space ~
20843 columns into this inset.
20846 \begin_layout Standard
20847 Here is an example:
20850 \begin_layout Standard
20852 \begin_inset Flex Multiple Columns
20855 \begin_layout Plain Layout
20860 The Adventure of the Empty House
20863 \begin_inset Newline newline
20866 by Sir Arthur Conan Doyle
20869 \begin_layout Plain Layout
20872 It was in the spring of the year 1894 that all London was interested,
20873 and the fashionable world dismayed,
20874 by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
20875 The public has already learned those particulars of the crime which came out in the police investigation,
20876 but a good deal was suppressed upon that occasion,
20877 since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
20879 at the end of nearly ten years,
20880 am I allowed to supply those missing links which make up the whole of that remarkable chain.
20881 The crime was of interest in itself,
20882 but that interest was as nothing to me compared to the inconceivable sequel,
20883 which afforded me the greatest shock and surprise of any event in my adventurous life.
20885 after this long interval,
20886 I find myself thrilling as I think of it,
20887 and feeling once more that sudden flood of joy,
20889 and incredulity which utterly submerged my mind.
20890 Let me say to that public,
20891 which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
20892 that they are not to blame me if I have not shared my knowledge with them,
20893 for I should have considered it my first duty to do so,
20894 had I not been barred by a positive prohibition from his own lips,
20895 which was only withdrawn upon the third of last month.
20903 \begin_layout Standard
20904 To get 3 or more columns,
20905 set the cursor into the multicolumn inset and use the menu
20907 Insert\SpecialChar menuseparator
20909 \begin_inset space ~
20913 \begin_inset space ~
20919 The number of the desired columns is written into that inset (for 3
20920 \begin_inset space ~
20924 \begin_inset Quotes eld
20928 \begin_inset Quotes erd
20932 \begin_inset Newline newline
20935 Here is an example with 3
20936 \begin_inset space ~
20942 \begin_layout Standard
20943 \begin_inset Flex Multiple Columns
20946 \begin_layout Plain Layout
20949 \begin_inset Argument 1
20952 \begin_layout Plain Layout
20959 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
20960 and that after his disappearance I never failed to read with care the various problems which came before the public.
20961 And I even attempted,
20963 for my own private satisfaction,
20964 to employ his methods in their solution,
20965 though with indifferent success.
20968 which appealed to me like this tragedy of Ronald Adair.
20969 As I read the evidence at the inquest,
20970 which led up to a verdict of willful murder against some person or persons unknown,
20971 I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
20972 There were points about this strange business which would,
20974 have specially appealed to him,
20975 and the efforts of the police would have been supplemented,
20976 or more probably anticipated,
20977 by the trained observation and the alert mind of the first criminal agent in Europe.
20979 as I drove upon my round,
20980 I turned over the case in my mind and found no explanation which appeared to me to be adequate.
20981 At the risk of telling a twice-told tale,
20982 I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
20990 \begin_layout Standard
20991 You can have up to 10
20992 \begin_inset space ~
20995 columns if you want to,
20996 but that might not be very pleasant for the readers of your document.
20999 \begin_layout Standard
21001 \change_deleted 564990737 1672236245
21002 \begin_inset Newpage newpage
21010 \begin_layout Subsubsection
21011 Columns inside Columns
21014 \begin_layout Standard
21015 You can also have columns inside columns:
21018 \begin_layout Standard
21019 \begin_inset Flex Multiple Columns
21022 \begin_layout Plain Layout
21025 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
21026 at that time governor of one of the Australian colonies.
21027 Adair's mother had returned from Australia to undergo the operation for cataract,
21030 and her daughter Hilda were living together at 427 Park Lane.
21033 \begin_layout Plain Layout
21034 \begin_inset Flex Multiple Columns
21037 \begin_layout Plain Layout
21040 The youth moved in the best society
21041 \begin_inset space ~
21045 so far as was known,
21046 no enemies and no particular vices.
21047 He had been engaged to Miss Edith Woodley,
21049 but the engagement had been broken off by mutual consent some months before,
21050 and there was no sign that it had left any very profound feeling behind it.
21051 For the rest {sic} the man's life moved in a narrow and conventional circle,
21052 for his habits were quiet and his nature unemotional.
21053 Yet it was upon this easy-going young aristocrat that death came,
21054 in most strange and unexpected form,
21055 between the hours of ten and eleven-twenty on the night of March 30,
21064 \begin_layout Plain Layout
21067 Ronald Adair was fond of cards
21068 \begin_inset space ~
21071 – playing continually,
21072 but never for such stakes as would hurt him.
21073 He was a member of the Baldwin,
21075 and the Bagatelle card clubs.
21077 after dinner on the day of his death,
21078 he had played a rubber of whist at the latter club.
21079 He had also played there in the afternoon.
21084 The evidence of those who had played with him
21085 \begin_inset space ~
21092 \begin_inset space ~
21095 – showed that the game was whist,
21096 and that there was a fairly equal fall of the cards.
21097 Adair might have lost five pounds,
21099 His fortune was a considerable one,
21100 and such a loss could not in any way affect him.
21101 He had played nearly every day at one club or other,
21102 but he was a cautious player,
21103 and usually rose a winner.
21104 It came out in evidence that,
21105 in partnership with Colonel Moran,
21106 he had actually won as much as four hundred and twenty pounds in a sitting,
21108 from Godfrey Milner and Lord Balmoral.
21109 So much for his recent history as it came out at the inquest.
21117 \begin_layout Subsubsection
21121 \begin_layout Standard
21122 The examples in this section show some more special features of multiple columns.
21125 \begin_layout Standard
21126 For more features of multiple columns,
21128 \begin_inset CommandInset href
21130 name "documentation"
21131 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
21136 of the \SpecialChar LaTeX
21138 \begin_inset Flex Code
21141 \begin_layout Plain Layout
21150 \begin_layout Paragraph
21154 \begin_layout Standard
21155 To add a preface text for multiple columns,
21156 set the cursor into the multicolumn inset and use the menu
21158 Insert\SpecialChar menuseparator
21162 Write your preface text into that inset.
21163 \begin_inset Newline newline
21166 This is an example with some preface text:
21169 \begin_layout Standard
21170 \begin_inset VSpace bigskip
21176 \begin_layout Standard
21177 \begin_inset Flex Multiple Columns
21180 \begin_layout Plain Layout
21181 \begin_inset Argument 2
21184 \begin_layout Plain Layout
21185 And the story continues and continues and continues and continues\SpecialChar ldots
21193 On the evening of the crime,
21194 he returned from the club exactly at ten.
21195 His mother and sister were out spending the evening with a relation.
21196 The servant deposed that she heard him enter the front room on the second floor,
21197 generally used as his sitting-room.
21198 She had lit a fire there,
21199 and as it smoked she had opened the window.
21200 No sound was heard from the room until eleven-twenty,
21201 the hour of the return of Lady Maynooth and her daughter.
21202 Desiring to say good-night,
21203 she attempted to enter her son's room.
21204 The door was locked on the inside,
21205 and no answer could be got to their cries and knocking.
21207 and the door forced.
21208 The unfortunate young man was found lying near the table.
21209 His head had been horribly mutilated by an expanding revolver bullet,
21210 but no weapon of any sort was to be found in the room.
21218 \begin_layout Standard
21219 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
21221 For example the command
21224 \begin_layout LyX-Code
21227 subsection{subsection title}
21230 \begin_layout Standard
21231 creates a subsection.
21232 In this example the preface is a subsubsection:
21235 \begin_layout Standard
21236 \begin_inset Flex Multiple Columns
21239 \begin_layout Plain Layout
21240 \begin_inset Argument 2
21243 \begin_layout Plain Layout
21247 \begin_layout Plain Layout
21256 This is a subsubsection heading as a preface
21260 \begin_layout Plain Layout
21274 A minute examination of the circumstances served only to make the case more complex.
21275 In the first place,
21276 no reason could be given why the young man should have fastened the door upon the inside.
21277 There was the possibility that the murderer had done this,
21278 and had afterwards escaped by the window.
21279 The drop was at least twenty feet,
21281 and a bed of crocuses in full bloom lay beneath.
21282 Neither the flowers nor the earth showed any sign of having been disturbed,
21283 nor were there any marks upon the narrow strip of grass which separated the house from the road.
21286 it was the young man himself who had fastened the door.
21287 But how did he come by his death?
21288 No one could have climbed up to the window without leaving traces.
21289 Suppose a man had fired through the window,
21290 he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
21292 Park Lane is a frequented thoroughfare;
21293 there is a cab stand within a hundred yards of the house.
21294 No one had heard a shot.
21302 \begin_layout Standard
21303 If there is less vertical space than 6
21304 \begin_inset space ~
21307 text lines is left on the page at the beginning of the multiple columns,
21308 a page break will be inserted before the multiple columns.
21309 Depending on the number of lines of the preface text,
21310 you might want to change this space.
21311 This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
21313 Insert\SpecialChar menuseparator
21315 \begin_inset space ~
21319 \begin_inset space ~
21323 \begin_inset space ~
21329 Insert into that inset the amount of space like e.
21330 \begin_inset space \thinspace{}
21334 \begin_inset space \space{}
21338 \begin_inset Quotes eld
21342 \begin_inset Quotes erd
21346 \begin_inset Newline newline
21349 In this example the space is set to 7
21350 \begin_inset space ~
21353 text lines by using
21354 \begin_inset Flex Code
21357 \begin_layout Plain Layout
21366 \begin_inset Flex Code
21369 \begin_layout Plain Layout
21377 needs to be inserted as \SpecialChar TeX
21381 \begin_layout Standard
21382 \begin_inset Flex Multiple Columns
21385 \begin_layout Plain Layout
21386 \begin_inset Argument 3
21389 \begin_layout Plain Layout
21394 \begin_layout Plain Layout
21410 On the evening of the crime,
21411 he returned from the club exactly at ten.
21412 His mother and sister were out spending the evening with a relation.
21413 The servant deposed that she heard him enter the front room on the second floor,
21414 generally used as his sitting-room.
21415 She had lit a fire there,
21416 and as it smoked she had opened the window.
21417 No sound was heard from the room until eleven-twenty,
21418 the hour of the return of Lady Maynooth and her daughter.
21419 Desiring to say good-night,
21420 she attempted to enter her son's room.
21421 The door was locked on the inside,
21422 and no answer could be got to their cries and knocking.
21424 and the door forced.
21425 The unfortunate young man was found lying near the table.
21426 His head had been horribly mutilated by an expanding revolver bullet,
21427 but no weapon of any sort was to be found in the room.
21435 \begin_layout Paragraph
21439 \begin_layout Standard
21440 The amount of space before and after multiple columns can be changed by changing the length
21441 \begin_inset Flex Code
21444 \begin_layout Plain Layout
21453 For example the command
21456 \begin_layout LyX-Code
21464 \begin_layout Standard
21465 in \SpecialChar TeX
21466 Code changes its value to 3
21467 \begin_inset space \thinspace{}
21471 The change must be made before the multiple columns' start.
21472 The predefined value is 13
21473 \begin_inset space \thinspace{}
21479 \begin_layout Standard
21481 \begin_inset Flex Code
21484 \begin_layout Plain Layout
21493 \begin_inset space \thinspace{}
21499 \begin_layout Standard
21503 \begin_layout Plain Layout
21509 multicolsep}{2.5cm}
21517 \begin_layout Standard
21518 \begin_inset Flex Multiple Columns
21521 \begin_layout Plain Layout
21524 All day I turned these facts over in my mind,
21525 endeavouring to hit upon some theory which could reconcile them all,
21526 and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
21527 I confess that I made little progress.
21528 In the evening I strolled across the Park,
21529 and found myself about six o'clock at the Oxford Street end of Park Lane.
21530 A group of loafers upon the pavements,
21531 all staring up at a particular window,
21532 directed me to the house which I had come to see.
21534 thin man with coloured glasses,
21535 whom I strongly suspected of being a plain-clothes detective,
21536 was pointing out some theory of his own,
21537 while the others crowded round to listen to what he said.
21538 I got as near him as I could,
21539 but his observations seemed to me to be absurd,
21540 so I withdrew again in some disgust.
21541 As I did so I struck against an elderly,
21543 who had been behind me,
21544 and I knocked down several books which he was carrying.
21552 \begin_layout Standard
21553 \begin_inset Note Greyedout
21556 \begin_layout Plain Layout
21562 The values you set with
21563 \begin_inset Flex Code
21566 \begin_layout Plain Layout
21574 will be used for all following multiple columns until you change them again.
21582 \begin_layout Standard
21586 \begin_layout Plain Layout
21598 \begin_inset Note Note
21601 \begin_layout Plain Layout
21602 go back to the default
21610 \begin_layout Standard
21612 \change_deleted 564990737 1672236355
21613 \begin_inset Newpage newpage
21621 \begin_layout Paragraph
21625 \begin_layout Standard
21626 A column break can be forced by inserting the command
21627 \begin_inset Flex Code
21630 \begin_layout Plain Layout
21638 as \SpecialChar TeX
21639 Code to that position in the text where the column should be broken.
21640 Note that this leads in most cases to whitespace in the text.
21641 \begin_inset Newline newline
21644 Here is an example:
21647 \begin_layout Standard
21648 \begin_inset Flex Multiple Columns
21651 \begin_layout Plain Layout
21654 \begin_inset Quotes eld
21657 You're surprised to see me,
21659 \begin_inset Quotes erd
21667 \begin_layout Plain Layout
21670 I acknowledged that I was.
21673 \begin_layout Plain Layout
21676 \begin_inset Quotes eld
21682 and when I chanced to see you go into this house,
21683 as I came hobbling after you,
21684 I thought to myself,
21685 I'll just step in and see that kind gentleman,
21686 and tell him that if I was a bit gruff in my manner there was not any harm meant,
21687 and that I am much obliged to him for picking up my books.
21688 \begin_inset Quotes erd
21694 \begin_layout Plain Layout
21697 \begin_inset Quotes eld
21700 You make too much of a trifle,
21701 \begin_inset Quotes erd
21706 \begin_inset Quotes eld
21709 May I ask how you knew who I was?
21710 \begin_inset Quotes erd
21713 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
21717 \begin_layout Plain Layout
21729 \begin_layout Plain Layout
21732 \begin_inset Quotes eld
21737 if it isn't too great a liberty,
21738 I am a neighbour of yours,
21739 for you'll find my little bookshop at the corner of Church Street,
21740 and very happy to see you,
21742 Maybe you collect yourself,
21747 \begin_inset space ~
21763 \begin_inset space ~
21768 With five volumes you could just fill that gap on that second shelf.
21772 \begin_inset Quotes erd
21783 \begin_layout Paragraph
21787 \begin_layout Standard
21788 The width of the columns is automatically calculated,
21789 but you can modify the space between the columns.
21790 This is done by changing the length
21791 \begin_inset Flex Code
21794 \begin_layout Plain Layout
21803 Its predefined value is 10
21804 \begin_inset space \thinspace{}
21808 Here is an example where
21809 \begin_inset Flex Code
21812 \begin_layout Plain Layout
21821 \begin_inset space \thinspace{}
21827 \begin_layout Standard
21831 \begin_layout Plain Layout
21845 \begin_layout Standard
21846 \begin_inset Flex Multiple Columns
21849 \begin_layout Plain Layout
21852 My observations of No.
21853 \begin_inset space \space{}
21856 427 Park Lane did little to clear up the problem in which I was interested.
21857 The house was separated from the street by a low wall and railing,
21858 the whole not more than five feet high.
21859 It was perfectly easy,
21861 for anyone to get into the garden,
21862 but the window was entirely inaccessible,
21863 since there was no water pipe or anything which could help the most active man to climb it.
21864 More puzzled than ever,
21865 I retraced my steps to Kensington.
21866 I had not been in my study five minutes when the maid entered to say that a person desired to see me.
21867 To my astonishment it was none other than my strange old book collector,
21869 wizened face peering out from a frame of white hair,
21870 and his precious volumes,
21871 a dozen of them at least,
21872 wedged under his right arm.
21880 \begin_layout Standard
21884 \begin_layout Plain Layout
21896 \begin_inset Note Note
21899 \begin_layout Plain Layout
21900 go back to the default
21908 \begin_layout Paragraph
21912 \begin_layout Standard
21913 Between the columns a rule with a width of the length
21914 \begin_inset Flex Code
21917 \begin_layout Plain Layout
21926 If this rule width is set to 0
21927 \begin_inset space \thinspace{}
21930 pt (this is the default),
21931 the rule is suppressed.
21932 In the following example the rule is 2
21933 \begin_inset space \thinspace{}
21939 \begin_layout Standard
21943 \begin_layout Plain Layout
21949 columnseprule}{2pt}
21957 \begin_layout Standard
21958 \begin_inset Flex Multiple Columns
21961 \begin_layout Plain Layout
21964 \begin_inset Quotes eld
21967 You're surprised to see me,
21969 \begin_inset Quotes erd
21977 \begin_layout Plain Layout
21980 I acknowledged that I was.
21983 \begin_layout Plain Layout
21986 \begin_inset Quotes eld
21992 and when I chanced to see you go into this house,
21993 as I came hobbling after you,
21994 I thought to myself,
21995 I'll just step in and see that kind gentleman,
21996 and tell him that if I was a bit gruff in my manner there was not any harm meant,
21997 and that I am much obliged to him for picking up my books.
21998 \begin_inset Quotes erd
22004 \begin_layout Plain Layout
22007 \begin_inset Quotes eld
22010 You make too much of a trifle,
22011 \begin_inset Quotes erd
22016 \begin_inset Quotes eld
22019 May I ask how you knew who I was?
22020 \begin_inset Quotes erd
22026 \begin_layout Plain Layout
22029 \begin_inset Quotes eld
22034 if it isn't too great a liberty,
22035 I am a neighbour of yours,
22036 for you'll find my little bookshop at the corner of Church Street,
22037 and very happy to see you,
22039 Maybe you collect yourself,
22044 \begin_inset space ~
22060 \begin_inset space ~
22065 With five volumes you could just fill that gap on that second shelf.
22069 \begin_inset Quotes erd
22080 \begin_layout Standard
22081 \begin_inset VSpace defskip
22087 \begin_layout Standard
22088 The rule can be colored by redefining the command
22089 \begin_inset Flex Code
22092 \begin_layout Plain Layout
22101 This is done by inserting the command
22104 \begin_layout LyX-Code
22109 columnseprulecolor}{
22114 \begin_layout Standard
22115 as \SpecialChar TeX
22116 Code before the multicolumn inset.
22118 \begin_inset Flex Code
22121 \begin_layout Plain Layout
22127 in this command by a color of your choice.
22128 You can use all pre- and self-defined colors.
22137 \begin_inset space ~
22142 for more information about pre- and self-defined colors.
22143 To go back to the default color insert the command
22146 \begin_layout LyX-Code
22151 columnseprulecolor}{
22156 \begin_layout Standard
22157 Here is the example with a cyan rule and 1
22158 \begin_inset space \thinspace{}
22161 cm column separation:
22164 \begin_layout Standard
22168 \begin_layout Plain Layout
22177 \begin_layout Plain Layout
22183 columnseprulecolor}{
22193 \begin_layout Standard
22194 \begin_inset Flex Multiple Columns
22197 \begin_layout Plain Layout
22200 \begin_inset Quotes eld
22203 You're surprised to see me,
22205 \begin_inset Quotes erd
22213 \begin_layout Plain Layout
22216 I acknowledged that I was.
22219 \begin_layout Plain Layout
22222 \begin_inset Quotes eld
22228 and when I chanced to see you go into this house,
22229 as I came hobbling after you,
22230 I thought to myself,
22231 I'll just step in and see that kind gentleman,
22232 and tell him that if I was a bit gruff in my manner there was not any harm meant,
22233 and that I am much obliged to him for picking up my books.
22234 \begin_inset Quotes erd
22240 \begin_layout Plain Layout
22243 \begin_inset Quotes eld
22246 You make too much of a trifle,
22247 \begin_inset Quotes erd
22252 \begin_inset Quotes eld
22255 May I ask how you knew who I was?
22256 \begin_inset Quotes erd
22262 \begin_layout Plain Layout
22265 \begin_inset Quotes eld
22270 if it isn't too great a liberty,
22271 I am a neighbour of yours,
22272 for you'll find my little bookshop at the corner of Church Street,
22273 and very happy to see you,
22275 Maybe you collect yourself,
22280 \begin_inset space ~
22296 \begin_inset space ~
22301 With five volumes you could just fill that gap on that second shelf.
22305 \begin_inset Quotes erd
22316 \begin_layout Standard
22320 \begin_layout Plain Layout
22326 columnseprule}{0pt}
22329 \begin_layout Plain Layout
22335 columnseprulecolor}{
22343 \begin_inset Note Note
22346 \begin_layout Plain Layout
22347 go back to the default
22355 \begin_layout Section
22357 \change_inserted 564990737 1671270380
22361 \begin_layout Subsection
22363 \change_inserted 564990737 1671270398
22365 \change_deleted 564990737 1671270396
22371 \begin_layout Standard
22374 as well as any other text processor uses by default rectangular paragraphs.
22375 For special cases like for example posters,
22376 invitation cards or poems you can modify the paragraph shape to one of your choice.
22378 \change_deleted 564990737 1672311802
22379 This can be done by using the \SpecialChar LaTeX
22381 \begin_inset Flex Code
22384 \begin_layout Plain Layout
22390 which is loaded by using in the document settings the module
22392 Custom paragraph shapes
22395 \change_inserted 564990737 1672311802
22398 This module uses the
22402 package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
22408 \begin_layout Subsubsection
22412 \begin_layout Standard
22417 provides the following shapes:
22420 \begin_layout Standard
22421 \begin_inset Tabular
22422 <lyxtabular version="3" rows="13" columns="3">
22423 <features booktabs="true" islongtable="true" longtabularalignment="center">
22424 <column alignment="left" valignment="middle" width="16col%">
22425 <column alignment="left" valignment="middle" width="40col%">
22426 <column alignment="left" valignment="middle" width="35col%">
22427 <row endhead="true">
22428 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22431 \begin_layout Plain Layout
22440 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22443 \begin_layout Plain Layout
22452 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22455 \begin_layout Plain Layout
22465 <row interlinespace="default">
22466 <cell alignment="left" valignment="top" usebox="none">
22469 \begin_layout Plain Layout
22477 <cell alignment="left" valignment="top" usebox="none">
22480 \begin_layout Plain Layout
22483 Circle with circular hole (in the size of a CD/DVD)
22488 <cell alignment="left" valignment="top" usebox="none">
22491 \begin_layout Plain Layout
22495 take care there is not too much text
22501 <row interlinespace="default">
22502 <cell alignment="left" valignment="top" usebox="none">
22505 \begin_layout Plain Layout
22513 <cell alignment="left" valignment="top" usebox="none">
22516 \begin_layout Plain Layout
22524 <cell alignment="left" valignment="top" usebox="none">
22527 \begin_layout Plain Layout
22531 calculation might fail
22537 <row interlinespace="default">
22538 <cell alignment="left" valignment="top" usebox="none">
22541 \begin_layout Plain Layout
22549 <cell alignment="left" valignment="top" usebox="none">
22552 \begin_layout Plain Layout
22555 Rhomboid (symbolizing a
22556 \begin_inset Quotes eld
22560 \begin_inset Quotes erd
22568 <cell alignment="left" valignment="top" usebox="none">
22571 \begin_layout Plain Layout
22580 <row interlinespace="default">
22581 <cell alignment="left" valignment="top" usebox="none">
22584 \begin_layout Plain Layout
22592 <cell alignment="left" valignment="top" usebox="none">
22595 \begin_layout Plain Layout
22603 <cell alignment="left" valignment="top" usebox="none">
22606 \begin_layout Plain Layout
22615 <row interlinespace="default">
22616 <cell alignment="left" valignment="top" usebox="none">
22619 \begin_layout Plain Layout
22627 <cell alignment="left" valignment="top" usebox="none">
22630 \begin_layout Plain Layout
22638 <cell alignment="left" valignment="top" usebox="none">
22641 \begin_layout Plain Layout
22650 <row interlinespace="default">
22651 <cell alignment="left" valignment="top" usebox="none">
22654 \begin_layout Plain Layout
22662 <cell alignment="left" valignment="top" usebox="none">
22665 \begin_layout Plain Layout
22668 Nut for bolt (hexagon with circular hole)
22673 <cell alignment="left" valignment="top" usebox="none">
22676 \begin_layout Plain Layout
22685 <row interlinespace="default">
22686 <cell alignment="left" valignment="top" usebox="none">
22689 \begin_layout Plain Layout
22697 <cell alignment="left" valignment="top" usebox="none">
22700 \begin_layout Plain Layout
22708 <cell alignment="left" valignment="top" usebox="none">
22711 \begin_layout Plain Layout
22720 <row interlinespace="default">
22721 <cell alignment="left" valignment="top" usebox="none">
22724 \begin_layout Plain Layout
22732 <cell alignment="left" valignment="top" usebox="none">
22735 \begin_layout Plain Layout
22743 <cell alignment="left" valignment="top" usebox="none">
22746 \begin_layout Plain Layout
22755 <row interlinespace="default">
22756 <cell alignment="left" valignment="top" usebox="none">
22759 \begin_layout Plain Layout
22767 <cell alignment="left" valignment="top" usebox="none">
22770 \begin_layout Plain Layout
22778 <cell alignment="left" valignment="top" usebox="none">
22781 \begin_layout Plain Layout
22790 <row interlinespace="default">
22791 <cell alignment="left" valignment="top" usebox="none">
22794 \begin_layout Plain Layout
22802 <cell alignment="left" valignment="top" usebox="none">
22805 \begin_layout Plain Layout
22808 Normal/reversed rain drop
22813 <cell alignment="left" valignment="top" usebox="none">
22816 \begin_layout Plain Layout
22820 calculation might fail
22826 <row interlinespace="default">
22827 <cell alignment="left" valignment="top" usebox="none">
22830 \begin_layout Plain Layout
22839 <cell alignment="left" valignment="top" usebox="none">
22842 \begin_layout Plain Layout
22845 The \SpecialChar TeX
22851 <cell alignment="left" valignment="top" usebox="none">
22854 \begin_layout Plain Layout
22863 <row interlinespace="default">
22864 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22867 \begin_layout Plain Layout
22871 \begin_inset Newline newline
22879 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22882 \begin_layout Plain Layout
22885 Triangles in different orientations
22890 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22893 \begin_layout Plain Layout
22909 \begin_layout Standard
22910 To use a shape for your paragraph,
22911 simply select it in \SpecialChar LyX
22912 's pull-down box for environments in the toolbar.
22915 \begin_layout Standard
22916 \begin_inset Newpage newpage
22922 \begin_layout Standard
22923 Here is an example paragraph in the shape of a nut:
22926 \begin_layout Standard
22927 \begin_inset VSpace bigskip
22936 Lorem ipsum dolor sit amet,
22937 consetetur sadipscing elitr,
22938 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22940 At vero eos et accusam et justo duo dolores et ea rebum.
22941 Stet clita kasd gubergren,
22942 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22943 Lorem ipsum dolor sit amet,
22944 consetetur sadipscing elitr,
22945 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22949 \begin_layout Standard
22950 \begin_inset VSpace bigskip
22956 \begin_layout Standard
22957 \begin_inset Note Greyedout
22960 \begin_layout Plain Layout
22970 paragraphs cannot run over a page break.
22978 \begin_layout Standard
22979 \begin_inset VSpace bigskip
22985 \begin_layout Standard
22987 \begin_inset Flex Code
22990 \begin_layout Plain Layout
22996 takes care that the shape will always be preserved,
22997 no matter how much text is in the paragraph.
22998 Therefore the paragraph size changes with the amount of contained text.
22999 This can lead to paragraph sizes exceeding the page margins.
23000 To demonstrate the size scaling,
23001 here is the same example paragraph but with twice as much text:
23004 \begin_layout Standard
23005 \begin_inset Newpage newpage
23014 Lorem ipsum dolor sit amet,
23015 consetetur sadipscing elitr,
23016 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23018 At vero eos et accusam et justo duo dolores et ea rebum.
23019 Stet clita kasd gubergren,
23020 no sea takimata sanctus est Lorem ipsum dolor sit amet.
23021 Lorem ipsum dolor sit amet,
23022 consetetur sadipscing elitr,
23023 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23025 Lorem ipsum dolor sit amet,
23026 consetetur sadipscing elitr,
23027 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23029 At vero eos et accusam et justo duo dolores et ea rebum.
23030 Stet clita kasd gubergren,
23031 no sea takimata sanctus est Lorem ipsum dolor sit amet.
23032 Lorem ipsum dolor sit amet,
23033 consetetur sadipscing elitr,
23034 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23038 \begin_layout Standard
23039 \begin_inset VSpace bigskip
23045 \begin_layout Standard
23046 An exception is the shape
23051 It cannot be scaled because it must fit the size of a CD/DVD.
23052 Therefore the amount of text that fits into the shape is limited.
23053 \begin_inset Newline newline
23065 meaning that the calculation of their size can fail,
23066 depending on the amount of text.
23067 You will then get the \SpecialChar LaTeX
23069 \begin_inset Quotes eld
23072 Arithmetic overflow
23073 \begin_inset Quotes erd
23077 In this case one can try to remove or add some text;
23078 if nothing works one has to use another shape.
23081 \begin_layout Standard
23082 \begin_inset VSpace bigskip
23088 \begin_layout Standard
23089 For shapes with tips you will maybe see that \SpecialChar LaTeX
23090 's hyphenation routine fails for text in the tips.
23091 Therefore it is often necessary to add hyphenation points
23096 arg "specialchar-insert hyphenation"
23101 ) to the corresponding text parts.
23104 \begin_layout Standard
23105 \begin_inset VSpace bigskip
23111 \begin_layout Standard
23112 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
23113 You can therefore not use the paragraph dialog to align such paragraphs.
23114 A solution is to put the paragraph into a minipage or parbox and align the box.
23115 The problem is hereby to find the right width for the box.
23116 Because if it is too wide and you center the box,
23117 the paragraph is not centered too because it sticks at the left side of the box.
23118 So you might have to play a bit with the width until it fits.
23119 Here are two heart-shaped paragraphs,
23120 the first one is not aligned,
23121 the second one is right-aligned:
23124 \begin_layout Standard
23125 \begin_inset Newpage newpage
23131 \begin_layout Heart
23135 Lo\SpecialChar softhyphen
23136 rem ipsum dolor sit amet,
23137 consetetur sadipscing elitr,
23138 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23140 At vero eos et accusam et justo duo dolores et ea rebum.
23141 Stet clita kasd gubergren,
23142 no sea takimata sanctus est Lorem ipsum dolor sit amet.
23145 \begin_layout Standard
23146 \begin_inset VSpace bigskip
23152 \begin_layout Standard
23155 \begin_inset Box Frameless
23165 height_special "totalheight"
23170 backgroundcolor "none"
23173 \begin_layout Heart
23177 Lo\SpecialChar softhyphen
23178 rem ipsum dolor sit amet,
23179 consetetur sadipscing elitr,
23180 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23182 At vero eos et accusam et justo duo dolores et ea rebum.
23183 Stet clita kasd gubergren,
23184 no sea takimata sanctus est Lorem ipsum dolor sit amet.
23192 \begin_layout Subsubsection
23196 \begin_layout Standard
23197 You can define any shape you want.
23198 Doing this manually is a lot of work because every coordinate must be specified.
23199 But there is a way to let the computer calculate the coordinates:
23202 \begin_layout Enumerate
23203 Install the program
23204 \begin_inset CommandInset href
23207 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
23215 \begin_layout Enumerate
23222 TeX/LaTeX\SpecialChar menuseparator
23223 Settings\SpecialChar menuseparator
23226 and select the font size you are using in your document.
23227 For example this document uses the size 12
23228 \begin_inset space \thinspace{}
23234 \begin_layout Enumerate
23238 \begin_layout Enumerate
23241 TeX/LaTeX\SpecialChar menuseparator
23244 to export the shape to coordinates.
23245 In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
23249 \begin_layout Plain Layout
23250 For more information see
23251 \begin_inset CommandInset href
23253 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
23266 \begin_layout Standard
23267 The coordinates are written into a \SpecialChar TeX
23269 To use it for your \SpecialChar LyX
23273 \begin_layout Enumerate
23274 Place the cursor before the first character of your paragraph (or into a new empty one).
23277 \begin_layout Enumerate
23278 Open in \SpecialChar LyX
23281 Insert\SpecialChar menuseparator
23282 File\SpecialChar menuseparator
23284 \begin_inset space ~
23290 select the file and use
23299 \begin_layout Standard
23300 \begin_inset VSpace defskip
23306 \begin_layout Standard
23307 \begin_inset Note Greyedout
23310 \begin_layout Plain Layout
23316 The changed shape only applies to the current paragraph;
23317 everything is reset to normal for the next paragraph.
23318 Therefore the shape definition file must be input into every paragraph with the desired shape.
23326 \begin_layout Standard
23327 \begin_inset VSpace bigskip
23333 \begin_layout Standard
23334 Here is an example:
23337 \begin_layout Standard
23338 \begin_inset VSpace bigskip
23344 \begin_layout Standard
23345 \begin_inset CommandInset include
23347 filename "SpecialParagraphShape.tex"
23354 Lorem ipsum dolor sit amet,
23355 consetetur sadipscing elitr,
23356 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23358 At vero eos et accusam et justo duo dolores et ea rebum.
23359 Stet clita kasd gubergren,
23360 no sea takimata sanctus est Lorem ipsum dolor sit amet.
23361 Lorem ipsum dolor sit amet,
23362 consetetur sadipscing elitr,
23363 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23367 \begin_layout Standard
23368 \begin_inset VSpace bigskip
23374 \begin_layout Standard
23380 to draw complexer shapes in
23384 you can draw the shape in a program of your choice and import the resulting image to
23389 Then you only need to draw a line or spline along the outline of the image.
23392 \begin_layout Standard
23393 \begin_inset VSpace bigskip
23399 \begin_layout Standard
23402 Custom paragraph shapes
23404 also provides the two commands
23412 which can be used to define custom shapes coordinate by coordinate.
23416 \begin_layout Plain Layout
23417 These commands are internally used for all shapes described here.
23422 For information how these styles are used and about further customization possibilities,
23424 \begin_inset CommandInset href
23426 name "documentation"
23427 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
23433 \begin_inset Flex Code
23436 \begin_layout Plain Layout
23445 \begin_layout Subsection
23447 \change_inserted 564990737 1672311925
23453 \begin_layout Hanging
23455 \change_inserted 564990737 1672311925
23458 This module adds the
23464 one where all but the first line of the paragraph is indented.
23465 This may not appear in your \SpecialChar LyX
23466 document but will appear in the final output.
23469 \begin_layout Subsection
23471 \change_inserted 564990737 1672311925
23474 \begin_inset CommandInset label
23476 name "subsec:Initials"
23480 Initials (Drop Caps)
23483 \begin_layout Initial
23485 \change_inserted 564990737 1672311925
23488 \begin_inset Argument 2
23491 \begin_layout Plain Layout
23493 \change_inserted 564990737 1672311925
23504 \begin_inset Argument 3
23507 \begin_layout Plain Layout
23509 \change_inserted 564990737 1672311925
23519 module adds a drop capitals paragraph style
23523 for paragraph environments which you can use wherever you want to have drop capitals.
23524 You then have three more items in the
23531 \begin_layout Itemize
23533 \change_inserted 564990737 1672311925
23539 which creates an inset for the drop capital
23542 \begin_layout Itemize
23544 \change_inserted 564990737 1672311925
23550 which creates an inset for the rest of the word
23553 \begin_layout Itemize
23555 \change_inserted 564990737 1672311925
23561 which allow you configure the formatting of the drop capital.
23564 \begin_layout Standard
23566 \change_inserted 564990737 1672311925
23569 To customize the appearance of the style,
23572 Help\SpecialChar menuseparator
23573 Embedded Objects\SpecialChar menuseparator
23574 Objects Surrounded by Text\SpecialChar menuseparator
23580 \begin_layout Section
23582 \change_inserted 564990737 1672312011
23588 \begin_layout Subsection
23590 \change_inserted 564990737 1672312011
23593 Hyphenatable Text Markup
23596 \begin_layout Standard
23598 \change_inserted 564990737 1672312011
23601 This package defines text styles to highlight,
23604 underline and capitalize/small-cap text by means of the
23609 As opposed to the markup provided by the Text Properties dialog,
23610 words marked-up with
23616 \begin_inset CommandInset href
23618 name "soul documentation"
23619 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
23627 \begin_layout Subsection
23629 \change_inserted 564990737 1672312011
23635 \begin_layout Standard
23637 \change_inserted 564990737 1672312011
23640 This module defines some character styles for logical markup:
23644 \begin_inset Flex Noun
23647 \begin_layout Plain Layout
23649 \change_inserted 564990737 1672312011
23666 \begin_inset Flex Emph
23669 \begin_layout Plain Layout
23671 \change_inserted 564990737 1672312011
23686 \begin_inset Flex Strong
23689 \begin_layout Plain Layout
23691 \change_inserted 564990737 1672312011
23703 \begin_inset Flex Code
23706 \begin_layout Plain Layout
23708 \change_inserted 564990737 1672312011
23718 which are accessed via the
23723 dit\SpecialChar menuseparator
23725 \begin_inset space ~
23729 \begin_inset space ~
23741 \begin_layout Chapter
23743 \change_deleted 564990737 1671304317
23747 \change_inserted 564990737 1671304322
23749 \change_deleted 564990737 1671304331
23750 ies with Bib\SpecialChar TeX
23756 \begin_layout Standard
23757 The most basic information about how to use Bib\SpecialChar TeX
23762 with \SpecialChar LyX
23763 is contained in the section
23765 Bibliography databases
23772 The following subsections explain special bibliography features supported by \SpecialChar LyX
23776 \begin_layout Section
23777 Alternative Citation Styles
23780 \begin_layout Standard
23781 Standard Bib\SpecialChar TeX
23783 \begin_inset space \thinspace{}
23787 \begin_inset space \space{}
23791 \begin_inset Quotes eld
23795 \begin_inset Quotes erd
23798 ) to refer to a cited work.
23800 in many scientific disciplines,
23801 other citation styles are in use.
23802 The most common one is the author-year style (e.
23803 \begin_inset space \thinspace{}
23807 \begin_inset space \space{}
23811 \begin_inset Quotes eld
23815 \begin_inset Quotes erd
23820 supports three packages that provide this style,
23822 \begin_inset Flex Code
23825 \begin_layout Plain Layout
23833 \begin_inset Flex Code
23836 \begin_layout Plain Layout
23844 \begin_inset Flex Code
23847 \begin_layout Plain Layout
23854 Each of these packages has their pros and cons,
23855 which cannot be listed in detail.
23856 If you only want to have simple author-year (or author-numerical) style,
23857 or if you want to use one of the countless style files for
23858 \begin_inset Flex Code
23861 \begin_layout Plain Layout
23868 then the established
23869 \begin_inset Flex Code
23872 \begin_layout Plain Layout
23878 package is probably your choice.
23879 If you look for specific citation styles common in law studies,
23880 you might consider the
23881 \begin_inset Flex Code
23884 \begin_layout Plain Layout
23891 If you want to have full control over the formatting or look for advanced features such as ibidem,
23892 footnote citations,
23893 full title citations,
23894 advanced date formats (such as 400 BC) or full localization to other languages than English,
23895 you should definitely consider
23896 \begin_inset Flex Code
23899 \begin_layout Plain Layout
23906 which exceeds all other packages in terms of features,
23907 but is also quite heavy and more resource-hungry.
23910 \begin_layout Standard
23911 The handling of these packages in \SpecialChar LyX
23912 is basically the same.
23914 \begin_inset Flex Noun
23917 \begin_layout Plain Layout
23918 Document\SpecialChar menuseparator
23925 \begin_inset Flex Noun
23928 \begin_layout Plain Layout
23935 \begin_inset Flex Noun
23938 \begin_layout Plain Layout
23945 \begin_inset Flex Noun
23948 \begin_layout Plain Layout
23956 \begin_inset Flex Noun
23959 \begin_layout Plain Layout
23967 \begin_inset Flex Noun
23970 \begin_layout Plain Layout
23971 Biblatex (Natbib mode)
23978 \begin_inset Flex Noun
23981 \begin_layout Plain Layout
23988 \begin_inset Flex Noun
23991 \begin_layout Plain Layout
23998 \begin_inset space ~
24001 6.5.3 in the User's Guide for more information on these choices).
24002 With all these packages,
24003 you will get some extra features in the citation dialog and you can select the style of the reference (
24004 \begin_inset Quotes eld
24008 \begin_inset Quotes erd
24013 \begin_inset Quotes eld
24017 \begin_inset Quotes erd
24022 \begin_inset Quotes eld
24027 \begin_inset Quotes erd
24032 \begin_inset Quotes eld
24036 \begin_inset Quotes erd
24040 Note that either package needs specifically designed style files.
24041 They all ship their own,
24042 but there are lots of additional style files,
24043 and there is even an interactive style file builder
24047 \begin_layout Plain Layout
24049 \begin_inset Flex URL
24052 \begin_layout Plain Layout
24054 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
24065 \begin_inset Flex Code
24068 \begin_layout Plain Layout
24077 \begin_layout Section
24078 Subdivided Bibliographies
24081 \begin_layout Standard
24082 Sometimes you might need to divide your bibliography into several sections.
24083 If you are for instance a historian,
24084 the possibility to separate sources and scientific works is most likely a
24085 \begin_inset Quotes eld
24089 \begin_inset Quotes erd
24094 Bib\SpecialChar TeX
24095 itself does not allow you to do this.
24096 But with the help of some \SpecialChar LaTeX
24098 Bib\SpecialChar TeX
24099 can be extended to fit your needs.
24102 \begin_layout Standard
24104 provides native support for one of these packages,
24113 \begin_layout Plain Layout
24115 \begin_inset Flex URL
24118 \begin_layout Plain Layout
24120 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
24130 The advantage of this package (compared to other packages such as
24134 ) is that you don't need to define new citation commands.
24136 you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
24138 If you want to divide your bibliography into the sections
24139 \begin_inset Quotes eld
24143 \begin_inset Quotes erd
24147 \begin_inset Quotes eld
24151 \begin_inset Quotes erd
24155 you first need to create two bibliographic databases,
24157 \begin_inset space \thinspace{}
24161 \begin_inset space \space{}
24165 \begin_inset Flex Code
24168 \begin_layout Plain Layout
24175 \begin_inset Flex Code
24178 \begin_layout Plain Layout
24188 \begin_layout Standard
24190 \begin_inset Flex Noun
24193 \begin_layout Plain Layout
24194 Document\SpecialChar menuseparator
24201 \begin_inset Flex Noun
24204 \begin_layout Plain Layout
24211 \begin_inset Flex Noun
24214 \begin_layout Plain Layout
24215 Subdivided bibliography
24221 Now you can insert multiple Bib\SpecialChar TeX
24223 one for each section of your bibliography.
24224 Returning to our example:
24225 Insert the Bib\SpecialChar TeX
24227 \begin_inset Flex Code
24230 \begin_layout Plain Layout
24236 and a second one for the database
24237 \begin_inset Flex Code
24240 \begin_layout Plain Layout
24247 You are free to use the same or different styles for each section.
24249 you can choose if the bibliography section should contain
24250 \begin_inset Quotes eld
24253 all cited references
24254 \begin_inset Quotes erd
24257 of the specified database(s) (which is the default),
24259 \begin_inset Quotes eld
24262 all uncited references
24263 \begin_inset Quotes erd
24267 \begin_inset Quotes eld
24271 \begin_inset Quotes erd
24275 This might be useful if you would like to separate your bibliography into three sections:
24277 \begin_inset Quotes eld
24281 \begin_inset Quotes erd
24286 \begin_inset Quotes eld
24290 \begin_inset Quotes erd
24295 \begin_inset Quotes eld
24299 \begin_inset Quotes erd
24303 The titles for the sections can be added as ordinary sections or subsections.
24305 \begin_inset Flex Code
24308 \begin_layout Plain Layout
24314 removes the bibliography title,
24315 you have to manually re-add that,
24316 too (as a chapter* or section*,
24320 \begin_layout Standard
24326 the procedure is a bit different.
24337 \begin_inset Flex Noun
24340 \begin_layout Plain Layout
24341 Subdivided bibliography
24346 option is disabled if you use
24356 provides its own means to generate subdivided bibliographies.
24357 You can either add keywords to bibliography entries via the
24358 \begin_inset Flex Code
24361 \begin_layout Plain Layout
24367 entry option and then filter bibliography sections by keyword (by adding
24368 \begin_inset Flex Code
24371 \begin_layout Plain Layout
24378 \begin_inset Flex Noun
24381 \begin_layout Plain Layout
24387 field of the dialog that opens if you left-click on the
24388 \begin_inset Flex Noun
24391 \begin_layout Plain Layout
24392 Biblatex Generated Bibliography
24398 or you can filter by entry types (such as
24407 \begin_inset space \thinspace{}
24412 \begin_inset Flex Code
24415 \begin_layout Plain Layout
24422 \begin_inset Flex Code
24425 \begin_layout Plain Layout
24432 \begin_inset Flex Noun
24435 \begin_layout Plain Layout
24442 or you can create so-called
24443 \begin_inset Quotes eld
24446 Bibliography Categories
24447 \begin_inset Quotes erd
24450 to which you can assign individual entries.
24451 Please refer to the Biblatex manual,
24454 Subdivided Bibliographies
24460 \begin_layout Section
24461 Multiple Bibliographies
24462 \begin_inset CommandInset label
24464 name "subsec:Multiple-Bibliographies"
24471 \begin_layout Standard
24472 Multiple bibliographies,
24474 \begin_inset space \thinspace{}
24478 \begin_inset space \space{}
24481 a bibliography for each part,
24484 subsection or child (sub-document) of the document,
24485 are also supported by \SpecialChar LyX
24487 In order to enable it,
24489 \begin_inset Flex Noun
24492 \begin_layout Plain Layout
24493 Document\SpecialChar menuseparator
24494 Settings\SpecialChar menuseparator
24500 and select the relevant unit (e.
24501 \begin_inset space \thinspace{}
24506 \begin_inset Quotes eld
24510 \begin_inset Quotes erd
24514 \begin_inset Flex Noun
24517 \begin_layout Plain Layout
24518 Multiple Bibliographies
24524 Then add a Bib(la)\SpecialChar TeX
24525 bibliography to each unit (e.
24526 \begin_inset space \thinspace{}
24530 section) of your document.
24532 a separate bibliography,
24533 containing only the references done in the current unit is generated.
24536 \begin_layout Standard
24537 If you use Bib\SpecialChar TeX
24540 \begin_inset Flex Code
24543 \begin_layout Plain Layout
24550 \begin_inset Flex Code
24553 \begin_layout Plain Layout
24559 package is used to create multiple bibliographies.
24560 The former package is used if you select
24561 \begin_inset Quotes eld
24565 \begin_inset Quotes erd
24573 \begin_inset Flex Noun
24576 \begin_layout Plain Layout
24577 Sectioned Bibliography
24583 In all other cases,
24585 \begin_inset Flex Code
24588 \begin_layout Plain Layout
24598 \begin_layout Plain Layout
24599 An alternative approach,
24600 if you are willing to use some
24601 \begin_inset Flex Noun
24604 \begin_layout Plain Layout
24612 \begin_inset space ~
24616 \begin_inset CommandInset ref
24618 reference "sec:Inserting-TeX-Code"
24625 \begin_inset Flex Code
24628 \begin_layout Plain Layout
24640 \begin_inset Flex Code
24643 \begin_layout Plain Layout
24651 encloses the specified units in
24652 \begin_inset Flex Code
24655 \begin_layout Plain Layout
24662 \begin_inset Flex Code
24665 \begin_layout Plain Layout
24674 \begin_inset Flex Code
24677 \begin_layout Plain Layout
24685 in order to create the units.
24686 Note that this approach has some limitations.
24688 every citation reference has to be inside some
24689 \begin_inset Flex Code
24692 \begin_layout Plain Layout
24699 So citations outside a defined unit (e.
24700 \begin_inset space \thinspace{}
24704 before the first section if you use
24705 \begin_inset Quotes eld
24709 \begin_inset Quotes erd
24713 \begin_inset Quotes eld
24717 \begin_inset Quotes erd
24721 You can also create your own units by entering
24722 \begin_inset Flex Code
24725 \begin_layout Plain Layout
24734 \begin_inset Flex Code
24737 \begin_layout Plain Layout
24745 as \SpecialChar TeX
24746 code (for instance to work around the mentioned limitation).
24750 \begin_inset Flex Code
24753 \begin_layout Plain Layout
24759 s cannot be nested.
24760 A second limitation is that
24761 \begin_inset Flex Code
24764 \begin_layout Plain Layout
24770 always processes all references of a bibliography database,
24771 even if they are not cited.
24772 This can result in odd labels (e.
24773 \begin_inset space \thinspace{}
24778 \begin_inset Quotes eld
24782 \begin_inset Quotes erd
24785 if two works of this author from 2014 are in the database,
24786 even if only one is cited).
24789 \begin_layout Standard
24796 \begin_inset Flex Code
24799 \begin_layout Plain Layout
24805 option is used instead.
24806 If you need specific units,
24807 you can start them with the \SpecialChar TeX
24809 \begin_inset Flex Code
24812 \begin_layout Plain Layout
24821 \begin_inset Flex Code
24824 \begin_layout Plain Layout
24834 If you also want to control the end of the unit,
24835 use the environment
24836 \begin_inset Flex Code
24839 \begin_layout Plain Layout
24849 \begin_inset Flex Code
24852 \begin_layout Plain Layout
24864 \begin_inset Flex Code
24867 \begin_layout Plain Layout
24873 s cannot be nested.
24874 In addition to the individual bibliography of the current unit,
24879 also provides an easy way to output all bibliographies,
24882 \begin_inset space \thinspace{}
24886 at the end of the document).
24888 \begin_inset Quotes eld
24891 all reference units
24892 \begin_inset Quotes erd
24895 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
24896 Please refer to the
24900 manual for more information on this topic.
24903 \begin_layout Chapter
24905 \change_deleted 564990737 1671355654
24909 \change_inserted 564990737 1671355667
24911 \change_deleted 564990737 1671355661
24913 \change_inserted 564990737 1671355684
24915 \begin_inset CommandInset label
24917 name "chap:bullets"
24922 \change_deleted 564990737 1671355684
24924 \begin_inset CommandInset label
24935 \begin_layout Standard
24941 \begin_layout Section
24945 \begin_layout Standard
24947 provides 216 bullet shapes that can be accessed from a simple dialog.
24948 Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
24949 These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
24953 \begin_layout Plain Layout
24955 actually you can but you'll have to do it by hand.
24963 \begin_layout Section
24967 \begin_layout Standard
24968 Open the dialog by selecting the
24969 \begin_inset Flex Noun
24972 \begin_layout Plain Layout
24973 Document\SpecialChar menuseparator
24979 menu item and then select the
24980 \begin_inset Flex Noun
24983 \begin_layout Plain Layout
24992 \begin_layout Standard
24993 The dialog provides you with a table of bullet shapes.
24994 A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
24995 The row of buttons across the top is used to select which bullet depth you are changing.
24997 \change_deleted 244031559 1603875981
24998 A text entry under the table shows the currently selected bullet shape's \SpecialChar LaTeX
24999 equivalent and this can be edited if desired.
25000 If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
25006 \begin_layout Standard
25007 The six panels are divided up by the packages they require.
25008 The following table shows the mappings from button name to \SpecialChar LaTeX
25012 \begin_layout Standard
25014 \begin_inset Tabular
25015 <lyxtabular version="3" rows="7" columns="2">
25016 <features tabularvalignment="middle">
25017 <column alignment="center" valignment="top" width="0pt">
25018 <column alignment="center" valignment="top" width="0pt">
25020 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25023 \begin_layout Plain Layout
25038 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25041 \begin_layout Plain Layout
25058 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25061 \begin_layout Plain Layout
25076 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25079 \begin_layout Plain Layout
25088 base \SpecialChar LaTeX
25096 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25099 \begin_layout Plain Layout
25114 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25117 \begin_layout Plain Layout
25134 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25137 \begin_layout Plain Layout
25152 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25155 \begin_layout Plain Layout
25172 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25175 \begin_layout Plain Layout
25190 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25193 \begin_layout Plain Layout
25210 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25213 \begin_layout Plain Layout
25228 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25231 \begin_layout Plain Layout
25248 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25251 \begin_layout Plain Layout
25266 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25269 \begin_layout Plain Layout
25292 \begin_layout Standard
25294 doesn't stop you using bullets from packages you don't have.
25295 If you get errors from \SpecialChar LaTeX
25296 when you try to view or print the file,
25297 then it is likely you are missing a package.
25301 \begin_layout Plain Layout
25303 doesn't restrict your use since you may be editing locally and exporting elsewhere.
25311 \begin_layout Section
25315 \begin_layout Standard
25316 Select which bullet depth you want to change then select the bullet shape and size.
25317 Any changes will not be visible in \SpecialChar LyX
25319 but are visible when viewing the document.
25322 \begin_layout Standard
25323 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
25327 \begin_layout Plain Layout
25329 \change_inserted 564990737 1672138075
25330 \begin_inset CommandInset label
25332 name "fn:If-you-really"
25342 want to have multiple sets of paragraphs with different sets of bullets in each,
25343 then you're going to have to get your hands dirty with \SpecialChar TeX
25345 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
25346 code for a wide range of bullet shapes.
25347 To make your own custom paragraphs you have the following options:
25350 \begin_layout Plain Layout
25354 \begin_layout Plain Layout
25370 \begin_layout Plain Layout
25374 \begin_layout Plain Layout
25396 \begin_layout Itemize
25397 Use the \SpecialChar LaTeX
25399 \begin_inset Flex Code
25402 \begin_layout Plain Layout
25410 to specify a new bullet shape for a given depth.
25411 You'll also need to save the current bullet shape so you can restore it again afterwards.
25412 In this itemized list the following \SpecialChar LaTeX
25413 code was used to change the bullet used for the first depth.
25417 \begin_layout LyX-Code
25427 \begin_layout LyX-Code
25444 \begin_layout Itemize
25445 Note that the itemize depth is specified in Roman numerals as part of the
25454 \begin_layout Itemize
25455 \begin_inset Argument item:1
25458 \begin_layout Plain Layout
25462 \begin_layout Plain Layout
25480 Specify each individual entry by starting each item with the bullet shape enclosed in a
25481 \begin_inset Quotes eld
25485 \begin_inset Quotes erd
25488 inset (available at
25490 Insert\SpecialChar menuseparator
25494 \begin_inset Flex Noun
25497 \begin_layout Plain Layout
25506 this item was started with
25507 \begin_inset Flex Code
25510 \begin_layout Plain Layout
25525 \begin_layout Plain Layout
25529 \begin_layout Plain Layout
25545 \begin_layout Plain Layout
25546 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
25547 The way used here was:
25550 \begin_layout LyX-Code
25565 \begin_layout Chapter
25569 \begin_layout Section
25570 Multipart Documents
25573 \begin_layout Subsection
25577 \begin_layout Standard
25578 When you are working on a large file with many sections,
25579 it is often convenient to break up the document into several files,
25580 or perhaps you have something where a table may change from time to time,
25581 but the preceding text does not.
25583 you should seriously consider using multipart documents.
25585 scientific papers often have five major sections:
25591 Each of these could be its own separate \SpecialChar LyX
25594 \begin_inset Quotes eld
25598 \begin_inset Quotes erd
25601 file which contains the title,
25606 plus the five included files.
25607 It is important to note that each of these files is a full \SpecialChar LyX
25608 file which can be formatted and printed on its own,
25609 as well as included in a master file.
25610 Each of these files must have the same document class,
25612 don't attempt to mix book classes with article classes.
25613 You may also include \SpecialChar LaTeX
25616 these files must not have their own preamble (i.
25617 \begin_inset space \thinspace{}
25621 \begin_inset space \space{}
25624 everything up to and including the
25625 \begin_inset Flex Code
25628 \begin_layout Plain Layout
25636 line as well as the
25637 \begin_inset Flex Code
25640 \begin_layout Plain Layout
25648 line must be deleted) or else errors will be generated when you try to make a DVI file.
25651 \begin_layout Standard
25653 allows you to include files quite easily with
25654 \begin_inset Flex Noun
25657 \begin_layout Plain Layout
25658 Insert\SpecialChar menuseparator
25660 \begin_inset space ~
25669 When you click on this selection a small box is inserted into the file at the current cursor location.
25670 Clicking on the box raises a dialog which allows you to select the file to be included,
25671 and the method of its inclusion.
25675 \begin_layout Standard
25676 The file selection box should by now be obvious.
25677 The three inclusion methods are
25678 \begin_inset Quotes eld
25682 \begin_inset Quotes erd
25687 \begin_inset Quotes eld
25691 \begin_inset Quotes erd
25696 \begin_inset Quotes eld
25700 \begin_inset Quotes erd
25705 \begin_inset Quotes eld
25709 \begin_inset Quotes erd
25713 \begin_inset Quotes eld
25717 \begin_inset Quotes erd
25720 are similar in many ways,
25721 but there are also some notable differences:
25724 \begin_layout Enumerate
25726 \begin_inset Quotes eld
25730 \begin_inset Quotes erd
25733 are typeset beginning on a new page,
25734 while files that are
25735 \begin_inset Quotes eld
25739 \begin_inset Quotes erd
25742 are typeset starting on the current page.
25745 \begin_layout Enumerate
25746 \begin_inset Quotes eld
25750 \begin_inset Quotes erd
25753 files cannot themselves
25754 \begin_inset Quotes eld
25758 \begin_inset Quotes erd
25762 \begin_inset Quotes eld
25766 \begin_inset Quotes erd
25771 \begin_inset Quotes eld
25775 \begin_inset Quotes erd
25780 infinite sub-inputting is possible.
25783 \begin_layout Enumerate
25784 \begin_inset Quotes eld
25788 \begin_inset Quotes erd
25791 allow for the output of only selected
25792 \begin_inset Quotes eld
25796 \begin_inset Quotes erd
25800 while maintaining the actual counters (pagination etc.) and references (please refer to the section
25803 \begin_inset space ~
25811 \begin_inset space ~
25816 manual for details).
25819 \begin_layout Standard
25822 \begin_inset Quotes eld
25826 \begin_inset Quotes erd
25829 is the preferred method for chapters that are outsourced to child documents,
25831 \begin_inset Quotes eld
25835 \begin_inset Quotes erd
25838 is more suitable for arbitrary file inheritance.
25841 \begin_layout Standard
25843 \begin_inset Quotes eld
25847 \begin_inset Quotes erd
25850 included file allows you to include a file typeset exactly as it appears in the file,
25852 \begin_inset space \thinspace{}
25856 \begin_inset space \space{}
25860 \begin_inset Flex Code
25863 \begin_layout Plain Layout
25870 with the characters set in a fixed-width typewriter font.
25872 spaces in this file are invisible,
25873 though two consecutive spaces are conserved,
25874 unlike \SpecialChar LyX
25875 's normal treatment of spaces.
25878 \begin_inset Flex Noun
25881 \begin_layout Plain Layout
25883 \begin_inset space ~
25887 \begin_inset space ~
25891 \begin_inset space ~
25899 checkbox typesets a mark to unambiguously define the presence of a space.
25903 \begin_layout Standard
25905 the master file is converted into a full \SpecialChar LaTeX
25906 file before typesetting,
25907 while the included files are converted to \SpecialChar LaTeX
25908 files that do not have all the preamble information.
25911 \begin_layout Subsection
25912 Cross-References Between Files
25915 \begin_layout Standard
25916 \begin_inset Box Shadowbox
25926 height_special "totalheight"
25931 backgroundcolor "none"
25934 \begin_layout Plain Layout
25935 This section is somewhat out of date.
25936 Need to describe default master documents and how children are opened when the master is.
25945 \begin_layout Standard
25946 It is possible to set up cross-references between the different files.
25948 open all the files in question:
25949 let's call them A and B in a two file example,
25950 where B is included in A.
25951 Let's say you insert a label in A,
25952 then want to reference it in B.
25953 Open the cross-reference dialog whilst in document B,
25954 and you can select the
25955 \begin_inset Quotes eld
25959 \begin_inset Quotes erd
25965 \begin_layout Subsection
25966 Bibliography Lists in all Subdocuments
25969 \begin_layout Standard
25970 If you work with child documents,
25971 you might want to have only one main bibliography at the end,
25972 but still be able to have a selected bibliography for the child if you output it on its own.
25973 Here is how to achieve this.
25976 \begin_layout Standard
25977 For the main document,
25978 you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
25979 If the bibliography inset is in the master file,
25980 the references will be inherited by all children,
25981 so they are available in the citation dialog within each child.
25984 \begin_layout Standard
25985 For child-specific bibliographies,
25986 insert bibliography insets within the child documents,
25987 at the place where the bibliography should appear when the child is compiled separately.
25989 the trick is to insert them into a branch (
25991 Insert\SpecialChar menuseparator
25992 Branch\SpecialChar menuseparator
25993 Insert New Branch...
25997 \begin_inset space \thinspace{}
26002 \begin_inset Quotes eld
26006 \begin_inset Quotes erd
26010 Within the children,
26011 activate the branch (
26013 Document\SpecialChar menuseparator
26014 Settings...\SpecialChar menuseparator
26019 deactivate the branch (
26021 Document\SpecialChar menuseparator
26022 Settings...\SpecialChar menuseparator
26026 Now the child's bibliography will be ignored by the master,
26027 but considered by the child.
26030 \begin_layout Standard
26031 If you need multiple bibliographies (e.
26032 \begin_inset space \thinspace{}
26036 one per child in the
26041 please refer to sec.
26042 \begin_inset space ~
26046 \begin_inset CommandInset ref
26048 reference "subsec:Multiple-Bibliographies"
26056 \begin_layout Section
26061 \begin_layout Standard
26062 Users sometimes need to be able to
26063 \begin_inset Quotes eld
26067 \begin_inset Quotes erd
26071 file together with all the images (and other files) on which it depends,
26072 either for sending to a publisher or for sharing with a co-author.
26074 includes a Python script (
26075 \begin_inset Flex Code
26078 \begin_layout Plain Layout
26084 ) that automates this process.
26086 you must have either the
26087 \begin_inset Flex Code
26090 \begin_layout Plain Layout
26097 \begin_inset Flex Code
26100 \begin_layout Plain Layout
26106 python modules installed on your system.
26108 the script prefers the
26109 \begin_inset Flex Code
26112 \begin_layout Plain Layout
26119 \begin_inset Flex Code
26122 \begin_layout Plain Layout
26128 format on Unix-like systems and the
26129 \begin_inset Flex Code
26132 \begin_layout Plain Layout
26141 \begin_layout Standard
26143 's configuration process will set the script up to export a `\SpecialChar LyX
26145 and this format will then be available under
26146 \begin_inset Flex Code
26149 \begin_layout Plain Layout
26150 File\SpecialChar menuseparator
26159 \begin_layout Standard
26160 Independently of the platform,
26161 the generation of a particular archive format can be forced by adding either the
26162 \begin_inset Flex Code
26165 \begin_layout Plain Layout
26172 \begin_inset Flex Code
26175 \begin_layout Plain Layout
26182 \begin_inset Flex Code
26185 \begin_layout Plain Layout
26192 \begin_inset Flex Code
26195 \begin_layout Plain Layout
26201 format) switch to the
26202 \begin_inset Flex Code
26205 \begin_layout Plain Layout
26207 \SpecialChar menuseparator
26215 \begin_inset Flex Code
26218 \begin_layout Plain Layout
26219 Tools\SpecialChar menuseparator
26220 Preferences\SpecialChar menuseparator
26221 File Handling\SpecialChar menuseparator
26228 (Make sure you add the switch after the script name,
26232 \begin_layout Section
26233 Fancy Headers and Footers
26236 \begin_layout Standard
26237 The default page layout is rather plain;
26239 \begin_inset Flex Code
26242 \begin_layout Plain Layout
26249 all you get is a centered page number at the bottom of the page.
26250 This document uses KOMA-script's book class,
26251 so it appears to be a bit fancier.
26252 But to really put on a show,
26253 you need to set the document page style to
26254 \begin_inset Quotes eld
26258 \begin_inset Quotes erd
26262 as mentioned in the
26267 This section describes the \SpecialChar LaTeX
26268 code you need to insert in your \SpecialChar LaTeX
26269 preamble in order to get the desired effects.
26272 \begin_layout Standard
26273 For more information on fancy headers,
26275 \begin_inset Flex Code
26278 \begin_layout Plain Layout
26284 package documentation.
26286 \begin_inset Flex URL
26289 \begin_layout Plain Layout
26291 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
26299 \begin_layout Standard
26300 The page header is divided into three fields,
26301 not surprisingly labeled
26302 \begin_inset Quotes eld
26306 \begin_inset Quotes erd
26311 \begin_inset Quotes eld
26315 \begin_inset Quotes erd
26320 \begin_inset Quotes eld
26324 \begin_inset Quotes erd
26328 The footer is also divided into these three fields.
26329 The \SpecialChar LaTeX
26330 commands to set these fields in the simplest manner are
26331 \begin_inset Flex Code
26334 \begin_layout Plain Layout
26344 \begin_inset Flex Code
26347 \begin_layout Plain Layout
26357 \begin_inset Flex Code
26360 \begin_layout Plain Layout
26370 \begin_inset Flex Code
26373 \begin_layout Plain Layout
26383 Suppose you wish to put your name in the upper left hand corner of each page.
26384 Simply insert the following command in the preamble:
26388 \begin_layout Standard
26397 \begin_layout Standard
26398 You will now see your name in the upper left.
26399 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,
26401 \begin_inset space \thinspace{}
26407 \begin_layout Standard
26415 \begin_layout Standard
26416 Let's get really fancy:
26417 lets put the section number with the word
26418 \begin_inset Quotes eld
26422 \begin_inset Quotes erd
26426 \begin_inset space \thinspace{}
26430 \begin_inset space \space{}
26433 Section 3) in the upper left,
26434 the page number (e.
26435 \begin_inset space \thinspace{}
26439 \begin_inset space \space{}
26442 Page 4) in the upper right,
26443 your name in the lower left,
26444 and the date in the lower right.
26445 The following commands should now appear in the preamble:
26448 \begin_layout Standard
26458 \begin_layout Standard
26466 \begin_layout Standard
26476 \begin_layout Standard
26485 \begin_layout Standard
26493 \begin_layout Standard
26503 \begin_layout Standard
26505 \begin_inset Flex Code
26508 \begin_layout Plain Layout
26517 \begin_inset Flex Code
26520 \begin_layout Plain Layout
26528 access \SpecialChar LaTeX
26529 's section and page counters,
26530 and so print out the current section and page number.
26532 \begin_inset Flex Code
26535 \begin_layout Plain Layout
26543 simply prints out today's date.
26546 \begin_layout Standard
26547 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
26548 If you don't want one of the rules,
26549 set its thickness to 0.
26550 The header rule has a default thickness of 0.4pt,
26551 the footer rule is 0pt.
26557 \begin_inset Flex Code
26560 \begin_layout Plain Layout
26565 headrulewidth}{0.4pt}
26571 \begin_inset Flex Code
26574 \begin_layout Plain Layout
26579 footrulewidth}{0.4pt}
26584 to set the thicknesses.
26587 \begin_layout Standard
26588 You can switch the header/footer settings on and off for individual pages using commands like
26589 \begin_inset Flex Code
26592 \begin_layout Plain Layout
26595 thispagestyle{empty}
26602 \begin_inset Flex Code
26605 \begin_layout Plain Layout
26608 thispagestyle{plain}
26615 \begin_inset Flex Code
26618 \begin_layout Plain Layout
26621 thispagestyle{fancy}
26627 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
26630 title pages are marked as plain by default,
26631 while following pages are marked fancy when using the global fancy setting.
26634 \begin_layout Standard
26635 As a final example,
26636 it is possible to include an image in the header or footer.
26637 Suppose you want to put a company logo in the upper lefthand corner.
26638 You might try something like
26641 \begin_layout Standard
26650 includegraphics{logo.eps}}}
26653 \begin_layout Standard
26655 (you may need to preface this with
26656 \begin_inset Flex Code
26659 \begin_layout Plain Layout
26662 usepackage{graphics}
26667 if you don't include graphics elsewhere in your document).
26670 \begin_layout Chapter
26672 and the World Wide Web
26675 \begin_layout Standard
26677 has long supported the export of documents to various web-friendly formats,
26679 Before version 2.0,
26681 HTML export was always accomplished by the use of external converters.
26685 \begin_layout Plain Layout
26686 For details on the use of external converters with \SpecialChar LyX
26692 section of the Customization manual.
26697 These fall into two large groups:
26698 there are converters that use \SpecialChar LaTeX
26699 as an intermediate format,
26701 \begin_inset Flex Code
26704 \begin_layout Plain Layout
26712 \begin_inset Flex Code
26715 \begin_layout Plain Layout
26723 \begin_inset Flex Code
26726 \begin_layout Plain Layout
26733 relying upon \SpecialChar LyX
26734 to produce the \SpecialChar LaTeX
26736 and there is a converter that works directly on \SpecialChar LyX
26739 \begin_inset Flex Code
26742 \begin_layout Plain Layout
26750 All of these have different advantages and disadvantages.
26754 \begin_layout Standard
26755 The \SpecialChar LaTeX
26756 -based converters have the advantage that,
26758 they know everything about the exported document that \SpecialChar LaTeX
26760 Such converters do not care,
26762 if a certain block of code was produced by \SpecialChar LyX
26763 or was Evil Red Text.
26764 These converters know about
26765 \begin_inset Flex Code
26768 \begin_layout Plain Layout
26777 and can often make use of the
26778 \begin_inset Flex Code
26781 \begin_layout Plain Layout
26787 files generated by Bib\SpecialChar TeX
26791 is a very hard language to parse—
26792 it is sometimes said that only \SpecialChar TeX
26793 itself understands \SpecialChar TeX
26795 and \SpecialChar LaTeX
26796 -based converters will often choke on what seem to be quite simple constructs;
26797 complex ones can throw them completely,
26798 and as of this writing,
26804 manual will not export with
26805 \begin_inset Flex Code
26808 \begin_layout Plain Layout
26815 though the others will.
26816 The other issue concerns how math is handled.
26817 These converters typically convert the formulae into little pictures that are then linked from the HTML document.
26818 Since these are actually generated by \SpecialChar LaTeX
26821 But they do not scale well,
26822 and just getting them to look as if they are actually meant to be in your document—
26823 so that the font sizes seem to be roughly the same—
26824 can be a challenge.
26827 \begin_layout Standard
26829 \begin_inset Flex Code
26832 \begin_layout Plain Layout
26840 \begin_inset CommandInset href
26842 name "http://pinchito.es/elyxer/"
26843 target "http://pinchito.es/elyxer/"
26848 ) solves some of these problems.
26850 the formulae it produces scale perfectly,
26851 since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
26852 But even moderately complex formula are rendered less well than with
26853 \begin_inset Flex Code
26856 \begin_layout Plain Layout
26863 this reflects the limitations of HTML.
26867 \begin_layout Plain Layout
26870 \begin_inset Flex Code
26873 \begin_layout Plain Layout
26880 can also use jsMath and MathJax for equations,
26881 but this setting is only available globally and requires one to have access to a server that runs the backend.
26886 More importantly (as of version 1.1.1,
26889 \begin_inset Flex Code
26892 \begin_layout Plain Layout
26899 has limited support for math macros and no support for user-defined paragraph or character styles.
26900 These limitations make
26901 \begin_inset Flex Code
26904 \begin_layout Plain Layout
26911 unsuitable for many of the documents \SpecialChar LyX
26915 these problems could be solved,
26916 but the \SpecialChar LyX
26917 developers have decided to follow a different path and have made \SpecialChar LyX
26918 itself capable of writing XHTML,
26919 just as it is capable of writing \SpecialChar LaTeX
26925 \begin_layout Standard
26926 As of this writing,
26927 XHTML output remains under development and should probably be regarded as
26928 \begin_inset Quotes eld
26932 \begin_inset Quotes erd
26939 \begin_layout Plain Layout
26941 \begin_inset Flex Code
26944 \begin_layout Plain Layout
26945 development/HTML/HTML.notes
26951 which can be found in the \SpecialChar LyX
26953 \begin_inset CommandInset href
26955 name "accessed online"
26956 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
26962 usually contains up-to-date information about the state of XHTML output.
26963 See also the list of XHTML bugs on
26964 \begin_inset CommandInset href
26966 name "the bug tracker"
26967 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"
26978 the developers have chosen this approach because it has several potential advantages over the other two.
26981 \begin_layout Standard
26982 These advantages are primarily due to the fact that the XHTML output routines,
26983 since they are part of \SpecialChar LyX
26985 know everything \SpecialChar LyX
26986 knows about the document being exported.
26990 \begin_layout Plain Layout
26991 Another advantage is that,
26992 since these routines are internal to \SpecialChar LyX
26994 they are immune to changes in \SpecialChar LyX
26996 or to changes in the semantics of existing insets.
27001 So they know about the table of contents (as displayed in the outline),
27002 about the counters associated with different paragraph styles,
27003 and about user-defined styles.
27004 The XHTML output routines know what \SpecialChar LyX
27005 knows about internationalization,
27007 so they will output
27008 \begin_inset Quotes eld
27012 \begin_inset Quotes erd
27016 \begin_inset Quotes eld
27024 \begin_inset Quotes erd
27028 depending upon the language in effect at the time.
27032 \begin_layout Standard
27034 the output routines know what \SpecialChar LyX
27035 knows about document layout,
27037 about how the document is to be rendered on screen.
27038 We use this information when we output the document as XHTML.
27045 generates CSS style information corresponding to the layout information it uses to render the document on screen:
27046 if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
27048 then (by default) they will be sans-serif and bold when viewed in a web browser,
27050 And this is true not just for pre-defined styles,
27053 including user-defined styles.
27055 the XHTML output routines make no distinction between user-defined paragraph and
27056 \change_deleted 244031559 1603876931
27058 \change_inserted 244031559 1603876940
27061 styles and \SpecialChar LyX
27062 's own pre-defined styles:
27064 everything \SpecialChar LyX
27065 knows about the styles is contained in the layout files.
27066 And much the same is true as regards pre-defined textual insets,
27068 and various custom insets.
27072 \begin_layout Standard
27073 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
27074 output can be customized and extended:
27075 through layout files and modules.
27076 See chapter five of the
27080 manual for the details.
27083 \begin_layout Standard
27084 The remainder of this chapter contains more detailed information on XHTML output,
27086 and ways to work around those limitations.
27089 \begin_layout Section
27090 Math Output in XHTML
27093 \begin_layout Standard
27095 offers four choices for how math is rendered.
27096 These have various advantages and disadvantages:
27099 \begin_layout Itemize
27101 \begin_inset Newline newline
27104 MathML is a dialect of XML designed specifically for mathematics on the web,
27105 and it typically renders very well in browsers that support it.
27106 The disadvantage is that not all browsers support MathML,
27107 and support is not complete even in the Gecko-based browsers,
27109 \begin_inset Newline newline
27112 If \SpecialChar LyX
27113 is unable to render a formula as MathML—
27115 if the formula uses the
27116 \begin_inset Flex Code
27119 \begin_layout Plain Layout
27126 then it will instead output the formula as an image.
27130 \begin_layout Itemize
27132 \begin_inset Newline newline
27135 As mentioned above,
27137 \begin_inset Flex Code
27140 \begin_layout Plain Layout
27146 outputs math as HTML,
27151 \begin_layout Plain Layout
27153 has borrowed some of the CSS for its HTML output from
27154 \begin_inset Flex Code
27157 \begin_layout Plain Layout
27168 For simple formulae,
27169 this can work quite well,
27170 though with more complicated formulae it tends to break down.
27172 this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
27173 fairly simple math.
27174 \begin_inset Newline newline
27177 If Lyx is unable to render a formula as HTML—
27179 if the formula uses the
27180 \begin_inset Flex Code
27183 \begin_layout Plain Layout
27190 then it will instead output the formula as an image.
27194 \begin_layout Itemize
27196 \begin_inset Newline newline
27200 \begin_inset Flex Code
27203 \begin_layout Plain Layout
27211 will output formulae as images,
27212 the very same images,
27214 that are used for instant preview.
27218 \begin_layout Plain Layout
27219 Instant preview does
27223 have to be on for images to be output,
27229 The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
27231 so they are very accurate.
27233 as mentioned earlier,
27234 is that these are bitmapped images,
27235 so they do not scale terribly well,
27236 and one cannot copy them,
27238 \begin_inset Newline newline
27241 The size of the images can be controlled by setting the
27242 \begin_inset Quotes eld
27245 Math Images Scaling
27246 \begin_inset Quotes erd
27250 \begin_inset Flex Noun
27253 \begin_layout Plain Layout
27254 Document\SpecialChar menuseparator
27255 Settings\SpecialChar menuseparator
27265 \begin_layout Plain Layout
27266 For those who want to know,
27267 this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
27273 \begin_inset Newline newline
27276 If \SpecialChar LyX
27277 for some reason fails to create an image for a formula (e.g.,
27278 if a required \SpecialChar LaTeX
27279 package is not installed),
27280 then it will fall back to outputing the raw \SpecialChar LaTeX
27284 \begin_layout Itemize
27287 \begin_inset Newline newline
27292 will happily output math as \SpecialChar LaTeX
27294 As well as being the output of last resort,
27295 this method can be used with such tools as
27296 \begin_inset CommandInset href
27299 target "http://www.math.union.edu/~dpvc/jsMath/"
27305 which uses JavaScript to render \SpecialChar LaTeX
27306 embedded in HTML documents.
27308 wraps the \SpecialChar LaTeX
27310 \begin_inset Flex Code
27313 \begin_layout Plain Layout
27319 (for inline formulas) or
27320 \begin_inset Flex Code
27323 \begin_layout Plain Layout
27329 (for displayed formulas) with
27330 \begin_inset Flex Code
27333 \begin_layout Plain Layout
27340 as is required for jsMath.
27343 \begin_layout Standard
27344 One of these output methods must be selected under
27345 \begin_inset Flex Noun
27348 \begin_layout Plain Layout
27349 Document\SpecialChar menuseparator
27350 Settings\SpecialChar menuseparator
27360 This is a document-wide setting,
27364 \begin_layout Standard
27367 will offer the user the option to select an alternate output method for a particular inset,
27369 one that isn't being rendered very well by MathML.
27373 \begin_layout Plain Layout
27375 since \SpecialChar LyX
27376 falls back to images if the inset contains ERT,
27377 then one can force output as an image by putting some harmless ERT into the math,
27380 \begin_inset Formula $a=b\relax$
27391 \begin_layout Section
27392 Bibliography and Citations
27395 \begin_layout Standard
27396 XHTML output fully supports bibliographies and citations.
27400 \begin_layout Standard
27401 Citation labels are generated by the same machinery that generates \SpecialChar LyX
27402 's on-screen labels,
27403 so the labels will look in the output much as they do in \SpecialChar LyX
27406 If you are using numerical citations,
27407 then \SpecialChar LyX
27408 will output numerical labels,
27409 such as [1] or [17],
27410 rather than simply showing the citation key in square brackets,
27411 as it does on-screen.
27412 If you are using author-year citations,
27413 then \SpecialChar LyX
27414 will add lowercase letters to the years,
27415 just as Bib\SpecialChar TeX
27417 if it finds more than one citation for a given author-year combination.
27418 The labels will be printed with the bibliography entries.
27419 Note that there is,
27421 no way to customize the appearance of the labels,
27423 to choose between square brackets and parentheses.
27426 \begin_layout Standard
27427 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
27428 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.
27429 The formatting can be customized in your layout file or,
27436 manual for the details.
27439 \begin_layout Standard
27440 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
27441 So you can see things like this:
27444 \begin_layout Quote
27447 \begin_inset Quotes eld
27450 Context and Logical Form
27451 \begin_inset Quotes erd
27457 Language in Context:
27461 Oxford University Press,
27467 \begin_layout Quote
27470 \begin_inset Quotes eld
27473 Semantics in Context
27474 \begin_inset Quotes erd
27480 Language in Context:
27484 Oxford University Press,
27490 \begin_layout Standard
27491 This should be fixed before long.
27494 \begin_layout Standard
27495 There is no support at present for sectioned bibliographies.
27496 If you have multiple bibliographies,
27497 then \SpecialChar LyX
27498 will print the same bibliography over and over.
27501 \begin_layout Section
27505 \begin_layout Standard
27507 will happily export indexes as XHTML,
27508 but with certain limitations at the moment.
27511 \begin_layout Standard
27512 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
27520 \begin_layout Plain Layout
27521 The main issue here is that \SpecialChar LyX
27522 itself does not really handle these.
27523 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
27529 We'll describe how they are handled using the subsection headings from that section.
27532 \begin_layout Itemize
27533 Grouping Index Entries (aka,
27536 makes an effort to support these,
27537 but the entries must be separated by
27538 \begin_inset Quotes eld
27543 \begin_inset Quotes erd
27548 there must be spaces around the exclamation point.
27549 This is because it is otherwise too difficult to check for escaped exclamation points,
27554 \begin_layout Itemize
27556 There is no support at all for page ranges,
27557 since these make no sense with XHMTL.
27559 you will just get two index entries,
27563 \begin_layout Itemize
27565 There is no support for cross-referencing.
27566 If \SpecialChar LyX
27567 finds an entry containing the
27568 \begin_inset Quotes eld
27571 |see\SpecialChar ldots
27573 \begin_inset Quotes erd
27577 it is just dropped,
27578 and the rest is treated as an ordinary index entry.
27581 \begin_layout Itemize
27584 does support attempts to fix the sorting order.
27585 It will take what is before the first `@' it finds and use that for sorting,
27586 taking what follows the first `@' to be the actual entry.
27589 does not check for escaped `@',
27590 so do not try to index email addresses.
27593 \begin_layout Itemize
27594 Index Entry Layout:
27595 You can format entries by using the text style dialog,
27596 or by using any other method available within \SpecialChar LyX
27598 There is no support for constructs like:
27600 \begin_inset Quotes eld
27604 \begin_inset Quotes erd
27609 if \SpecialChar LyX
27610 finds a pipe symbol,
27613 it will delete it and everything that follows it.
27616 \begin_layout Itemize
27618 There is no support for multiple indexes.
27620 all index entries will be printed as one large index.
27621 To avoid our printing several versions of the index,
27622 we print only the main index,
27623 so make sure you have one.
27626 \begin_layout Section
27627 Nomenclature and Glossary
27630 \begin_layout Standard
27631 There is at present no support for glossaries.
27632 Adding it would be fairly trivial,
27636 \begin_layout Chapter
27638 \change_inserted 1075283030 1616534180
27642 \begin_layout Standard
27644 \change_inserted 1075283030 1616534386
27647 can generate documents in the DocBook XML vocabulary.
27648 With versions 2.3 and before,
27649 only select templates could be used to generate DocBook documents (only version 4).
27650 Starting with \SpecialChar LyX
27652 most \SpecialChar LyX
27653 layouts can generate valid DocBook documents (only version 5).
27654 This feature is built into \SpecialChar LyX
27655 and does not require the use of external tools.
27658 \begin_layout Standard
27660 \change_inserted 1075283030 1616534437
27661 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
27662 output can be customized and extended:
27663 through layout files and modules.
27664 See chapter five of the
27668 manual for the details.
27671 \begin_layout Standard
27673 \change_inserted 1075283030 1616534475
27674 Most \SpecialChar LyX
27675 features are supported with DocBook,
27679 \begin_layout Itemize
27681 \change_inserted 1075283030 1616534741
27682 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
27686 All formulae are also available in raw \SpecialChar TeX
27687 in the DocBook output for further processing.
27690 \begin_layout Itemize
27692 \change_inserted 1075283030 1616534852
27693 Bibliographies and citations are implemented,
27694 including with an external BibTeX file.
27695 Bibliography entries are not prerendered when the detailed information are available,
27696 but rather output with the standard DocBook constructs.
27697 The external DocBook processor is expected to handle the rendering of entries.
27700 \begin_layout Itemize
27702 \change_inserted 1075283030 1616534863
27703 Indexes are supported,
27704 including multiple indices.
27711 and cross-references (
27716 with the exception of the same symbols escaped.
27725 ) are not supported.
27726 There is no support for escaping of index entries.
27729 \begin_layout Itemize
27731 \change_inserted 1075283030 1616534884
27732 Glossaries are implemented.
27735 \begin_layout Standard
27737 \change_inserted 1075283030 1616534894
27738 Two major parameters can be set at the document level.
27741 \begin_layout Itemize
27743 \change_inserted 1075283030 1616534948
27746 can generate tables either as HTML (default value) or CALS,
27747 depending on the user's requirements.
27748 Most DocBook processors accept both formats.
27751 \begin_layout Itemize
27753 \change_inserted 1075283030 1616535006
27756 MathML is included within its own name space,
27758 The implication is that there must be an indication of the tags belonging to the MathML standard.
27759 Three choices are offered:
27764 \begin_layout Itemize
27766 \change_inserted 1075283030 1616535044
27768 the MathML name space is defined for each formula (using the
27772 attribute on each formula)
27775 \begin_layout Itemize
27777 \change_inserted 1075283030 1616535090
27783 the MathML name space is defined at the document level (using the
27787 attribute on the root element).
27788 Each MathML is prefixed with
27799 \begin_layout Itemize
27801 \change_inserted 1075283030 1616620405
27817 \begin_layout Standard
27819 \change_inserted 1075283030 1616620470
27820 This option is especially useful if you want \SpecialChar LyX
27821 to match your personal style or to work with buggy software that only accepts one prefix for MathML.
27827 \begin_layout Chapter
27828 The \SpecialChar LyX
27832 \begin_layout Section
27836 \begin_layout Standard
27837 The `\SpecialChar LyX
27838 server' allows other programs to talk to \SpecialChar LyX
27840 invoke \SpecialChar LyX
27842 and retrieve information about the \SpecialChar LyX
27844 This is only intended for advanced users,
27845 but they should find it useful.
27846 It is by writing to the \SpecialChar LyX
27849 that bibliography managers,
27852 \begin_inset Quotes eld
27856 \begin_inset Quotes erd
27859 citations to \SpecialChar LyX
27863 \begin_layout Section
27864 Starting the \SpecialChar LyX
27866 \begin_inset CommandInset label
27868 name "sec:Starting-the-Server"
27875 \begin_layout Standard
27876 The \SpecialChar LyX
27877 server works through the use of a pair of named pipes.
27878 These are usually located in
27879 \begin_inset Flex Code
27882 \begin_layout Plain Layout
27889 (except on Windows,
27894 named pipes are special objects located in
27895 \begin_inset Flex Code
27898 \begin_layout Plain Layout
27910 ) and have the names
27911 \begin_inset Quotes eld
27915 \begin_inset Flex Code
27918 \begin_layout Plain Layout
27925 \begin_inset Quotes erd
27929 \begin_inset Quotes eld
27933 \begin_inset Flex Code
27936 \begin_layout Plain Layout
27943 \begin_inset Quotes erd
27947 External programs write into
27948 \begin_inset Flex Code
27951 \begin_layout Plain Layout
27957 and read back data from
27958 \begin_inset Flex Code
27961 \begin_layout Plain Layout
27968 The stem of the pipe names can be defined in the
27969 \begin_inset Flex Noun
27972 \begin_layout Plain Layout
27973 Tools\SpecialChar menuseparator
27981 \begin_inset Flex Code
27984 \begin_layout Plain Layout
27985 "/home/myhome/lyxpipe"
27992 \begin_inset Flex Code
27995 \begin_layout Plain Layout
28009 on Windows (where any working path instead of lyxpipe can be used,
28011 \begin_inset Flex Code
28014 \begin_layout Plain Layout
28037 configure this manually in order for the server to start.
28040 \begin_layout Standard
28043 \begin_inset Flex Code
28046 \begin_layout Plain Layout
28053 \begin_inset Flex Code
28056 \begin_layout Plain Layout
28062 ' to create the pipes.
28063 If one of the pipes already exists,
28065 will assume that another \SpecialChar LyX
28066 process is already running and will not start the server.
28067 On POSIX (Unix like) systems,
28068 if for some other reason,
28070 \begin_inset Quotes eld
28074 \begin_inset Quotes erd
28077 pipe is left in existence when \SpecialChar LyX
28079 then \SpecialChar LyX
28080 will try to delete it.
28081 If this fails for some reason,
28082 you will need to delete the pipes manually and then restart \SpecialChar LyX
28085 pipes are deleted by the OS on program termination or crash,
28087 \begin_inset Quotes eld
28091 \begin_inset Quotes erd
28094 pipes should not be possible.
28097 \begin_layout Standard
28098 To have several \SpecialChar LyX
28099 processes with servers at the same time,
28100 you have to use different configurations,
28101 perhaps by using separate user directories,
28103 \begin_inset Flex Code
28106 \begin_layout Plain Layout
28116 \begin_layout Standard
28117 If you are developing a client program,
28118 you might find it useful to enable debugging information from the \SpecialChar LyX
28120 Do this by starting \SpecialChar LyX
28122 \begin_inset Flex Code
28125 \begin_layout Plain Layout
28134 \begin_layout Standard
28135 You can find a complete example client written in C++ in the source distribution as
28136 \begin_inset Flex Code
28139 \begin_layout Plain Layout
28140 development/lyxserver/server_monitor.cpp
28148 \begin_layout Standard
28149 Another useful tool is the command-line based client found in
28150 \begin_inset Flex Code
28153 \begin_layout Plain Layout
28154 src/client/lyxclient
28162 \begin_layout Section
28163 Normal communication
28166 \begin_layout Standard
28167 To issue a \SpecialChar LyX
28169 the client writes a line of ASCII text into the input pipe.
28170 This line has the following format:
28173 \begin_layout Quote
28187 \begin_layout Description
28188 clientname is a name that the client can choose arbitrarily.
28189 Its only use is that \SpecialChar LyX
28190 will echo it if it sends an answer—
28191 so a client can dispatch results from different requesters.
28194 \begin_layout Description
28195 function is the function you want \SpecialChar LyX
28197 It is the same as the commands you'd use in the minibuffer.
28200 \begin_layout Description
28201 argument is an optional argument which is meaningful only to some functions (for instance,
28203 \begin_inset Quotes eld
28207 \begin_inset Quotes erd
28210 LFUN will insert the argument as text at the cursor position).
28213 \begin_layout Standard
28214 The answer from \SpecialChar LyX
28215 will arrive in the output pipe and be of the form
28218 \begin_layout Quote
28232 \begin_layout Standard
28241 are just echoed from the command request,
28246 is more or less useful information filled according to how the command execution worked out.
28249 \begin_inset Quotes eld
28253 \begin_inset Quotes erd
28257 will return information about the internal state of \SpecialChar LyX
28259 while other will return an empty data-response.
28260 This means that the command execution went fine.
28263 \begin_layout Standard
28265 the response from \SpecialChar LyX
28266 will have this form
28269 \begin_layout Quote
28283 \begin_layout Standard
28288 should contain an explanation of why the command failed.
28291 \begin_layout Standard
28295 \begin_layout LyX-Code
28296 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
28297 \begin_inset Newline newline
28300 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
28301 \begin_inset Newline newline
28304 read a <~/.lyxpipe.out
28305 \begin_inset Newline newline
28311 \begin_layout Subsection
28312 AppleScript (Mac OS X)
28315 \begin_layout Standard
28316 Since \SpecialChar LyX
28319 supports basic interactions with AppleScript for normal communication through the command run.
28320 This command takes a direct argument (the
28324 to perform) and an optional argument.
28325 It either returns the output of the function or triggers an error with the error message and code.
28328 \begin_layout Standard
28332 \begin_layout LyX-Code
28333 tell application "\SpecialChar LyX
28337 \begin_layout LyX-Code
28341 \begin_layout LyX-Code
28342 -- Stores the current file name into f
28345 \begin_layout LyX-Code
28346 set f to (run "server-get-filename" with argument "")
28349 \begin_layout LyX-Code
28350 on error the error_message number the error_number
28353 \begin_layout LyX-Code
28354 display dialog "Error:
28355 " & the error_number & ".
28359 \begin_layout LyX-Code
28360 & the error_message buttons {"OK"} default button 1
28363 \begin_layout LyX-Code
28367 \begin_layout LyX-Code
28371 \begin_layout Section
28375 \begin_layout Standard
28377 can notify clients of events going on asynchronously.
28378 Currently it will only do this if the user binds a key sequence with the function
28379 \begin_inset Quotes eld
28383 \begin_inset Quotes erd
28387 The format of the string \SpecialChar LyX
28388 sends is as follows:
28391 \begin_layout Quote
28392 \begin_inset Flex Code
28395 \begin_layout Plain Layout
28406 \begin_layout Standard
28411 is the printed representation of the key sequence that was actually typed by the user.
28414 \begin_layout Standard
28415 This mechanism can be used to extend \SpecialChar LyX
28416 's command set and implement macros.
28417 Bind some key sequence to
28418 \begin_inset Quotes eld
28422 \begin_inset Quotes erd
28426 Then start a client that listens on the output pipe,
28427 dispatches the command according to the sequence,
28428 and starts a function that may use \SpecialChar LyX
28429 calls and \SpecialChar LyX
28430 requests to issue a command or a series of commands to \SpecialChar LyX
28434 \begin_layout Section
28435 The simple \SpecialChar LyX
28439 \begin_layout Standard
28441 implements a simple protocol that can be used for session management.
28442 All messages are of the form
28445 \begin_layout Quote
28455 \begin_layout Standard
28461 \begin_inset Quotes eld
28465 \begin_inset Quotes erd
28469 \begin_inset Quotes eld
28473 \begin_inset Quotes erd
28478 \begin_inset Quotes eld
28482 \begin_inset Quotes erd
28485 is received from a client,
28487 will report back to inform the client that it's listening to it's messages,
28489 \begin_inset Quotes eld
28493 \begin_inset Quotes erd
28496 sent from \SpecialChar LyX
28497 will inform clients that \SpecialChar LyX
28501 \begin_layout Section
28502 Reverse DVI/PDF search
28505 \begin_layout Standard
28506 Some DVI/PDF viewers
28510 \begin_layout Plain Layout
28511 The following viewers offer the reverse PDF search feature:
28512 Okular on KDE/Linux,
28514 Skim on Mac OSX and SumatraPDF on Windows.
28523 facility (also called
28528 This means that you can tell \SpecialChar LyX
28529 to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
28531 the viewer must be able to communicate with \SpecialChar LyX
28533 This is done via the \SpecialChar LyX
28534 server either by using the named pipe (
28539 or the UNIX domain socket (
28543 ) that \SpecialChar LyX
28544 creates in its temporary directory (this is the way the
28545 \begin_inset Flex Code
28548 \begin_layout Plain Layout
28554 program communicates with \SpecialChar LyX
28557 you need a helper script that mediates between the viewer and \SpecialChar LyX
28560 the viewer can communicate with \SpecialChar LyX
28562 This depends on the selected viewer and on your operating system.
28563 The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
28565 we will thus describe how to setup reverse search for specific viewers.
28566 Before we turn to this,
28568 we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
28571 \begin_layout Subsection
28573 \begin_inset CommandInset label
28575 name "subsec:rev-search"
28582 \begin_layout Standard
28583 In most cases \SpecialChar LyX
28584 will do the work for you by pressing the following button in the toolbar:
28588 arg "buffer-toggle-output-sync"
28593 you can also enable the feature by checking
28595 Synchronize with Output
28598 \begin_inset Flex Noun
28601 \begin_layout Plain Layout
28602 Document\SpecialChar menuseparator
28603 Settings\SpecialChar menuseparator
28610 In such a case \SpecialChar LyX
28611 will automatically insert the necessary Sync\SpecialChar TeX
28612 macro (for PDF) or load the srcltx package (for DVI) respectively.
28613 This option can be easily reached also on
28614 \begin_inset Flex Code
28617 \begin_layout Plain Layout
28626 \begin_layout Standard
28627 If you need a different setting,
28628 you can select or input a custom macro from the drop down box just below
28629 \begin_inset Flex Noun
28632 \begin_layout Plain Layout
28633 Document\SpecialChar menuseparator
28634 Settings\SpecialChar menuseparator
28635 Output\SpecialChar menuseparator
28636 Synchronize with Output
28644 \begin_layout Standard
28645 Note that the method
28646 \begin_inset Flex Code
28649 \begin_layout Plain Layout
28657 enables gzip compression.
28658 If your viewer does not support it,
28659 you should instead use
28660 \begin_inset Flex Code
28663 \begin_layout Plain Layout
28674 \begin_layout Standard
28675 Please also note that including the
28676 \begin_inset Flex Code
28679 \begin_layout Plain Layout
28686 \begin_inset Flex Code
28689 \begin_layout Plain Layout
28695 sometimes has an undesired impact on the typesetting.
28697 you should switch output synchronization off for the final typesetting if you use the
28698 \begin_inset Flex Code
28701 \begin_layout Plain Layout
28708 \begin_inset Flex Code
28711 \begin_layout Plain Layout
28721 \begin_layout Standard
28722 In case you need some more special settings that are not covered by the automatic settings,
28723 read the next section about how to set up output synchronization manually.
28724 If the automatic setup suits your needs,
28725 you can readily jump to section
28726 \begin_inset space ~
28730 \begin_inset CommandInset ref
28732 reference "subsec:configuring-viewers"
28738 where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
28741 \begin_layout Subsection
28745 \begin_layout Standard
28747 provides several different methods for reverse search.
28748 Some are built-in in the
28749 \begin_inset Flex Code
28752 \begin_layout Plain Layout
28759 some are provided by external packages.
28760 Your choice depends on whether your \SpecialChar LaTeX
28761 distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
28762 The available methods are described in the following.
28765 \begin_layout Subsubsection*
28766 Built-in DVI-search via src-specials (DVI only)
28769 \begin_layout Standard
28770 This method provides the DVI file with the necessary information for reverse search.
28771 It is available in \SpecialChar LaTeX
28772 since quite some time (any somewhat recent \SpecialChar LaTeX
28773 distribution should include it),
28774 and it works reliably.
28777 \begin_inset Flex Noun
28780 \begin_layout Plain Layout
28791 \begin_inset Flex Noun
28794 \begin_layout Plain Layout
28805 \begin_inset Flex Noun
28808 \begin_layout Plain Layout
28809 Preferences\SpecialChar menuseparator
28810 File Handling\SpecialChar menuseparator
28817 \begin_inset Flex Code
28820 \begin_layout Plain Layout
28821 latex -src-specials $$i
28827 If this doesn't work,
28828 check if your \SpecialChar TeX
28829 engine needs different options (the syntax might differ in some distributions).
28832 \begin_layout Subsubsection*
28833 External Packages (PDFSync and scrltx)
28836 \begin_layout Standard
28845 provide reverse search facility for PDF output (via pdflatex) and DVI output,
28847 In order to enable it,
28848 load the packages in the \SpecialChar LyX
28853 \begin_layout Itemize
28854 \begin_inset Flex Code
28857 \begin_layout Plain Layout
28860 usepackage{pdfsync}
28865 for reverse PDF search,
28868 \begin_layout Itemize
28869 \begin_inset Flex Code
28872 \begin_layout Plain Layout
28875 usepackage[active]{srcltx}
28880 for reverse DVI search.
28883 \begin_layout Standard
28884 If you want to be able to perform both DVI and PDF reverse searches,
28885 you can also insert in the preamble the following lines
28888 \begin_layout LyX-Code
28892 \begin_inset Newline newline
28898 \begin_inset Newline newline
28903 usepackage{pdfsync}
28904 \begin_inset Newline newline
28910 \begin_inset Newline newline
28915 usepackage[active]{srcltx}
28916 \begin_inset Newline newline
28924 \begin_layout Standard
28926 you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
28929 \begin_layout Standard
28930 Note that PDFSync might affect the output layout of your document.
28931 It is therefore advised to disable PDFsync for final documents.
28934 \begin_layout Subsubsection*
28935 Built-in reverse search via Sync\SpecialChar TeX
28939 \begin_layout Standard
28941 \begin_inset Flex Code
28944 \begin_layout Plain Layout
28950 have built-in support for both PDF and DVI reverse search.
28953 Sync\SpecialChar TeX
28956 facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
28961 You need at least \SpecialChar TeX
28962 Live 2008 or a recent Mik\SpecialChar TeX
28963 distribution in order to use it.
28967 \begin_layout Plain Layout
28969 Mik\SpecialChar TeX
28970 does not understand/obey the command \SpecialChar LyX
28971 inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
28974 \begin_layout Plain Layout
28975 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
28976 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
28977 by adding the -synctex=1 switch).
28982 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
28984 SumatraPDF on Windows;
28985 see the next section for details) already provide Sync\SpecialChar TeX
28989 \begin_layout Standard
28990 To enable Sync\SpecialChar TeX
28993 \begin_inset Flex Noun
28996 \begin_layout Plain Layout
29007 \begin_inset Flex Noun
29010 \begin_layout Plain Layout
29015 (plain) -> DraftDVI
29021 \begin_inset Flex Noun
29024 \begin_layout Plain Layout
29025 Preferences\SpecialChar menuseparator
29026 File Handling\SpecialChar menuseparator
29033 \begin_inset Flex Code
29036 \begin_layout Plain Layout
29037 latex -synctex=1 $$i
29043 and for PDF output,
29045 \begin_inset Flex Noun
29048 \begin_layout Plain Layout
29053 (pdflatex) -> PDF (pdflatex)
29059 \begin_inset Flex Code
29062 \begin_layout Plain Layout
29063 pdflatex -synctex=1 $$i
29069 Should your viewer not be considered in the following description,
29070 or in case of missing success,
29071 please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
29076 \begin_layout Plain Layout
29077 Note that the option
29078 \begin_inset Flex Code
29081 \begin_layout Plain Layout
29087 option enables gzip compression.
29088 If your viewer does not support it,
29089 you should instead use
29090 \begin_inset Flex Code
29093 \begin_layout Plain Layout
29107 \begin_layout Subsection
29108 Configuring and using specific viewers
29109 \begin_inset CommandInset label
29111 name "subsec:configuring-viewers"
29118 \begin_layout Subsubsection*
29119 Xdvi (all platforms)
29122 \begin_layout Standard
29124 \begin_inset Flex Code
29127 \begin_layout Plain Layout
29134 you don't need to do anything else for performing a reverse DVI search,
29135 as \SpecialChar LyX
29136 already provides the necessary hooks for automatically using the
29137 \begin_inset Flex Code
29140 \begin_layout Plain Layout
29147 Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
29151 \begin_layout Standard
29153 if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
29155 simply change the DVI viewer in
29156 \begin_inset Flex Noun
29159 \begin_layout Plain Layout
29160 Preferences\SpecialChar menuseparator
29161 File Handling\SpecialChar menuseparator
29171 \begin_layout Plain Layout
29172 On Mac OSX you have to use
29173 \begin_inset Flex Code
29176 \begin_layout Plain Layout
29177 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
29188 \begin_inset Flex Code
29191 \begin_layout Plain Layout
29192 xdvi -editor "lyxeditor.sh %f %l"
29199 \begin_inset Flex Code
29202 \begin_layout Plain Layout
29208 is a suitable script.
29210 a minimal shell script is the following one:
29213 \begin_layout LyX-Code
29215 \begin_inset Newline newline
29218 LYXPIPE="/path/to/lyxpipe"
29219 \begin_inset Newline newline
29222 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
29223 \begin_inset Newline newline
29226 echo "$COMMAND" > "${LYXPIPE}".in || exit
29227 \begin_inset Newline newline
29230 read TMP < "${LYXPIPE}".out || exit
29233 \begin_layout Standard
29235 \begin_inset Flex Code
29238 \begin_layout Plain Layout
29244 is the LyXServer pipe path specified in
29245 \begin_inset Flex Noun
29248 \begin_layout Plain Layout
29249 Preferences\SpecialChar menuseparator
29259 \begin_layout Plain Layout
29261 \begin_inset Flex Code
29264 \begin_layout Plain Layout
29270 folder of a source distribution you can find a
29271 \begin_inset Flex Code
29274 \begin_layout Plain Layout
29280 script which is able to locate the
29284 based on your preferences.
29292 \begin_layout Subsubsection*
29296 \begin_layout Standard
29298 \begin_inset Flex Code
29301 \begin_layout Plain Layout
29302 /Applications/MacDviX_Folder/calleditor.script
29308 add the following lines:
29311 \begin_layout LyX-Code
29312 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
29313 \begin_inset Newline newline
29319 \begin_layout Standard
29320 Modify the lines accordingly if you install \SpecialChar LyX
29321 somewhere else than in the Applications folder.
29324 \begin_layout Standard
29325 Reverse search is triggered by Alt-click (OPTION-click).
29328 \begin_layout Subsubsection*
29332 \begin_layout Standard
29334 \begin_inset Flex Code
29337 \begin_layout Plain Layout
29338 open -a Skim.app $$i
29343 to the viewer setting in
29344 \begin_inset Flex Noun
29347 \begin_layout Plain Layout
29348 Preferences\SpecialChar menuseparator
29349 File Handling\SpecialChar menuseparator
29350 File formats\SpecialChar menuseparator
29358 \begin_inset Flex Noun
29361 \begin_layout Plain Layout
29362 Skim\SpecialChar menuseparator
29363 Preferences\SpecialChar menuseparator
29370 \begin_inset Flex Noun
29373 \begin_layout Plain Layout
29379 preset and enter command
29380 \begin_inset Flex Noun
29383 \begin_layout Plain Layout
29384 /Applications/\SpecialChar LyX
29385 .app/Contents/MacOS/lyxeditor
29393 \begin_layout Standard
29394 Reverse search is triggered by COMMAND-SHIFT-click
29397 \begin_layout Subsubsection*
29401 \begin_layout Standard
29402 Reverse search with evince does not work out of the box,
29403 but it can be achieved by means of some third party helper scripts.
29405 \begin_inset CommandInset href
29407 target "https://wiki.lyx.org/LyX/SyncTeX"
29415 \begin_layout Subsubsection*
29419 \begin_layout Standard
29421 \begin_inset Flex Noun
29424 \begin_layout Plain Layout
29425 Settings\SpecialChar menuseparator
29426 Configure Okular\SpecialChar menuseparator
29433 \begin_inset Quotes erd
29437 This inserts the appropriate command (
29438 \begin_inset Flex Code
29441 \begin_layout Plain Layout
29450 \begin_layout Standard
29451 Reverse search is triggered by SHIFT-click.
29453 \change_inserted -712698321 1578211026
29454 Note that this only works if Okular is in
29455 \begin_inset Quotes eld
29459 \begin_inset Quotes erd
29463 \begin_inset space \thinspace{}
29467 the hand symbol is clicked).
29472 \begin_layout Subsubsection*
29476 \begin_layout Standard
29477 Qpdfview supports Sync\SpecialChar TeX
29478 since version 0.3.5.
29480 \begin_inset Flex Noun
29483 \begin_layout Plain Layout
29484 Edit\SpecialChar menuseparator
29485 Settings\SpecialChar menuseparator
29492 click on the input field of the
29493 \begin_inset Quotes eld
29497 \begin_inset Quotes erd
29500 item and add the command
29501 \begin_inset Flex Code
29504 \begin_layout Plain Layout
29513 \begin_layout Standard
29514 Reverse search is triggered by double-click or,
29515 in more recent versions,
29519 \begin_layout Subsubsection*
29523 \begin_layout Standard
29526 \begin_inset Flex Noun
29529 \begin_layout Plain Layout
29530 View\SpecialChar menuseparator
29536 menu and select the
29537 \begin_inset Quotes eld
29541 \begin_inset Quotes erd
29546 \begin_inset Quotes eld
29549 New\SpecialChar ldots
29551 \begin_inset Quotes erd
29555 in the window that opens,
29557 \begin_inset Quotes eld
29562 \begin_inset Quotes erd
29565 (or any other name you like) in the
29566 \begin_inset Quotes eld
29570 \begin_inset Quotes erd
29574 Now click on the button labeled
29575 \begin_inset Quotes eld
29580 \begin_inset Quotes erd
29583 to open a file dialog and navigate to the directory containing the batch file
29584 \begin_inset Flex Code
29587 \begin_layout Plain Layout
29595 \begin_inset Flex Code
29598 \begin_layout Plain Layout
29604 and then specify the program arguments as
29605 \begin_inset Flex Code
29608 \begin_layout Plain Layout
29616 \begin_inset Flex Code
29619 \begin_layout Plain Layout
29625 wrapper is used for communicating with \SpecialChar LyX
29633 \begin_layout LyX-Code
29635 \begin_inset Newline newline
29638 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
29647 \begin_inset Newline newline
29661 \begin_layout Standard
29662 Make sure that the \SpecialChar LyX
29663 Server pipe path you specified in \SpecialChar LyX
29665 \begin_inset Flex Code
29668 \begin_layout Plain Layout
29683 otherwise change the
29684 \begin_inset Flex Code
29687 \begin_layout Plain Layout
29693 wrapper accordingly.
29696 \begin_layout Standard
29698 reverse search is triggered by double-click.
29701 \begin_layout Subsubsection*
29702 SumatraPDF (Windows)
29705 \begin_layout Standard
29706 In order to use SumatraPDF for inverse search,
29708 \begin_inset Flex Code
29711 \begin_layout Plain Layout
29712 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
29717 in the viewer setting in
29718 \begin_inset Flex Noun
29721 \begin_layout Plain Layout
29722 Preferences\SpecialChar menuseparator
29723 File Handling\SpecialChar menuseparator
29724 File formats\SpecialChar menuseparator
29732 \begin_inset Flex Code
29735 \begin_layout Plain Layout
29741 is the previous wrapper.
29742 If SumatraPDF.exe is not in your command PATH,
29743 use its full file name.
29746 \begin_layout Standard
29747 Reverse search is triggered by double-click.
29750 \begin_layout Subsubsection*
29754 \begin_layout Standard
29756 make sure that yap is your default DVI viewer in the Windows environment,
29759 \begin_inset Flex Noun
29762 \begin_layout Plain Layout
29763 View\SpecialChar menuseparator
29769 menu and select the
29770 \begin_inset Quotes eld
29774 \begin_inset Quotes erd
29779 \begin_inset Quotes eld
29782 New\SpecialChar ldots
29784 \begin_inset Quotes erd
29788 in the window that opens,
29790 \begin_inset Quotes eld
29795 \begin_inset Quotes erd
29798 (or any other name you like) in the
29799 \begin_inset Quotes eld
29803 \begin_inset Quotes erd
29807 Now click on the button labeled
29808 \begin_inset Quotes eld
29813 \begin_inset Quotes erd
29816 to open a file dialog and navigate to the directory containing the
29817 \begin_inset Flex Code
29820 \begin_layout Plain Layout
29826 program (which is installed by default on Cygwin along with the \SpecialChar LyX
29829 \begin_inset Flex Code
29832 \begin_layout Plain Layout
29838 and then specify the program arguments as
29839 \begin_inset Flex Code
29842 \begin_layout Plain Layout
29850 you will be using the
29854 for communicating with \SpecialChar LyX
29857 for whatever reason,
29858 you want to use the
29864 \begin_inset Flex Code
29867 \begin_layout Plain Layout
29873 option and be sure to specify the \SpecialChar LyX
29874 Server pipe path in the \SpecialChar LyX
29878 \begin_layout Standard
29880 reverse search is triggered by double-click.
29883 \begin_layout Subsubsection*
29884 SumatraPDF (Cygwin)
29887 \begin_layout Standard
29888 In order to use SumatraPDF for inverse search,
29890 \begin_inset Flex Code
29893 \begin_layout Plain Layout
29894 SumatraPDF -inverse-search "lyxeditor -g %f %l"
29899 in the viewer setting in
29900 \begin_inset Flex Noun
29903 \begin_layout Plain Layout
29904 Preferences\SpecialChar menuseparator
29905 File Handling\SpecialChar menuseparator
29906 File formats\SpecialChar menuseparator
29913 If SumatraPDF.exe is not in your command PATH,
29914 use its full posix path.
29916 \begin_inset Flex Code
29919 \begin_layout Plain Layout
29925 enables communication via the
29932 \begin_inset Flex Code
29935 \begin_layout Plain Layout
29941 option if you want to use the
29946 and be sure to specify the \SpecialChar LyX
29947 Server pipe path in the \SpecialChar LyX
29951 \begin_layout Standard
29952 Reverse search is triggered by double-click.
29955 \begin_layout Section
29959 \begin_layout Standard
29961 as the name implies,
29963 \begin_inset Quotes eld
29967 \begin_inset Quotes erd
29971 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
29973 If forward search is set up (as described in what follows),
29974 you can put the cursor anywhere in your \SpecialChar LyX
29977 \begin_inset Flex Noun
29980 \begin_layout Plain Layout
29981 Navigate\SpecialChar menuseparator
29988 \begin_inset Flex Noun
29991 \begin_layout Plain Layout
29997 in the context menu via right mouse click),
29998 and then the viewer will jump to that position as well.
30001 that your viewer supports this function.
30004 \begin_layout Standard
30005 To make forward search possible,
30006 you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
30008 This can be done via the methods described in the section
30009 \begin_inset CommandInset ref
30011 reference "subsec:rev-search"
30019 \begin_layout Standard
30021 you need to configure \SpecialChar LyX
30022 for using your viewers in
30023 \begin_inset Flex Noun
30026 \begin_layout Plain Layout
30027 Tools\SpecialChar menuseparator
30028 Preferences\SpecialChar menuseparator
30029 Output\SpecialChar menuseparator
30036 We provide a range of tested configurations for some viewers,
30037 which you can select from the drop down list.
30038 If none of these configurations suits you,
30039 you have to find out and enter a suitable configuration yourself.
30040 The definition syntax uses the following placeholders:
30043 \begin_layout Itemize
30045 \begin_inset Flex Code
30048 \begin_layout Plain Layout
30058 \begin_layout Itemize
30060 \begin_inset Flex Code
30063 \begin_layout Plain Layout
30070 name of the (temporary) exported .tex file (without path)
30073 \begin_layout Itemize
30075 \begin_inset Flex Code
30078 \begin_layout Plain Layout
30085 name of the (temporary) exported .tex file (including path)
30088 \begin_layout Itemize
30090 \begin_inset Flex Code
30093 \begin_layout Plain Layout
30100 name of the exported output file (either dvi or pdf,
30101 depending on which one exists in the temporary directory)
30104 \begin_layout Standard
30105 Note that only some of the viewers provide full and usable forward search functionality out of the box,
30112 \begin_layout Plain Layout
30113 You might want to set
30114 \begin_inset Flex Code
30117 \begin_layout Plain Layout
30124 \begin_inset Flex Noun
30127 \begin_layout Plain Layout
30128 Tools\SpecialChar menuseparator
30129 Preferences\SpecialChar menuseparator
30130 File Handling\SpecialChar menuseparator
30132 \begin_inset space ~
30151 \begin_layout Plain Layout
30152 SumatraPDF can also use DDE commands through the external program CMCDDE —
30154 \begin_inset CommandInset href
30156 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
30172 \begin_layout Plain Layout
30173 Forward search with evince can be achieved by means of third party helper scripts.
30175 \begin_inset CommandInset href
30177 target "https://wiki.lyx.org/LyX/SyncTeX"
30188 require some extra tools in order to use forward search.
30189 While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
30190 some other viewers – e.
30191 \begin_inset space \thinspace{}
30195 xpdf – allow at least to reload the document and jump to a specific page of the file,
30196 so you can at least navigate
30197 \begin_inset Quotes eld
30201 \begin_inset Quotes erd
30205 This latter functionality is provided by an external call of synctex (see the predefined example configurations).
30209 \begin_layout Standard
30210 Forward search works both with DVI and PDF output.
30212 simply checks which preview format you have used before (i.
30213 \begin_inset space \thinspace{}
30217 which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
30218 \change_deleted 564990737 1672743015
30222 \begin_layout Standard
30224 \change_deleted 564990737 1672743015
30225 Special Document Classes
30228 \begin_layout Standard
30230 \change_deleted 564990737 1669742044
30234 \begin_layout Standard
30236 \change_deleted 564990737 1669742044
30242 \begin_layout Standard
30244 \change_deleted 564990737 1669742044
30248 \begin_layout Standard
30250 \change_deleted 564990737 1669742044
30251 This section describes how \SpecialChar LyX
30252 can be used to write articles for submission to the scientific journal
30254 Astronomy and Astrophysics
30257 \begin_inset Flex URL
30260 \begin_layout Plain Layout
30262 https://www.aanda.org/
30267 ) using Version 5.01 of the document class
30272 This package can be downloaded from the ftp site
30275 \begin_layout Standard
30277 \change_deleted 564990737 1669742044
30278 \begin_inset VSpace medskip
30284 \begin_layout Standard
30287 \change_deleted 564990737 1669742044
30288 \begin_inset Flex URL
30291 \begin_layout Plain Layout
30293 ftp://ftp.edpsciences.org/pub/aa/readme.html
30301 \begin_layout Standard
30303 \change_deleted 564990737 1669742044
30304 \begin_inset VSpace medskip
30310 \begin_layout Standard
30312 \change_deleted 564990737 1669742044
30313 A manual comes together with that package,
30314 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.
30318 \begin_layout Standard
30320 \change_deleted 564990737 1669742044
30321 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
30323 That change involved also some slight changes to the style files,
30324 namely the removal of the thesaurus command.
30325 The \SpecialChar LyX
30326 class aa supports the newest version of these style files,
30328 If you have an older version installed,
30331 the old (version 4) layout has been kept as
30336 Please refer to the comments in
30339 Dir/layouts/aapaper.layout
30344 \begin_layout Standard
30346 \change_deleted 564990737 1669742044
30350 \begin_layout Standard
30352 \change_deleted 564990737 1669742044
30353 It is recommended you start from the example template distributed with \SpecialChar LyX
30355 If you are not using a template,
30356 note the following settings:
30359 \begin_layout Itemize
30361 \change_deleted 564990737 1669742044
30368 Document\SpecialChar menuseparator
30372 that one was obvious).
30375 \begin_layout Itemize
30377 \change_deleted 564990737 1669742044
30378 Don't change the option
30381 \begin_inset space ~
30392 The whole layout is done by the macros,
30393 you shouldn't change anything.
30396 \begin_layout Standard
30398 \change_deleted 564990737 1669742044
30402 \begin_layout Standard
30404 \change_deleted 564990737 1669742044
30405 First thing to enter is the header information.
30406 It consists of seven entries,
30407 of which some are optional.
30411 \begin_layout Itemize
30413 \change_deleted 564990737 1669742044
30422 \begin_layout Itemize
30424 \change_deleted 564990737 1669742044
30433 \begin_layout Itemize
30435 \change_deleted 564990737 1669742044
30444 \begin_layout Itemize
30446 \change_deleted 564990737 1669742044
30455 \begin_layout Itemize
30457 \change_deleted 564990737 1669742044
30463 [optional] if more than one author:
30464 whom to contact for offprint requests.
30467 \begin_layout Itemize
30469 \change_deleted 564990737 1669742044
30475 [optional] mail address for contacts.
30478 \begin_layout Itemize
30480 \change_deleted 564990737 1669742044
30487 Suggested format is
30494 \begin_layout Standard
30496 \change_deleted 564990737 1669742044
30497 There is no need to issue the
30504 this is done automatically by \SpecialChar LyX
30505 when the header is finished.
30506 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
30507 just to get the best optics and meets the layout of the real document.
30510 \begin_layout Standard
30512 \change_deleted 564990737 1669742044
30513 If you want to place footnotes in the header block,
30515 \begin_inset space \thinspace{}
30519 \begin_inset space \space{}
30522 to state your present address,
30523 just use the standard footnote via the menu
30525 Insert\SpecialChar menuseparator
30530 will automagically use the term
30539 \begin_layout Standard
30541 \change_deleted 564990737 1669742044
30544 Edit\SpecialChar menuseparator
30548 you'll find two insets which are relevant for the titling:
30551 \begin_layout Itemize
30553 \change_deleted 564990737 1669742044
30560 to mark corresponding author\SpecialChar breakableslash
30562 The institutes are numbered sequentially as they appear in the
30567 so you have to put a marker to each author.
30570 \begin_layout Itemize
30572 \change_deleted 564990737 1669742044
30577 to supply an email address for fast contact.
30580 \begin_layout Standard
30582 \change_deleted 564990737 1669742044
30583 In addition to these topics,
30584 the macros use one additional \SpecialChar LaTeX
30585 command that has no counterpart in \SpecialChar LyX
30589 \begin_layout Itemize
30591 \change_deleted 564990737 1669742044
30598 to separate different names for more than one author and institute,
30602 \begin_layout Standard
30604 \change_deleted 564990737 1669742044
30605 The appropriate command has to be entered in \SpecialChar LyX
30606 and marked as \SpecialChar LaTeX
30612 \begin_layout Standard
30614 \change_deleted 564990737 1669742044
30618 \begin_layout Standard
30620 \change_deleted 564990737 1669742044
30621 The abstract should immediately follow the header block.
30622 With version 5 the abstract environment was changed to a command,
30623 and there is now a restriction to only one paragraph.
30625 it should contain an entry with the keywords.
30626 This is done via the paragraph style
30631 Refer to the example paper.
30634 \begin_layout Standard
30636 \change_deleted 564990737 1669742044
30637 Supported environments
30640 \begin_layout Standard
30642 \change_deleted 564990737 1669742044
30643 The A&A paper layout supports the following environments for structuring your text:
30646 \begin_layout Itemize
30648 \change_deleted 564990737 1669742044
30654 \begin_layout Itemize
30656 \change_deleted 564990737 1669742044
30662 \begin_layout Itemize
30664 \change_deleted 564990737 1669742044
30670 \begin_layout Itemize
30672 \change_deleted 564990737 1669742044
30678 \begin_layout Itemize
30680 \change_deleted 564990737 1669742044
30686 \begin_layout Itemize
30688 \change_deleted 564990737 1669742044
30694 \begin_layout Itemize
30696 \change_deleted 564990737 1669742044
30702 \begin_layout Itemize
30704 \change_deleted 564990737 1669742044
30710 \begin_layout Itemize
30712 \change_deleted 564990737 1669742044
30718 \begin_layout Itemize
30720 \change_deleted 564990737 1669742044
30726 \begin_layout Itemize
30728 \change_deleted 564990737 1669742044
30734 \begin_layout Itemize
30736 \change_deleted 564990737 1669742044
30743 \begin_layout Standard
30745 \change_deleted 564990737 1669742044
30746 Commands not supported by \SpecialChar LyX
30750 \begin_layout Standard
30752 \change_deleted 564990737 1669742044
30753 Some commands are not yet supported by the
30757 layout for \SpecialChar LyX
30759 Some have already been mentioned.
30760 For the sake of completeness,
30761 they are listed all together here:
30764 \begin_layout Itemize
30766 \change_deleted 564990737 1669742044
30774 \begin_layout Itemize
30776 \change_deleted 564990737 1669742044
30784 \begin_layout Itemize
30786 \change_deleted 564990737 1669742044
30794 \begin_layout Itemize
30796 \change_deleted 564990737 1669742044
30804 \begin_layout Standard
30806 \change_deleted 564990737 1669742044
30807 If you want to use any of these commands,
30808 you have to enter them yourself.
30811 Do not forget to mark them as \SpecialChar LaTeX
30815 \begin_layout Standard
30817 \change_deleted 564990737 1669742044
30818 Figure and Table Floats
30821 \begin_layout Standard
30823 \change_deleted 564990737 1669742044
30825 provides support for the necessary float environments
30836 therefore we won't tell much about it here.
30840 \begin_inset space ~
30846 Just remember that tables should be left-aligned.
30848 select the table and change the alignment in
30850 Edit\SpecialChar menuseparator
30852 \begin_inset space ~
30858 \begin_layout Standard
30860 \change_deleted 564990737 1669742044
30861 There is only one special thing:
30862 the figures with caption besides the figure.
30863 To create such a figure,
30864 you have to do the following:
30867 \begin_layout Enumerate
30869 \change_deleted 564990737 1669742044
30870 Create a wide figure float:
30873 Insert\SpecialChar menuseparator
30874 Float\SpecialChar menuseparator
30878 then right click in the figure and select
30881 \begin_inset space ~
30889 \begin_layout Enumerate
30891 \change_deleted 564990737 1669742044
30892 Enter your caption text.
30895 \begin_layout Enumerate
30897 \change_deleted 564990737 1669742044
30902 to move the cursor above the caption.
30905 \begin_layout Enumerate
30907 \change_deleted 564990737 1669742044
30911 \begin_layout Enumerate
30913 \change_deleted 564990737 1669742044
30914 Position the cursor behind the figure and insert a horizontal fill:
30917 Insert\SpecialChar menuseparator
30919 \begin_inset space ~
30922 Character\SpecialChar menuseparator
30924 \begin_inset space ~
30932 \begin_layout Enumerate
30934 \change_deleted 564990737 1669742044
30935 Switch to \SpecialChar LaTeX
30940 \begin_inset space ~
30948 \begin_layout Enumerate
30950 \change_deleted 564990737 1669742044
30960 Do not close the brace!
30963 \begin_layout Enumerate
30965 \change_deleted 564990737 1669742044
30966 Position the cursor behind the caption text,
30967 switch to \SpecialChar LaTeX
30968 mode and insert the closing brace:
30972 \begin_inset space ~
30984 \begin_layout Standard
30986 \change_deleted 564990737 1669742044
30988 refer to the figures in the example paper.
30991 \begin_layout Standard
30993 \change_deleted 564990737 1669742044
30997 \begin_layout Standard
30999 \change_deleted 564990737 1669742044
31001 the paper has to be formated in a special double-spacing layout.
31003 you have to give the option
31007 to the document class.
31008 This must be done using the custom class options field in the
31010 Document\SpecialChar menuseparator
31014 Just enter the string
31021 \begin_layout Standard
31023 \change_deleted 564990737 1669742044
31027 \begin_layout Standard
31029 \change_deleted 564990737 1669742044
31034 directory contains an example paper written with \SpecialChar LyX
31036 It is the example paper from the original macro package,
31037 translated to \SpecialChar LyX
31039 Use it for inspiration,
31040 and compare the original \SpecialChar LaTeX
31041 code with \SpecialChar LyX
31045 \begin_layout Standard
31047 \change_deleted 564990737 1671097429
31051 \begin_layout Standard
31053 \change_deleted 564990737 1671097429
31058 can be used to type letters according to German conventions.
31059 A template file is included in
31061 .../lyx/share/templates
31063 for you to use as a starting point.
31066 \begin_layout Standard
31068 \change_deleted 564990737 1671097429
31072 \begin_layout Standard
31074 \change_deleted 564990737 1671097429
31075 See the \SpecialChar LyX
31081 It contains all infos you need.
31084 \begin_layout Standard
31086 \change_deleted 564990737 1669755802
31090 \begin_layout Standard
31092 \change_deleted 564990737 1669755802
31095 Panayotis Papasotiriou
31098 \begin_layout Standard
31100 \change_deleted 564990737 1669755802
31104 \begin_layout Standard
31106 \change_deleted 564990737 1669755802
31107 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
31109 International Journal of Modern Physics C
31113 the ijmpd package is for creating manuscripts to be submitted to the
31115 International Journal of Modern Physics D
31118 Both journals are published by World Scientific.
31119 The corresponding document classes are named
31130 together with instructions for the authors,
31131 can be downloaded from the sites
31132 \begin_inset Flex URL
31135 \begin_layout Plain Layout
31137 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
31143 \begin_inset Flex URL
31146 \begin_layout Plain Layout
31148 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
31154 Both packages are modified versions of the standard
31155 \begin_inset Quotes eld
31159 \begin_inset Quotes erd
31163 and they are almost (but not exactly) identical.
31164 Most of their features are supported by \SpecialChar LyX
31166 I have used \SpecialChar LyX
31167 successfully to write articles submitted to both journals without any problem.
31170 \begin_layout Standard
31172 \change_deleted 564990737 1669755802
31176 \begin_layout Standard
31178 \change_deleted 564990737 1669755802
31180 the easiest way to write a paper is to start with a template.
31183 File\SpecialChar menuseparator
31200 This will give an (almost) empty document that includes the most common fields found in a manuscript.
31201 Simply overwrite the existing text (including the brackets,
31207 You should keep in mind the following remarks.
31210 \begin_layout Enumerate
31212 \change_deleted 564990737 1669755802
31214 won't let you change the font size and the page style of the document,
31215 because such modifications are not allowed by both packages.
31218 \begin_layout Enumerate
31220 \change_deleted 564990737 1669755802
31221 The language of the document should not be changed.
31222 Before previewing your paper,
31223 be sure that the babel package is not used.
31228 arg "dialog-show document"
31233 \SpecialChar menuseparator
31238 \begin_inset Quotes eld
31242 \begin_inset Quotes erd
31252 \begin_layout Enumerate
31254 \change_deleted 564990737 1669755802
31256 \begin_inset Quotes eld
31260 \begin_inset Quotes erd
31263 style must be used to define keywords.
31266 \begin_layout Enumerate
31268 \change_deleted 564990737 1669755802
31269 The ijmpc package provides a style named
31270 \begin_inset Quotes eld
31273 Classification Codes
31274 \begin_inset Quotes erd
31278 which can be used to define classification codes,
31279 such as PACS numbers.
31280 Note that this facility is not supported by the ijmpd package.
31283 \begin_layout Enumerate
31285 \change_deleted 564990737 1669755802
31286 Several new environments are available:
31288 \begin_inset Quotes eld
31292 \begin_inset Quotes erd
31297 \begin_inset Quotes eld
31301 \begin_inset Quotes erd
31306 \begin_inset Quotes eld
31310 \begin_inset Quotes erd
31315 \begin_inset Quotes eld
31319 \begin_inset Quotes erd
31324 \begin_inset Quotes eld
31328 \begin_inset Quotes erd
31333 \begin_inset Quotes eld
31337 \begin_inset Quotes erd
31342 \begin_inset Quotes eld
31346 \begin_inset Quotes erd
31351 \begin_inset Quotes eld
31355 \begin_inset Quotes erd
31360 \begin_inset Quotes eld
31364 \begin_inset Quotes erd
31369 \begin_inset Quotes eld
31373 \begin_inset Quotes erd
31378 \begin_inset Quotes eld
31382 \begin_inset Quotes erd
31387 \begin_inset Quotes eld
31391 \begin_inset Quotes erd
31396 \begin_inset Quotes eld
31400 \begin_inset Quotes erd
31405 \begin_inset Quotes eld
31409 \begin_inset Quotes erd
31413 Their use is more or less obvious.
31415 supports all these environments;
31416 it will use the proper label,
31418 and numbering scheme for each of them.
31421 \begin_layout Enumerate
31423 \change_deleted 564990737 1669755802
31424 Both packages use basic citations;
31425 the natbib package should not be used.
31426 In \SpecialChar LyX
31428 citation references are shown as usual;
31430 citations are shown as superscripts.
31431 If you want to use a citation as normal text,
31438 \begin_inset space \thinspace{}
31442 \begin_inset space \space{}
31446 \begin_inset Quotes eld
31450 \begin_inset space \space{}
31460 \begin_inset Quotes erd
31466 \begin_layout Enumerate
31468 \change_deleted 564990737 1669755802
31470 \begin_inset Quotes eld
31474 \begin_inset Quotes erd
31477 section in both packages.
31478 To put acknowledgments,
31480 \begin_inset Quotes eld
31484 \begin_inset Quotes erd
31490 \begin_layout Enumerate
31492 \change_deleted 564990737 1669755802
31493 Appendices may be added to the paper,
31498 the Acknowledgments and
31504 provides a special environment,
31506 \begin_inset Quotes eld
31510 \begin_inset Quotes erd
31513 which marks the beginning of the appendices.
31514 This environment should be left blank;
31515 it just sends a \SpecialChar LaTeX
31517 but nothing is really printed.
31518 In \SpecialChar LyX
31521 \begin_inset Quotes eld
31525 \begin_inset Quotes erd
31528 is printed with blue letters,
31529 as a signal that all sections after that point are appendices.
31530 To write an appendix,
31532 \begin_inset Quotes eld
31536 \begin_inset Quotes erd
31541 will number each appendix with capital letters,
31542 as required by both journals.
31544 \begin_inset Quotes eld
31548 \begin_inset Quotes erd
31555 be present before the first appendix;
31557 all appendices will be numbered as normal sections in the output.
31560 \begin_layout Enumerate
31562 \change_deleted 564990737 1669755802
31563 The ijmpc and the ijmpd packages use the
31567 command to implement table captions.
31569 a table created by \SpecialChar LyX
31570 is printed correctly,
31571 but its caption is ignored.
31573 you can use some \SpecialChar TeX
31574 code to overcome this problem,
31575 so that captions are printed as expected.
31577 create a float table as usual,
31578 remove the caption,
31579 and replace it with the \SpecialChar TeX
31591 you must also the \SpecialChar TeX
31596 immediately after the tabular material.
31597 Study the example table included in the template files to see how this trick is implemented.
31599 If you need table captions,
31600 you should implement the whole table float in a
31605 then include this file to the \SpecialChar LyX
31608 Insert\SpecialChar menuseparator
31609 File\SpecialChar menuseparator
31611 \begin_inset space ~
31617 Details on how to create a table float can be found in the files
31626 included in the corresponding packages.
31629 \begin_layout Standard
31631 \change_deleted 564990737 1669755802
31632 Preparing a paper for submission
31635 \begin_layout Standard
31637 \change_deleted 564990737 1669755802
31638 Before you submit your paper you must export the \SpecialChar LyX
31639 document as a \SpecialChar LaTeX
31642 File\SpecialChar menuseparator
31643 Export\SpecialChar menuseparator
31651 \begin_layout Plain Layout
31652 Actually you have the choice between \SpecialChar LaTeX
31653 (plain) and pdflatex.
31654 If you intend to use pdflatex to prepare the paper,
31655 you should use the pdflatex option so that included graphics are converted to PDF format,
31656 ready for use by pdflatex.
31662 then make the following changes to the resulting
31669 \begin_layout Enumerate
31671 \change_deleted 564990737 1669755802
31672 Remove the comment lines before the
31681 \begin_layout Enumerate
31683 \change_deleted 564990737 1669755802
31684 Remove everything between (and including) the
31697 except for any commands you specifically put into the \SpecialChar LaTeX
31701 \begin_layout Standard
31703 \change_deleted 564990737 1672743015
31708 file should be saved and processed through \SpecialChar LaTeX
31709 as many times as necessary.
31710 You may also want to check the resulting
31717 \begin_layout Standard
31719 \change_deleted 564990737 1669801478
31723 \begin_layout Standard
31725 \change_deleted 564990737 1669801478
31731 \begin_layout Standard
31733 \change_deleted 564990737 1669801478
31737 \begin_layout Standard
31739 \change_deleted 564990737 1669801478
31740 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
31741 Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
31742 \begin_inset Flex URL
31745 \begin_layout Plain Layout
31747 ftp://ftp.iop.org/pub/journals/latex2e
31755 \begin_layout Standard
31757 \change_deleted 564990737 1669801478
31761 \begin_layout Standard
31763 \change_deleted 564990737 1669801478
31764 The easiest way to write a paper is to start with the template
31768 that is available via
31770 File\SpecialChar menuseparator
31773 The template explains how to use the special text environments.
31774 Here are the most important advices:
31777 \begin_layout Itemize
31779 \change_deleted 564990737 1669801478
31780 To be able to compile your document to a PDF,
31783 ensure that the no AMS packages are loaded in
31785 Document\SpecialChar menuseparator
31786 Settings\SpecialChar menuseparator
31792 \begin_layout Itemize
31794 \change_deleted 564990737 1669801478
31797 The title environment defines the kind of your paper.
31798 So use one of the following environments for the title:
31802 \begin_layout Itemize
31804 \change_deleted 564990737 1669801478
31813 \begin_layout Itemize
31815 \change_deleted 564990737 1669801478
31824 \begin_layout Itemize
31826 \change_deleted 564990737 1669801478
31832 for a Topical review
31835 \begin_layout Itemize
31837 \change_deleted 564990737 1669801478
31846 \begin_layout Itemize
31848 \change_deleted 564990737 1669801478
31857 \begin_layout Itemize
31859 \change_deleted 564990737 1669801478
31865 for a Paper (same as Title)
31868 \begin_layout Itemize
31870 \change_deleted 564990737 1669801478
31876 for a Preliminary communication
31879 \begin_layout Itemize
31881 \change_deleted 564990737 1669801478
31887 for a Rapid communication
31890 \begin_layout Itemize
31892 \change_deleted 564990737 1669801478
31898 for a Letter to the editor
31902 \begin_layout Itemize
31904 \change_deleted 564990737 1669801478
31907 All title environments except of
31911 can have an optional short title.
31914 \begin_layout Itemize
31916 \change_deleted 564990737 1669801478
31917 There is a general title environment
31921 which is not directly supported by \SpecialChar LyX
31923 This can be used as \SpecialChar TeX
31924 code when your document doesn't fit into one of the other title types.
31927 \begin_layout Standard
31929 \change_deleted 564990737 1672743015
31930 For more informations like hints for special table and formula formatting,
31931 look at the IOP author guidelines.
31934 \begin_layout Standard
31936 \change_deleted 564990737 1670317155
31940 \begin_layout Standard
31942 \change_deleted 564990737 1670317155
31945 Panayotis Papasotiriou
31948 \begin_layout Standard
31950 \change_deleted 564990737 1670317155
31954 \begin_layout Standard
31956 \change_deleted 564990737 1670317155
31957 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
31958 Most known of them (at least in my domain of interest) are
31960 Astrophysics and Space Science
31967 but there are many others (see a complete list at
31968 \begin_inset Flex URL
31971 \begin_layout Plain Layout
31973 http://www.wkap.nl/jrnllist.htm/JRNLHOME
31979 The Kluwer package may be downloaded from the site
31980 \begin_inset Flex URL
31983 \begin_layout Plain Layout
31985 http://www.wkap.nl/kaphtml.htm/STYLEFILES
31991 A complete user guide is contained in that package (but it can also be downloaded separately).
31994 \begin_layout Standard
31996 \change_deleted 564990737 1670317155
31998 supports many features of the package but not everything.
32000 the \SpecialChar TeX
32001 code needed is reduced to some
32002 \begin_inset Quotes eld
32006 \begin_inset Quotes erd
32009 commands of the package (see
32010 \begin_inset space ~
32014 \begin_inset CommandInset ref
32016 reference "subsec:kluwer_peculiarities"
32022 I have recently used \SpecialChar LyX
32023 to write an article submitted to the
32025 Astrophysics and Space Science
32027 without any problem.
32030 \begin_layout Standard
32032 \change_deleted 564990737 1670317155
32036 \begin_layout Standard
32038 \change_deleted 564990737 1670317155
32039 The easiest way to write a paper is to start with the Kluwer template file.
32042 File\SpecialChar menuseparator
32055 This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
32056 As in most templates,
32057 simply overwrite the existing text (including the brackets,
32062 ) with the correct information.
32065 \begin_layout Standard
32067 \change_deleted 564990737 1670317155
32068 Preparing a paper for submission
32071 \begin_layout Standard
32073 \change_deleted 564990737 1670317155
32074 As in the AAS\SpecialChar TeX
32076 before you submit your paper to a journal you must
32077 \begin_inset Quotes eld
32081 \begin_inset Quotes erd
32087 \begin_layout Enumerate
32089 \change_deleted 564990737 1670317155
32090 Export your paper as a \SpecialChar LaTeX
32095 File\SpecialChar menuseparator
32096 Export\SpecialChar menuseparator
32104 \begin_layout Enumerate
32106 \change_deleted 564990737 1670317155
32111 file with a text editor and make the following changes
32115 \begin_layout Enumerate
32117 \change_deleted 564990737 1670317155
32118 remove the comment lines before the
32127 \begin_layout Enumerate
32129 \change_deleted 564990737 1670317155
32130 remove everything between (and including) the
32143 except for any commands you specifically put into the \SpecialChar LaTeX
32147 \begin_layout Standard
32149 \change_deleted 564990737 1670317155
32158 \begin_layout Enumerate
32160 \change_deleted 564990737 1670317155
32165 file through \SpecialChar LaTeX
32166 as many times as necessary (usually up to three).
32169 \begin_layout Enumerate
32171 \change_deleted 564990737 1670317155
32178 \begin_inset space \thinspace{}
32182 \begin_inset space \space{}
32190 and check if everything is OK (it should,
32191 if you didn't make any mistake).
32194 \begin_layout Standard
32196 \change_deleted 564990737 1670317155
32197 \begin_inset Quotes eld
32201 \begin_inset Quotes erd
32204 of the Kluwer package
32205 \begin_inset CommandInset label
32207 name "subsec:kluwer_peculiarities"
32214 \begin_layout Standard
32216 \change_deleted 564990737 1670317155
32217 The Kluwer package has the following
32218 \begin_inset Quotes eld
32222 \begin_inset Quotes erd
32228 \begin_layout Enumerate
32230 \change_deleted 564990737 1670317155
32231 It is possible to write multiple articles in the same \SpecialChar LaTeX
32236 \begin_layout Plain Layout
32237 I can't imagine any good reason to do this.
32243 Each article must be included in the environment
32244 \begin_inset Quotes eld
32248 \begin_inset Quotes erd
32253 this environment cannot be omitted,
32254 even if you write just one article.
32256 each article starts with the command
32264 ends with the command
32271 Although this can be implemented in \SpecialChar LyX
32273 I didn't included it,
32274 since it looks ugly and can confuse the novice user.
32276 you need to enter them directly and mark them as \SpecialChar LaTeX
32277 code (the well-known
32278 \begin_inset Quotes eld
32283 \begin_inset Quotes erd
32289 \begin_layout Enumerate
32291 \change_deleted 564990737 1670317155
32292 Information given at the beginning of the article (i.
32293 \begin_inset space \thinspace{}
32297 \begin_inset space \space{}
32306 abstract and keywords) must be included in an environment called
32307 \begin_inset Quotes eld
32311 \begin_inset Quotes erd
32315 This is not implemented in \SpecialChar LyX
32317 so you must enter title,
32319 \begin_inset space ~
32322 between two \SpecialChar TeX
32338 \begin_layout Enumerate
32340 \change_deleted 564990737 1670317155
32341 According to the user manual,
32342 the label of each bibliography item must be written as
32365 \begin_layout Standard
32367 \change_deleted 564990737 1670317155
32372 template takes care of all these
32373 \begin_inset Quotes eld
32377 \begin_inset Quotes erd
32381 If you start a new paper using this template you don't need to do anything special.
32385 \begin_layout Enumerate
32387 \change_deleted 564990737 1670317155
32388 don't delete the \SpecialChar TeX
32389 code included in the template,
32393 \begin_layout Enumerate
32395 \change_deleted 564990737 1670317155
32396 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
32399 \begin_layout Standard
32401 \change_deleted 564990737 1671097446
32405 \begin_layout Standard
32407 \change_deleted 564990737 1671097446
32412 provides an alternative to the standard
32417 It provides similar functionality,
32418 but you might prefer this layout with sans serif sections,
32423 \begin_layout Standard
32425 \change_deleted 564990737 1671097446
32426 Springer Journals (
32433 \begin_layout Standard
32435 \change_deleted 564990737 1671097446
32441 \begin_layout Standard
32443 \change_deleted 564990737 1671097446
32447 \begin_layout Standard
32449 \change_deleted 564990737 1671097446
32450 These are the layout files for some of the journal formats used by Springer Verlag and listed on
32451 \begin_inset Flex URL
32454 \begin_layout Plain Layout
32456 http://www.springer.de/author/tex/help-journals.html
32462 where you should also go to fetch the class files (yes,
32463 these are \SpecialChar LaTeX2e
32465 It is a modular system:
32466 the things common to all journals are implemented in
32471 which journal-specific layout files (such as,
32473 \begin_inset space \thinspace{}
32477 \begin_inset space \space{}
32484 for Journal of Geodesy) can include.
32487 \begin_layout Standard
32489 \change_deleted 564990737 1671097446
32490 This means that implementing support for any other Springer journal on this list is as simple as writing your own
32498 file following the outline given in
32506 \begin_layout Standard
32508 \change_deleted 564990737 1671097446
32509 It is reasonably well tested only for the Journal of Geodesy.
32518 come with the standard \SpecialChar LyX
32520 Install the relevant class file (downloaded from Springer) in a proper directory,
32521 reconfigure \SpecialChar LaTeX
32522 (in the te\SpecialChar TeX
32528 as root if necessary —
32529 doesn't \SpecialChar LyX
32530 take care of this?),
32531 reconfigure \SpecialChar LyX
32532 and it should work.
32535 \begin_layout Standard
32537 \change_deleted 564990737 1671097446
32541 \begin_layout Standard
32543 \change_deleted 564990737 1671097446
32544 A large number of theorem-like styles —
32559 \begin_layout Standard
32561 \change_deleted 564990737 1671097446
32567 Running_\SpecialChar LaTeX
32578 See the Springer class file documentation for details.
32581 \begin_layout Standard
32583 \change_deleted 564990737 1671097446
32587 \begin_layout Itemize
32589 \change_deleted 564990737 1671097446
32603 \begin_layout Itemize
32605 \change_deleted 564990737 1671097446
32608 Probability Theory and Related Fields
32616 Jean-Marc Lasgouttes
32619 \begin_layout Standard
32621 \change_deleted 564990737 1671097446
32626 \begin_layout Standard
32628 \change_deleted 564990737 1671097446
32632 \begin_layout Standard
32634 \change_deleted 564990737 1671097446
32635 These files are partly based on the older
32640 which was again based on a tinkered-with version of an old \SpecialChar LaTeX
32641 2.09 style file from Springer.
32649 Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
32650 layout file mechanism.
32653 \begin_layout Standard
32655 \change_deleted 564990737 1671097446
32659 \begin_layout Standard
32661 \change_deleted 564990737 1671097446
32663 But probably less than in the old hacked-\SpecialChar LaTeX
32671 \begin_layout Chapter
32673 Features needing Extra Software
32676 \begin_layout Section
32677 Checking \SpecialChar TeX
32681 \begin_layout Standard
32687 \begin_layout Subsection
32691 \begin_layout Standard
32700 \begin_layout Plain Layout
32705 is not yet available when you are using the \SpecialChar LaTeX
32706 distribution MiK\SpecialChar TeX
32721 \begin_inset space ~
32732 \begin_inset Newline newline
32736 \begin_inset CommandInset href
32738 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
32746 \begin_layout Standard
32749 Chk\SpecialChar TeX
32752 package is a program that was written by
32753 \begin_inset Flex Noun
32756 \begin_layout Plain Layout
32758 \begin_inset space ~
32766 in frustration because some constructs in \SpecialChar LaTeX
32767 are sometimes non-intuitive,
32768 and easy to forget.
32769 The program runs over your \SpecialChar LaTeX
32771 checks the integrity of the file,
32772 and flags some common errors.
32773 In other technical words,
32778 for \SpecialChar LaTeX
32782 \begin_layout Standard
32784 what is a syntax checker doing in \SpecialChar LyX
32785 which is supposed to produce correct \SpecialChar LaTeX
32787 The answer is simple:
32792 not only checks the
32801 checks for type-errors,
32804 Chk\SpecialChar TeX
32807 catches some common
32812 in addition to the syntactical ones.
32816 Chk\SpecialChar TeX
32819 is capable of detecting several common errors,
32823 \begin_layout Itemize
32824 Ellipsis detection:
32825 \begin_inset Newline newline
32828 Use \SpecialChar ldots
32832 \begin_layout Itemize
32833 No space in front of/after parenthesis:
32834 \begin_inset Newline newline
32840 \begin_layout Itemize
32841 Enforcement of normal space after common abbreviations:
32842 \begin_inset Newline newline
32846 \begin_inset space \thinspace{}
32850 \begin_inset space \space{}
32853 is too wide spacing.
32856 \begin_layout Itemize
32857 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
32858 \begin_inset Newline newline
32862 And this is wrong spacing.
32865 \begin_layout Itemize
32866 Space in front of labels and similar commands:
32867 \begin_inset Newline newline
32870 The label should stick right up to the text to avoid falling to a wrong page.
32872 \begin_inset CommandInset label
32882 \begin_layout Plain Layout
32883 This footnote is in danger of falling off to a wrong page
32888 The label is separated too much.
32891 \begin_layout Itemize
32892 Space in front of references,
32893 instead of hard spaces:
32894 \begin_inset Newline newline
32897 If you have bad luck,
32898 the text will break right between the referenced text and reference number,
32901 \begin_inset CommandInset ref
32903 reference "sec:chktex"
32911 \begin_layout Itemize
32913 \begin_inset Quotes eld
32917 \begin_inset Quotes erd
32921 \begin_inset Formula $\times$
32925 \begin_inset Newline newline
32928 2x2 looks cheap compared to
32929 \begin_inset Formula $2\times2$
32935 \begin_layout Standard
32936 and more \SpecialChar ldots
32937 It is an invaluable tool when you are
32938 \begin_inset Quotes eld
32942 \begin_inset Quotes erd
32945 your document before printing,
32946 and you should run it right after the obligatory spelling check,
32947 and before you go fine tuning the typesetting.
32950 \begin_layout Subsection
32954 \begin_layout Standard
32955 If you have the program installed,
32956 usage is as simple as choosing
32958 Tools\SpecialChar menuseparator
32960 \begin_inset space ~
32966 This will make \SpecialChar LyX
32967 generate a \SpecialChar LaTeX
32968 file of your document,
32971 Chk\SpecialChar TeX
32975 and then make \SpecialChar LyX
32977 \begin_inset Quotes eld
32981 \begin_inset Quotes erd
32984 with the warnings from
32986 Chk\SpecialChar TeX
32991 The warnings will be placed close to the point of the mistake,
32992 and you can quickly find them by using the
32994 Navigate\SpecialChar menuseparator
32998 or the shortcut key
33007 Open the error boxes by clicking on them with the mouse,
33008 or use the shortcut key
33017 or the corresponding
33026 Read the warning and correct the mistake,
33027 if it is a mistake.
33028 If you have trouble understanding what the warning is about,
33029 you can safely ignore it.
33030 Remember that there is a hidden layer between the document on screen and the technical details in invoking
33032 Chk\SpecialChar TeX
33036 and this gap can make some warnings seem arcane or just plain silly.
33039 \begin_layout Standard
33040 This document is an excellent testing bed for the feature,
33041 and it should provide quite a few warnings for you to fiddle with.
33042 Since computers are only so smart,
33043 expect most of the warnings to be false alarms,
33047 \begin_layout Subsection
33048 How to fine tune it
33051 \begin_layout Standard
33055 Chk\SpecialChar TeX
33058 makes more noise than suits your mood.
33059 Then you can choose not to use it,
33060 wait until your mood changes,
33061 or try to customize
33063 Chk\SpecialChar TeX
33066 to get better along with you.
33069 \begin_layout Standard
33072 Chk\SpecialChar TeX
33079 very configurable and extensible,
33080 you should not expect to solve all problems with
33082 Chk\SpecialChar TeX
33085 in \SpecialChar LyX
33087 Since \SpecialChar LyX
33088 has to generate a somewhat special \SpecialChar LaTeX
33089 file to be able to match the line numbers from the
33091 Chk\SpecialChar TeX
33098 \begin_layout Plain Layout
33099 You can inspect the specific output from
33105 Document\SpecialChar menuseparator
33108 \begin_inset space ~
33122 to the internal document structure,
33123 some of the warnings will not appear correctly.
33124 There are two things you can do about this:
33127 \begin_layout Itemize
33130 Chk\SpecialChar TeX
33133 invocation command line in
33134 \begin_inset Flex Noun
33137 \begin_layout Plain Layout
33138 Tools\SpecialChar menuseparator
33139 Preferences\SpecialChar menuseparator
33140 Output\SpecialChar menuseparator
33141 LaTeX\SpecialChar menuseparator
33150 Chk\SpecialChar TeX
33153 installation configuration file (usually with the file
33158 See below to learn what warnings can be enabled and disabled on the command line.
33161 \begin_layout Itemize
33162 Export your document as a raw \SpecialChar LaTeX
33165 File\SpecialChar menuseparator
33166 Export\SpecialChar menuseparator
33175 Invoked in this way,
33176 it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
33178 but with a little patience,
33179 you should be able to do it.
33182 \begin_layout Standard
33183 Here follows the warning messages that can be enabled and disabled in
33192 to disable a warning,
33197 to enable a warning.
33198 The emphasized entries are disabled by default,
33199 because the default is "
33201 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
33206 \begin_layout Standard
33207 Notice that you should only use the options that enable and disable warnings,
33208 because \SpecialChar LyX
33209 relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
33216 \begin_layout Enumerate
33220 Command terminated with space.
33223 \begin_layout Enumerate
33226 Non-breaking space (
33227 \begin_inset Quotes eld
33235 \begin_inset Quotes erd
33238 ) should have been used.
33241 \begin_layout Enumerate
33245 You should enclose the previous parenthesis with
33246 \begin_inset Quotes eld
33254 \begin_inset Quotes erd
33260 \begin_layout Enumerate
33263 Italic correction (
33264 \begin_inset Quotes eld
33274 \begin_inset Quotes erd
33277 ) found in non-italic buffer.
33280 \begin_layout Enumerate
33283 Italic correction (
33284 \begin_inset Quotes eld
33294 \begin_inset Quotes erd
33297 ) found more than once.
33300 \begin_layout Enumerate
33304 No italic correction (
33305 \begin_inset Quotes eld
33315 \begin_inset Quotes erd
33321 \begin_layout Enumerate
33325 \begin_inset Quotes eld
33333 \begin_inset Quotes erd
33337 \begin_inset Quotes eld
33345 \begin_inset Quotes erd
33351 \begin_layout Enumerate
33354 Wrong length of dash may have been used.
33357 \begin_layout Enumerate
33361 \begin_inset Quotes eld
33369 \begin_inset Quotes erd
33374 \begin_inset Quotes eld
33382 \begin_inset Quotes erd
33388 \begin_layout Enumerate
33392 \begin_inset Quotes eld
33400 \begin_inset Quotes erd
33406 \begin_layout Enumerate
33410 \begin_inset Quotes eld
33418 \begin_inset Quotes erd
33421 to achieve an ellipsis.
33424 \begin_layout Enumerate
33427 Inter-word spacing (
33428 \begin_inset Quotes eld
33438 \begin_inset Quotes eld
33441 ) should perhaps be used.
33444 \begin_layout Enumerate
33447 Inter-sentence spacing (
33448 \begin_inset Quotes eld
33458 \begin_inset Quotes erd
33461 ) should perhaps be used.
33464 \begin_layout Enumerate
33467 Could not find argument for command.
33470 \begin_layout Enumerate
33474 \begin_inset Quotes eld
33482 \begin_inset Quotes erd
33488 \begin_layout Enumerate
33491 Math mode still on at end of \SpecialChar LaTeX
33495 \begin_layout Enumerate
33499 \begin_inset Quotes eld
33507 \begin_inset Quotes erd
33510 doesn't match the number of
33511 \begin_inset Quotes eld
33519 \begin_inset Quotes erd
33525 \begin_layout Enumerate
33528 You should use either
33531 \begin_inset Quotes eld
33539 \begin_inset Quotes erd
33544 as an alternative to
33545 \begin_inset Quotes eld
33553 \begin_inset Quotes erd
33559 \begin_layout Enumerate
33566 " (ASCII 39) instead of "
33573 \begin_layout Enumerate
33576 User-specified pattern found.
33579 \begin_layout Enumerate
33582 This command might not be intended.
33585 \begin_layout Enumerate
33592 \begin_layout Enumerate
33610 \begin_layout Enumerate
33613 Delete this space to maintain correct page references.
33616 \begin_layout Enumerate
33620 You might wish to put this between a pair of
33621 \begin_inset Quotes eld
33629 \begin_inset Quotes erd
33635 \begin_layout Enumerate
33638 You ought to remove spaces in front of punctuation.
33641 \begin_layout Enumerate
33644 Could not execute \SpecialChar LaTeX
33648 \begin_layout Enumerate
33657 in front of small punctuation.
33660 \begin_layout Enumerate
33668 may look prettier here.
33671 \begin_layout Enumerate
33675 Multiple spaces detected in output.
33678 \begin_layout Enumerate
33681 This text may be ignored.
33684 \begin_layout Enumerate
33690 \begin_inset Quotes eld
33695 to begin quotation,
33703 \begin_layout Enumerate
33714 \begin_inset Quotes eld
33722 \begin_layout Enumerate
33728 \begin_layout Enumerate
33731 You should perhaps use
33732 \begin_inset Quotes eld
33740 \begin_inset Quotes erd
33746 \begin_layout Enumerate
33749 You should put a space in front of/after parenthesis.
33752 \begin_layout Enumerate
33755 You should avoid spaces in front of/after parenthesis.
33758 \begin_layout Enumerate
33762 You should not use punctuation in front of/after quotes.
33765 \begin_layout Enumerate
33768 Double space found.
33771 \begin_layout Enumerate
33774 You should put punctuation outside inner/inside display math mode.
33777 \begin_layout Enumerate
33780 You ought to not use primitive \SpecialChar TeX
33781 in \SpecialChar LaTeX
33785 \begin_layout Enumerate
33788 You should remove spaces in front of
33789 \begin_inset Quotes eld
33797 \begin_inset Quotes erd
33803 \begin_layout Enumerate
33806 \begin_inset Quotes eld
33814 \begin_inset Quotes erd
33817 is normally not followed by
33818 \begin_inset Quotes eld
33826 \begin_inset Quotes erd
33832 \begin_layout Standard
33833 In later versions of \SpecialChar LyX
33835 we hope to provide a more complete interface to this tool (and it's smaller cousin
33839 ) to exploit the full power of it.
33840 But it's not exactly useless as it is now:
33841 go try it on one of your existing documents of a certain length and be surprised.
33844 \begin_layout Section
33845 Version Control in \SpecialChar LyX
33849 \begin_layout Standard
33852 Lars Gullik Bjønnes
33859 \begin_layout Subsection
33863 \begin_layout Standard
33865 supports some of the most basic RCS/CVS/SVN/GIT commands.
33866 If you need something a bit more sophisticated you will have to do that manually in a terminal.
33869 \begin_layout Standard
33870 Also note that CVS support is not as good as subversion support,
33871 so we advise using SVN instead.
33872 A good place to start learning Subversion is the SVN Book
33876 \begin_layout Plain Layout
33877 \begin_inset CommandInset href
33879 target "http://svnbook.red-bean.com/"
33890 In the case of RCS you should read
33891 \begin_inset Quotes eld
33895 \begin_inset Quotes erd
33904 This file describes all the basic features of RCS.
33905 You should especially notice the comment about a RCS directory,
33906 and the notion of a master RCS file (the file ending in
33913 \begin_layout Standard
33914 Before you begin to use the version control features in \SpecialChar LyX
33916 you should be familiar with RCS/CVS/SVN/GIT usage.
33917 The implementation in \SpecialChar LyX
33918 assumes a recent version of the GNU RCS or CVS/SVN package —
33919 no guarantees are made for older versions.
33920 Most of the log messages are not currently displayed after operations —
33921 you can check them in the Messages pane if you are unsure.
33922 Regular users of version control will appreciate the VC toolbar,
33923 which can be enabled via
33925 View\SpecialChar menuseparator
33926 Toolbars\SpecialChar menuseparator
33928 \begin_inset space ~
33936 \begin_layout Standard
33937 For introducing your own external commands consult
33938 \begin_inset Flex Code
33941 \begin_layout Plain Layout
33955 \begin_layout Standard
33956 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
33958 Document\SpecialChar menuseparator
33962 Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
33963 Compressed LyX documents are binary files,
33964 which cannot be merged by version control systems.
33967 \begin_layout Subsection
33968 RCS commands in \SpecialChar LyX
33972 \begin_layout Standard
33973 The following sections describe the RCS commands supported by \SpecialChar LyX
33975 You can find them in the
33977 File\SpecialChar menuseparator
33979 \begin_inset space ~
33986 was tested against RCS 5.7/5.8.
33989 \begin_layout Subsubsection
33995 \begin_layout Standard
33996 If your document is not under revision control,
33997 this is the only item shown in the menu.
33998 And if it is under revision control,
34003 item is not visible.
34007 \begin_layout Standard
34008 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
34009 You are asked interactively to supply an initial description of the document.
34010 The document is now set in Read-Only mode and you have to
34013 \begin_inset space ~
34017 \begin_inset space ~
34021 \begin_inset space ~
34027 before making any changes to it.
34028 A document under revision control has a
34029 \begin_inset Quotes eld
34032 [RCS:<version> <locker>]
34033 \begin_inset Quotes erd
34036 item tagged to the filename in the minibuffer.
34039 \begin_layout Standard
34040 RCS command that is run:
34043 \begin_layout LyX-Code
34046 ci -q -u -i -t-"<initial description>" <file-name>
34049 \begin_layout Standard
34054 to understand the switches.
34058 \begin_layout Subsubsection
34064 \begin_layout Standard
34065 When you are finished editing a file,
34066 you check in your changes.
34068 you are asked for a description of the changes.
34069 This is stored in the history log.
34070 The version number is bumped,
34071 your changes are applied to the master RCS file,
34072 the document is unlocked and set to Read-Only mode.
34075 \begin_layout Itemize
34079 ci -q -u -m"<description>" <file-name>
34082 \begin_layout Subsubsection
34088 \begin_layout Standard
34089 By doing this you lock the document so that only you can edit it.
34090 This will also make the document Read-Write only for you.
34091 You will usually continue editing for a while and when you are finished you check in your changes.
34092 The status line is changed to reflect that you have locked the file.
34095 \begin_layout Itemize
34099 co -q -l <file-name>
34102 \begin_layout Subsubsection
34105 Revert To Repository Version
34108 \begin_layout Standard
34109 This will discard all changes made to the document since the last check in.
34110 You get a warning before changes are discarded.
34113 \begin_layout Itemize
34117 co -f -u<version> <file-name>
34120 \begin_layout Subsubsection
34126 \begin_layout Standard
34127 This will create a copy of the current document.
34128 Since RCS does not support copy operations natively,
34129 the version history is not preserved,
34130 and the copy is added as a new file.
34131 It requires a clean document without any changes since the last checkin.
34132 You are asked for a file name and a description of the copy operation.
34133 After that the copy is created,
34134 both locally and in the repository.
34135 If the parent directories of the copied and original document differ,
34136 all relative paths of included files of the copy are adjusted (like in
34138 File\SpecialChar menuseparator
34144 the copy is loaded instead of the original document.
34147 \begin_layout Labeling
34148 \labelwidthstring 00.00.0000
34150 \begin_inset space ~
34155 \begin_inset space ~
34159 \begin_inset Newline newline
34163 \begin_inset Flex Code
34166 \begin_layout Plain Layout
34169 \begin_inset Quotes qld
34173 \begin_inset Quotes qld
34182 \begin_inset Flex Code
34185 \begin_layout Plain Layout
34188 \begin_inset Quotes qld
34192 \begin_inset Quotes qld
34201 \begin_inset Newline newline
34205 \begin_inset Flex Code
34208 \begin_layout Plain Layout
34212 \begin_inset Quotes qld
34216 \begin_inset Quotes qld
34227 \begin_layout Subsubsection
34233 \begin_layout Standard
34234 This makes as if the last check in never happened.
34235 No changes are made to the document loaded into \SpecialChar LyX
34237 but the last version is removed from the master RCS file.
34240 \begin_layout Itemize
34244 rcs -o<version> <file-name>
34247 \begin_layout Subsubsection
34253 \begin_layout Standard
34254 This shows the complete history of the RCS document.
34259 is shown in a browser.
34267 \begin_layout Subsubsection
34271 \begin_layout Standard
34273 supports RCS version number,
34275 date and time of last commit.
34276 All those are extracted from
34278 rlog -r <file-name>
34282 \begin_inset CommandInset ref
34284 reference "subsec:VCS-Revision-Information"
34292 \begin_layout Subsection
34293 CVS commands in \SpecialChar LyX
34297 \begin_layout Standard
34298 A subset of CVS operations is supported by \SpecialChar LyX
34300 You can find the commands in the
34302 File\SpecialChar menuseparator
34304 \begin_inset space ~
34310 The version control system SVN is more powerful,
34311 so please use it instead of CVS if possible.
34314 \begin_layout Subsubsection
34320 \begin_layout Standard
34321 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
34322 If you're using a client-server setup you may need to login before doing the first repository checkout.
34325 \begin_layout Standard
34326 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.
34327 Standard CVS repositories don't operate with a file locking mechanism.
34328 This may be surprising,
34329 but conflicts only occur if people disagree on the proper content of the same part of a document.
34331 if co-workers are used to communicate regularly,
34332 these conflicts occur rarely.
34333 If they don't communicate they have a fundamental problem anyway.
34334 Nevertheless some people like to work with so called
34335 \begin_inset Quotes eld
34339 \begin_inset Quotes erd
34343 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.
34344 When the changes are checked in the working copy returns to readonly state.
34345 With \SpecialChar LyX
34346 one has to edit the
34347 \begin_inset Flex Code
34350 \begin_layout Plain Layout
34356 file and add the line
34357 \begin_inset Flex Code
34360 \begin_layout Plain Layout
34366 to work with reserved checkouts.
34367 The benefit is the possibility to see who is using a writable copy of some document.
34368 It's not guaranteed only one user makes a copy writable.
34371 \begin_layout Standard
34373 tries to guess if you're using reserved or non-reserved checkouts.
34374 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.
34375 When a reserved checkout is detected you have to use
34376 \begin_inset Flex Noun
34379 \begin_layout Plain Layout
34385 to make your working copy writable if it's readonly.
34387 \begin_inset Flex Noun
34390 \begin_layout Plain Layout
34396 operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
34399 \begin_layout Standard
34400 More information about CVS can be found here
34401 \begin_inset Flex URL
34404 \begin_layout Plain Layout
34406 http://www.nongnu.org/cvs
34412 \begin_inset Flex URL
34415 \begin_layout Plain Layout
34417 http://ximbiot.com/cvs
34425 \begin_layout Standard
34430 to understand the sub-commands and the switches mentioned below.
34433 \begin_layout Subsubsection
34439 \begin_layout Standard
34440 If your document is not under revision control,
34441 this is the only item shown in the menu.
34442 And if it is under revision control,
34447 item is not visible.
34451 \begin_layout Standard
34452 This command registers in CVS your document
34453 \begin_inset Flex Strong
34456 \begin_layout Plain Layout
34464 in the case you have already the documents directory under CVS control (in particular
34469 This means you have to create or checkout the archive by yourself using external tools.
34470 (In case you forget that step \SpecialChar LyX
34471 registers the document with RCS.)
34474 \begin_layout Standard
34475 Then you are asked interactively to supply an initial description of the document.
34476 Don't forget that registered file is not yet checked in.
34479 \begin_layout Standard
34480 CVS command that is run:
34483 cvs -q add -m"<entered message>" "<file-name>"
34486 \begin_layout Standard
34491 above and for all other CVS commands is an abbreviation for
34492 \begin_inset Quotes eld
34495 change the current working directory to file location and use the file name without path component as argument
34496 \begin_inset Quotes erd
34502 \begin_layout Subsubsection
34508 \begin_layout Standard
34509 When you are finished editing a file,
34510 you commit your changes.
34511 When you do this and you had changed the document,
34512 you are asked for a description of the changes.
34513 After that changes are written to the repository.
34514 In case you didn't change the document and a reserved checkout is detected the reservation made on
34515 \begin_inset Flex Noun
34518 \begin_layout Plain Layout
34527 \begin_layout Labeling
34528 \labelwidthstring 00.00.0000
34530 \begin_inset space ~
34535 \begin_inset space ~
34539 \begin_inset Newline newline
34543 \begin_inset Flex Code
34546 \begin_layout Plain Layout
34549 -q commit -m"<description>" "<file-name>"
34555 \begin_inset Newline newline
34559 \begin_inset Flex Code
34562 \begin_layout Plain Layout
34573 \begin_layout Subsubsection
34579 \begin_layout Standard
34580 When you are sharing a repository with others,
34581 you may have to incorporate their changes into your working copy.
34584 \begin_layout Standard
34588 cvs -q update "<file-name>"
34591 \begin_layout Standard
34592 If a readonly checkout is detected the working copy is made writable and reserved.
34595 \begin_layout Standard
34599 cvs -q edit "<file-name>"
34602 \begin_layout Subsubsection
34605 Revert To Repository Version
34608 \begin_layout Standard
34609 This will discard all changes made to the document since the last check in.
34610 You get a warning before changes are discarded.
34611 Firstly the file is deleted,
34612 secondly CVS update command is run.
34615 \begin_layout Standard
34619 cvs -q update "<file-name>"
34622 \begin_layout Standard
34623 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
34626 \begin_layout Standard
34630 cvs -q unedit "<file-name>"
34633 \begin_layout Subsubsection
34639 \begin_layout Standard
34640 This will create a copy of the current document.
34641 Since CVS does not support copy operations natively,
34642 the version history is not preserved,
34643 and the copy is added as a new file.
34644 It requires a clean document without any changes since the last checkin.
34645 You are asked for a file name and a description of the copy operation.
34646 After that the copy is created,
34647 both locally and in the repository.
34648 If the parent directories of the copied and original document differ,
34649 all relative paths of included files of the copy are adjusted (like in
34651 File\SpecialChar menuseparator
34657 the copy is loaded instead of the original document.
34660 \begin_layout Labeling
34661 \labelwidthstring 00.00.0000
34663 \begin_inset space ~
34668 \begin_inset space ~
34672 \begin_inset Newline newline
34676 \begin_inset Flex Code
34679 \begin_layout Plain Layout
34686 \begin_inset Flex Code
34689 \begin_layout Plain Layout
34696 \begin_inset Newline newline
34700 \begin_inset Flex Code
34703 \begin_layout Plain Layout
34704 cvs -q add "<new-file-name>"
34712 \begin_layout Subsubsection
34718 \begin_layout Standard
34719 This will rename the current document.
34720 Since CVS does not support rename operations natively,
34721 the version history is not preserved,
34722 the renamed document is added as a new file,
34723 and the original document is deleted.
34724 It requires a clean document without any changes since the last checkin.
34725 You are asked for a file name and a description of the rename operation.
34726 After that the document is renamed,
34727 both locally and in the repository.
34728 If the parent directories of the new and old file names differ,
34729 all relative paths of included files are adjusted (like in
34731 File\SpecialChar menuseparator
34737 the document is reloaded using the new name.
34740 \begin_layout Labeling
34741 \labelwidthstring 00.00.0000
34743 \begin_inset space ~
34748 \begin_inset space ~
34752 \begin_inset Newline newline
34756 \begin_inset Flex Code
34759 \begin_layout Plain Layout
34766 \begin_inset Flex Code
34769 \begin_layout Plain Layout
34776 \begin_inset Newline newline
34780 \begin_inset Flex Code
34783 \begin_layout Plain Layout
34784 cvs -q add "<new-file-name>"
34790 \begin_inset Newline newline
34794 \begin_inset Flex Code
34797 \begin_layout Plain Layout
34798 cvs -q remove "<file-name>"
34806 \begin_layout Subsubsection
34807 Update of the local directory checkout from repository
34810 \begin_layout Standard
34811 Once your documents gets more complex,
34812 containing sub-documents and pictures,
34814 \begin_inset Flex Code
34817 \begin_layout Plain Layout
34823 files and so on using version control becomes more complicated.
34825 supports updating the whole tree in which resides the document.
34826 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.
34827 You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
34828 It's good practice anyway to store multipart documents in an extra directory.
34831 \begin_layout Standard
34833 \begin_inset Flex Code
34836 \begin_layout Plain Layout
34837 Update local directory from repository
34842 command updates the whole directory.
34843 If local changes are detected user is warned before update starts.
34844 In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
34845 You have to review and correct the result of the merge.
34846 You'll find the conflicts enclosed in pairs of
34847 \begin_inset Flex Code
34850 \begin_layout Plain Layout
34857 \begin_inset Flex Code
34860 \begin_layout Plain Layout
34867 \begin_inset Flex Code
34870 \begin_layout Plain Layout
34877 The first part is your version as before the update operation with the document name prepended.
34878 The second one is the repository version with the version number after the sequence of
34879 \begin_inset Flex Code
34882 \begin_layout Plain Layout
34891 \begin_layout Labeling
34892 \labelwidthstring 00.00.0000
34894 \begin_inset space ~
34899 \begin_inset space ~
34903 \begin_inset Newline newline
34907 \begin_inset Flex Code
34910 \begin_layout Plain Layout
34919 (Ask if changes are detected.)
34920 \begin_inset Newline newline
34924 \begin_inset Flex Code
34927 \begin_layout Plain Layout
34939 \begin_layout Standard
34941 \begin_inset Flex Code
34944 \begin_layout Plain Layout
34950 stands for the path to the document.
34953 \begin_layout Subsubsection
34959 \begin_layout Standard
34960 This shows the complete history of the CVS document.
34963 cvs log "<file-name>"
34965 is shown in a browser.
34968 \begin_layout Subsubsection
34972 \begin_layout Standard
34974 supports CVS version number,
34976 date and time of last commit.
34977 All those are extracted from
34979 cvs log -r <file-name>
34983 \begin_inset CommandInset ref
34985 reference "subsec:VCS-Revision-Information"
34993 \begin_layout Subsection
34994 SVN commands in \SpecialChar LyX
34998 \begin_layout Standard
34999 SVN is now partially supported by \SpecialChar LyX
35001 You can find the commands in the
35003 File\SpecialChar menuseparator
35005 \begin_inset space ~
35011 Please note that if you use password protected access to repository via ssh,
35012 you will be asked in terminal window.
35014 was tested against SVN 1.5,
35020 \begin_layout Plain Layout
35021 Most of the commands will work with 1.4 too,
35023 \begin_inset CommandInset ref
35025 reference "subsec:SVN-Repo-Update"
35031 There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
35039 \begin_layout Subsubsection
35045 \begin_layout Standard
35046 If your document is not under revision control,
35047 this is the only item shown in the menu.
35048 And if it is under revision control,
35053 item is not visible.
35056 \begin_layout Standard
35057 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
35062 This means you have to checkout the archive by yourself.
35065 \begin_layout Standard
35066 Then you are asked interactively to supply an initial description of the document.
35067 Don't forget that registered file is not yet commited.
35070 \begin_layout Standard
35071 SVN command that is run:
35075 \begin_inset Quotes qld
35079 \begin_inset Quotes qld
35085 \begin_layout Standard
35090 to understand the switches.
35093 \begin_layout Subsubsection
35099 \begin_layout Standard
35100 When you are finished editing a file,
35101 you commit your changes.
35103 you are asked for a description of the changes.
35104 After that changes are commited.
35107 \begin_layout Standard
35112 \begin_layout Plain Layout
35113 In case locking is not enabled.
35115 \begin_inset CommandInset ref
35117 reference "subsec:SVN-File-Locking"
35129 svn commit -q -m"<description>" <file-name>
35132 \begin_layout Subsubsection
35138 \begin_layout Standard
35139 Updates the changes of this file from the repository.
35140 Be sure you understand SVN merging and conflicts resolving before using this function,
35141 because all conflicts has to be resolved manually by you!
35144 \begin_layout Standard
35149 \begin_layout Plain Layout
35157 svn update --non-interactive
35158 \begin_inset Quotes qld
35162 \begin_inset Quotes qld
35168 \begin_layout Subsubsection
35171 Revert To Repository Version
35174 \begin_layout Standard
35175 This will discard all changes made to the document since the last check in.
35176 You get a warning before changes are discarded.
35179 \begin_layout Standard
35184 \begin_inset Quotes qld
35188 \begin_inset Quotes qld
35194 \begin_layout Subsubsection
35200 \begin_layout Standard
35201 This will create a copy of the current document including the version history.
35202 It requires a clean document without any changes since the last checkin.
35203 You are asked for a file name and a description of the copy operation.
35204 After that the copy is created,
35205 both locally and in the repository.
35206 If the parent directories of the copied and original document differ,
35207 all relative paths of included files of the copy are adjusted (like in
35209 File\SpecialChar menuseparator
35215 the copy is loaded instead of the original document.
35218 \begin_layout Labeling
35219 \labelwidthstring 00.00.0000
35221 \begin_inset space ~
35226 \begin_inset space ~
35230 \begin_inset Newline newline
35234 \begin_inset Flex Code
35237 \begin_layout Plain Layout
35241 \begin_inset Quotes qld
35245 \begin_inset Quotes qld
35249 \begin_inset Quotes qld
35253 \begin_inset Quotes qld
35262 \begin_inset Newline newline
35266 \begin_inset Flex Code
35269 \begin_layout Plain Layout
35278 \begin_layout Subsubsection
35284 \begin_layout Standard
35285 This will rename the current document including the version history.
35286 It requires a clean document without any changes since the last checkin.
35287 You are asked for a file name and a description of the rename operation.
35288 After that the document is renamed,
35289 both locally and in the repository.
35290 If the parent directories of the new and old file names differ,
35291 all relative paths of included files are adjusted (like in
35293 File\SpecialChar menuseparator
35299 the document is reloaded using the new name.
35302 \begin_layout Labeling
35303 \labelwidthstring 00.00.0000
35305 \begin_inset space ~
35310 \begin_inset space ~
35314 \begin_inset Newline newline
35318 \begin_inset Flex Code
35321 \begin_layout Plain Layout
35325 \begin_inset Quotes qld
35329 \begin_inset Quotes qld
35333 \begin_inset Quotes qld
35337 \begin_inset Quotes qld
35346 \begin_inset Newline newline
35350 \begin_inset Flex Code
35353 \begin_layout Plain Layout
35362 \begin_layout Subsubsection
35363 \begin_inset CommandInset label
35365 name "subsec:SVN-Repo-Update"
35369 Update of the local directory checkout from repository
35373 \begin_layout Plain Layout
35374 Note that this command will work only with subversion
35375 \begin_inset Formula $\geqq1.5$
35386 \begin_layout Standard
35387 All the commands above have one shortcoming – they deal with the current document only.
35388 Once your document contains pictures,
35390 \begin_inset Flex Code
35393 \begin_layout Plain Layout
35399 files and so on administration becomes more complicated.
35401 now supports updating the whole tree in which resides the document
35405 \begin_layout Plain Layout
35406 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
35413 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.
35417 \begin_layout Standard
35418 \begin_inset Flex Code
35421 \begin_layout Plain Layout
35422 Update local directory from repository
35427 command updates the whole directory and in case of merge conflicts local version of the files are left,
35428 so no unintended data loss occurs.
35429 If local changes are detected user is warned before update starts.
35432 \begin_layout Labeling
35433 \labelwidthstring 00.00.0000
35435 \begin_inset space ~
35440 \begin_inset space ~
35444 \begin_inset Newline newline
35448 \begin_inset Flex Code
35451 \begin_layout Plain Layout
35457 (Ask if changes are detected.)
35458 \begin_inset Newline newline
35462 \begin_inset Flex Code
35465 \begin_layout Plain Layout
35466 svn update --accept mine-full $path
35474 \begin_layout Standard
35476 \begin_inset Flex Code
35479 \begin_layout Plain Layout
35485 stands for the path to the document.
35488 \begin_layout Subsubsection
35494 \begin_layout Standard
35495 This shows the complete history of the SVN document.
35499 \begin_inset Quotes qld
35503 \begin_inset Quotes qld
35508 is shown in a browser.
35511 \begin_layout Subsubsection
35513 \begin_inset CommandInset label
35515 name "subsec:SVN-File-Locking"
35522 \begin_layout Standard
35523 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.
35524 When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
35525 which guarantees that only one user is allowed to edit file at the given time.
35528 \begin_layout Standard
35529 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
35531 \begin_inset CommandInset ref
35533 reference "subsec:Automatical-Locking-Property"
35539 \begin_inset Flex Code
35542 \begin_layout Plain Layout
35552 \begin_layout Plain Layout
35553 \begin_inset Flex URL
35556 \begin_layout Plain Layout
35558 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
35569 If this property is detected for a given document \SpecialChar LyX
35570 starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
35571 This in particular means there are two different modes of file use in \SpecialChar LyX
35575 \begin_layout Itemize
35577 The loaded file is in the read-only mode.
35578 For editing on needs to check-out.
35583 consists of updating from the repository and gaining write lock.
35584 If the lock is not possible to obtain,
35585 we remain in unlocked state.
35588 \begin_layout Itemize
35590 The loaded file is in the
35591 \begin_inset Quotes els
35595 \begin_inset Quotes ers
35599 No other user is allowed to edit the file.
35604 consists of commiting changes and releasing write-lock.
35605 If no changes have been made to the document,
35606 no commit will be produced
35610 \begin_layout Plain Layout
35611 Don't be puzzled by the fact that you will be asked for commit message anyway.
35616 and only the write-lock will be released.
35619 \begin_layout Standard
35623 \begin_layout Labeling
35624 \labelwidthstring 00.00.0000
35628 svn commit -q -m"<description>" "<file-name>"
35629 \begin_inset Newline newline
35632 svn unlock "<file-name>"
35635 \begin_layout Labeling
35636 \labelwidthstring 00.00.0000
35640 svn update "<file-name>"
35641 \begin_inset Newline newline
35644 svn lock "<file-name>"
35647 \begin_layout Subsubsection
35650 \begin_inset CommandInset label
35652 name "subsec:Automatical-Locking-Property"
35658 Automatic Locking Property
35661 \begin_layout Standard
35662 The above mentioned automatic setting of write permissions of the .lyx file can be set through
35664 File\SpecialChar menuseparator
35666 \begin_inset space ~
35669 Control\SpecialChar menuseparator
35670 Use Locking Property
35673 This command is active only when the file is not locked on the svn server (i.e.
35674 you need to check-out before proceeding).
35677 \begin_layout Labeling
35678 \labelwidthstring 00.00.0000
35680 \begin_inset space ~
35686 \begin_layout Labeling
35687 \labelwidthstring 00.00.0000
35691 svn propset svn:needs-lock ON "<file-name>"
35694 \begin_layout Labeling
35695 \labelwidthstring 00.00.0000
35699 svn propdel svn:needs-lock "<file-name>"
35702 \begin_layout Subsubsection
35703 \begin_inset CommandInset label
35705 name "subsec:VCS-Revision-Information"
35709 Revision Information in Documents
35712 \begin_layout Standard
35713 There are more possibilities how to activate revision information in our document.
35716 \begin_layout Itemize
35722 \begin_layout Itemize
35723 tree revision information (
35724 \begin_inset Flex Code
35727 \begin_layout Plain Layout
35734 The result is the output of the
35735 \begin_inset Flex Code
35738 \begin_layout Plain Layout
35745 the following table gives you an idea,
35746 how to read the results.
35749 \begin_layout Standard
35751 \begin_inset Tabular
35752 <lyxtabular version="3" rows="6" columns="2">
35753 <features tabularvalignment="middle">
35754 <column alignment="left" valignment="top">
35755 <column alignment="left" valignment="top">
35757 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
35760 \begin_layout Plain Layout
35768 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
35771 \begin_layout Plain Layout
35781 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35784 \begin_layout Plain Layout
35790 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35793 \begin_layout Plain Layout
35794 mixed revision working copy
35801 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35804 \begin_layout Plain Layout
35810 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35813 \begin_layout Plain Layout
35814 modified working copy
35821 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35824 \begin_layout Plain Layout
35830 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35833 \begin_layout Plain Layout
35834 switched working copy
35841 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35844 \begin_layout Plain Layout
35850 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35853 \begin_layout Plain Layout
35854 partial working copy,
35855 from a sparse checkout
35862 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
35865 \begin_layout Plain Layout
35871 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
35874 \begin_layout Plain Layout
35877 switched working copy
35890 \begin_layout Itemize
35891 file revision information.
35892 The result comes from parsing the output of
35893 \begin_inset Flex Code
35896 \begin_layout Plain Layout
35898 \begin_inset space ~
35902 \begin_inset space ~
35906 \begin_inset space ~
35915 Supported flags are:
35919 \begin_layout Itemize
35920 version number of the last commit (
35921 \begin_inset Flex Code
35924 \begin_layout Plain Layout
35933 \begin_layout Itemize
35934 author of the last commit (
35935 \begin_inset Flex Code
35938 \begin_layout Plain Layout
35947 \begin_layout Itemize
35948 date of the last commit (
35949 \begin_inset Flex Code
35952 \begin_layout Plain Layout
35961 \begin_layout Itemize
35962 time of the last commit (
35963 \begin_inset Flex Code
35966 \begin_layout Plain Layout
35976 \begin_layout Standard
35977 You can obtain this info via InsetInfo (
35978 \change_inserted 5863208 1564400022
35981 Insert\SpecialChar menuseparator
35982 Field\SpecialChar menuseparator
35983 Version Control Revision
35984 \change_deleted 5863208 1564399852
35989 \begin_inset Flex Code
35992 \begin_layout Plain Layout
35993 info-insert buffer vcs-date
36001 The information will be available only when you have the file stored under svn managment (i.e.
36003 \begin_inset Flex Code
36006 \begin_layout Plain Layout
36012 directory is available with your document).
36016 \begin_layout Itemize
36019 possibility is to use svn keywords
36023 \begin_layout Plain Layout
36024 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
36030 In short – you set file keywords property (e.g.
36033 svn propset svn:keywords 'Rev' file.lyx
36035 ) and then paste keyword \SpecialChar TeX
36040 \begin_layout Plain Layout
36041 This is an easy way how to ensure that \SpecialChar LyX
36042 won't break the line in the middle of keyword tag.
36047 tag in your document (e.g.
36049 \begin_inset Flex Code
36052 \begin_layout Plain Layout
36059 This way svn client will automatically substitute revision number (e.g.
36061 \begin_inset Flex Code
36064 \begin_layout Plain Layout
36071 ) after each update and commit.
36072 There are more problems with this approach.
36074 the '$' character is used in \SpecialChar TeX
36075 world for math equations,
36076 so any occurence of math formula
36077 \begin_inset Formula $Rev$
36081 \begin_inset Formula $Rev:59$
36084 in your \SpecialChar LyX
36086 Similarly for other keywords like Id,
36090 Secondly svn output is dependent on your locales,
36091 so its very easy that svn would produce some problematic strings once Date is used.
36092 Thirdly you get the whole 'Rev:
36093 59' string in your document instead of the plain number.
36094 Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
36095 to support it directly.
36098 \begin_layout Subsection
36099 SVN and Windows Environment
36102 \begin_layout Quote
36103 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
36104 they would be well advised to use TortoiseSVN.
36111 \begin_layout Subsubsection
36115 \begin_layout Standard
36116 In addition to installing \SpecialChar LyX
36118 and having access to a Subversion repository,
36119 the user will need to install the Subversion client program.
36120 A Windows installer for the client program is available from
36121 \begin_inset CommandInset href
36124 target "http://www.collab.net/nonav/downloads/subversion/"
36130 The user may also want to install
36131 \begin_inset CommandInset href
36134 target "http://tortoisesvn.tigris.org/"
36140 which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
36141 Operations done outside \SpecialChar LyX
36142 will typically be more convenient using the Explorer context menu.
36143 Note that TortoiseSVN is not a replacement for the client program,
36144 which is what \SpecialChar LyX
36148 \begin_layout Subsubsection
36149 Bringing a document under Subversion control
36152 \begin_layout Standard
36153 Before a \SpecialChar LyX
36154 document can be brought under version control in Subversion,
36155 its parent directory needs to be under version control.
36156 If the document is being added to a project already in the repository,
36157 this is accomplished by checking the project out to the directory where the new document will be placed.
36158 If the project itself is not yet under version control (for instance,
36159 if this document starts a new project),
36160 the directory must be imported into the repository.
36161 This is done outside \SpecialChar LyX
36163 Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
36164 or alternatively can be done using the command line client at a DOS prompt.
36165 The procedure for importing the project using TortoiseSVN is described below,
36166 assuming an existing repository and a new project being started in
36173 For information on using the Subversion client program,
36181 \begin_layout Enumerate
36188 in Windows Explorer,
36192 TortoiseSVN\SpecialChar menuseparator
36197 adjust the URL for the repository,
36201 \begin_layout Enumerate
36202 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
36206 Supply a name for the project folder and click OK.
36207 Add a message for the log file if desired,
36208 then click OK again.
36209 The new project folder should appear in the repository.
36211 click OK again to exit the repository browser.
36214 \begin_layout Enumerate
36215 Once again right click
36222 this time selecting SVN Checkout\SpecialChar ldots
36223 Select the URL of the project folder you just created in the repository,
36224 and set the checkout directory to
36232 You will be warned about a non-empty folder;
36233 click OK to proceed.
36234 You should now have a
36245 \begin_layout Enumerate
36246 Create or open your document in \SpecialChar LyX
36249 File\SpecialChar menuseparator
36251 \begin_inset space ~
36254 Control\SpecialChar menuseparator
36258 Add a log message and click OK to commit the document to version control.
36261 \begin_layout Standard
36262 From this point onward,
36263 you should have full functionality in the
36265 File\SpecialChar menuseparator
36267 \begin_inset space ~
36273 You also have the option of checking the document in and out,
36274 viewing its history,
36276 using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
36279 \begin_layout Subsubsection
36280 SSH tunnel used with SVN under Windows
36283 \begin_layout Standard
36284 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
36285 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,
36286 also be prepared for a great deal of frustration\SpecialChar ldots
36290 \begin_layout Enumerate
36291 Get an svn client for windows,
36292 as described in the previous sections.
36293 When it is a fresh install run some svn command (e.g.
36295 \begin_inset Flex Code
36298 \begin_layout Plain Layout
36304 ) to create config files,
36305 which you will need to change later on.
36308 \begin_layout Enumerate
36309 Choose an ssh client for Windows.
36310 There are several possibilities,
36311 we will use the one from Putty tools
36315 \begin_layout Plain Layout
36316 \begin_inset Flex URL
36319 \begin_layout Plain Layout
36321 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
36332 You will need to set the connection up so that the client doesn't ask for any password from you.
36333 To keep things easy we will use only keys without any additional password protection etc.
36337 \begin_layout Enumerate
36339 \begin_inset Flex Code
36342 \begin_layout Plain Layout
36349 Save your private .ppk key file and put the public one on the server side.
36350 If the SVN server runs on Linux,
36351 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
36352 \begin_inset Quotes eld
36357 Public key for pasting into OpenSSH authorized_keys file
36360 \begin_inset Quotes erd
36363 edit field into the server's
36364 \begin_inset Flex Code
36367 \begin_layout Plain Layout
36368 ~/.ssh/authorized_keys
36374 \begin_inset Flex Code
36377 \begin_layout Plain Layout
36386 \begin_layout Enumerate
36388 \begin_inset Flex Code
36391 \begin_layout Plain Layout
36398 In the SVN config file
36402 \begin_layout Plain Layout
36403 Exact path depends on Windows version,
36404 usually somewhere around
36405 \begin_inset Flex Code
36408 \begin_layout Plain Layout
36411 Documents and Settings
36425 \begin_inset Flex Code
36428 \begin_layout Plain Layout
36448 \begin_inset Flex Code
36451 \begin_layout Plain Layout
36452 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
36461 \begin_layout Plain Layout
36462 It will usually take a lot of time to get exact command right and it depends on many things.
36463 For example do not have some remote server saved as a default session in Putty etc.
36465 try to connect via plink without SVN first.
36474 \begin_layout Enumerate
36475 Checkout the SVN archive,
36477 \begin_inset space \thinspace{}
36481 \begin_inset Newline newline
36485 \begin_inset Flex Code
36488 \begin_layout Plain Layout
36489 svn co svn+ssh://user@server/repository_path
36497 \begin_layout Subsubsection
36498 End-of-Line Conversions
36501 \begin_layout Standard
36502 When the collaborators are mixing Linux and Windows environments,
36504 will use different line endings inside the .lyx files.
36505 This is not a problem as far as \SpecialChar LyX
36506 functionality is concerned,
36507 but the commit diffs will be huge and merge-conflicts prone.
36508 Fortunately SVN itself knows
36512 \begin_layout Plain Layout
36513 \begin_inset Flex URL
36516 \begin_layout Plain Layout
36518 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
36528 how to deal with CR/LF problems when switching .lyx files to the
36529 \begin_inset Flex Code
36532 \begin_layout Plain Layout
36542 \begin_layout Plain Layout
36545 \begin_inset Flex Code
36548 \begin_layout Plain Layout
36549 svn propset svn:eol-style native FILE_NAME
36562 \begin_layout Subsection
36563 GIT commands in \SpecialChar LyX
36567 \begin_layout Standard
36568 A minimal subset of GIT commands is now supported by \SpecialChar LyX
36570 You can find the commands in the
36572 File\SpecialChar menuseparator
36574 \begin_inset space ~
36580 Please note that if you use password protected access to repository via ssh,
36581 you will be asked in terminal window.
36583 was tested against GIT 1.7.
36587 \begin_layout Plain Layout
36588 Windows users please note that you need to ensure that git is on the path.
36589 This can be set from within \SpecialChar LyX
36592 Tools\SpecialChar menuseparator
36593 Preferences\SpecialChar menuseparator
36594 Paths\SpecialChar menuseparator
36605 \begin_layout Standard
36606 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
36607 With traditional version control systems there is one central server which hosts the repository.
36608 Users commit their changes to the server,
36609 and get updates made by other users from it.
36611 users commit to a local repository.
36612 The local repository can be synchronized with one or more remote repositories using the
36613 \begin_inset Flex Code
36616 \begin_layout Plain Layout
36623 \begin_inset Flex Code
36626 \begin_layout Plain Layout
36634 does not interact in any way with remote GIT repositories.
36635 It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
36636 If you use remote GIT repositories you need to do the
36637 \begin_inset Flex Code
36640 \begin_layout Plain Layout
36647 \begin_inset Flex Code
36650 \begin_layout Plain Layout
36656 operations with your favourite GIT client.
36659 \begin_layout Subsubsection
36665 \begin_layout Standard
36666 If your document is not under revision control,
36667 this is the only item shown in the menu.
36668 And if it is under revision control,
36673 item is not visible.
36676 \begin_layout Standard
36677 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
36682 This means you have to checkout the archive by yourself.
36685 \begin_layout Standard
36686 Then you are asked interactively to supply an initial description of the document.
36687 Don't forget that registered file is not yet committed.
36690 \begin_layout Standard
36691 GIT command that is run:
36695 \begin_inset Quotes qld
36699 \begin_inset Quotes qld
36705 \begin_layout Standard
36710 to understand the switches.
36713 \begin_layout Subsubsection
36719 \begin_layout Standard
36720 When you are finished editing a file,
36721 you commit your changes.
36723 you are asked for a description of the changes.
36724 After that changes are committed.
36727 \begin_layout Standard
36731 git commit -q -m"<description>" <file-name>
36734 \begin_layout Subsubsection
36737 Revert To Repository Version
36740 \begin_layout Standard
36741 This will discard all changes made to the document since the last check in.
36742 You get a warning before changes are discarded.
36745 \begin_layout Standard
36750 \begin_inset Quotes qld
36754 \begin_inset Quotes qld
36760 \begin_layout Subsubsection
36766 \begin_layout Standard
36767 This will rename the current document including the version history.
36768 It requires a clean document without any changes since the last checkin.
36769 You are asked for a file name and a description of the rename operation.
36770 After that the document is renamed,
36771 both locally and in the repository.
36772 If the parent directories of the new and old file names differ,
36773 all relative paths of included files are adjusted (like in
36775 File\SpecialChar menuseparator
36781 the document is reloaded using the new name.
36784 \begin_layout Labeling
36785 \labelwidthstring 00.00.0000
36787 \begin_inset space ~
36792 \begin_inset space ~
36796 \begin_inset Newline newline
36800 \begin_inset Flex Code
36803 \begin_layout Plain Layout
36807 \begin_inset Quotes qld
36811 \begin_inset Quotes qld
36815 \begin_inset Quotes qld
36819 \begin_inset Quotes qld
36828 \begin_inset Newline newline
36832 \begin_inset Flex Code
36835 \begin_layout Plain Layout
36844 \begin_layout Subsubsection
36850 \begin_layout Standard
36851 This shows the complete history of the GIT document.
36855 \begin_inset Quotes qld
36859 \begin_inset Quotes qld
36864 is shown in a browser.
36867 \begin_layout Subsubsection
36871 \begin_layout Standard
36873 supports GIT hash number of the last commit to the file,
36875 \change_inserted 1119979965 1564297456
36876 its abbreviated form,
36880 date and time of last commit.
36881 All those are extracted from
36883 git log -n 1 --pretty=format:%H%n
36884 \change_inserted 1119979965 1564297427
36890 Tree version information is obtained via
36892 git describe --abbrev --dirty --long
36896 \begin_inset CommandInset ref
36898 reference "subsec:VCS-Revision-Information"
36906 \begin_layout Subsection
36910 \begin_layout Standard
36911 With the recent addition of the
36912 \begin_inset Flex Code
36915 \begin_layout Plain Layout
36921 function \SpecialChar LyX
36922 power users are allowed to create their own commands for revision control.
36925 \begin_layout Standard
36926 As an example you can see how two TortoiseSVN commands could be integrated directly:
36929 \begin_layout Description
36932 \begin_inset Flex Code
36935 \begin_layout Plain Layout
36936 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
36944 \begin_layout Description
36947 \begin_inset Flex Code
36950 \begin_layout Plain Layout
36951 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
36959 \begin_layout Subsection
36960 Version control and Document comparison
36963 \begin_layout Standard
36964 One of the typical uses of version control is to inspect the changes between revisions,
36965 usually by creating
36966 \begin_inset Flex Code
36969 \begin_layout Plain Layout
36976 While this is useful for plain text files,
36977 it is much less useful in the case of \SpecialChar LyX
36979 which have more a complicated structure.
36980 Hence we provide binding to the Document comparison feature.
36981 There are two ways of calling this feature – either by direct call of
36982 \begin_inset Flex Code
36985 \begin_layout Plain Layout
36992 function (for details see \SpecialChar LyX
36993 functions manual) or by the toolbar icon
37007 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 '
37008 \begin_inset Flex Noun
37011 \begin_layout Plain Layout
37017 ' revisions back means comparison of the edited file with last commited revision).
37021 \begin_layout Standard
37022 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,
37023 numbers always point to the last number in RCS revision number,
37026 We don't currently support GIT addressing of revisions,
37027 one can just compare edited document with its revision X steps backs,
37028 where X is addressed as
37029 \begin_inset Flex Code
37032 \begin_layout Plain Layout
37041 \begin_layout Section
37043 \change_inserted 564990737 1672161575
37044 \begin_inset CommandInset label
37046 name "sec:Literate-Programming"
37052 Literate Programming
37055 \begin_layout Standard
37060 (kayvan@sylvan.com)
37065 original documentation written by
37067 Edmar Wienskoski Jr.
37070 (edmar-w-jr@technologist.com)
37073 \begin_layout Subsection
37077 \begin_layout Standard
37078 The main purpose of this documentation is to show you how to use \SpecialChar LyX
37079 for literate programming,
37080 where it is assumed that you are familiar with this programming technique,
37082 \begin_inset Quotes eld
37086 \begin_inset Quotes erd
37090 \begin_inset Quotes eld
37094 \begin_inset Quotes erd
37098 If that is not the case,
37099 please follow the web links provided in the following sections.
37100 There is a lot of good documentation out there covering old development history to the latest tools tips.
37103 \begin_layout Standard
37104 It is also assumed that you are familiar with \SpecialChar LyX
37105 itself to a point that you are comfortable changing your \SpecialChar LyX
37107 and X resources file.
37108 If that is not the case please refer to other \SpecialChar LyX
37109 documentation to cover your specific needs.
37112 \begin_layout Subsection
37113 Literate Programming
37116 \begin_layout Standard
37117 From the Literate Programming FAQ:
37121 \begin_layout Quotation
37122 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
37124 literate programs should be enjoyable reading,
37127 I couldn't resist!) In general,
37128 literate programs combine source and documentation in a single file.
37129 Literate programming tools then parse the file to produce either readable documentation or compilable source.
37130 The WEB style of literate programming was created by D.
37131 \begin_inset space \thinspace{}
37135 Knuth during the development of his \SpecialChar TeX
37136 typesetting software.
37140 \begin_layout Standard
37141 Another excerpt says:
37144 \begin_layout Quotation
37147 How is literate programming different from verbose commenting?
37150 \begin_layout Quotation
37151 There are three distinguishing characteristics.
37152 In order of importance,
37158 \begin_layout Itemize
37159 flexible order of elaboration
37162 \begin_layout Itemize
37163 automatic support for browsing
37166 \begin_layout Itemize
37167 typeset documentation,
37168 especially diagrams and mathematics
37172 \begin_layout Standard
37173 Now that I sparked your curiosity,
37174 take a look in the references.
37177 \begin_layout Subsubsection
37181 \begin_layout Standard
37182 The complete Literate Programming FAQ can be found at:
37185 \begin_layout Quote
37186 Literate Programming FAQ
37187 \begin_inset Flex URL
37190 \begin_layout Plain Layout
37192 http://www.literateprogramming.com/lpfaq.pdf
37200 \begin_layout Standard
37201 The FAQ lists 23 (twenty three!) different literate programming tools.
37202 Where some are specialized or
37203 \begin_inset Quotes eld
37207 \begin_inset Quotes erd
37210 for particular programming languages,
37211 while other have general scope.
37216 for my own use for several reasons:
37219 \begin_layout Itemize
37220 It can generate the documentation either in \SpecialChar LaTeX
37224 \begin_layout Itemize
37225 It has a open architecture,
37227 \begin_inset space \thinspace{}
37231 \begin_inset space \space{}
37234 it is easy to plug in new filters
37238 \begin_layout Plain Layout
37243 are programs that read a given data stream and output a manipulated data stream.
37245 a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
37251 and to perform special processing that you may need.
37255 \begin_layout Itemize
37256 There is a good selection of filters available already (the HTML is one of them).
37259 \begin_layout Itemize
37263 \begin_layout Standard
37264 The Noweb web page can be found at:
37268 \begin_layout Quote
37270 \begin_inset Flex URL
37273 \begin_layout Plain Layout
37275 https://www.cs.tufts.edu/~nr/noweb/
37283 \begin_layout Standard
37284 Starting from there you can reach many other interesting links and even some literate program examples.
37287 \begin_layout Subsection
37289 and Literate Programming with Noweb
37292 \begin_layout Standard
37293 The \SpecialChar LyX
37294 support for Literate Programming is provided by using the generic \SpecialChar LyX
37295 converters mechanism.
37296 This support is provided in a
37297 \begin_inset Quotes eld
37301 \begin_inset Quotes erd
37306 \begin_inset space \thinspace{}
37310 \begin_inset space \space{}
37313 you will be able to use this new \SpecialChar LyX
37314 feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
37318 \begin_layout Subsubsection
37319 Generating documents and code (weaving and tangling)
37322 \begin_layout Paragraph
37323 Using the noweb module
37326 \begin_layout Standard
37327 If you have installed Noweb and \SpecialChar LyX
37329 whenever you open a new document,
37330 after you have chosen its document class,
37333 Document\SpecialChar menuseparator
37337 \begin_inset Quotes eld
37341 \begin_inset Quotes erd
37345 If Noweb is correctly installed,
37346 when you click on the
37347 \begin_inset Quotes eld
37351 \begin_inset Quotes erd
37356 \begin_inset Quotes eld
37360 \begin_inset Quotes erd
37363 module in the available list and you can add it to your document.
37366 \begin_layout Paragraph
37370 \begin_layout Standard
37372 enables you to write code with a custom inset named
37373 \begin_inset Flex Noun
37376 \begin_layout Plain Layout
37383 Noweb delimits chunks like this:
37386 \begin_layout LyX-Code
37390 \begin_layout LyX-Code
37394 \begin_layout LyX-Code
37398 \begin_layout LyX-Code
37402 \begin_layout LyX-Code
37406 \begin_layout Standard
37407 The problem is that whatever is written in between the << and the
37411 must be taken literally,
37413 \begin_inset space \thinspace{}
37417 \begin_inset space \space{}
37421 should be prevented from making any special interpretation of what has been written.
37422 This is also handled by
37423 \begin_inset Flex Noun
37426 \begin_layout Plain Layout
37433 that works like a normal text inset but has a free spacing capability.
37436 \begin_layout Standard
37438 you can also use the
37439 \begin_inset Quotes eld
37443 \begin_inset Quotes erd
37446 construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
37449 \begin_layout LyX-Code
37453 \begin_layout LyX-Code
37454 def some_function(args):
37457 \begin_layout LyX-Code
37458 "This is the doc string for this function."
37461 \begin_layout LyX-Code
37467 \begin_layout LyX-Code
37468 @ %def some_function
37471 \begin_layout Standard
37472 For an example of this usage and the resulting cross-reference output,
37473 look at the Literate python program in
37475 LIBDIR/examples/listerrors.lyx
37477 which should make this all clear.
37480 \begin_layout Paragraph
37481 Generating the documentation
37484 \begin_layout Standard
37485 At this point you already have a new document file with a proper document class,
37486 and with some code and text on it.
37488 The answer is simple,
37491 View\SpecialChar menuseparator
37496 Just like you would do for a plain document.
37497 No special procedure is required.
37500 \begin_layout Standard
37501 To help orientate you,
37502 I will now explain what happens inside \SpecialChar LyX
37506 \begin_layout Enumerate
37509 Update\SpecialChar menuseparator
37512 menu option is chosen,
37513 a \SpecialChar LaTeX
37519 \begin_layout Standard
37520 If the document is of any literate class the generated file will be named with an extension name defined by the
37521 \begin_inset Quotes eld
37525 \begin_inset Quotes erd
37528 format (defined in the Preferences panel),
37529 otherwise the file will have the usual
37537 \begin_layout Enumerate
37538 Note that the only difference so far is in the name of the file,
37539 no special processing is required by \SpecialChar LyX
37541 Given that you formatted the code using the
37542 \begin_inset Flex Noun
37545 \begin_layout Plain Layout
37553 takes care of the business.
37556 \begin_layout Enumerate
37557 If the document is of any literate class \SpecialChar LyX
37558 will then use the internal \SpecialChar LyX
37559 to Noweb converter,
37560 followed by the Noweb to \SpecialChar LaTeX
37565 \begin_layout Plain Layout
37566 The converters are defined in the
37568 Tools\SpecialChar menuseparator
37573 \begin_inset Quotes eld
37577 \begin_inset Quotes erd
37589 manual for general information about converters.
37594 to generate the \SpecialChar LaTeX
37599 \begin_layout Standard
37600 Otherwise it will just skip this step.
37604 \begin_layout Enumerate
37607 is invoked and the regular post processing continues as in a plain document.
37610 \begin_layout Standard
37611 Independence from a particular
37612 \begin_inset Quotes eld
37616 \begin_inset Quotes erd
37619 is easily achieved by changing the commands that are run by the various converters.
37622 \begin_layout Paragraph
37623 Generating the code
37626 \begin_layout Standard
37627 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
37628 a \SpecialChar LaTeX
37629 file is generated just like step 1 above.
37637 This converter needs to be defined by the user and is not installed by default,
37638 though the Program format is.
37639 This converter (like any other converter) will have two parts:
37642 \begin_layout Enumerate
37643 The converter program itself.
37644 This program performs the conversion from the one format to the other (in this case,
37645 from the Noweb format to the Program pseudo-format).
37648 \begin_layout Enumerate
37649 The error log parser.
37650 This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
37652 This makes it possible for \SpecialChar LyX
37653 to place error boxes in the right places in the file buffer.
37656 \begin_layout Standard
37659 \begin_inset Quotes eld
37663 \begin_inset Quotes erd
37670 \begin_layout LyX-Code
37678 \begin_layout Standard
37679 This basically means that \SpecialChar LyX
37681 \begin_inset Quotes eld
37685 \begin_inset Quotes erd
37688 (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
37689 temp directory) and the directory path of the original \SpecialChar LyX
37694 \begin_layout Standard
37695 This is an implementation of
37696 \begin_inset Quotes eld
37700 \begin_inset Quotes erd
37703 that you can place in a directory on your path:
37706 \begin_layout LyX-Code
37712 \begin_layout LyX-Code
37718 \begin_layout LyX-Code
37721 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
37724 \begin_layout Standard
37725 The next part of the converter setting is the
37726 \begin_inset Quotes eld
37730 \begin_inset Quotes erd
37733 which is to be set to
37736 \begin_layout LyX-Code
37739 parselog=$$s/scripts/listerrors
37742 \begin_layout Standard
37743 This will run any errors that are generated by the
37744 \begin_inset Quotes eld
37748 \begin_inset Quotes erd
37751 process through the
37752 \begin_inset Quotes eld
37756 \begin_inset Quotes erd
37762 \begin_layout Standard
37763 The build will normally take place in \SpecialChar LyX
37764 's temporary directory,
37765 so the files produced by the conversion will be in that directory.
37767 will copy out what it regards as the `main' file,
37772 conversion may produce several files,
37773 and so most of these would then be deleted when \SpecialChar LyX
37775 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.
37778 \begin_layout Paragraph
37779 Build instructions in the document
37782 \begin_layout Standard
37783 The last piece of the integration between \SpecialChar LyX
37785 \begin_inset Quotes eld
37789 \begin_inset Quotes erd
37794 the instructions for building your program should be embedded in a chunk of its own.
37796 \begin_inset Quotes eld
37800 \begin_inset Quotes erd
37803 above uses the notangle command to look for this chunk (called
37804 \begin_inset Quotes eld
37808 \begin_inset Quotes erd
37811 ) and runs its contents through
37812 \begin_inset Quotes eld
37816 \begin_inset Quotes erd
37822 \begin_layout Standard
37824 such a chunk would look something like this:
37827 \begin_layout LyX-Code
37831 \begin_layout LyX-Code
37833 \begin_inset Newline newline
37836 if [ -z "${NOWEB_SOURCE}" ]
37837 \begin_inset Newline newline
37843 \begin_layout LyX-Code
37844 NOWEB_SOURCE=myfile.nw
37845 \begin_inset Newline newline
37849 \begin_inset Newline newline
37853 code to extract files ...
37854 use NOWEB_OUTPUT_DIR here ...]
37855 \begin_inset Newline newline
37859 code to compile files ...]
37860 \begin_inset Newline newline
37866 \begin_layout Standard
37868 \change_deleted 564990737 1672161716
37871 LIBDIR/examples/listerrors.lyx
37875 LIBDIR/examples/Literate.lyx
37876 \change_inserted 564990737 1672161716
37881 File\SpecialChar menuseparator
37882 Open Example\SpecialChar menuseparator
37883 Modules\SpecialChar menuseparator
37890 \change_deleted 564990737 1672161729
37894 \begin_inset Quotes eld
37898 \begin_inset Quotes erd
37901 program for some illustrations of how all of these pieces go together or in
37902 \change_deleted 564990737 1672161756
37905 LIBDIR/examples/noweb2lyx.lyx
37906 \change_inserted 564990737 1672161756
37911 File\SpecialChar menuseparator
37912 Open Example\SpecialChar menuseparator
37913 Modules\SpecialChar menuseparator
37914 Noweb2\SpecialChar LyX
37926 \change_deleted 564990737 1672161767
37929 files show off the language-indepence of the \SpecialChar LyX
37930 literate programming support since they are written in Python
37931 \change_deleted 564990737 1672161782
37935 and Perl respectively.
37938 \begin_layout Subsubsection
37939 Configuring \SpecialChar LyX
37943 \begin_layout Standard
37944 All the Literate Programming support is configured by the
37946 Tools\SpecialChar menuseparator
37950 \begin_inset Quotes eld
37954 \begin_inset Quotes erd
37958 The important parts are:
37961 \begin_layout Description
37963 \begin_inset space ~
37967 \begin_inset Quotes eld
37971 \begin_inset Quotes erd
37975 \begin_inset space ~
37978 format Set up via the File Formats tab,
37979 this is where the Noweb-specific pieces are set up.
37989 the file extension is set to
37994 This tells \SpecialChar LyX
37995 to create a file with a
37999 extension in the first step of the conversion process.
38002 \begin_layout Description
38004 \begin_inset space ~
38012 \begin_inset space ~
38015 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).
38018 \begin_layout Description
38028 This converter performs the
38029 \begin_inset Quotes eld
38033 \begin_inset Quotes erd
38036 of the literate document.
38039 \begin_inset Quotes eld
38044 noweave -delay -index $$i > $$o
38047 \begin_inset Quotes erd
38053 \begin_layout Description
38063 \begin_inset Quotes eld
38067 \begin_inset Quotes erd
38072 the Converter is set to
38073 \begin_inset Quotes eld
38081 \begin_inset Quotes erd
38086 \begin_inset Newline newline
38090 \begin_inset Quotes eld
38095 parselog=$$s/scripts/listerrors
38098 \begin_inset Quotes erd
38104 \begin_layout Subsubsection
38108 \begin_layout Standard
38109 There is also a new function implemented in the \SpecialChar LyX
38112 \begin_inset Quotes eld
38115 server-goto-file-row" function,
38116 to be used with ddd/gdb or other debugger.
38120 \begin_layout Standard
38121 When debugging code with ddd/gdb,
38122 it is possible to invoke a text editor at the current execution position with a single key stroke.
38123 The default ddd configuration for that is shift-ctrl-V.
38124 It happens that you can define the editor command line invocation in ddd by accessing the
38126 Edit\SpecialChar menuseparator
38127 Preferences\SpecialChar menuseparator
38130 dialog and changing the "Edit Sources" entry.
38133 \begin_layout Standard
38134 I take advantage of the newly created \SpecialChar LyX
38135 server function and this ddd feature,
38137 \begin_inset Quotes eld
38141 \begin_inset Quotes erd
38147 \begin_layout LyX-Code
38148 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
38151 \begin_layout Standard
38153 whenever you are using ddd and find a point in the program that you want to edit,
38154 you just press shift-ctrl-V (in the ddd window),
38155 and ddd will forward this information to \SpecialChar LyX
38156 through the \SpecialChar LyX
38157 server and then the \SpecialChar LyX
38158 window will show the same file with the cursor at the same position ddd was pointing to.
38159 No more guessing or long scrolling to locate a point in the program back from debugging !
38162 \begin_layout Standard
38163 Note however that you must enable the \SpecialChar LyX
38164 server to get this feature working (it is disabled by default).
38166 \begin_inset space ~
38170 \begin_inset CommandInset ref
38172 reference "sec:Starting-the-Server"
38177 explains how to do that.
38180 \begin_layout Subsubsection
38184 \begin_layout Standard
38185 There are six new buttons that can be added to your \SpecialChar LyX
38187 Four of these buttons are short cuts to layout styles:
38210 one for the custom inset
38215 The last one is a short cut to the
38216 \begin_inset Quotes eld
38220 \begin_inset Quotes erd
38227 \begin_layout Standard
38229 has a range of buttons that are available for tool bar customization.
38230 In my toolbar I like to combine the six short cuts above with two more:
38235 \SpecialChar menuseparator
38240 \SpecialChar menuseparator
38247 Document\SpecialChar menuseparator
38248 View\SpecialChar menuseparator
38252 Here is how it looks like:
38255 \begin_layout LyX-Code
38259 \begin_layout LyX-Code
38263 \begin_layout LyX-Code
38264 Icon "layout Standard"
38267 \begin_layout LyX-Code
38268 Icon "layout Section"
38271 \begin_layout LyX-Code
38272 Icon "layout \SpecialChar LaTeX
38276 \begin_layout LyX-Code
38277 Icon "layout \SpecialChar LyX
38281 \begin_layout LyX-Code
38282 Icon "flex.insert Chunk"
38285 \begin_layout LyX-Code
38289 \begin_layout LyX-Code
38293 \begin_layout LyX-Code
38294 Icon "buffer-typeset"
38297 \begin_layout LyX-Code
38298 Icon "build-program"
38301 \begin_layout LyX-Code
38305 \begin_layout LyX-Code
38309 \begin_layout LyX-Code
38313 \begin_layout LyX-Code
38317 \begin_layout LyX-Code
38321 \begin_layout Subsubsection
38322 Colors customization
38325 \begin_layout Standard
38326 There are a number of colors in \SpecialChar LyX
38327 that can be customized in
38332 One of the things that bothers people is the \SpecialChar LaTeX
38334 The default color is red,
38335 since the chunks uses \SpecialChar LaTeX
38337 and there is a lot of chunks in literate documents,
38338 you may get tired of seeing everything in red.
38339 You can change it by going to the tabs
38349 \begin_layout Standard
38350 The next thing is the visible presence of the newline character in the screen.
38351 You can choose the color of this particular character and make it blend in the background.
38352 I recommend you choosing a color that is close to the background but not equal,
38353 that way you still can see it is there,
38354 but it is not bothering you anymore.
38357 \begin_layout Subsection
38362 \begin_layout Standard
38372 \change_inserted 564990737 1672161863
38376 Help\SpecialChar menuseparator
38377 Specific Manuals\SpecialChar menuseparator
38385 \change_deleted 564990737 1671643409
38391 \change_inserted 564990737 1672161856
38395 File\SpecialChar menuseparator
38396 Open Example\SpecialChar menuseparator
38397 Modules\SpecialChar menuseparator
38404 \change_deleted 564990737 1671643461
38405 the Sweave manual (menu
38407 Help\SpecialChar menuseparator
38411 \change_inserted 564990737 1672161856
38415 Help\SpecialChar menuseparator
38416 Specific Manuals\SpecialChar menuseparator
38418 \change_deleted 564990737 1672161921
38424 \change_inserted 564990737 1672161917
38428 File\SpecialChar menuseparator
38429 Open Example\SpecialChar menuseparator
38430 Modules\SpecialChar menuseparator
38434 \change_deleted 564990737 1672742969
38438 \begin_layout Standard
38440 \change_deleted 564990737 1671355343
38444 \begin_layout Standard
38446 \change_deleted 564990737 1671355343
38447 You can do everything with \SpecialChar LyX
38448 that you can do with \SpecialChar LaTeX
38452 cannot support every \SpecialChar LaTeX
38454 But you can always use \SpecialChar TeX
38456 This chapter shows you some more special things you might want to use.
38457 For other special things you can do with figures,
38464 \begin_inset space ~