1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
68 \float_placement class
69 \float_alignment class
73 \pdf_title "LyX's Additional Features manual"
74 \pdf_author "LyX Team"
75 \pdf_subject "LyX's additional features documentation"
76 \pdf_keywords "LyX, Documentation, Additional"
78 \pdf_bookmarksnumbered true
79 \pdf_bookmarksopen false
80 \pdf_bookmarksopenlevel 1
85 \pdf_pdfusetitle false
86 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
89 \use_package amsmath 1
90 \use_package amssymb 1
93 \use_package mathdots 1
94 \use_package mathtools 1
96 \use_package stackrel 1
97 \use_package stmaryrd 1
98 \use_package undertilde 1
100 \cite_engine_type default
104 \paperorientation portrait
110 \notefontcolor #0000ff
117 \paragraph_separation indent
118 \paragraph_indentation default
120 \math_indentation default
121 \math_numbering_side default
122 \quotes_style english
126 \paperpagestyle headings
128 \tracking_changes true
129 \output_changes false
131 \postpone_fragile_content false
135 \docbook_table_output 0
136 \docbook_mathml_prefix 1
137 \author -712698321 "Jürgen Spitzmüller"
140 \author 244031559 "Yuriy"
141 \author 274215730 "scott"
142 \author 564990737 "John Lyx"
143 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
144 \author 1075283030 "Thibaut"
145 \author 1119979965 "Joel A. Kulesza"
151 Additional \SpecialChar LyX
155 \begin_layout Subtitle
157 \change_deleted 630872221 1622909155
159 \change_inserted 630872221 1622909155
166 by the \SpecialChar LyX
171 \begin_layout Plain Layout
173 Principal maintainer of this file is
175 Richard Kimberly Heck
178 If you have comments or error corrections,
179 please send them to the \SpecialChar LyX
180 Documentation mailing list,
182 \begin_inset Flex Code
185 \begin_layout Plain Layout
186 <lyx-docs@lists.lyx.org>
199 \begin_layout Standard
200 \begin_inset CommandInset toc
201 LatexCommand tableofcontents
208 \begin_layout Standard
210 \change_inserted 5863208 1672865652
211 \begin_inset Note Note
214 \begin_layout Plain Layout
216 \change_inserted 5863208 1672865674
217 Note to all translators:
220 \begin_layout Plain Layout
222 \change_inserted 5863208 1672865817
223 This manual was restructured for LyX 2.4.
224 Attached are notes for translators to help them to find their way round the new structure of Additional.lyx.
225 This note itself will be deleted in the final 2.4 release.
226 \begin_inset Newline newline
232 \begin_layout Plain Layout
234 \change_inserted 5863208 1672865801
237 Additional.lyx 2.4 Changes
240 \begin_layout Itemize
242 \change_inserted 5863208 1672865801
247 \begin_layout Itemize
249 \change_inserted 5863208 1672865801
254 \begin_layout Itemize
256 \change_inserted 5863208 1672865801
263 \begin_layout Itemize
265 \change_inserted 5863208 1672865801
267 moved and minor edits
270 \begin_layout Itemize
272 \change_inserted 5863208 1672865801
277 \begin_layout Itemize
279 \change_inserted 5863208 1672865801
284 \begin_layout Itemize
286 \change_inserted 5863208 1672865801
291 \begin_layout Itemize
293 \change_inserted 5863208 1672865801
295 moved and significant edits
298 \begin_layout Itemize
300 \change_inserted 5863208 1672865801
305 \begin_layout Itemize
307 \change_inserted 5863208 1672865801
312 \begin_layout Itemize
314 \change_inserted 5863208 1672865801
316 moved and minor edits
319 \begin_layout Itemize
321 \change_inserted 5863208 1672865801
326 \begin_layout Itemize
328 \change_inserted 5863208 1672865801
333 \begin_layout Itemize
335 \change_inserted 5863208 1672865801
340 \begin_layout Itemize
342 \change_inserted 5863208 1672865801
347 \begin_layout Itemize
349 \change_inserted 5863208 1672865824
354 \begin_layout Itemize
356 \change_inserted 5863208 1672865831
361 \begin_layout Itemize
363 \change_inserted 5863208 1672865831
368 \begin_layout Itemize
370 \change_inserted 5863208 1672865831
375 \begin_layout Itemize
377 \change_inserted 5863208 1672865831
382 \begin_layout Itemize
384 \change_inserted 5863208 1672865831
389 \begin_layout Itemize
391 \change_inserted 5863208 1672865831
396 \begin_layout Itemize
398 \change_inserted 5863208 1672865831
400 moved with minor edits
403 \begin_layout Itemize
405 \change_inserted 5863208 1672865831
410 \begin_layout Itemize
412 \change_inserted 5863208 1672865831
417 \begin_layout Itemize
419 \change_inserted 5863208 1672865831
421 moved with minor edits
424 \begin_layout Itemize
426 \change_inserted 5863208 1672865831
431 \begin_layout Itemize
433 \change_inserted 5863208 1672865831
438 \begin_layout Itemize
440 \change_inserted 5863208 1672865831
445 \begin_layout Itemize
447 \change_inserted 5863208 1672865831
448 (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.)
452 \begin_layout Itemize
454 \change_inserted 5863208 1672865831
461 \begin_layout Itemize
463 \change_inserted 5863208 1672865831
464 All module descriptions new except:
467 \begin_layout Itemize
469 \change_inserted 5863208 1672865831
471 moved with minor edits
474 \begin_layout Itemize
476 \change_inserted 5863208 1672865831
477 Custom header/footer text:
478 moved with minor edits
481 \begin_layout Itemize
483 \change_inserted 5863208 1672865831
485 moved with minor edits
488 \begin_layout Itemize
490 \change_inserted 5863208 1672865831
491 Custom paragraph shapes:
492 moved with minor edits
495 \begin_layout Itemize
497 \change_inserted 5863208 1672865831
499 moved with minor edits
503 \begin_layout Itemize
505 \change_inserted 5863208 1672865831
512 \begin_layout Itemize
514 \change_inserted 5863208 1672865831
515 Content moved but unchanged
519 \begin_layout Itemize
521 \change_inserted 5863208 1672865831
528 \begin_layout Itemize
530 \change_inserted 5863208 1672865845
531 Content moved but unchanged
535 \begin_layout Itemize
537 \change_inserted 5863208 1672865845
540 new chapter and content
543 \begin_layout Itemize
545 \change_inserted 5863208 1672865845
546 All other chapters unchanged but renumbered except:
549 \begin_layout Itemize
551 \change_inserted 5863208 1672865845
552 section 11.3 Literate programming:
563 \begin_layout Chapter
567 \begin_layout Standard
568 This manual is essentially Part II of the
570 User's Guide\SpecialChar endofsentence
573 The reason for separating the two documents is simple:
578 is already quite lengthy,
579 and it contains information on all of the basic features one needs to know in order to prepare most documents.
582 Team has worked to make \SpecialChar LyX
583 extensible through various configuration files and external packages.
584 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
586 you can create a layout file (or module) for it without having to alter \SpecialChar LyX
588 We've already had contributions of several new features this way,
589 and some of them are documented here.
590 There are also some more `advanced' features,
591 such as how to control the presentation of bibliographies and how to work with multi-part documents,
592 that are not covered in the
596 and are discussed here.
599 \begin_layout Standard
600 This manual also documents some special features,
602 \change_deleted 244031559 1603802929
605 \change_inserted 244031559 1603802931
609 \change_deleted 244031559 1603802954
614 which require additional software to work properly.
615 There is also a chapter on \SpecialChar LyX
618 there's a chapter of \SpecialChar LaTeX
620 things you can use to spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
628 only WYSIWYM and will only ever interface to some,
634 \begin_layout Standard
635 If you haven't read the
640 you are definitely in the wrong manual.
645 is the first place to go,
646 since it describes the notation and format of all of the manuals.
647 You should also be thoroughly familiar with the
651 and all of the basic features of \SpecialChar LyX
652 before attempting to read this one.
655 \begin_layout Standard
656 Since many of the topics in this manual depend heavily on \SpecialChar LyX
657 's interaction with \SpecialChar LaTeX
659 this first chapter covers the inner workings of \SpecialChar LyX
660 and how to direct \SpecialChar LyX
661 to generate exactly the \SpecialChar LaTeX
663 It is obviously for more seasoned \SpecialChar LyX
667 \begin_layout Chapter
669 and \SpecialChar LaTeX
673 \begin_layout Section
675 Uses \SpecialChar LaTeX
679 \begin_layout Standard
680 This chapter is for both \SpecialChar TeX
681 -nicians and the \SpecialChar LaTeX
684 we'll explain how \SpecialChar LyX
685 and \SpecialChar LaTeX
686 work together to produce printable output.
687 This is the only place in any of the manuals where we assume you know something about \SpecialChar LaTeX
691 \begin_layout Standard
695 \begin_inset Quotes eld
698 WYSIWYM frontend to \SpecialChar LaTeX
700 \begin_inset Quotes erd
703 but that's no longer true.
704 There are frontends to \SpecialChar LaTeX
709 \begin_layout Plain Layout
710 Some familar ones are \SpecialChar TeX
716 There are also the \SpecialChar LaTeX
717 modes for vi and emacs,
723 These are basically text editors with the ability to run \SpecialChar LaTeX
724 and mark any errors in the file you're editing.
725 Although \SpecialChar LyX
735 run \SpecialChar LaTeX
737 and it also indicates errors in the file,
741 you don't need to know \SpecialChar LaTeX
742 to use \SpecialChar LyX
745 has added its own extensions to \SpecialChar LaTeX
747 Try the following sometime:
749 \change_deleted -712698321 1674917358
753 \begin_inset Flex Noun
756 \begin_layout Plain Layout
759 Export\SpecialChar menuseparator
766 \change_inserted -712698321 1674917358
767 Export\SpecialChar menuseparator
773 \change_deleted -712698321 1674917366
775 \begin_inset Flex Noun
778 \begin_layout Plain Layout
785 \change_inserted -712698321 1674917366
793 \change_deleted -712698321 1674917371
795 \begin_inset Flex Noun
798 \begin_layout Plain Layout
799 View\SpecialChar menuseparator
810 \change_inserted -712698321 1674917371
813 View\SpecialChar menuseparator
823 then look at the preamble of the resulting
824 \begin_inset Flex Code
827 \begin_layout Plain Layout
834 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
836 These macros are defined automatically,
837 according to the features you use in the document.
840 \begin_layout Standard
841 There are several commands that automatically invoke \SpecialChar LaTeX
846 \begin_layout Itemize
848 \change_deleted -712698321 1674917379
849 \begin_inset Flex Noun
852 \begin_layout Plain Layout
853 Document\SpecialChar menuseparator
860 \change_inserted -712698321 1674917379
863 Document\SpecialChar menuseparator
869 \begin_layout Itemize
871 \change_deleted -712698321 1674917381
872 \begin_inset Flex Noun
875 \begin_layout Plain Layout
876 Document\SpecialChar menuseparator
883 \change_inserted -712698321 1674917381
886 Document\SpecialChar menuseparator
892 \begin_layout Standard
893 They will only invoke \SpecialChar LaTeX
894 if the file has changed since the last time \SpecialChar LaTeX
899 \begin_layout Standard
900 When \SpecialChar LyX
901 runs \SpecialChar LaTeX
902 on the file you're editing,
903 it performs these steps:
906 \begin_layout Enumerate
907 Convert the document to \SpecialChar LaTeX
908 and save to a file with the extension
909 \begin_inset Flex Code
912 \begin_layout Plain Layout
919 \begin_inset Flex Code
922 \begin_layout Plain Layout
931 \begin_layout Enumerate
932 Run \SpecialChar LaTeX
934 \begin_inset Flex Code
937 \begin_layout Plain Layout
943 file (maybe several times),
944 and run any other commands (such as
945 \begin_inset Flex Code
948 \begin_layout Plain Layout
955 \begin_inset Flex Code
958 \begin_layout Plain Layout
964 ) needed to compile the \SpecialChar LaTeX
968 \begin_layout Enumerate
969 If there are any errors,
973 \begin_layout Standard
974 If you have run \SpecialChar LaTeX
976 \change_deleted -712698321 1674917394
978 \begin_inset Flex Noun
981 \begin_layout Plain Layout
982 View\SpecialChar menuseparator
989 \change_inserted -712698321 1674917394
992 View\SpecialChar menuseparator
999 then runs a DVI viewer to display the DVI-file.
1001 \change_deleted -712698321 1674917400
1003 \begin_inset Flex Noun
1006 \begin_layout Plain Layout
1007 View\SpecialChar menuseparator
1014 \change_inserted -712698321 1674917400
1017 View\SpecialChar menuseparator
1024 performs further steps:
1027 \begin_layout Enumerate
1029 \begin_inset Flex Code
1032 \begin_layout Plain Layout
1038 to convert the DVI file to PostScript.
1041 \begin_layout Enumerate
1042 Run a PostScript viewer,
1044 \begin_inset Flex Code
1047 \begin_layout Plain Layout
1054 to display the PostScript file.
1057 \begin_layout Standard
1059 does similar things when viewing,
1064 \begin_layout Section
1065 Translating \SpecialChar LaTeX
1066 files into \SpecialChar LyX
1070 \begin_layout Standard
1071 You can import a \SpecialChar LaTeX
1072 file into \SpecialChar LyX
1074 \change_deleted -712698321 1674917408
1076 \begin_inset Flex Noun
1079 \begin_layout Plain Layout
1080 File\SpecialChar menuseparator
1081 Import\SpecialChar menuseparator
1088 \change_inserted -712698321 1674917408
1091 File\SpecialChar menuseparator
1092 Import\SpecialChar menuseparator
1097 command in \SpecialChar LyX
1099 This will call a program named
1100 \begin_inset Flex Code
1103 \begin_layout Plain Layout
1109 which will create a file
1110 \begin_inset Flex Code
1113 \begin_layout Plain Layout
1120 \begin_inset Flex Code
1123 \begin_layout Plain Layout
1131 will then open that file.
1135 \begin_layout Plain Layout
1136 \begin_inset Flex Code
1139 \begin_layout Plain Layout
1145 can also be run from the command line,
1154 \begin_layout Standard
1155 \begin_inset Flex Code
1158 \begin_layout Plain Layout
1164 will translate most legal \SpecialChar LaTeX
1167 It will put things it doesn't understand into \SpecialChar TeX
1169 so after translating a file with
1170 \begin_inset Flex Code
1173 \begin_layout Plain Layout
1180 you can look for \SpecialChar TeX
1181 code and hand-edit it until it looks right.
1184 \begin_layout Standard
1185 If you don't know what \SpecialChar TeX
1187 read the next section.
1190 \begin_layout Section
1191 \begin_inset CommandInset label
1193 name "sec:Inserting-TeX-Code"
1197 Inserting \SpecialChar TeX
1198 Code into \SpecialChar LyX
1202 \begin_layout Standard
1203 Anything you can do in \SpecialChar LaTeX
1204 you can do in \SpecialChar LyX
1206 for a very simple reason:
1207 You can always insert \SpecialChar TeX
1208 code into any \SpecialChar LyX
1212 and will never be able to,
1213 display every possible \SpecialChar LaTeX
1215 If ever you need to insert \SpecialChar LaTeX
1216 commands into your \SpecialChar LyX
1219 \begin_inset Flex Code
1222 \begin_layout Plain Layout
1230 which you can insert into your document with
1231 \change_deleted -712698321 1674917417
1233 \begin_inset Flex Noun
1236 \begin_layout Plain Layout
1237 Insert\SpecialChar menuseparator
1248 \change_inserted -712698321 1674917417
1251 Insert\SpecialChar menuseparator
1256 or the keyboard shortcut
1265 \begin_layout Standard
1266 Here's an example of inserting \SpecialChar LaTeX
1267 commands in a \SpecialChar LyX
1269 The code looks like this:
1272 \begin_layout LyX-Code
1276 \begin_inset Newline newline
1281 begin{minipage}{5cm}
1282 \begin_inset Newline newline
1285 This is an example of a minipage environment.
1287 \begin_inset Newline newline
1290 can put nearly everything in it,
1292 \begin_inset Newline newline
1297 \begin_inset Newline newline
1303 \begin_inset Newline newline
1307 \begin_inset Newline newline
1312 begin{minipage}{5cm}
1313 \begin_inset Newline newline
1319 \begin_inset Newline newline
1324 begin{minipage}{5cm}
1325 \begin_inset Newline newline
1330 \begin_inset Newline newline
1336 \begin_inset Newline newline
1342 \begin_inset Newline newline
1348 \begin_inset Newline newline
1356 \begin_layout LyX-Code
1360 \begin_layout Standard
1362 \begin_inset Flex Code
1365 \begin_layout Plain Layout
1372 box containing this text is directly after this paragraph.
1373 Those of you reading the manual in \SpecialChar LyX
1374 will only see the \SpecialChar TeX
1376 Those reading a printed version of the manuals will see the actual results:
1377 \begin_inset VSpace bigskip
1383 \begin_layout Standard
1387 \begin_layout Plain Layout
1394 \begin_layout Plain Layout
1398 begin{minipage}{5cm}
1401 \begin_layout Plain Layout
1403 This is an example of a minipage environment.
1404 You can put nearly everything in it,
1405 even (non-floating) figures and tables.
1409 \begin_layout Plain Layout
1416 \begin_layout Plain Layout
1421 \begin_layout Plain Layout
1425 begin{minipage}{5cm}
1428 \begin_layout Plain Layout
1435 \begin_layout Plain Layout
1439 begin{minipage}{5cm}
1442 \begin_layout Plain Layout
1448 \begin_layout Plain Layout
1455 \begin_layout Plain Layout
1462 \begin_layout Plain Layout
1469 \begin_layout Plain Layout
1479 \begin_inset VSpace bigskip
1485 \begin_layout Standard
1486 In addition to using \SpecialChar TeX
1488 you can also create a separate file containing some complex \SpecialChar LaTeX
1489 structure and then use
1490 \change_deleted -712698321 1674917427
1492 \begin_inset Flex Noun
1495 \begin_layout Plain Layout
1496 Insert\SpecialChar menuseparator
1498 \begin_inset space ~
1507 \change_inserted -712698321 1674917427
1510 Insert\SpecialChar menuseparator
1512 \begin_inset space ~
1519 to include your file (you should select the type
1520 \begin_inset Flex Code
1523 \begin_layout Plain Layout
1530 We recommend that you only do this if you have a
1531 \begin_inset Flex Code
1534 \begin_layout Plain Layout
1546 you'll have a big job tracking down \SpecialChar LaTeX
1550 \begin_layout Standard
1551 There are a few last points to emphasize:
1554 \begin_layout Itemize
1560 check if your \SpecialChar LaTeX
1564 \begin_layout Itemize
1565 Beware of reinventing the wheel.
1568 \begin_layout Standard
1571 does have quite a few features tucked into it,
1572 and more are coming.
1573 Be sure to check the manuals to make sure that \SpecialChar LyX
1574 doesn't have such-and-such feature before you decide you have to do it by hand.
1576 there are numerous \SpecialChar LaTeX
1577 packages out there to do all sorts of things,
1578 from labels to envelopes to fancy multipage tables.
1580 \change_inserted 244031559 1603815732
1582 \begin_inset CommandInset href
1585 target "https://www.ctan.org/"
1591 \change_deleted 244031559 1603815732
1593 \begin_inset CommandInset href
1596 target "http://www.ctan.org/"
1606 \begin_layout Standard
1607 If you do need to do some wild and fancy things within your document,
1608 be sure to check out a good \SpecialChar LaTeX
1609 book for assistance.
1610 There are a number of them listed in the bibliography of the
1617 \begin_layout Section
1619 and the \SpecialChar LaTeX
1623 \begin_layout Subsection
1624 About the \SpecialChar LaTeX
1628 \begin_layout Standard
1629 If you already know \SpecialChar LaTeX
1631 there is no need to explain here what the preamble is good for.
1633 the following will give you some ideas—
1634 we recommend again that you consult a \SpecialChar LaTeX
1635 book for further information.
1637 you should read the points below,
1638 because they explain what you can do and what you don't need to do in the \SpecialChar LaTeX
1639 preamble of a \SpecialChar LyX
1643 \begin_layout Standard
1644 The \SpecialChar LaTeX
1645 preamble comes at the very beginning of a document,
1654 \begin_layout Itemize
1655 Declare the document class.
1657 \begin_inset Newline newline
1661 already does this for you.
1662 If you're a seasoned \SpecialChar LaTeX
1664 and you have a custom document class you want to use,
1667 Customization Manual
1669 for information on how to make \SpecialChar LyX
1673 \begin_layout Itemize
1674 Declare the usage of packages.
1676 \begin_inset Newline newline
1680 packages provide special commands,
1681 which are only available within a document when the package has been declared in the preamble.
1682 In addition to providing special commands,
1683 the inclusion of a package can change the document.
1686 \begin_inset Flex Code
1689 \begin_layout Plain Layout
1695 forces all paragraphs to be indented.
1696 There are other packages for labels,
1703 \begin_layout Itemize
1708 \begin_inset Newline newline
1711 There are several \SpecialChar LaTeX
1712 counters and variables that
1716 be set globally from within the preamble in order to have the desired effect.
1717 (There are variables that you can set and reset inside the document,
1718 too.) Margins are a good example of something that must be set in the preamble.
1719 Another example is the label format for lists.
1720 You can actually set these just about anywhere,
1721 but it's best to do it just once,
1722 inside the preamble.
1725 \begin_layout Itemize
1726 Declare user defined commands (with
1727 \begin_inset Flex Code
1730 \begin_layout Plain Layout
1739 \begin_inset Flex Code
1742 \begin_layout Plain Layout
1751 \begin_inset Newline newline
1754 These are abbreviations for \SpecialChar LaTeX
1755 commands which appear very often inside a document.
1756 Although the preamble is a good place to declare such commands,
1761 be declared anywhere (before they are used for the first time,
1763 This can be useful if there is a lot of raw \SpecialChar LaTeX
1764 code in your document,
1765 which normally should not be the case.
1768 \begin_layout Standard
1770 adds its own set of definitions to the preamble of the
1771 \begin_inset Flex Code
1774 \begin_layout Plain Layout
1781 This makes \SpecialChar LaTeX
1782 files generated by \SpecialChar LyX
1786 \begin_layout Subsection
1787 Changing the Preamble
1790 \begin_layout Standard
1791 The commands which \SpecialChar LyX
1792 adds to the preamble of a \SpecialChar LaTeX
1794 you can't change them without patching \SpecialChar LyX
1798 add your own stuff to the preamble by selecting
1799 \begin_inset Flex Noun
1802 \begin_layout Plain Layout
1805 \begin_inset space ~
1814 \change_deleted -712698321 1674917437
1816 \begin_inset Flex Noun
1819 \begin_layout Plain Layout
1820 Document\SpecialChar menuseparator
1827 \change_inserted -712698321 1674917437
1830 Document\SpecialChar menuseparator
1837 adds anything in the
1838 \begin_inset Flex Noun
1841 \begin_layout Plain Layout
1847 dialog to its own built-in preamble.
1848 Before adding your own declarations in the preamble,
1849 you should make sure that \SpecialChar LyX
1850 doesn't already support what you want to do.
1851 (Remember what we said about reinventing the wheel?) Also,
1854 make sure your preamble code is correct
1858 doesn't check it for you.
1859 If there is an error,
1860 you're likely to get an error like
1861 \begin_inset Quotes eld
1865 \begin_inset Flex Code
1868 \begin_layout Plain Layout
1877 \begin_inset Quotes erd
1881 If you see this error,
1882 check your preamble.
1885 \begin_layout Subsection
1889 \begin_layout Standard
1890 Here are some examples of what you can add to a preamble,
1894 \begin_layout Subsubsection
1899 \begin_layout Standard
1900 There are two variables under \SpecialChar LaTeX
1901 that control page position:
1903 \begin_inset Flex Code
1906 \begin_layout Plain Layout
1915 \begin_inset Flex Code
1918 \begin_layout Plain Layout
1927 Their names should be self-explanatory.
1928 These variables are useful if you think for a moment about computer labels.
1930 the size of a print medium and the area of the medium that you can actually print on aren't the same.
1932 \begin_inset Flex Code
1935 \begin_layout Plain Layout
1944 \begin_inset Flex Code
1947 \begin_layout Plain Layout
1958 \begin_layout Standard
1959 The default values for
1960 \begin_inset Flex Code
1963 \begin_layout Plain Layout
1972 \begin_inset Flex Code
1975 \begin_layout Plain Layout
1984 \begin_inset space \thinspace{}
1989 \begin_inset space \thinspace{}
1993 \begin_inset space \space{}
1996 the page isn't shifted.
1998 some DVI drivers always seem to shift the page.
1999 We have no idea why,
2000 or why the sysadmin hasn't fixed such behavior.
2001 If you're using \SpecialChar LyX
2002 on a system that you don't personally maintain,
2003 and your sysadmin is a doofus,
2005 \begin_inset Flex Code
2008 \begin_layout Plain Layout
2017 \begin_inset Flex Code
2020 \begin_layout Plain Layout
2029 Suppose your left and top margins are always 0.5
2030 \begin_inset space \thinspace{}
2034 You can add this to the preamble:
2037 \begin_layout LyX-Code
2045 \begin_layout LyX-Code
2053 \begin_layout Standard
2054 and your margins should now be correct.
2057 \begin_layout Subsubsection
2062 \begin_layout Standard
2064 suppose you wanted to print out a bunch of address labels.
2065 There's a rather nice package,
2066 available at your nearest CTAN archive,
2067 for printing sheets of labels:
2069 \begin_inset Flex Code
2072 \begin_layout Plain Layout
2080 your system may not have this package installed by default.
2081 We leave that up to you to check.
2082 You'll also want to read the documentation for it;
2083 we're not going to do that for you.
2084 Since this is an example,
2086 we'll give you an example of how you use this package.
2089 \begin_layout Standard
2091 make sure you're using the
2092 \begin_inset Flex Code
2095 \begin_layout Plain Layout
2103 you need to put the following in your preamble:
2106 \begin_layout LyX-Code
2112 \begin_layout LyX-Code
2118 \begin_layout LyX-Code
2124 \begin_layout LyX-Code
2130 \begin_layout LyX-Code
2136 \begin_layout LyX-Code
2142 \begin_layout LyX-Code
2148 \begin_layout Standard
2149 This sets things up for Avery label sheets,
2151 You're now ready to print labels,
2152 but you'll need to insert \SpecialChar LaTeX
2154 placing the commands
2155 \begin_inset Flex Code
2158 \begin_layout Plain Layout
2167 \begin_inset Flex Code
2170 \begin_layout Plain Layout
2178 around each label text.
2179 This and other special features of
2180 \begin_inset Flex Code
2183 \begin_layout Plain Layout
2189 are explained in its documentation.
2192 \begin_layout Standard
2194 someone may write a \SpecialChar LyX
2195 layout file to support this package directly.
2196 Maybe that someone is you.
2199 \begin_layout Subsubsection
2201 Paragraph Indentation
2204 \begin_layout Standard
2205 Americans are trained to indent the first line of
2210 As with all of their other weird quirks,
2211 most Americans will whine and moan until they can have their way and indent the first line of all paragraphs.
2222 \begin_layout Standard
2224 this behavior isn't standard typography.
2226 you typically only indent the first line of a paragraph
2230 it follows another one.
2231 The idea behind indenting the first line of a paragraph is to distinguish neighboring paragraphs from one another.
2232 If there is no previous paragraph—
2234 if it follows a figure or is the first paragraph in a section—
2235 then there is no need for indentation.
2239 \begin_layout Standard
2240 If you're a typical American (we're still joking!),
2242 you don't care about such esoteric things;
2243 you want your indentation!
2244 Add this to the preamble:
2247 \begin_layout LyX-Code
2250 usepackage{indentfirst}
2253 \begin_layout Standard
2254 If your \SpecialChar TeX
2255 distribution isn't braindead,
2256 you'll have this package,
2257 and all of your paragraphs will get the indentation the Founding Fathers intended they should have.
2260 \begin_layout Subsubsection
2265 \begin_layout Standard
2266 You can also check out the preamble of this document to get an idea of some of the advanced things you can do.
2269 \begin_layout Section
2271 and \SpecialChar LaTeX
2275 \begin_layout Standard
2276 When \SpecialChar LyX
2277 calls \SpecialChar LaTeX
2279 it tells \SpecialChar LaTeX
2280 to blithely ignore any errors and keep going.
2281 It then uses the logfile from the \SpecialChar LaTeX
2282 run to do a post-mortem.
2283 After analyzing the logfile,
2285 displays a dialog listing the errors.
2286 Clicking on any one of them will take you to the position in your \SpecialChar LyX
2287 file where the error occurred.
2291 \begin_layout Plain Layout
2294 Analyzing the logfile is a tough job,
2295 and \SpecialChar LyX
2296 doesn't always go to the right line.
2297 There are also cases where \SpecialChar LaTeX
2298 reports the error on one line,
2299 but the actual error is earlier.
2300 This is not unlike forgetting a closing brace in a program:
2301 You'll get an error,
2310 \begin_layout Standard
2311 Some folks also like to look at the log file directly:
2312 It is available from
2313 \change_deleted -712698321 1674917444
2315 \begin_inset Flex Noun
2318 \begin_layout Plain Layout
2319 Document\SpecialChar menuseparator
2321 \begin_inset space ~
2330 \change_inserted -712698321 1674917444
2333 Document\SpecialChar menuseparator
2335 \begin_inset space ~
2343 There are some fairly common error messages and warnings.
2344 We'll cover those here.
2345 You should look at a good \SpecialChar LaTeX
2346 book for a complete listing.
2349 \begin_layout Itemize
2350 \begin_inset Flex Code
2353 \begin_layout Plain Layout
2360 \begin_inset Newline newline
2363 Anything beginning with these words is a warning message for the purpose of
2364 \begin_inset Quotes eld
2368 \begin_inset Quotes erd
2371 the \SpecialChar LaTeX
2373 You'll get messages like this if you added or changed cross-references or bibliography entries,
2376 is trying to tell you that you need to make another run.
2377 You can by-and-large ignore these.
2380 \begin_layout Itemize
2381 \begin_inset Flex Code
2384 \begin_layout Plain Layout
2391 \begin_inset Newline newline
2394 Another warning message,
2395 this time about fonts which \SpecialChar LaTeX
2397 The rest of the message will often say something about a replacement font that \SpecialChar LaTeX
2399 You can safely ignore these,
2403 \begin_layout Itemize
2404 \begin_inset Flex Code
2407 \begin_layout Plain Layout
2416 \begin_inset Newline newline
2425 It seems to generate at least one of these messages for just about any document you write.
2426 They are warnings about lines that were too long and run past the right margin.
2427 This happens if \SpecialChar LaTeX
2428 does not find a reasonable way to break the lines (notoriously often with typewriter font,
2429 since this does not allow for automatic break points).
2431 this is unnoticeable in the final output.
2432 (It can be just a point or two.) Sometimes,
2434 the lines run rather visibly into the margin;
2435 something you will not want to have in your final print.
2437 \begin_inset Newline newline
2440 There are several global ways to try to minimize the overfull lines.
2443 Enable micro-typographic extensions
2447 Document\SpecialChar menuseparator
2448 Settings\SpecialChar menuseparator
2451 might already improve things a lot.
2454 code such as the following in
2456 Document\SpecialChar menuseparator
2457 Settings\SpecialChar menuseparator
2460 usually reduces the overfull lines drastically (we use this in the preamble of this document):
2464 \begin_layout LyX-Code
2468 \begin_inset Newline newline
2474 \begin_inset Newline newline
2479 emergencystretch 1.5em
2480 \begin_inset Newline newline
2488 \begin_layout Standard
2491 you eventually have to rewrite the text to get the line breaking right.
2495 \begin_layout Plain Layout
2496 For more information,
2498 \begin_inset Flex URL
2501 \begin_layout Plain Layout
2503 http://www.tex.ac.uk/FAQ-overfull.html
2516 \begin_layout Standard
2518 you should check the respective lines,
2519 at least for the final version of your document.
2520 Your eyes will tell you if there's a problem with something that's too wide.
2524 \begin_layout Plain Layout
2525 You can also enable the `draft' option in
2526 \change_deleted -712698321 1674917458
2528 \begin_inset Flex Noun
2531 \begin_layout Plain Layout
2532 Document\SpecialChar menuseparator
2539 \change_inserted -712698321 1674917458
2542 Document\SpecialChar menuseparator
2548 and then \SpecialChar LaTeX
2549 will draw a black box in the margin of lines that are overfull.
2558 \begin_layout Itemize
2559 \begin_inset Flex Code
2562 \begin_layout Plain Layout
2571 \begin_inset Newline newline
2574 Not quite as common as its cousin.
2575 This happens again if \SpecialChar LaTeX
2576 does not find a reasonable break point and consequently generates too loose lines.
2577 As with the overfull lines,
2578 you should check if this is a visible problem.
2581 \begin_layout Itemize
2582 \begin_inset Flex Code
2585 \begin_layout Plain Layout
2594 \begin_inset Flex Code
2597 \begin_layout Plain Layout
2606 \begin_inset Newline newline
2609 Warnings about troubles breaking the page.
2611 just look at the output.
2612 Your eyes will tell you where something has gone wrong.
2615 \begin_layout Itemize
2616 \begin_inset Flex Code
2619 \begin_layout Plain Layout
2622 \begin_inset Quotes els
2626 \begin_inset Quotes ers
2635 \begin_inset Newline newline
2639 \begin_inset Quotes eld
2643 \begin_inset Quotes erd
2646 isn't installed on this system.
2647 This usually appears because some package your document needs isn't installed.
2648 If you didn't touch the preamble or didn't use the
2649 \begin_inset Flex Code
2652 \begin_layout Plain Layout
2661 then one of the packages \SpecialChar LyX
2662 tried to load is missing.
2664 \change_deleted -712698321 1674917468
2666 \begin_inset Flex Noun
2669 \begin_layout Plain Layout
2670 Help\SpecialChar menuseparator
2678 \change_inserted -712698321 1674917478
2681 Help\SpecialChar menuseparator
2686 to get a list of packages that \SpecialChar LyX
2688 This file is updated whenever you reconfigure \SpecialChar LyX
2690 \change_deleted -712698321 1674917484
2692 \begin_inset Flex Noun
2695 \begin_layout Plain Layout
2696 Tools\SpecialChar menuseparator
2703 \change_inserted -712698321 1674917484
2706 Tools\SpecialChar menuseparator
2711 ) and tells you which packages have been detected and what they do.
2712 \begin_inset Newline newline
2716 \begin_inset Flex Code
2719 \begin_layout Plain Layout
2727 command and the package in question isn't installed,
2728 then you'll need to install it yourself.
2731 \begin_layout Itemize
2732 \begin_inset Flex Code
2735 \begin_layout Plain Layout
2743 \begin_inset Newline newline
2746 Error messages beginning with this are trying to tell you that you specified a bad or undefined option to a package.
2747 Check the package's documentation.
2750 \begin_layout Itemize
2751 \begin_inset Flex Code
2754 \begin_layout Plain Layout
2755 Undefined control sequence
2761 \begin_inset Newline newline
2764 If you've inserted \SpecialChar LaTeX
2765 code into your document,
2767 you'll get one of these.
2768 You may have forgotten to load a package.
2770 this error message usually means that you used an undefined command.
2774 \begin_layout Standard
2775 There are other error and warning messages.
2776 Some are self-explanatory.
2777 These are usually \SpecialChar LaTeX
2779 Others are downright cryptic.
2780 These are usually \SpecialChar TeX
2786 what they mean or how to decipher them.
2790 \begin_layout Standard
2791 There's a general sequence you should follow if you get error messages:
2794 \begin_layout Enumerate
2795 Look at the \SpecialChar LaTeX
2796 code you inserted for typos.
2799 \begin_layout Enumerate
2800 If there are no typos,
2801 check that you used the command(s) correctly.
2804 \begin_layout Enumerate
2805 If you get a bunch of error boxes piled up at the very top of the document—
2806 and especially if you see a
2807 \begin_inset Quotes eld
2811 \begin_inset Flex Code
2814 \begin_layout Plain Layout
2823 \begin_inset Quotes erd
2827 it means that there are errors in the preamble.
2828 Start debugging your preamble.
2831 \begin_layout Enumerate
2832 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2833 code to the document,
2834 the first suspect is your \SpecialChar LaTeX
2835 distribution itself.
2836 Check for missing packages and install them.
2839 \begin_layout Enumerate
2841 so there are no missing packages.
2842 Did you use any of the fine-tuning options in \SpecialChar LyX
2850 like trying to manually insert lots of
2851 \begin_inset Flex Code
2854 \begin_layout Plain Layout
2856 \change_deleted 177693 1654669036
2858 \change_inserted 177693 1654669038
2862 \begin_inset space ~
2866 \change_deleted 177693 1654669040
2868 \change_inserted 177693 1654669041
2878 \begin_inset Flex Code
2881 \begin_layout Plain Layout
2889 \begin_inset Flex Code
2892 \begin_layout Plain Layout
2899 Did you try to kludge something together with these instead of using the appropriate paragraph environment?
2902 \begin_layout Enumerate
2904 you didn't use any of the fine-tuning options,
2905 you played by the rules.
2906 Did you try to pull a fancy maneuver?
2907 Did you do something funky inside a table or an equation,
2908 like inserting a graphic into a table cell?
2911 \begin_layout Enumerate
2912 Do you have long sections of text where \SpecialChar LaTeX
2913 cannot find a place to break a line?
2916 is rather strict about how much extra inter-word spacing it will add in order to break a line.
2918 you should rework the paragraph to avoid the problem.
2921 \begin_layout Enumerate
2922 Did you go overboard with the nesting?
2924 (currently) doesn't check to make sure you're in the limits for nesting environments.
2925 If you nested a bunch of environments to the
2926 \begin_inset Formula $17^{\mathrm{th}}$
2931 (The limit in \SpecialChar LaTeX
2935 \begin_layout Enumerate
2937 you didn't get any error messages,
2938 but your output looks awful.
2939 If you have a table or figure that's too wide or long for the page,
2944 \begin_layout Enumerate
2945 rescale the figure so it fits.
2948 \begin_layout Enumerate
2949 trim down the table so it fits.
2953 \begin_layout Enumerate
2954 If something else is wrong with the output,
2955 and you didn't try to pull anything fancy or kludge the fine-tuning options,
2956 we're not sure what's wrong.
2959 \begin_layout Standard
2960 If all this doesn't help—
2966 you might have found a bug in \SpecialChar LyX
2971 \begin_layout Chapter
2973 \change_inserted 564990737 1672345271
2977 \begin_layout Standard
2979 \change_inserted 564990737 1672345272
2986 originally offered four standard document classes,
2990 but individuals and organizations,
2991 most notably the American Mathematical Society in the early days,
2992 have made many contributions to extending the range of document classes.
2993 In this chapter we summarize the main externally maintained classes,
2994 some of which are marked “Unavailable:” in the pull-down
2997 \begin_inset space ~
3011 ocument\SpecialChar menuseparator
3016 ettings\SpecialChar menuseparator
3018 \begin_inset space ~
3023 dialog and which you will need to install as described in the
3025 Installing New Document Classes
3031 manual if you want to use them.
3035 \begin_layout Section
3037 \change_inserted 564990737 1670439533
3038 \begin_inset CommandInset label
3040 name "sec:Collections"
3047 \begin_layout Subsection
3049 \change_inserted 564990737 1672345298
3050 \begin_inset CommandInset label
3052 name "subsec:AMS-LaTeX-(American-Mathematical"
3056 AMS-\SpecialChar LaTeX
3057 (American Mathematical Society)
3060 \begin_layout Standard
3062 \change_inserted 564990737 1672345298
3063 The \SpecialChar LyX
3064 supported document classes
3072 are maintained by the Society;
3073 use of their features is described in the Math manual and on their website
3074 \begin_inset Flex URL
3077 \begin_layout Plain Layout
3079 \change_inserted 564990737 1672345298
3081 http://www.ams.org/publications/authors/tex/amslatex
3089 The following summary was originally provided by
3096 \change_inserted -712698321 1673082716
3098 \change_inserted 564990737 1672345298
3101 and the \SpecialChar LyX
3105 \change_deleted 564990737 1672345297
3108 AMS \SpecialChar LaTeX
3112 \begin_layout Standard
3114 \change_deleted 564990737 1672345297
3122 Richard Kimberly Heck
3127 \begin_layout Standard
3128 \begin_inset VSpace bigskip
3134 \begin_layout Standard
3136 The AMS \SpecialChar LaTeX
3137 layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
3138 The layouts are not tailored to a specific journal,
3140 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
3142 That documentation is available on the Web at
3143 \begin_inset Flex URL
3146 \begin_layout Plain Layout
3154 \begin_inset Flex URL
3157 \begin_layout Plain Layout
3159 ftp://ftp.ams.org/pub/tex/amslatex/
3165 These layouts are appropriate,
3167 for any mathematical writing.
3171 \begin_layout Standard
3173 \change_deleted -712698321 1673083001
3175 \change_inserted -712698321 1673083002
3178 basic AMS \SpecialChar LaTeX
3183 \begin_layout Itemize
3185 The standard AMS article format
3186 \change_inserted 564990737 1672345333
3190 File\SpecialChar menuseparator
3191 Open Example\SpecialChar menuseparator
3192 Articles\SpecialChar menuseparator
3193 American Mathematical Society (AMS)
3200 \begin_layout Itemize
3202 the standard AMS book (really,
3204 \change_inserted 564990737 1672345366
3208 File\SpecialChar menuseparator
3209 Open Example\SpecialChar menuseparator
3210 Books\SpecialChar menuseparator
3211 American Mathematical Society (AMS)
3216 \change_inserted 564990737 1672345369
3220 \begin_layout Itemize
3222 \change_inserted 564990737 1672345383
3224 the standard AMS proceedings format.
3227 \begin_layout Standard
3229 \change_inserted 564990737 1672345383
3231 only supports the first two natively;
3234 Installing New Document Classes
3240 manual if you want to use
3247 \begin_layout Standard
3248 The layouts themselves contain only the minimum necessary to use the AMS classes.
3251 contain any of the `theorem' environments used for setting theorems,
3254 These are contained,
3257 \change_deleted 564990737 1672345416
3259 \begin_inset Flex Code
3262 \begin_layout Plain Layout
3269 \change_inserted 564990737 1672345416
3277 which is loaded by default when you select one of the AMS classes.
3278 (It can also be used with other classes and can be removed,
3279 if you would rather use something else.) Less commonly used environments are in the
3280 \change_deleted 564990737 1672345436
3282 \begin_inset Flex Code
3285 \begin_layout Plain Layout
3286 Theorems (AMS-Extended)
3292 \change_inserted 564990737 1672345436
3295 AMS Theorems (Extended)
3300 which must be loaded manually.
3303 \begin_layout Standard
3305 theorems and the like are numbered consecutively throughout the document,
3306 but this may be modified by loading the module
3307 \change_deleted 564990737 1672345461
3309 \begin_inset Flex Code
3312 \begin_layout Plain Layout
3313 Theorems (Order by Section)
3319 \change_inserted 564990737 1672345461
3322 Standard Theorems (Numbered by Section)
3328 \begin_inset Flex Code
3331 \begin_layout Plain Layout
3339 \change_deleted 564990737 1672345479
3341 \begin_inset Flex Code
3344 \begin_layout Plain Layout
3345 Theorems (Order by Chapter)
3351 \change_inserted 564990737 1672345480
3354 Standard Theorems (Numbered by Chapter)
3359 These will number the results as
3360 \begin_inset Formula $n.m$
3364 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).
3365 Many environments are also available unnumbered.
3366 These are indicated by an asterisk at the end.
3367 If you happen to want
3373 \change_deleted 564990737 1672345498
3375 \begin_inset Flex Code
3378 \begin_layout Plain Layout
3385 \change_inserted 564990737 1672345498
3388 Standard Theorems (Unnumbered)
3392 provides that option.
3395 \begin_layout Standard
3396 Note that these modules do not
3400 to be used with the AMS classes.
3401 It is perfectly possible to use the
3402 \change_deleted 564990737 1672345520
3404 \begin_inset Flex Code
3407 \begin_layout Plain Layout
3414 \change_inserted 564990737 1672345520
3422 and the others mentioned,
3425 \begin_inset Flex Code
3428 \begin_layout Plain Layout
3430 \change_deleted -712698321 1673083855
3432 \change_inserted -712698321 1673083855
3433 Article (Standard Class)
3442 \begin_inset Flex Code
3445 \begin_layout Plain Layout
3447 \change_deleted -712698321 1673083858
3449 \change_inserted -712698321 1673083862
3450 Report (Standard Class)
3459 \begin_inset Flex Code
3462 \begin_layout Plain Layout
3464 \change_deleted -712698321 1673083819
3466 \change_inserted -712698321 1673083822
3478 \begin_layout Subsubsection
3479 What these layouts provide
3482 \begin_layout Standard
3483 There is a long list of included environments provided by these layouts.
3484 In AMS-\SpecialChar LaTeX
3488 an opportunity to define an unlimited variety of `theorem' environments.
3490 the AMS recommends the environments that are available in \SpecialChar LyX
3495 \begin_layout Standard
3496 The following environments—
3497 as well as the standard environments,
3499 \begin_inset Flex Noun
3502 \begin_layout Plain Layout
3510 \begin_inset Flex Noun
3513 \begin_layout Plain Layout
3521 \begin_inset Flex Noun
3524 \begin_layout Plain Layout
3532 \begin_inset Flex Noun
3535 \begin_layout Plain Layout
3543 \begin_inset Flex Noun
3546 \begin_layout Plain Layout
3554 \begin_inset Flex Code
3557 \begin_layout Plain Layout
3564 \begin_inset Flex Code
3567 \begin_layout Plain Layout
3576 \begin_layout Description
3577 Address This should be the author's permanent address.
3580 \begin_layout Description
3582 \begin_inset space ~
3585 Address This should be the author's temporary address at the time of submission,
3586 if different from the Address.
3589 \begin_layout Description
3590 Email Author's e-mail address
3593 \begin_layout Description
3594 URL Author's Web address,
3598 \begin_layout Description
3599 Keywords Key words or phrases used to identify specific topics discussed in the paper.
3602 \begin_layout Description
3603 Subjectclass These refer to the AMS Subject Classifications,
3604 published and described in
3606 Mathematical Reviews
3609 These are also available online at the AMS cites listed above.
3612 \begin_layout Description
3616 \begin_layout Description
3620 \begin_layout Description
3624 \begin_layout Standard
3625 The following environments are provided by both the
3626 \change_deleted 564990737 1672345566
3628 \begin_inset Flex Code
3631 \begin_layout Plain Layout
3638 \change_inserted 564990737 1672345566
3646 \change_deleted 564990737 1672345580
3648 \begin_inset Flex Code
3651 \begin_layout Plain Layout
3658 \change_inserted 564990737 1672345580
3666 in the latter case in both
3667 \change_deleted -712698321 1673084072
3671 \change_deleted -712698321 1673084073
3675 \change_deleted -712698321 1673084075
3679 \change_deleted -712698321 1673084077
3683 These same environments are provided only in the starred versions by the
3684 \change_deleted 564990737 1672345596
3686 \begin_inset Flex Code
3689 \begin_layout Plain Layout
3696 \change_inserted 564990737 1672345596
3700 \change_inserted -712698321 1673084060
3708 \begin_layout Theorem
3709 This is typically used for the statements of major results.
3713 \begin_layout Corollary*
3714 This is used for statements which follow fairly directly from previous statements.
3716 these can be major results.
3721 These are smaller results needed to prove other statements.
3724 \begin_layout Proposition
3725 These are less major results which (hopefully) add to the general theory being discussed.
3728 \begin_layout Conjecture
3729 These are statements provided without justification,
3730 which the author does not know how to prove,
3731 but which seem to be true (to the author,
3735 \begin_layout Definition*
3736 Guess what this is for.
3737 The font is different for this environment than for the previous ones.
3741 \begin_layout Example*
3742 Used for examples illustrating proven results.
3745 \begin_layout Problem
3746 It's not really known what this is for.
3747 You should figure it out.
3750 \begin_layout Exercise*
3751 Write a description for this one.
3754 \begin_layout Remark
3755 This environment is also a type of theorem,
3756 usually a lesser sort of observation.
3759 \begin_layout Claim*
3760 Often used in the course of giving a proof of a larger result.
3765 these are used to break up long arguments,
3766 using specific instances of some condition.
3771 The numbering scheme for cases is on its own,
3772 not together with other numbered statements.
3777 At the end of this environment,
3778 a QED symbol (usually a square,
3779 but it can vary with different styles) is placed.
3780 If you want to have other environments within this one—
3783 and have the QED symbol appear only after them,
3784 then the other environments need to be nested within the proof environment.
3787 Nesting Environments
3793 for information on nesting.
3798 \change_inserted 564990737 1672345651
3799 Used in a way similar to Proposition,
3800 though perhaps lower on the scale.
3803 \begin_layout Standard
3804 And these environments are provided by
3805 \change_deleted 564990737 1672345684
3807 \begin_inset Flex Code
3810 \begin_layout Plain Layout
3811 Theorems (AMS-Extended)
3817 \change_inserted 564990737 1672345689
3820 AMS Theorems (Extended
3827 \begin_layout Criterion*
3828 A required condition.
3831 \begin_layout Algorithm*
3832 A general procedure to be used.
3835 \begin_layout Axiom*
3836 This is a property or statement taken as true within the system being discussed.
3839 \begin_layout Condition*
3840 Sometimes used to state a condition assumed within the present context of discussion.
3844 Similar to a Remark.
3847 \begin_layout Notation*
3848 Used for the explanation of,
3853 \begin_layout Summary
3854 Do we really need to tell you?
3858 \begin_layout Standard
3860 \change_deleted -712698321 1675595089
3866 \begin_layout Conclusion*
3867 Sometimes used at the end of a long train of argument.
3868 \change_deleted 564990737 1672345729
3874 \change_deleted 564990737 1672345638
3875 Used in a way similar to Proposition,
3876 though perhaps lower on the scale.
3877 \change_inserted 564990737 1672345720
3881 \begin_layout Assumption*
3883 \change_inserted 564990737 1672345721
3887 \begin_layout Question*
3889 \change_inserted 564990737 1672345721
3893 \begin_layout Standard
3895 \change_inserted 564990737 1672345721
3896 There are ten more Maths modules available including several offering options ordered on
3898 (Numbered by Type \SpecialChar ldots
3906 \begin_layout Standard
3908 the AMS classes automatically provide the AMS \SpecialChar LaTeX
3909 and AMS fonts packages.
3910 They need to be available on your system in order to use these environments.
3913 \begin_layout Subsection
3915 \change_inserted 564990737 1671383236
3916 \begin_inset CommandInset label
3918 name "subsec:Extra-font-sizes"
3925 \begin_layout Standard
3927 \change_inserted 564990737 1671383236
3928 The “Extra font sizes” collection provides the document classes
3931 \begin_inset space \thinspace{}
3934 (with extra font sizes)
3940 \begin_inset space \thinspace{}
3943 (with extra font sizes)
3949 \begin_inset space \thinspace{}
3952 (with extra font sizes)
3957 \begin_inset space \thinspace{}
3960 (with extra font sizes)
3980 document classes respectively but offer the additional
3986 \begin_inset space ~
3999 ocument\SpecialChar menuseparator
4004 ettings\SpecialChar menuseparator
4010 \begin_layout Subsection
4012 \change_inserted 564990737 1671383236
4016 \begin_layout Standard
4018 \change_inserted 564990737 1671383236
4019 The document classes
4022 \begin_inset space \thinspace{}
4030 \begin_inset space \thinspace{}
4045 document classes to facilitate the use of Hebrew in \SpecialChar LyX
4049 \begin_layout Subsection
4051 \change_inserted 564990737 1671383236
4052 \begin_inset CommandInset label
4054 name "subsec:Japanese"
4059 \change_inserted -712698321 1675848645
4061 \change_inserted 564990737 1671383236
4065 \begin_layout Standard
4067 \change_inserted -712698321 1675848905
4069 included a collection of several bundles that aim to facilitate typesetting Japanese documents.
4070 The bundles have been developed at different times,
4071 they thus support different typesetting engines and features.
4072 This collection is the oldest one.
4073 It adjusts the \SpecialChar LaTeX
4074 standard classes to requirements of Japanese typesetting,
4075 for horizontal and vertical writing.
4076 The collection includes
4078 Japanese Article (Standard Class)
4084 \begin_inset space \thinspace{}
4087 (Standard Class Vertical Writing)
4093 \begin_inset space \thinspace{}
4102 \begin_inset space \thinspace{}
4105 (Standard Class Vertical Writing)
4111 \begin_inset space \thinspace{}
4114 (Japanese Standard Class)
4120 \begin_inset space \thinspace{}
4123 (Standard Class Vertical Writing).
4126 \begin_layout Subsection
4128 \change_inserted -712698321 1675848929
4129 \begin_inset CommandInset label
4131 name "subsec:Japanese-JS"
4135 Japanese (JS Bundle)
4140 \begin_layout Standard
4142 \change_inserted -712698321 1675849034
4143 This collection includes improved versions of the classes included in
4145 Japanese (Standard Classes)
4148 \begin_inset space ~
4152 \begin_inset CommandInset ref
4154 reference "subsec:Japanese"
4160 \change_deleted -712698321 1675849038
4161 The document classes
4162 \change_inserted -712698321 1673089024
4166 \change_deleted -712698321 1673089025
4168 \change_inserted -712698321 1673089025
4170 \change_inserted 564990737 1671383236
4172 \begin_inset space \thinspace{}
4176 \change_deleted -712698321 1673089027
4178 \change_inserted 564990737 1671383236
4180 \change_deleted -712698321 1675848222
4182 \change_inserted -712698321 1675848223
4184 \change_inserted 564990737 1671383236
4186 \change_deleted -712698321 1675849103
4191 \change_inserted 564990737 1671383236
4195 \change_deleted -712698321 1675849055
4197 \begin_inset space \thinspace{}
4200 (Japanese Standard Class Vertical Writing)
4206 \begin_inset space \thinspace{}
4209 (Japanese Standard Class)
4213 \change_inserted -712698321 1675849107
4217 \change_deleted -712698321 1673089053
4219 \change_inserted -712698321 1673089064
4221 \change_inserted 564990737 1671383236
4223 \begin_inset space \thinspace{}
4227 \change_deleted -712698321 1673089067
4229 \change_inserted 564990737 1671383236
4231 \change_deleted -712698321 1675849059
4233 \change_inserted -712698321 1675849059
4235 \change_inserted 564990737 1671383236
4237 \change_deleted -712698321 1675849095
4244 \begin_inset space \thinspace{}
4247 (Japanese Standard Class Vertical Writing)
4253 \begin_inset space \thinspace{}
4256 (Japanese Standard Class)
4262 \begin_inset space \thinspace{}
4265 (Japanese Vertical Writing)
4270 \begin_inset space \thinspace{}
4273 (Japanese Standard Class)
4275 provide document classes for the Japanese language
4276 \change_inserted 564990737 1671383236
4279 \change_inserted -712698321 1675849238
4280 A report class can be obtained by using
4283 \begin_inset space \thinspace{}
4294 Document\SpecialChar menuseparator
4295 Settings\SpecialChar menuseparator
4296 Document Class\SpecialChar menuseparator
4297 Class Options\SpecialChar menuseparator
4305 \begin_layout Subsection
4307 \change_inserted -712698321 1675848572
4308 \begin_inset CommandInset label
4310 name "subsec:Japanese-BX"
4314 Japanese (BX Bundle)
4317 \begin_layout Standard
4319 \change_inserted -712698321 1675851891
4320 This bundle contains the document classes
4323 \begin_inset space \thinspace{}
4332 \begin_inset space \thinspace{}
4341 \begin_inset space \thinspace{}
4346 which provide alternative document classes for Japanese documents.
4350 Japanese Slides (BX Bundle)
4352 for presentation slides,
4354 As opposed to the classes of the
4364 \begin_inset CommandInset ref
4366 reference "subsec:Japanese"
4371 \begin_inset CommandInset ref
4373 reference "subsec:Japanese-JS"
4378 which support only p\SpecialChar LaTeX
4379 and up\SpecialChar LaTeX
4381 the classes of this bundle also support pdf\SpecialChar LaTeX
4383 Xe\SpecialChar LaTeX
4384 and Lua\SpecialChar LaTeX
4386 with the aid of suitable packages that provide capability of Japanese typesetting.
4389 \begin_layout Subsection
4391 \change_inserted -712698321 1675850366
4392 \begin_inset CommandInset label
4394 name "subsec:Japanese-JLReq"
4398 Japanese (JLReq Class)
4401 \begin_layout Standard
4403 \change_inserted -712698321 1675850768
4404 This bundle draws on the
4408 class which faithfully traces the standard of
4410 Requirements for Japanese Text Layout
4412 set by the World Wide Web Consortium (W3C,
4414 \begin_inset Flex URL
4417 \begin_layout Plain Layout
4419 \change_inserted -712698321 1675850769
4421 https://www.w3.org/TR/jlreq/?lang=en
4429 It can be used with Lua\SpecialChar LaTeX
4430 as well as p\SpecialChar LaTeX
4431 and up\SpecialChar LaTeX
4435 \begin_layout Standard
4437 \change_inserted -712698321 1675850585
4438 LyX provides layouts for
4441 \begin_inset space \thinspace{}
4450 \begin_inset space \thinspace{}
4459 \begin_inset space \thinspace{}
4464 which are all derived from the
4469 class via specific class options.
4472 \begin_layout Standard
4474 \change_inserted -712698321 1675850701
4475 An example article document is available at
4477 File\SpecialChar menuseparator
4478 Open Example\SpecialChar menuseparator
4479 Articles\SpecialChar menuseparator
4480 Japanese Article (JLReq Class)
4483 English documentation is available at
4484 \begin_inset Flex URL
4487 \begin_layout Plain Layout
4489 \change_inserted -712698321 1675850350
4491 http://mirrors.ctan.org/macros/jptex/latex/jlreq/jlreq.pdf
4499 \change_inserted 564990737 1671383236
4503 \begin_layout Subsection
4505 \change_inserted 564990737 1672429136
4506 \begin_inset CommandInset label
4508 name "subsec:KOMA-Script"
4515 \begin_layout Standard
4517 \change_inserted 564990737 1672429136
4527 and the \SpecialChar LyX
4529 \change_deleted 564990737 1672429136
4533 \begin_layout Standard
4535 \change_deleted 564990737 1672429136
4543 \begin_layout Subsubsection
4545 \change_inserted 564990737 1672429161
4549 \begin_layout Standard
4551 \change_inserted 564990737 1672429162
4552 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
4553 it was formally launched with the addition of a letter class in 1994.
4555 a second letter class has been added.
4556 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.
4562 \begin_layout Standard
4563 The \SpecialChar LyX
4565 \change_deleted -712698321 1673089779
4568 article (koma-script)
4569 \change_inserted -712698321 1673089784
4576 \change_deleted -712698321 1673089790
4579 report (koma-script)
4580 \change_inserted -712698321 1673089794
4587 \change_deleted -712698321 1673089790
4595 \change_inserted -712698321 1673089771
4602 \change_inserted -712698321 1673089799
4606 \change_deleted -712698321 1673089802
4608 \change_inserted -712698321 1673089802
4612 \change_deleted -712698321 1673089811
4621 correspond to the \SpecialChar LaTeX
4643 \begin_inset space ~
4646 of the Koma-Script family.
4647 They are replacements for the standard document classes
4667 and fit better to European typography conventions in a number of points.
4670 \begin_layout Itemize
4672 \change_deleted 564990737 1672429262
4673 Standard character size is
4674 \change_inserted 564990737 1672429263
4675 The base character sizes when you select a KOMA-Script class are
4678 \change_deleted -712698321 1673089877
4681 article (koma-script)
4682 \change_inserted -712698321 1673089877
4689 \change_deleted -712698321 1673089886
4692 report (koma-script)
4693 \change_inserted -712698321 1673089886
4700 \change_deleted -712698321 1673089893
4704 \change_inserted -712698321 1673089893
4706 \change_deleted 564990737 1672429267
4713 \change_deleted -712698321 1673089903
4716 letter (koma-script)
4717 \change_inserted -712698321 1673089903
4725 \begin_layout Itemize
4727 labels of the description environment,
4728 and a number of elements of the
4729 \change_deleted -712698321 1673089925
4732 letter (koma-script)
4733 \change_inserted -712698321 1673089925
4738 document class are set in a bold sans serif font.
4742 \begin_layout Plain Layout
4743 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
4744 especially in the appearance of headings.
4746 the ec bold sans serif fonts look a bit thin.
4747 Here the \SpecialChar LaTeX
4756 helps to produce the
4757 \begin_inset Quotes eld
4761 \begin_inset Quotes erd
4764 appearance when using the ec fonts.
4769 The numbering of chapter headings is made in the same way as the numbering of section headings,
4770 that is without the extra line
4771 \begin_inset Quotes eld
4774 Chapter\SpecialChar ldots
4776 \begin_inset Quotes erd
4781 the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
4782 to be entered in the field
4785 \begin_inset space ~
4792 Layout\SpecialChar menuseparator
4799 \begin_layout Itemize
4801 \change_deleted 564990737 1672429310
4802 The main means in the Koma-Script document classes to design the type area are the options
4810 (in \SpecialChar LyX
4811 to be entered in the extra class options field in the dialog
4813 Document\SpecialChar menuseparator
4817 They make a clearer modification of page margins possible as do the options of the dialog
4819 Document\SpecialChar menuseparator
4824 \change_inserted 564990737 1672429310
4825 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.
4826 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.
4827 You can change the sizes of the margins by changing the factor by which the page is divided into strips;
4828 the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
4833 \begin_layout Standard
4835 \change_inserted 564990737 1672429310
4836 Whatever the factor,
4837 two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
4838 leaving a text area occupying around half the page.
4839 Since most two-sided documents have a binding,
4840 this can make the inner margins appear too narrow;
4841 so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
4845 \begin_layout Standard
4847 \change_inserted 564990737 1672429310
4848 The main means in the Koma-Script document classes to design the type area are the options
4858 Document\SpecialChar menuseparator
4859 Settings\SpecialChar menuseparator
4860 Document Class\SpecialChar menuseparator
4861 Class Options\SpecialChar menuseparator
4868 \begin_layout Standard
4870 \change_inserted 564990737 1672429310
4872 the binding correction is 7.5mm which is added in the form
4879 \begin_inset space ~
4882 options\SpecialChar menuseparator
4890 To change the factor to 11,
4896 to the comma separated list of entries in the
4907 \begin_inset space ~
4913 If you want the default value of this factor for a page size other than A4,
4921 \begin_layout Standard
4923 \change_inserted 564990737 1672429310
4924 To use the circle method of calculating the page layout,
4935 \begin_layout Itemize
4936 The \SpecialChar LaTeX
4937 document classes of the Koma-Script family define a number of additional commands.
4938 Those part of it which makes sense in \SpecialChar LyX
4939 is implemented in corresponding paragraph types.
4942 \begin_layout Standard
4943 Detailed descriptions of the \SpecialChar LaTeX
4944 document classes of the Koma-Script family can be found in the Koma-Script documentation
4955 \begin_layout Subsubsection
4957 \change_inserted 564990737 1672429358
4960 \begin_inset CommandInset label
4962 name "subsec:article-(KOMA-Script),-report"
4967 \change_deleted -712698321 1673090826
4970 article (KOMA-Script)
4971 \change_inserted -712698321 1673090826
4975 \change_inserted 564990737 1672429358
4980 \change_deleted -712698321 1673090830
4981 report (KOMA-Script)
4982 \change_inserted -712698321 1673090840
4986 \change_inserted 564990737 1672429358
4991 \change_deleted -712698321 1673090835
4993 \change_inserted -712698321 1673090844
4997 \change_deleted 564990737 1672429367
5000 article (koma-script),
5001 report (koma-script),
5002 and book (koma-script)
5007 \begin_layout Standard
5008 The document classes
5009 \change_deleted -712698321 1673090858
5012 article (koma-script)
5013 \change_inserted -712698321 1673090858
5020 \change_deleted -712698321 1673090862
5023 report (koma-script)
5024 \change_inserted -712698321 1673090869
5031 \change_deleted -712698321 1673090866
5039 \change_inserted -712698321 1673090874
5044 are implemented in the layout files
5060 They contain all the paragraph types of the corresponding standard document classes
5077 with the exception of the \SpecialChar LyX
5083 which is replaced by the new
5087 -type having the same functionality.
5092 -Type there is a number of new paragraph types added.
5099 letter (koma-script)
5104 \begin_layout Itemize
5127 additionally inserting an entry in the table of contents.
5136 are not contained in
5138 article (koma-script)
5143 \begin_layout Itemize
5164 additionally clearing running heads.
5171 article (koma-script)
5177 \begin_layout Plain Layout
5190 report (koma-script)
5193 but since this is identical to
5198 is has not been implemented in \SpecialChar LyX
5207 \begin_layout Itemize
5213 generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
5216 \begin_layout Itemize
5225 are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
5226 you might want to place table captions always above the table).
5227 You can also use the class option
5245 You need at least Koma-Script version 2.8q to use this.
5248 \begin_layout Itemize
5254 can be used to set a bonmot,
5256 \begin_inset space \thinspace{}
5260 \begin_inset space \space{}
5263 at the beginning of a chapter.
5264 If you use the optional argument (
5266 Insert\SpecialChar menuseparator
5268 \begin_inset space ~
5274 you can insert the dictum's author there.
5275 Dictum and author are separated by a line.
5276 You need at least Koma-Script version 2.8q to use this.
5283 article (koma-script)
5288 \begin_layout Standard
5289 The following types,
5290 together with the standard types
5305 form the title area of the document.
5306 They must be entered ahead of the first
5307 \begin_inset Quotes eld
5311 \begin_inset Quotes erd
5318 \begin_layout Plain Layout
5319 The corresponding \SpecialChar LaTeX
5320 commands must appear before the
5331 When such a type is used more than once,
5332 the latter usage overwrites the former one,
5334 for every type only the latest usage is valid.
5335 The order of the different types however has,
5351 no effect on the appearance of the produced document.
5354 \begin_layout Itemize
5360 produces a centered paragraph above the ordinary title (
5374 ) for the subject of the document.
5377 \begin_layout Itemize
5383 produces a centered paragraph below the ordinary title (
5397 ) for the publishers' name.
5400 \begin_layout Itemize
5408 report (koma-script)
5414 produces a centered paragraph on its own page behind the title page,
5417 article (koma-script)
5419 produces a centered paragraph below the ordinary title (
5441 \begin_layout Itemize
5447 produces a left aligned paragraph above the ordinary title (
5466 ) for a document`s head.
5469 \begin_layout Itemize
5475 produces in a double-sided print in
5477 report (koma-script)
5483 a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
5485 article (koma-script)
5490 \begin_layout Itemize
5496 produces in a double-sided print in
5498 report (koma-script)
5504 a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
5506 article (koma-script)
5511 \begin_layout Itemize
5518 \begin_inset Quotes eld
5522 \begin_inset Quotes erd
5525 page ahead of the actual document containing a paragraph without special formatting.
5528 \begin_layout Standard
5530 \change_inserted 564990737 1672429680
5531 KOMA-Script offers a wide range of
5538 \begin_inset space ~
5548 ocument\SpecialChar menuseparator
5553 ettings\SpecialChar menuseparator
5555 \begin_inset space ~
5560 dialog which you can apply to the whole document,
5564 \begin_layout Description
5566 \change_inserted 564990737 1672429680
5573 which produces a PDF with a small black box at the end any line in which a formatting error occurs;
5574 the default setting is
5579 \begin_layout Description
5581 \change_inserted 564990737 1672429680
5588 which may take the values
5602 the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
5605 \begin_layout Description
5607 \change_inserted 564990737 1672429680
5614 which may take the values
5628 the first leaves it up to KOMA-Script to add periods after chapter,
5631 the second forces the addition of periods and third suppresses them
5634 \begin_layout Standard
5636 \change_inserted 564990737 1672429680
5637 and the math options:
5640 \begin_layout Description
5642 \change_inserted 564990737 1672429680
5649 which causes equations to be numbered on the left rather than on the right,
5653 \begin_layout Description
5655 \change_inserted 564990737 1672429680
5662 which causes equations to be left justified rather than centered.
5665 \begin_layout Standard
5667 \change_inserted 564990737 1672429680
5668 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
5669 commands and packages;
5671 if you want your captions in bold add
5674 \begin_layout Standard
5676 \change_inserted 564990737 1672429680
5681 setkomafont{captionlabel}{
5686 \begin_layout Standard
5688 \change_inserted 564990737 1672429680
5694 ocument\SpecialChar menuseparator
5701 \SpecialChar menuseparator
5706 \begin_inset space ~
5711 ) and the problem is solved.
5714 \begin_layout Standard
5716 \change_inserted 564990737 1672429680
5717 If you are writing a book,
5718 it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
5719 If you use the Chapter* environment,
5720 your Foreword and Preface will not appear in the Table of Contents;
5721 to make them to appear in the Table of contents,
5722 you need to use Chapter environments and add the \SpecialChar TeX
5726 \begin_layout Standard
5728 \change_inserted 564990737 1672429680
5736 \begin_layout Standard
5738 \change_inserted 564990737 1672429680
5739 at the very start of the book (not in the \SpecialChar LaTeX
5743 \begin_layout Standard
5745 \change_inserted 564990737 1672429680
5753 \begin_layout Standard
5755 \change_inserted 564990737 1672429680
5756 before the first chapter of the body of the text.
5758 \change_inserted -712698321 1673092640
5767 \begin_layout Standard
5769 \change_inserted 564990737 1672429680
5770 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
5775 \begin_layout Plain Layout
5777 \change_inserted 564990737 1672429680
5778 Appendices are normally “numbered” with letters.
5783 If you use the Chapter* environment,
5784 they will not appear in the Table of Contents;
5785 so add the \SpecialChar TeX
5789 \begin_layout Standard
5791 \change_inserted 564990737 1672429680
5799 \begin_layout Standard
5801 \change_inserted 564990737 1672429682
5802 before the first of these headings and use the Chapter environment.
5803 These commands will have no effect on the numbering in \SpecialChar LyX
5805 only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
5808 \begin_layout Standard
5809 The layout files for the document classes
5811 article (koma-script)
5816 report (koma-script)
5828 This is thought of as a place to define your own types.
5833 in your personal layout directory and edit the file!
5834 \change_deleted 564990737 1672430255
5838 \begin_layout Standard
5840 \change_deleted 564990737 1672430255
5841 letter (koma-script)
5844 \begin_layout Description
5846 \change_deleted 564990737 1672429749
5848 This section discusses the obsolete
5850 KOMA-Script-Letter (v.
5851 \begin_inset space ~
5857 which is not even included anymore in recent KOMA releases.
5858 Please refer to the next section for the current KOMA-Script-Letter class (v.
5859 \begin_inset space ~
5865 \begin_layout Standard
5868 \change_deleted 564990737 1672429749
5871 letter (koma-script)
5873 is implemented in the layout file
5878 It contains all the paragraph types of the corresponding standard document class
5884 with the exception of the \SpecialChar LyX
5899 which is replaced by the new
5906 in contrast to the standard document class,
5929 there are a number of new letter specific types.
5932 \begin_layout Standard
5934 \change_deleted 564990737 1672429749
5935 The appearance of the letter produced by this document class can be controlled by a number of \SpecialChar LaTeX
5937 which you can put in the \SpecialChar LaTeX
5942 \begin_layout Plain Layout
5944 the standard appearance of the letter`s heading,
5945 consisting of name and address,
5946 is quite self-willed.
5948 \begin_inset Quotes eld
5952 \begin_inset Quotes erd
5955 heading is produced by the following \SpecialChar LaTeX
5956 commands in the preamble:
5959 \begin_layout LyX-Code
5969 \begin_layout LyX-Code
5985 \begin_layout LyX-Code
5995 \begin_layout LyX-Code
6015 A detailed German description of such \SpecialChar LaTeX
6016 commands can be found in the Koma-Script documentation
6022 the letter's author can produce his personal letter layout.
6025 \begin_layout Standard
6027 \change_deleted 564990737 1672429749
6036 define the beginning of the letter and must be used in every letter.
6037 To emphasize them in the \SpecialChar LyX
6039 they are marked with the letter
6049 \begin_inset space ~
6053 It is possible to write any number of letters in one file.
6058 type produces a new letter using the same addressee and a
6062 type produces a new addressee.
6082 are ordinary paragraph types and can also be used several times in one and the same letter.
6085 \begin_layout Itemize
6087 \change_deleted 564990737 1672429749
6093 produces a paragraph for the addressee and implicitly defines the beginning of the letter.
6096 \begin_layout Itemize
6098 \change_deleted 564990737 1672429749
6104 produces a paragraph for the form of address and implicitly produces a new letter.
6107 \begin_layout Itemize
6109 \change_deleted 564990737 1672429749
6115 produces a paragraph for a close.
6118 \begin_layout Itemize
6120 \change_deleted 564990737 1672429749
6126 produces a paragraph for a postscript.
6129 \begin_layout Itemize
6131 \change_deleted 564990737 1672429749
6137 produces a paragraph for a distribution list.
6140 \begin_layout Itemize
6142 \change_deleted 564990737 1672429749
6148 produces a paragraph for enclosures.
6151 \begin_layout Standard
6153 \change_deleted 564990737 1672429749
6203 are input types provided with a label to enter information,
6204 which will be processed by the document class.
6208 \begin_layout Plain Layout
6209 It could be seen as a matter of inconsequence,
6218 described above are not such input types as well.
6219 Because of the special meaning of those types,
6221 I have implemented them as ordinary paragraph types with a one letter mark in the left margin.
6223 it would affect my feeling of symmetry,
6232 type had such a serious different appearance.
6237 The types must be used ahead of the corresponding
6244 \begin_layout Standard
6246 \change_deleted 564990737 1672429749
6247 An implementation of these types in a WYSIWYG fashion does not seem to make sense,
6248 because the real appearance of the produced letter does not only depend on the usage of the particular type,
6249 but also on other factors.
6251 a signature entered in the
6255 type will in the standard behavior appear in the produced letter only,
6256 when in the same letter also a
6261 The entered value of the
6265 type will in the standard behavior not appear in the produced letter at all.
6266 The possibility to design the letter`s heading freely is already indicated in a footnote above.
6269 \begin_layout Standard
6271 \change_deleted 564990737 1672429749
6272 The input types can also be used as empty paragraphs.
6274 \begin_inset space \thinspace{}
6278 \begin_inset space \space{}
6290 type is not used at all,
6291 in the standard behavior the value of the
6295 type is used as signature,
6301 no signature value is defined.
6304 \begin_layout Standard
6306 \change_deleted 564990737 1672429749
6307 By using the input types it is possible to write a letter template,
6308 containing filled input types with your personal dates (name,
6310 etc.) and empty input types for other dates you want to enter.
6313 \begin_layout Itemize
6315 \change_deleted 564990737 1672429749
6322 in the standard behavior appears as a centered paragraph in small caps in the letter`s heading.
6325 \begin_layout Itemize
6327 \change_deleted 564990737 1672429749
6334 in the standard behavior appears below the
6348 type appears instead.
6351 \begin_layout Itemize
6353 \change_deleted 564990737 1672429749
6360 in the standard behavior appears in a centered paragraph in the letter`s heading below the sender's name.
6363 \begin_layout Itemize
6365 \change_deleted 564990737 1672429749
6371 sender's telephone number,
6372 in the standard behavior only sets the \SpecialChar LaTeX
6382 \begin_layout Itemize
6384 \change_deleted 564990737 1672429749
6390 place of the letter`s making.
6393 \begin_layout Itemize
6395 \change_deleted 564990737 1672429749
6401 date of the letter`s making.
6411 in the standard behavior,
6412 produce the place and the date in a right-aligned line below the addressee's field.
6418 neither place nor date appear,
6419 independent of the value of the
6429 the date of the letter `s production is used.
6432 \begin_layout Itemize
6434 \change_deleted 564990737 1672429749
6440 sender`s back address,
6441 in the standard behavior appears above the addressee's field in a small sans serif font.
6444 \begin_layout Itemize
6446 \change_deleted 564990737 1672429749
6452 special mail information,
6453 in the standard behavior appears underlined above the addressee's field below the back address.
6456 \begin_layout Itemize
6458 \change_deleted 564990737 1672429749
6464 additional information,
6465 in the standard behavior appears on right side below the addressee`s field.
6468 \begin_layout Itemize
6470 \change_deleted 564990737 1672429749
6477 in the standard behavior appears in a big,
6479 sans serif font above the subject.
6482 \begin_layout Itemize
6484 \change_deleted 564990737 1672429749
6490 the letter's subject,
6491 in the standard behavior appears in a bold font above the
6498 \begin_layout Standard
6500 \change_deleted 564990737 1672429749
6525 produce a business letter like line above the
6529 line containing the fields
6530 \begin_inset Quotes eld
6534 \begin_inset Quotes erd
6539 \begin_inset Quotes eld
6543 \begin_inset Quotes erd
6548 \begin_inset Quotes eld
6552 \begin_inset Quotes erd
6557 \begin_inset Quotes eld
6561 \begin_inset Quotes erd
6566 \begin_inset Quotes eld
6570 \begin_inset Quotes erd
6575 \begin_inset Quotes eld
6579 \begin_inset Quotes erd
6590 \begin_inset Quotes eld
6593 business letter types
6594 \begin_inset Quotes erd
6602 type however does not appear,
6603 but only the \SpecialChar LaTeX
6611 The ordinary output of place and date in a right-aligned line below the addressee`s field is suppressed.
6612 The types are implemented as input types provided with a label and must be used ahead of the corresponding
6619 \begin_layout Itemize
6621 \change_deleted 564990737 1672429749
6630 \begin_layout Itemize
6632 \change_deleted 564990737 1672429749
6641 \begin_layout Itemize
6643 \change_deleted 564990737 1672429749
6652 \begin_layout Itemize
6654 \change_deleted 564990737 1672429749
6663 \begin_layout Itemize
6665 \change_deleted 564990737 1672429749
6676 \begin_layout Subsubsection
6678 \change_deleted 564990737 1672429773
6679 The new letter class:
6680 letter (koma-script v.2)
6681 \change_inserted 564990737 1672429774
6683 \begin_inset CommandInset label
6685 name "subsec:The-new-letter"
6689 The new letter class:
6691 \change_inserted -712698321 1673092709
6693 \change_deleted -712698321 1673092710
6695 \change_inserted -712698321 1673092710
6697 \change_inserted 564990737 1672429774
6699 \change_deleted -712698321 1673092713
6701 \change_inserted -712698321 1673092714
6703 \change_inserted 564990737 1672429774
6706 \change_inserted -712698321 1673092715
6708 \change_inserted 564990737 1672429774
6714 \begin_layout Standard
6720 \begin_layout Standard
6721 \begin_inset VSpace medskip
6727 \begin_layout Standard
6729 Koma-Script version 2.8 has introduced a new letter class
6733 which supersedes the now unsupported
6739 on the \SpecialChar LaTeX
6741 a completely new interface and is not compatible with the old class.
6745 though it is recommended you use the new class.
6748 \begin_layout Standard
6749 This class covers the same functionality as
6751 letter (koma-script),
6759 (receiver's address,
6779 will start a new letter (i.
6780 \begin_inset space \thinspace{}
6784 \begin_inset space \space{}
6787 you can write several letters per document).
6788 New elements are sender's
6807 and the possibility to use a
6813 Insert\SpecialChar menuseparator
6819 \begin_layout Standard
6820 The biggest improvement is,
6822 that the letter's layout is configurable to meet almost any needs.
6823 This can be done via the preamble or with a special style file (Letter Class Option,
6829 that will be read in as a class option.
6833 \begin_layout Plain Layout
6834 The KOMA package comes with some default
6845 file that follows german typesetting rules,
6850 that provides the default layout of the old
6855 The latter can be loaded with the class option
6862 Layout\SpecialChar menuseparator
6863 Document\SpecialChar menuseparator
6872 \change_deleted 564990737 1671617922
6880 \change_deleted 564990737 1671617938
6881 that is included in \SpecialChar LyX
6883 \change_inserted 564990737 1671617997
6889 ile\SpecialChar menuseparator
6891 \begin_inset space ~
6899 \begin_inset space ~
6902 Template\SpecialChar menuseparator
6903 Letters\SpecialChar menuseparator
6904 KOMA-Script Letter (V.2)
6909 A detailed description is to be found in the Koma-Script documentation (
6916 \begin_layout Subsubsection
6920 \begin_layout Standard
6921 Visualizing the Koma-Script document classes in \SpecialChar LyX
6923 the \SpecialChar LyX
6924 internals cause some problems.
6927 \begin_layout Itemize
6928 The chapter number of a
6932 type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
6933 The cause for that is the \SpecialChar LyX
6934 internal behavior for the labeltype
6941 \begin_layout Itemize
6942 The headings of the types
6951 \begin_inset Quotes eld
6955 \begin_inset Quotes erd
6960 but not in the \SpecialChar LyX
6963 Document\SpecialChar menuseparator
6965 \begin_inset space ~
6969 \begin_inset space ~
6977 \begin_layout Itemize
6982 document class appear in a skip separation mode,
6984 This is the standard behavior,
6985 no special \SpecialChar LaTeX
6986 commands are needed for that.
6989 Document\SpecialChar menuseparator
6992 dialog the corresponding radio button indicates
7001 value always has the effect that extra \SpecialChar LaTeX
7002 commands are inserted in the document to produce the gap,
7003 which is not what is wanted in this case.
7006 \begin_layout Subsection
7008 \change_inserted 564990737 1672743555
7009 \begin_inset CommandInset label
7011 name "subsec:Polish-M.W.collection"
7016 \begin_inset space \thinspace{}
7020 \begin_inset space \space{}
7024 \change_deleted 564990737 1670924933
7026 book (mwbk) and report (mwrep)
7027 \begin_inset Argument status
7030 \begin_layout Plain Layout
7045 \begin_layout Standard
7051 \begin_layout Standard
7052 The \SpecialChar LyX
7054 \change_deleted -712698321 1673094342
7058 \change_inserted -712698321 1673094343
7059 Polish Article (MW Bundle)
7065 \change_deleted -712698321 1673094349
7069 \change_inserted -712698321 1673094356
7070 Polish Report (MW Bundle)
7075 \change_deleted -712698321 1673094352
7083 \change_inserted -712698321 1673094359
7084 Polish Book (MW Bundle)
7088 correspond to the \SpecialChar LaTeX
7104 They are replacements for the standard document classes
7119 and fit better to Polish typography conventions in a number of points.
7123 \begin_layout Standard
7127 \begin_layout Itemize
7128 Unnumbered titles (with star,
7130 \begin_inset space \thinspace{}
7134 \begin_inset space \space{}
7141 ) are added into table of contents,
7144 \begin_layout Itemize
7145 Additional page styles:
7149 \begin_layout Description
7150 uheadings header with separated lines,
7153 \begin_layout Description
7154 myheadings custom header,
7155 contents headers via commands:
7171 \begin_layout Description
7172 myuheadings custom header with separated lines,
7175 \begin_layout Description
7176 outer page number is placed on outer side of page
7180 \begin_layout Itemize
7185 \begin_layout Description
7186 rmheadings serif titles —
7190 \begin_layout Description
7191 sfheadings sansserif titles,
7194 \begin_layout Description
7195 authortitle on title page first placed is author next title —
7199 \begin_layout Description
7200 titleauthor on title page first placed is title next author,
7203 \begin_layout Description
7204 withmarginpar reserve place on page for margins.
7208 \begin_layout Subsection
7210 \change_inserted 564990737 1672652245
7214 \begin_layout Standard
7216 \change_inserted 564990737 1672652245
7217 The document classes
7218 \change_deleted -712698321 1673094404
7222 \begin_inset space \thinspace{}
7226 \change_inserted -712698321 1673094404
7228 \change_inserted 564990737 1672652245
7232 \change_deleted -712698321 1673094408
7236 \begin_inset space \thinspace{}
7240 \change_inserted -712698321 1673094411
7242 \change_inserted 564990737 1672652245
7254 Detailed information about these document classes can be found in
7256 File\SpecialChar menuseparator
7257 Open Example\SpecialChar menuseparator
7258 Books\SpecialChar menuseparator
7263 File\SpecialChar menuseparator
7264 Open Example\SpecialChar menuseparator
7265 Handouts\SpecialChar menuseparator
7271 \begin_layout Section
7273 \change_inserted 564990737 1670439534
7277 \begin_layout Standard
7279 \change_inserted 564990737 1670794710
7280 See also the document classes in the Collections (section
7281 \begin_inset space ~
7285 \begin_inset CommandInset ref
7287 reference "sec:Collections"
7295 \begin_layout Subsection
7297 \change_deleted -712698321 1673095198
7299 \change_inserted -712698321 1673095198
7300 Astronomy & Astrophysics
7301 \change_inserted 564990737 1670794716
7305 \begin_layout Standard
7307 \change_inserted 564990737 1670794716
7313 updated by the \SpecialChar LyX
7317 \begin_layout Subsubsection
7319 \change_inserted 564990737 1670794716
7323 \begin_layout Standard
7325 \change_inserted 564990737 1670794716
7326 This section describes how \SpecialChar LyX
7327 can be used to write articles for submission to the scientific journal
7330 \change_deleted -712698321 1673095254
7332 \change_inserted -712698321 1673095254
7334 \change_inserted 564990737 1670794716
7338 \begin_inset CommandInset href
7341 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
7346 ) using Version 9.1 of the document class
7351 information about it is available at
7352 \begin_inset Flex URL
7355 \begin_layout Plain Layout
7357 \change_inserted 564990737 1670794716
7359 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
7369 \begin_layout Standard
7371 \change_inserted 564990737 1670794716
7372 A manual comes together with the package and should be consulted before installing this document class as described in the
7374 Installing New Document Classe
7384 \begin_layout Standard
7386 \change_inserted 564990737 1670794716
7387 \begin_inset Note Greyedout
7390 \begin_layout Plain Layout
7392 \change_inserted 564990737 1670794716
7393 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
7395 That change also involved some slight changes to the style files,
7396 namely the removal of the thesaurus command.
7397 If you have an older version installed,
7399 For information about compatibility with the old (version 4) layout,
7400 please refer to the comments in
7403 Dir/layouts/aapaper.layout
7413 \begin_layout Subsubsection
7415 \change_inserted 564990737 1670794716
7419 \begin_layout Standard
7421 \change_inserted 564990737 1671617129
7422 It is recommended you start from the template in the menu
7427 ile\SpecialChar menuseparator
7429 \begin_inset space ~
7437 \begin_inset space ~
7440 Template\SpecialChar menuseparator
7441 Articles\SpecialChar menuseparator
7442 Astronomy & Astrophysics
7445 If you are not using the template,
7446 note the following settings:
7449 \begin_layout Itemize
7451 \change_inserted 564990737 1670794716
7453 \change_deleted -712698321 1673095619
7457 \change_inserted -712698321 1673095619
7458 Astronomy & Astrophysics
7459 \change_inserted 564990737 1670794716
7467 ocument\SpecialChar menuseparator
7472 ettings\SpecialChar menuseparator
7474 \begin_inset space ~
7480 that one was obvious).
7483 \begin_layout Itemize
7485 \change_inserted 564990737 1670794716
7489 \begin_inset space ~
7501 \begin_inset space ~
7512 The whole layout is done by the macros,
7513 you shouldn't change anything.
7516 \begin_layout Subsubsection
7518 \change_inserted 564990737 1670794716
7522 \begin_layout Standard
7524 \change_inserted 564990737 1670794716
7525 First thing to enter is the header information.
7527 \change_deleted -712698321 1673167006
7529 \change_inserted -712698321 1673167007
7531 \change_inserted 564990737 1670794716
7533 of which one is optional.
7537 \begin_layout Itemize
7539 \change_inserted 564990737 1670794716
7548 \begin_layout Itemize
7550 \change_inserted 564990737 1670794716
7559 \begin_layout Itemize
7561 \change_inserted 564990737 1670794716
7570 \begin_layout Itemize
7572 \change_deleted -712698321 1673167065
7576 \change_inserted -712698321 1673167065
7578 \change_inserted 564990737 1670794716
7583 \change_inserted -712698321 1673167087
7587 \begin_layout Itemize
7589 \change_inserted -712698321 1673168577
7595 Determines to whom correspondence and reprints are to be sent.
7598 \begin_layout Itemize
7600 \change_inserted -712698321 1673168590
7605 [optional] Snail mail address for contacts.
7606 \change_inserted 564990737 1670794716
7610 \begin_layout Itemize
7612 \change_inserted 564990737 1670794716
7626 \begin_layout Standard
7628 \change_inserted -712698321 1673168612
7629 There is no need to issue the
7636 this is done automatically by \SpecialChar LyX
7637 when the header is finished.
7639 \change_inserted 564990737 1670794716
7640 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
7641 just to get the best optics and meets the layout of the real document.
7644 \begin_layout Standard
7646 \change_inserted 564990737 1670794716
7647 If you want to place footnotes in the header block,
7649 \begin_inset space \thinspace{}
7653 \begin_inset space \space{}
7656 to state your present address,
7657 just use the standard footnote via the menu
7662 nsert\SpecialChar menuseparator
7671 will automagically use the term
7678 \change_inserted -712698321 1673168649
7682 \begin_layout Standard
7684 \change_inserted -712698321 1673168649
7687 Edit\SpecialChar menuseparator
7691 you'll find two insets which are relevant for the titling:
7694 \begin_layout Itemize
7696 \change_inserted -712698321 1673168649
7703 to mark corresponding author\SpecialChar breakableslash
7705 The institutes are numbered sequentially as they appear in the
7710 so you have to put a marker to each author.
7713 \begin_layout Itemize
7715 \change_inserted -712698321 1673168649
7720 to supply an email address for fast contact.
7721 \change_inserted 564990737 1670794716
7725 \begin_layout Standard
7727 \change_inserted 564990737 1670794716
7728 In addition to these topics,
7729 the macros use three additional \SpecialChar LaTeX
7730 commands that have no counterpart in \SpecialChar LyX
7734 \begin_layout Itemize
7736 \change_inserted 564990737 1670794716
7743 to separate different names for more than one author and institute,
7747 \begin_layout Itemize
7749 \change_deleted -712698321 1673168671
7756 to mark corresponding author/institute pairs.
7757 The institutes are numbered sequentially as they appear in the
7762 so you have to put a marker to each author.
7765 \begin_layout Itemize
7767 \change_deleted -712698321 1673168671
7774 to supply an email address for fast contact.
7775 \change_inserted 564990737 1670794716
7779 \begin_layout Standard
7781 \change_deleted -712698321 1673168684
7784 \change_inserted -712698321 1673168684
7786 \change_inserted 564990737 1671642374
7787 he appropriate command has to be entered as \SpecialChar TeX
7788 code in \SpecialChar LyX
7790 See the examples in the template and in
7792 File\SpecialChar menuseparator
7793 Open Example\SpecialChar menuseparator
7794 Articles\SpecialChar menuseparator
7795 Astronomy & Astrophysics
7802 \begin_layout Subsubsection
7804 \change_inserted 564990737 1670794716
7808 \begin_layout Standard
7810 \change_inserted -712698321 1673168754
7811 The abstract should immediately follow the header block.
7812 With version 5 the abstract environment was changed to a command,
7813 and there is now a restriction to only one paragraph.
7815 it should contain an entry with the keywords.
7816 This is done via the paragraph style
7821 Refer to the example paper.
7822 \change_deleted -712698321 1673168754
7823 The abstract should immediately follow the header block and must contain five tokens:
7833 \begin_layout Enumerate
7835 \change_deleted -712698321 1673168754
7840 (optional) {} leave it empty if necessary
7843 \begin_layout Enumerate
7845 \change_deleted -712698321 1673168754
7853 \begin_layout Enumerate
7855 \change_deleted -712698321 1673168754
7863 \begin_layout Enumerate
7865 \change_deleted -712698321 1673168754
7873 \begin_layout Enumerate
7875 \change_deleted -712698321 1673168754
7880 (optional) {} leave it empty if necessary
7883 \begin_layout Standard
7885 \change_deleted -712698321 1673168754
7887 This structure not shown in
7892 \change_inserted 564990737 1670794716
7896 \begin_layout Subsubsection
7898 \change_inserted 564990737 1670794716
7899 Supported environments
7902 \begin_layout Standard
7904 \change_inserted 564990737 1670794716
7905 The A&A paper layout supports the following environments for structuring your text:
7908 \begin_layout Standard
7910 \change_inserted -712698321 1673169058
7913 \begin_inset Flex Multiple Columns
7916 \begin_layout Itemize
7918 \change_inserted -712698321 1673169058
7924 \begin_layout Itemize
7926 \change_inserted -712698321 1673169058
7932 \begin_layout Itemize
7934 \change_inserted -712698321 1673169058
7940 \begin_layout Itemize
7942 \change_inserted -712698321 1673169058
7948 \begin_layout Itemize
7950 \change_inserted -712698321 1673169058
7956 \begin_layout Itemize
7958 \change_inserted -712698321 1673169058
7964 \begin_layout Itemize
7966 \change_inserted -712698321 1673169058
7972 \begin_layout Itemize
7974 \change_inserted -712698321 1673169058
7980 \begin_layout Itemize
7982 \change_inserted -712698321 1673169058
7988 \begin_layout Itemize
7990 \change_inserted -712698321 1673169058
7996 \begin_layout Itemize
7998 \change_inserted -712698321 1673169058
8004 \begin_layout Itemize
8006 \change_inserted -712698321 1673169078
8015 \change_deleted -712698321 1673169058
8019 \begin_layout Itemize
8021 \change_deleted -712698321 1673169058
8027 \begin_layout Itemize
8029 \change_deleted -712698321 1673169058
8035 \begin_layout Itemize
8037 \change_deleted -712698321 1673169058
8043 \begin_layout Itemize
8045 \change_deleted -712698321 1673169058
8051 \begin_layout Itemize
8053 \change_deleted -712698321 1673169058
8059 \begin_layout Itemize
8061 \change_deleted -712698321 1673169058
8067 \begin_layout Itemize
8069 \change_deleted -712698321 1673169058
8075 \begin_layout Itemize
8077 \change_deleted -712698321 1673169058
8083 \begin_layout Itemize
8085 \change_deleted -712698321 1673169058
8091 \begin_layout Itemize
8093 \change_deleted -712698321 1673169058
8099 \begin_layout Itemize
8101 \change_deleted -712698321 1673169058
8106 \change_inserted 564990737 1670794716
8110 \begin_layout Subsubsection
8112 \change_inserted 564990737 1670794716
8113 Commands not supported by \SpecialChar LyX
8117 \begin_layout Standard
8119 \change_inserted 564990737 1670794716
8120 Some commands are not yet supported by the
8121 \change_deleted -712698321 1673169117
8125 \change_inserted -712698321 1673169117
8126 Astronomy & Astrophysics
8127 \change_inserted 564990737 1670794716
8130 layout for \SpecialChar LyX
8132 Some have already been mentioned.
8133 For the sake of completeness,
8134 they are listed all together here:
8137 \begin_layout Itemize
8139 \change_inserted 564990737 1670794716
8147 \begin_layout Itemize
8149 \change_inserted -712698321 1673168793
8157 \begin_layout Itemize
8159 \change_inserted -712698321 1673168793
8167 \begin_layout Itemize
8169 \change_inserted -712698321 1673168793
8175 \change_deleted -712698321 1673168793
8181 \begin_layout Itemize
8183 \change_deleted -712698321 1673168793
8191 \begin_layout Itemize
8193 \change_deleted -712698321 1673168793
8201 \begin_layout Itemize
8203 \change_deleted -712698321 1673168793
8209 \change_inserted 564990737 1670794716
8213 \begin_layout Standard
8215 \change_inserted 564990737 1670794716
8216 If you want to use any of these commands,
8217 you have to enter them yourself.
8218 Do not forget to use
8224 nsert\SpecialChar menuseparator
8227 \begin_inset space ~
8235 \begin_layout Subsubsection
8237 \change_inserted 564990737 1670794716
8238 Figure and Table Floats
8241 \begin_layout Standard
8243 \change_inserted 564990737 1670794716
8245 provides support for the necessary float environments
8256 therefore we won't tell much about it here.
8260 \begin_inset space ~
8266 Just remember that tables should be left-aligned.
8268 select the table and change the alignment in
8273 dit\SpecialChar menuseparator
8279 \begin_inset space ~
8283 \change_inserted -712698321 1673169201
8289 arg "layout-paragraph"
8293 \change_inserted 564990737 1670794716
8299 \begin_layout Standard
8301 \change_inserted 564990737 1670794716
8302 There is only one special thing:
8303 the figures with a caption beside the figure.
8304 To create such a figure,
8305 you have to do the following:
8308 \begin_layout Enumerate
8310 \change_inserted 564990737 1670794716
8311 Create a wide figure float:
8317 nsert\SpecialChar menuseparator
8322 t\SpecialChar menuseparator
8327 from within the float,
8333 dit\SpecialChar menuseparator
8339 \begin_inset space ~
8350 \begin_inset space ~
8362 \begin_layout Enumerate
8364 \change_inserted 564990737 1670794716
8365 Enter your caption text.
8368 \begin_layout Enumerate
8370 \change_inserted 564990737 1670794716
8375 to move the cursor above the caption.
8378 \begin_layout Enumerate
8380 \change_inserted 564990737 1670794716
8384 \begin_layout Enumerate
8386 \change_inserted 564990737 1670794716
8387 Position the cursor after the figure and insert a horizontal fill by using the menu:
8393 nsert\SpecialChar menuseparator
8398 rmatting\SpecialChar menuseparator
8404 \begin_inset space ~
8413 dialog and select the
8425 \change_deleted -712698321 1673169720
8427 \change_inserted -712698321 1673169724
8429 \change_inserted 564990737 1670794716
8433 \begin_layout Enumerate
8435 \change_inserted 564990737 1670794716
8436 Switch to \SpecialChar LaTeX
8441 \begin_inset space ~
8449 \begin_layout Enumerate
8451 \change_inserted 564990737 1670794716
8460 Do not close the brace!
8463 \begin_layout Enumerate
8465 \change_inserted 564990737 1670794716
8466 Position the cursor behind the caption text,
8467 switch to \SpecialChar LaTeX
8468 mode and insert the closing brace:
8472 \begin_inset space ~
8484 \begin_layout Standard
8486 \change_inserted 564990737 1671642458
8488 refer to the figures in the file in
8490 File\SpecialChar menuseparator
8491 Open Example\SpecialChar menuseparator
8492 Articles\SpecialChar menuseparator
8493 Astronomy & Astrophysics
8498 \begin_layout Subsubsection
8500 \change_inserted 564990737 1670794716
8504 \begin_layout Standard
8506 \change_inserted 564990737 1670794716
8508 the paper has to be formatted in a special double-spacing layout.
8510 you have to add the option
8521 \begin_inset space ~
8531 ocument\SpecialChar menuseparator
8536 ettings\SpecialChar menuseparator
8538 \begin_inset space ~
8547 \begin_layout Subsubsection
8549 \change_inserted 564990737 1670794716
8553 \begin_layout Standard
8555 \change_inserted 564990737 1671642520
8558 File\SpecialChar menuseparator
8559 Open Example\SpecialChar menuseparator
8560 Articles\SpecialChar menuseparator
8561 Astronomy & Astrophysics
8563 was written with \SpecialChar LyX
8565 It is the example paper from the original macro package,
8571 \begin_inset CommandInset href
8574 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
8580 but translated to \SpecialChar LyX
8581 using the older unstructured abstract type.
8582 Use it for inspiration,
8583 and compare the \SpecialChar LaTeX
8588 with the \SpecialChar LyX
8592 \begin_layout Subsection
8597 \begin_layout Standard
8603 \begin_layout Subsubsection
8607 \begin_layout Standard
8609 is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
8610 the Astrophysical Journal (including the Letters and Supplement),
8611 the Astronomical Journal,
8612 and the Publications of the Astronomical Society of the Pacific.
8614 has proven to be an excellent tool for generating these documents,
8615 especially given its equation,
8617 and figure handling capabilities.
8619 requires version 5.0 (or higher) of these macros;
8621 which is the version described here,
8623 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8624 2.09 and are fundamentally incompatible with \SpecialChar LyX
8626 The AAS\SpecialChar TeX
8627 package may be downloaded from the AAS\SpecialChar TeX
8631 \begin_layout Standard
8632 \begin_inset VSpace medskip
8638 \begin_layout Standard
8640 \begin_inset Flex URL
8643 \begin_layout Plain Layout
8645 https://aas.org/aastex/aastex-downloads
8653 \begin_layout Standard
8654 \begin_inset VSpace medskip
8660 \begin_layout Standard
8661 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
8664 will not reduce the need to figure out all the AAS\SpecialChar TeX
8666 it will only reduce the drudgery of typing everything in.
8667 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8668 document conforms completely to the requirements of the journal to which you are submitting your paper.
8671 \begin_layout Subsubsection
8672 Starting a New Paper
8675 \begin_layout Standard
8676 I strongly suggest that you start with the AAS\SpecialChar TeX
8680 File\SpecialChar menuseparator
8686 \change_inserted 564990737 1671617265
8687 \SpecialChar menuseparator
8688 Articles\SpecialChar menuseparator
8689 American Astronomical Society
8690 \change_deleted 564990737 1671617310
8694 enter the new file name,
8702 This will show the most common fields found in a manuscript.
8703 Simply overwrite the existing text (including the brackets,
8708 ) with the correct information.
8709 Many of the AAS\SpecialChar TeX
8710 commands and environments can be implemented directly in \SpecialChar LyX
8713 For commands such as these,
8714 the \SpecialChar LaTeX
8715 code must be entered directly and marked as such.
8716 Such commands are referred to as \SpecialChar TeX
8719 I tried to minimize the amount of \SpecialChar TeX
8720 code needed in an AAS\SpecialChar TeX
8724 \begin_layout Subsubsection
8725 Finishing Your Paper
8728 \begin_layout Standard
8729 When the paper is finished to your satisfaction and previews/prints correctly,
8731 \begin_inset Quotes eld
8735 \begin_inset Quotes erd
8738 actions which need to be done before you submit it to the journals.
8742 \begin_layout Enumerate
8743 Export your paper as a \SpecialChar LaTeX
8746 File\SpecialChar menuseparator
8747 Export\SpecialChar menuseparator
8755 \begin_layout Enumerate
8760 file with your favorite text editor
8764 \begin_layout Enumerate
8765 remove the comment lines before the
8774 \begin_layout Enumerate
8779 usepackage...{fontenc}
8781 line if it appears (usually just after
8797 \begin_layout Enumerate
8798 remove everything between (and including) the
8811 except for any commands you specifically put into the \SpecialChar LaTeX
8812 preamble (which should appear immediately after the
8813 \begin_inset Quotes eld
8816 User specified \SpecialChar LaTeX
8818 \begin_inset Quotes erd
8829 \begin_layout Enumerate
8830 Run the resulting file through \SpecialChar LaTeX
8831 to make sure it still processes correctly.
8834 \begin_layout Enumerate
8835 Reread the journal requirements to make sure your filenames and formats are correct.
8838 \begin_layout Enumerate
8842 \begin_layout Subsubsection
8843 Comments On Specific Commands
8846 \begin_layout Standard
8847 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8849 the AAS\SpecialChar TeX
8854 ) gives a good description of each.
8855 Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
8856 So let's begin \SpecialChar ldots
8860 \begin_layout Paragraph
8861 Things that work as expected
8864 \begin_layout Standard
8865 Because they work as you might expect,
8866 I simply list them and the section they are found in:
8983 begin{thebibliography}
8993 all the cite commands and their variations (2.13.2),
8994 the generic graphicx figure commands (2.14.1),
9023 amongst other places),
9054 \begin_layout Standard
9055 The following style options also work correctly:
9081 Simply put them in the
9087 Layout\SpecialChar menuseparator
9093 \begin_layout Paragraph
9095 but require more comment
9098 \begin_layout Standard
9099 The following items work,
9100 but require a little more discussion:
9103 \begin_layout Itemize
9104 These items are reserved for use by the journal editors,
9105 but you can put them into the \SpecialChar LaTeX
9106 preamble if you feel compelled to do so:
9144 \begin_layout Itemize
9145 These items may be placed in the \SpecialChar LaTeX
9147 and are included as blanks in the template file:
9171 \begin_layout Itemize
9178 (2.3) – can only be used
9179 \begin_inset Quotes eld
9183 \begin_inset Quotes erd
9187 not in the middle of a paragraph.
9188 Use \SpecialChar TeX
9189 code if you need to embed it.
9192 \begin_layout Itemize
9199 (2.3) – will have extra {} after it.
9200 This should not cause an error.
9203 \begin_layout Itemize
9210 (2.6) – can only be used
9211 \begin_inset Quotes eld
9215 \begin_inset Quotes erd
9219 not in the middle of a paragraph.
9220 Use \SpecialChar TeX
9221 code if you need to embed it.
9224 \begin_layout Itemize
9231 (2.8) – can't insert a cross-reference tag,
9232 you must type the tag name by hand
9235 \begin_layout Itemize
9249 \begin_layout Itemize
9256 (2.9) – will have extra {} after it.
9257 This should not cause an error.
9260 \begin_layout Itemize
9267 (2.11) – will have extra {} after it.
9268 This should not cause an error.
9271 \begin_layout Itemize
9278 (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
9280 Insert\SpecialChar menuseparator
9285 \begin_inset Quotes eld
9289 \begin_inset Quotes erd
9292 inserts an optional argument of the type needed by
9299 Hopefully it will be renamed someday.
9302 \begin_layout Itemize
9315 for the catalog ID optional parameter
9318 \begin_layout Itemize
9331 for the catalog ID optional parameter
9334 \begin_layout Paragraph
9335 Things not implemented,
9336 use \SpecialChar TeX
9340 \begin_layout Standard
9352 setcounter{equation}
9355 Journal name abbreviations (2.13.4),
9398 insert it as the first element in the lefthand cell after where you want it.
9399 Don't use any of \SpecialChar LyX
9400 's rules in the table),
9475 \begin_layout Paragraph
9476 Things that cannot be implemented
9479 \begin_layout Standard
9481 at least in any meaningful sort of way,
9482 so I suggest ignoring them.
9483 They are the references environment (2.13.3),
9484 and the deluxetable environment (2.15).
9486 really need to use deluxetable,
9487 I suggest editing it in a separate file with a text editor,
9490 Insert\SpecialChar menuseparator
9492 \begin_inset space ~
9497 to include it in your \SpecialChar LyX
9500 \change_deleted 564990737 1671642564
9506 \change_inserted 564990737 1671642618
9509 File\SpecialChar menuseparator
9510 Open Example\SpecialChar menuseparator
9511 Articles\SpecialChar menuseparator
9512 American Astronomical Society
9517 \change_inserted 564990737 1671642621
9523 \begin_layout Subsubsection
9527 and Other Ruminations
9530 \begin_layout Paragraph
9531 Getting \SpecialChar LyX
9532 and AAS\SpecialChar TeX
9536 \begin_layout Standard
9537 It can be a bit tricky to get \SpecialChar LyX
9538 to recognize a new layout and document class.
9539 When all else fails,
9543 \begin_layout Enumerate
9544 Make certain that \SpecialChar LaTeX
9545 can find AAS\SpecialChar TeX
9547 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9548 distribution into a directory completely unrelated to \SpecialChar LaTeX
9549 or AAS\SpecialChar TeX
9550 and run \SpecialChar LaTeX
9558 \begin_layout Enumerate
9563 appears in \SpecialChar LyX
9571 \begin_layout Enumerate
9574 Tools\SpecialChar menuseparator
9579 then restart \SpecialChar LyX
9583 \begin_layout Enumerate
9584 Open a regular new file,
9585 not from a template.
9587 \change_deleted -712698321 1673170671
9590 \change_inserted -712698321 1673170671
9593 American Astronomical Society (AASTeX V.
9594 \begin_inset space \thinspace{}
9601 appear in the class list in
9603 Document\SpecialChar menuseparator
9609 \begin_layout Standard
9610 If you get a warning from an existing AAS\SpecialChar TeX
9611 document about not being able to find the AAS\SpecialChar TeX
9612 layout or a message about
9613 \begin_inset Quotes eld
9616 You should not mix title layouts with normal ones
9617 \begin_inset Quotes erd
9621 things haven't been installed correctly.
9624 \begin_layout Paragraph
9626 error processing a table
9629 \begin_layout Standard
9633 attempts to center the table caption/title.
9634 This seems to produce a bad interaction in AAS\SpecialChar TeX
9635 so you should click somewhere in the caption/title,
9638 Edit\SpecialChar menuseparator
9640 \begin_inset space ~
9655 This took care of it for me.
9658 \begin_layout Paragraph
9662 \begin_layout Standard
9665 \change_inserted -712698321 1673170733
9669 \begin_layout Enumerate
9671 \change_deleted -712698321 1673170736
9674 I have noticed some funny spacing in the reference entries in the text.
9675 When you enter the bibliography item data,
9680 space between the last author and the parenthesis setting off the year;
9684 \begin_inset space \thinspace{}
9688 \begin_inset space \space{}
9704 \change_deleted -712698321 1673170741
9706 \change_inserted -712698321 1673170741
9710 \begin_layout Enumerate
9711 Entering the references at all is not obvious.
9712 The easiest thing is to start typing your first reference at the end of the document,
9713 then mark it as type
9718 That will put a small gray box in front of what you just typed.
9719 Click on the box to fill in the rest of the information.
9721 go to the end of an existing reference and press return.
9722 That will create a new line with its own box,
9726 \begin_layout Paragraph
9730 \begin_layout Standard
9731 Even though AAS\SpecialChar TeX
9732 provides its own figure commands (
9740 I much prefer \SpecialChar LaTeX
9741 's standard figure commands (with the default graphicx).
9750 \begin_inset space ~
9753 commands as \SpecialChar TeX
9754 code into a Figure Float box if you desire,
9755 but I never have much luck getting the layout right.
9756 With the standard graphics,
9762 usepackage{graphicx}
9764 command into the \SpecialChar LaTeX
9765 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9767 interspersing the figures in the text.
9768 I believe ApJ accepts figures exactly this way now;
9769 AJ might still use the
9770 \begin_inset Quotes eld
9773 stack everything at the end
9774 \begin_inset Quotes erd
9780 \begin_layout Paragraph
9781 Things I could have done,
9785 \begin_layout Standard
9787 \begin_inset Quotes eld
9791 \begin_inset Quotes erd
9794 things I could have implemented,
9797 I saw no point in double-spacing the text in the \SpecialChar LyX
9799 even though it is double-spaced in the paper manuscript.
9801 I chose not to make separate layouts for the preprint and preprint2 styles.
9802 Since I assume you will spend most of your time in the plain manuscript mode anyway,
9803 I decided not to chew up more disk space with this.
9807 \begin_layout Subsubsection
9811 \begin_layout Standard
9812 Your mileage may vary.
9813 I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
9815 the last 2% was the \SpecialChar LaTeX
9816 post-processing and a few cleanups.
9817 I have had no trouble with the submission process,
9818 and I'm sure the journals were never aware that there might be a difference.
9820 go forth and publish!
9823 \begin_layout Subsection
9825 \change_inserted 564990737 1671442131
9829 \begin_layout Standard
9831 \change_inserted 564990737 1671642768
9833 \change_deleted -712698321 1673171415
9837 \begin_inset space \thinspace{}
9841 \change_inserted 564990737 1671642768
9843 \change_deleted -712698321 1673171417
9845 \change_inserted 564990737 1671642768
9849 \change_deleted -712698321 1673171421
9855 \change_inserted -712698321 1673171424
9857 \change_inserted 564990737 1671642768
9858 document class together with the
9859 \change_deleted -712698321 1673171428
9861 \change_inserted -712698321 1673171429
9863 \change_inserted 564990737 1671642768
9867 \change_deleted -712698321 1673171431
9869 \change_inserted 564990737 1671642768
9872 to facilitate the description of chess games.
9875 File\SpecialChar menuseparator
9876 Open Example\SpecialChar menuseparator
9877 Articles\SpecialChar menuseparator
9891 \begin_layout Subsection
9893 \change_inserted 564990737 1671042028
9897 \begin_layout Standard
9899 \change_inserted 564990737 1671617396
9901 \change_deleted -712698321 1673171640
9905 \begin_inset space \thinspace{}
9909 \change_inserted 564990737 1671617396
9911 \change_deleted -712698321 1673171643
9913 \change_inserted 564990737 1671617396
9917 \change_inserted -712698321 1673171717
9919 \change_inserted 564990737 1671617396
9923 \change_deleted -712698321 1673171720
9925 \change_inserted 564990737 1671617396
9929 \change_deleted -712698321 1673171728
9931 \change_inserted -712698321 1673171728
9934 \change_inserted 564990737 1671617396
9936 \change_inserted -712698321 1673171744
9937 for journals in the Elsevier publishing house
9938 \change_inserted 564990737 1671617396
9940 This provides the following additional environments:
9944 \begin_inset space ~
9953 \begin_inset space ~
9962 \begin_inset space ~
9983 \change_inserted -712698321 1673172045
9987 \begin_layout Standard
9989 \change_inserted 564990737 1671617396
9990 A template is available in the menu
9995 ile\SpecialChar menuseparator
9997 \begin_inset space ~
10005 \begin_inset space ~
10008 Template\SpecialChar menuseparator
10009 Articles\SpecialChar menuseparator
10013 It has been customized with further environments and contains all the information you may need.
10015 the documentation is also available from
10016 \begin_inset CommandInset href
10019 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
10027 \begin_layout Subsection
10029 \change_inserted 564990737 1671042046
10033 \begin_layout Standard
10035 \change_inserted 564990737 1671042046
10037 \change_deleted -712698321 1673172423
10041 \begin_inset space \thinspace{}
10045 \change_inserted -712698321 1673172423
10046 Paper (Standard Class)
10047 \change_deleted -712698321 1673172423
10049 \change_inserted 564990737 1671042046
10052 provides an alternative to the
10053 \change_deleted -712698321 1673172092
10057 \change_inserted -712698321 1673172435
10060 Article (Standard Class)
10061 \change_inserted 564990737 1671042046
10065 It provides similar functionality,
10066 but you might prefer this layout with sans serif sections,
10071 \begin_layout Subsection
10072 Rev\SpecialChar TeX
10076 \begin_layout Standard
10082 \begin_layout Standard
10083 \begin_inset VSpace bigskip
10089 \begin_layout Standard
10094 \change_deleted -712698321 1673172482
10096 \begin_inset space ~
10100 \change_inserted -712698321 1673172487
10102 \begin_inset space \thinspace{}
10109 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
10111 \begin_inset Formula $\beta$
10118 \begin_layout Standard
10123 \change_deleted -712698321 1673172511
10125 \change_inserted -712698321 1673172517
10131 which works with Rev\SpecialChar TeX
10134 v3.1 is basically obsolete,
10135 as it works with \SpecialChar LaTeX
10137 That means that it doesn't interact very well with \SpecialChar LyX
10139 which requires \SpecialChar LaTeX2e
10141 although it has been kludged to work.
10142 Since Rev\SpecialChar TeX
10143 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
10147 \change_deleted -712698321 1673172538
10150 Rev\SpecialChar TeX
10152 \begin_inset space ~
10156 \change_inserted -712698321 1673172538
10158 \begin_inset space ~
10162 \begin_inset space \thinspace{}
10169 textclass should also be pretty easy to use.
10172 \begin_layout Standard
10173 These documents are supposed to be used in
10177 to the Rev\SpecialChar TeX
10179 so we don't describe any of the special Rev\SpecialChar TeX
10181 and assume you'll know what to put in the preamble if necessary.
10184 \begin_layout Subsubsection
10188 \begin_layout Standard
10189 All you need to do is install Rev\SpecialChar TeX
10191 as described in the package's README file.
10192 The package can be found at The Rev\SpecialChar TeX
10194 \begin_inset Flex URL
10197 \begin_layout Plain Layout
10199 http://publish.aps.org/revtex4/
10205 Install it somewhere that \SpecialChar LaTeX
10207 Test it by trying to \SpecialChar LaTeX
10208 a short Rev\SpecialChar TeX
10209 4 document in some random directory (i.
10210 \begin_inset space \thinspace{}
10214 \begin_inset space \space{}
10217 not the directory where you installed the class file.) Then,
10218 if you reconfigure \SpecialChar LyX
10220 it will find the class file and let you use the Rev\SpecialChar TeX
10224 \begin_layout Standard
10225 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
10234 \begin_inset space ~
10241 \change_deleted -712698321 1673172641
10242 the templates directory
10243 \change_inserted -712698321 1673172687
10246 File\SpecialChar menuseparator
10247 New From Templates\SpecialChar menuseparator
10255 \begin_layout Subsubsection
10259 \begin_layout Standard
10260 Optional arguments to
10268 \begin_inset Quotes eld
10272 \begin_inset Quotes erd
10276 \begin_inset Quotes eld
10280 \begin_inset Quotes erd
10287 \begin_inset space ~
10295 \begin_inset space ~
10302 Remember that in Rev\SpecialChar TeX
10304 at least one optional argument is required!
10308 \begin_layout Standard
10309 Other preamble matter,
10317 \begin_inset space ~
10324 \begin_inset space ~
10333 \begin_layout Subsubsection
10337 \begin_layout Standard
10338 The layouts basically correspond to the commands in Rev\SpecialChar TeX
10341 the Email layout corresponds to
10348 Note that (at least as of Rev\SpecialChar TeX
10358 layouts are exactly equivalent,
10359 so you shouldn't need to use both.
10363 \begin_layout Plain Layout
10364 In case you're curious,
10365 both were included so that
10369 would be able to translate both
10389 \begin_layout Subsubsection
10393 \begin_layout Standard
10394 There are a couple of important unique aspects of Rev\SpecialChar TeX
10395 4 which might cause bugs that will be even more confusing in \SpecialChar LyX
10399 \begin_layout Standard
10400 In Rev\SpecialChar TeX
10419 The \SpecialChar LyX
10420 equivalent is that there is a separate Thanks layout.
10425 write footnotes in the
10430 or weird things may happen.
10431 See the Rev\SpecialChar TeX
10432 4 documentation for more details.
10435 \begin_layout Standard
10440 \begin_inset space ~
10449 \begin_inset space ~
10459 layouts must be placed
10467 layout and the corresponding
10485 the \SpecialChar LaTeX
10489 \begin_layout Subsection
10491 \change_inserted 564990737 1671042072
10495 \begin_layout Standard
10497 \change_inserted 564990737 1671042072
10502 classes were replaced
10503 \change_deleted -712698321 1673176131
10505 \change_inserted 564990737 1671042072
10506 with a completely new
10507 \change_deleted -712698321 1673175919
10513 This package provides a \SpecialChar LaTeX
10514 class and templates for books to be published at Springer Gabler Research,
10515 Springer Vieweg Research,
10516 Springer Spektrum Research,
10517 Springer VS Research,
10518 or Springer VS Forschung.
10519 The documentation is available in German from
10520 \begin_inset CommandInset href
10523 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
10530 \change_inserted -712698321 1673176125
10537 Please find information at
10538 \begin_inset Flex URL
10541 \begin_layout Plain Layout
10543 \change_inserted -712698321 1673176047
10545 https://www.springernature.com/gp/authors/campaigns/latex-author-support
10553 Native \SpecialChar LyX
10554 support is not available yet.
10555 \change_inserted 564990737 1671042072
10559 \begin_layout Section
10561 \change_inserted 564990737 1670439560
10565 \begin_layout Standard
10567 \change_inserted 564990737 1670439581
10568 See also the document classes in the Collections (section
10569 \begin_inset space ~
10573 \begin_inset CommandInset ref
10575 reference "sec:Collections"
10583 \begin_layout Subsection
10587 \begin_layout Standard
10593 \begin_layout Subsubsection
10597 \begin_layout Standard
10598 Memoir is a very powerful and constantly evolving class.
10599 It has been designed with regard to fictional and non-fictional literature.
10600 Its aim is to let the user have maximum control over the typesetting of his document.
10601 Memoir is based on the standard book class,
10602 but it can also emulate the article class (see below).
10605 \begin_layout Standard
10607 the developer of Memoir,
10608 is known as the author of lots of useful packages in the \SpecialChar LaTeX
10610 Most of them have been merged with Memoir.
10612 it is much easier to layout the table of contents,
10614 chapter designs and such.
10618 does not support all of these goodies natively.
10619 Some of them might be added to forthcoming releases
10623 \begin_layout Plain Layout
10624 You are invited to send suggestions to
10625 \begin_inset Flex URL
10628 \begin_layout Plain Layout
10630 lyx-devel@lists.lyx.org
10641 lots will probably never be supported,
10642 due to the limitations of \SpecialChar LyX
10644 Of course you can still use all features with the help of some native \SpecialChar LaTeX
10645 commands (\SpecialChar TeX
10650 \begin_layout Plain Layout
10655 \begin_layout Plain Layout
10665 \begin_inset space ~
10669 \begin_inset CommandInset ref
10671 reference "sec:Inserting-TeX-Code"
10683 we can only list those features that are natively supported by \SpecialChar LyX
10685 For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
10689 \begin_layout Plain Layout
10694 \begin_layout Plain Layout
10704 \begin_inset Flex URL
10707 \begin_layout Plain Layout
10709 CTAN:/macros/latex/memoir/memman.pdf
10720 which is not only a user guide for the class,
10721 but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
10724 \begin_layout Subsubsection
10725 Basic features and restrictions
10728 \begin_layout Standard
10729 Memoir supports basically all features of the standard book classes.
10736 \begin_layout Description
10738 \begin_inset space ~
10742 Memoir has a broader range of font sizes:
10751 \begin_layout Description
10753 \begin_inset space ~
10757 The fancy page style is not supported,
10758 due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
10759 which confuses \SpecialChar LaTeX
10762 Memoir comes with a number of its own page styles (see
10764 Document\SpecialChar menuseparator
10765 Settings\SpecialChar menuseparator
10767 \begin_inset space ~
10773 If you want to use these for the chapter pages,
10774 you have to use the command
10780 in the main text or in preamble (e.
10781 \begin_inset space \thinspace{}
10785 \begin_inset space \space{}
10792 chapterstyle{companion}
10797 \begin_layout Description
10799 Sectionings (chapter,
10801 subsection etc.) come with an optional argument in the standard classes.
10803 you can specify an alternative version of the title for the table of contents and the headers (for instance,
10804 if the title is too long).
10805 In \SpecialChar LyX
10807 you can do this via
10809 Insert\SpecialChar menuseparator
10811 \begin_inset space ~
10816 at the beginning of a chapter/section.
10817 Memoir features a second optional argument and thus separates the table of contents from the header.
10818 You can define three variants of a title with this:
10819 one for the main text,
10820 one for the table of contents,
10821 and one for the headers.
10823 makes these available in form of specific
10834 \begin_layout Description
10836 In the standard classes (and in many other classes),
10837 the table of contents,
10838 the list of figures and the list of table start a new page automatically.
10839 Memoir does not follow this route.
10840 You have to insert a page break yourself,
10841 if you want to have one.
10844 \begin_layout Description
10846 For some unknown reason,
10847 Memoir uses pagination on the title page (in the standard classes,
10849 \begin_inset Quotes eld
10853 \begin_inset Quotes erd
10857 If you want an empty title page,
10862 aliaspagestyle{title}{empty}
10867 \begin_layout Description
10869 With the class option
10875 Document\SpecialChar menuseparator
10876 Settings\SpecialChar menuseparator
10877 Class Settings\SpecialChar menuseparator
10879 \begin_inset space ~
10885 you can emulate article style.
10887 counters (footnotes,
10889 tables etc.) will not be reset on new chapters,
10890 chapters don't start a new page (but are—
10892 \begin_inset Quotes eld
10896 \begin_inset Quotes erd
10903 use their own page,
10907 \begin_layout Description
10910 Memoir does not allow the use of the deprecated font commands,
10911 which have been used in the old \SpecialChar LaTeX
10913 \begin_inset space \thinspace{}
10917 \begin_inset space \space{}
10934 It produces an error and stops \SpecialChar LaTeX
10935 whenever such a command appears.
10940 reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
10942 Since a lot of packages and particularly Bib\SpecialChar TeX
10943 style files are still using those commands,
10944 we have decided to use this option by default.
10947 \begin_layout Subsubsection
10951 \begin_layout Standard
10952 We will only describe the features supported by \SpecialChar LyX
10953 (which is not much currently).
10954 Please consult the Memoir manual
10958 \begin_layout Plain Layout
10963 \begin_layout Plain Layout
10973 \begin_inset Flex URL
10976 \begin_layout Plain Layout
10978 CTAN:/macros/latex/memoir/memman.pdf
10991 \begin_layout Description
10993 You may wonder why an abstract is an extra feature.
10995 it is in book class.
10996 Usually books don't have abstracts.
11000 You can use it wherever and how often you like.
11003 \begin_layout Description
11005 You may know this older typesetting style:
11006 The contents of a chapter are summarized below the title and also in the table of contents (e.
11007 \begin_inset space \thinspace{}
11011 \begin_inset space \space{}
11016 Our hero arrives in Troia;
11017 he loses some friends;
11021 Chapterprecis does exactly this.
11022 It is therefore only sensible below a chapter.
11025 \begin_layout Description
11027 An epigraph is a smart slogan or motto at the beginning of a chapter.
11028 The epigraph environment provides an elegant way of typesetting such a motto.
11029 The motto itself (text) and its (optional) author (source) are divided by a short line.
11030 The author (source) can be inserted via
11032 Insert\SpecialChar menuseparator
11039 \begin_layout Description
11041 Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
11043 can only support a few of them.
11045 which is a centered title for poems,
11046 which will also be added to the table of contents (verse is the standard environment for poems.
11047 Memoir has some enhanced versions of verse,
11048 but you need to use \SpecialChar TeX
11050 because they have to be nested inside regular verse environments,
11051 which is not possible with \SpecialChar LyX
11055 \begin_layout Description
11058 but it adds no entry to the table of contents.
11061 \begin_layout Subsection
11063 \change_inserted 564990737 1671442175
11067 \begin_layout Standard
11069 \change_inserted 564990737 1671442175
11073 \change_inserted -712698321 1673182264
11075 \change_inserted 564990737 1671442175
11077 \change_deleted -712698321 1673182266
11081 \change_inserted 564990737 1671442175
11085 \change_deleted -712698321 1673182282
11089 \begin_inset space \thinspace{}
11093 \change_inserted 564990737 1671442175
11095 \change_inserted -712698321 1673182287
11097 \change_deleted -712698321 1673182290
11099 \change_inserted 564990737 1671442175
11102 document class but adds two environments:
11105 \begin_layout Description
11107 \change_inserted 564990737 1671442175
11108 Recipe a numbered section environment at the
11112 level which generates a bold centered heading above a double horizontal rule
11115 \begin_layout Description
11117 \change_inserted 564990737 1671442175
11128 are what are being described and the environment ends with a horizontal rule.
11131 \begin_layout Standard
11133 \change_inserted 564990737 1671642866
11136 File\SpecialChar menuseparator
11137 Open Example\SpecialChar menuseparator
11138 Books\SpecialChar menuseparator
11141 illustrates its use.
11144 \begin_layout Standard
11146 \change_deleted -712698321 1673186391
11148 \change_inserted -712698321 1673186393
11150 \change_inserted 564990737 1671442175
11151 is designed for typesetting one or two recipes per page
11152 \change_deleted -712698321 1673199172
11154 with dimensions of 5.5
11155 \begin_inset Quotes qrd
11159 \begin_inset Quotes qrd
11163 \change_inserted 564990737 1671442175
11165 The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient
11166 \change_inserted -712698321 1673186486
11168 \change_deleted -712698321 1673186487
11171 \change_inserted 564990737 1671442175
11173 \change_deleted -712698321 1673199346
11174 and the pages can be joined together or printed 2 per page to normal letterpaper easily.
11175 The size was chosen to work in half-page 3-ring binder cover sheets,
11176 because un-laminated paper just doesn't last in the kitchen.
11179 \begin_layout Standard
11181 \change_deleted -712698321 1673199346
11182 The half-letter pages can be printed two per page using your printer driver,
11183 or bound together using
11185 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
11195 is the compiled version of your recipes.
11196 \change_inserted -712698321 1673175424
11200 \begin_layout Section
11202 \change_inserted 564990737 1671442207
11204 \change_deleted -712698321 1673186818
11206 \change_inserted -712698321 1673186818
11208 \change_inserted 564990737 1671442207
11212 \begin_layout Subsection
11214 \change_inserted 564990737 1671442208
11216 \change_inserted -712698321 1673187876
11218 \change_inserted 564990737 1671442208
11222 \begin_layout Standard
11224 \change_inserted 564990737 1671642942
11226 \change_deleted -712698321 1673187623
11230 \begin_inset space \space{}
11234 \begin_inset space \thinspace{}
11238 \change_inserted 564990737 1671642942
11240 \change_inserted -712698321 1673187655
11242 \change_deleted -712698321 1673187624
11244 \change_inserted 564990737 1671642942
11252 an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
11255 File\SpecialChar menuseparator
11256 Open Example\SpecialChar menuseparator
11257 Curricula Vitae\SpecialChar menuseparator
11259 \change_deleted -712698321 1673187728
11261 \change_inserted 564990737 1671642942
11264 offers guidance on its use.
11265 Its documentation is available from
11266 \begin_inset CommandInset href
11269 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
11277 \begin_layout Subsection
11279 \change_inserted 564990737 1671442208
11281 \change_deleted -712698321 1673187829
11283 \change_inserted -712698321 1673187829
11285 \change_inserted 564990737 1671442208
11289 \begin_layout Standard
11291 \change_inserted 564990737 1671642984
11293 \change_deleted -712698321 1673187820
11297 \begin_inset space \space{}
11301 \begin_inset space \thinspace{}
11305 \change_inserted 564990737 1671642984
11307 \change_inserted -712698321 1673187823
11309 \change_deleted -712698321 1673187824
11311 \change_inserted 564990737 1671642984
11319 an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
11322 File\SpecialChar menuseparator
11323 Open Example\SpecialChar menuseparator
11324 Curricula Vitae\SpecialChar menuseparator
11327 offers guidance on its use.
11328 Its documentation is available from
11329 \begin_inset CommandInset href
11332 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
11340 \begin_layout Subsection
11342 \change_inserted 564990737 1671442208
11344 \change_inserted -712698321 1673187869
11346 \change_inserted 564990737 1671442208
11350 \begin_layout Standard
11352 \change_inserted 564990737 1671643003
11354 \change_deleted -712698321 1673187880
11358 \begin_inset space \space{}
11362 \begin_inset space \thinspace{}
11366 \change_inserted -712698321 1673187880
11368 \change_inserted 564990737 1671643003
11370 \change_inserted -712698321 1673187884
11372 \change_deleted -712698321 1673187884
11374 \change_inserted 564990737 1671643003
11382 This allows the creation of customizable CVs.
11385 File\SpecialChar menuseparator
11386 Open Example\SpecialChar menuseparator
11387 Curricula Vitae\SpecialChar menuseparator
11390 offers guidance on its use.
11391 Its documentation is available from
11392 \begin_inset CommandInset href
11395 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
11403 \begin_layout Subsection
11405 \change_inserted 564990737 1671442208
11407 \change_inserted -712698321 1673187900
11409 \change_inserted 564990737 1671442208
11413 \begin_layout Standard
11415 \change_inserted 564990737 1671643024
11417 \change_deleted -712698321 1673187895
11421 \begin_inset space \space{}
11425 \begin_inset space \thinspace{}
11429 \change_inserted -712698321 1673187895
11431 \change_inserted 564990737 1671643024
11433 \change_inserted -712698321 1673187897
11435 \change_deleted -712698321 1673187898
11437 \change_inserted 564990737 1671643024
11445 originally developed for use with \SpecialChar LyX
11449 File\SpecialChar menuseparator
11450 Open Example\SpecialChar menuseparator
11451 Curricula Vitae\SpecialChar menuseparator
11454 offers guidance on its use.
11455 Its documentation is available from
11456 \begin_inset CommandInset href
11459 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
11467 \begin_layout Section
11469 \change_inserted 564990737 1672652454
11473 \begin_layout Standard
11475 \change_inserted 564990737 1672652455
11477 \change_deleted -712698321 1673245882
11481 \begin_inset space \space{}
11485 \change_inserted -712698321 1673245882
11488 KOMA-Script Letter (V.
11490 \change_inserted 564990737 1672652455
11494 \begin_inset space ~
11498 \begin_inset CommandInset ref
11500 reference "subsec:The-new-letter"
11506 \change_deleted -712698321 1673245908
11510 \begin_inset space \space{}
11513 (with extra font sizes)
11514 \change_inserted -712698321 1673245908
11517 Letter (Standard Class with Extra Font Sizes)
11518 \change_inserted 564990737 1672652455
11522 \begin_inset space ~
11526 \begin_inset CommandInset ref
11528 reference "subsec:Extra-font-sizes"
11533 ) document classes .
11536 \begin_layout Subsection
11538 \change_inserted 564990737 1671041970
11540 \change_deleted -712698321 1673246109
11542 \change_inserted -712698321 1673246110
11544 \change_inserted 564990737 1671041970
11548 \begin_layout Standard
11550 \change_inserted 564990737 1671617528
11554 \change_deleted -712698321 1673246116
11556 \change_inserted -712698321 1673246116
11558 \change_inserted 564990737 1671617528
11562 \change_inserted -712698321 1673246192
11564 \change_inserted 564990737 1671617528
11570 \change_deleted -712698321 1673246242
11572 \change_inserted -712698321 1673246242
11575 \change_inserted 564990737 1671617528
11576 class for writing letters according to the
11577 \change_inserted -712698321 1673246140
11578 standards of the German Standards Institute (
11579 \change_deleted -712698321 1673246141
11581 \change_inserted 564990737 1671617528
11584 Deutsches Institut für Normung
11585 \change_inserted -712698321 1673246324
11588 \change_deleted -712698321 1673246131
11592 \change_inserted 564990737 1671617528
11594 The file in the menu
11599 ile\SpecialChar menuseparator
11601 \begin_inset space ~
11609 \begin_inset space ~
11612 Template\SpecialChar menuseparator
11613 Letters\SpecialChar menuseparator
11616 offers guidance on its use.
11617 The documentation is available from
11618 \begin_inset CommandInset href
11621 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
11629 \begin_layout Subsection
11631 \change_deleted -712698321 1673246778
11633 \change_inserted -712698321 1673246778
11635 \begin_inset space \space{}
11643 \begin_layout Standard
11645 \change_inserted 564990737 1672652499
11649 \begin_inset space \space{}
11655 \change_inserted -712698321 1673246198
11657 \change_inserted 564990737 1672652499
11663 \change_deleted -712698321 1673246247
11665 \change_inserted -712698321 1673246247
11668 \change_inserted 564990737 1672652499
11669 class for writing letters according to French conventions.
11670 The file in the menu
11675 ile\SpecialChar menuseparator
11677 \begin_inset space ~
11685 \begin_inset space ~
11688 Template\SpecialChar menuseparator
11689 Letters\SpecialChar menuseparator
11691 \begin_inset space \space{}
11696 offers guidance on its use.
11697 \change_inserted -712698321 1673246876
11701 \begin_layout Subsection
11703 \change_inserted -712698321 1673246876
11705 \begin_inset space \space{}
11711 \begin_layout Standard
11713 \change_inserted -712698321 1673246917
11717 \begin_inset space \space{}
11722 provides support for
11727 another \SpecialChar LaTeX
11728 class for writing letters,
11729 but also faxes and envelopes,
11731 The file in the menu
11736 ile\SpecialChar menuseparator
11738 \begin_inset space ~
11746 \begin_inset space ~
11749 Template\SpecialChar menuseparator
11750 Letters\SpecialChar menuseparator
11752 \begin_inset space \space{}
11757 offers guidance on its use.
11758 The documentation is available from
11759 \begin_inset CommandInset href
11762 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
11768 \change_inserted 564990737 1672652499
11772 \begin_layout Subsection
11774 \change_inserted 564990737 1672652499
11776 \change_inserted -712698321 1673246804
11778 \begin_inset space \thinspace{}
11782 \change_inserted 564990737 1672652499
11786 \begin_layout Standard
11788 \change_inserted 564990737 1672652499
11792 \begin_inset space \thinspace{}
11798 \change_inserted -712698321 1673246202
11800 \change_inserted 564990737 1672652499
11802 \change_deleted -712698321 1673246498
11804 \change_inserted 564990737 1672652499
11810 \change_deleted -712698321 1673246249
11812 \change_inserted -712698321 1673246249
11815 \change_inserted 564990737 1672652499
11816 class for writing letters in German.
11817 The file in the menu
11822 ile\SpecialChar menuseparator
11824 \begin_inset space ~
11832 \begin_inset space ~
11835 Template\SpecialChar menuseparator
11836 Letters\SpecialChar menuseparator
11838 \begin_inset space \thinspace{}
11843 offers guidance on its use.
11844 The documentation is available from
11845 \begin_inset CommandInset href
11848 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
11856 \begin_layout Subsection
11858 \change_deleted -712698321 1673246462
11862 \begin_layout Standard
11864 \change_deleted -712698321 1673246462
11873 document class for English letters and to create mailing labels.
11874 The file in the menu
11879 ile\SpecialChar menuseparator
11881 \begin_inset space ~
11889 \begin_inset space ~
11892 Template\SpecialChar menuseparator
11893 Letters\SpecialChar menuseparator
11894 Letter (Standard Class)
11896 offers guidance on its use.
11897 \change_inserted 564990737 1671617591
11901 \begin_layout Subsection
11903 \change_deleted -712698321 1673246872
11907 \begin_layout Standard
11909 \change_deleted -712698321 1673246872
11913 \begin_inset space \space{}
11922 document class for writing letters,
11923 faxes and envelopes in French.
11924 The file in the menu
11929 ile\SpecialChar menuseparator
11931 \begin_inset space ~
11939 \begin_inset space ~
11942 Template\SpecialChar menuseparator
11943 Letters\SpecialChar menuseparator
11945 \begin_inset space \space{}
11950 offers guidance on its use.
11951 The documentation is available from
11952 \begin_inset CommandInset href
11955 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
11961 \change_inserted 564990737 1672652527
11965 \begin_layout Section
11967 \change_inserted 564990737 1670439660
11971 \begin_layout Subsection
11973 \change_inserted 564990737 1671458922
11977 \begin_layout Standard
11979 \change_inserted 564990737 1671617655
11981 \change_deleted -712698321 1673255475
11985 \begin_inset space \thinspace{}
11989 \change_inserted -712698321 1673255475
11991 \change_inserted 564990737 1671617655
11993 \change_deleted -712698321 1673255477
11995 \change_inserted 564990737 1671617655
12003 \change_deleted -712698321 1673255496
12005 \change_inserted -712698321 1673255496
12008 \change_inserted 564990737 1671617655
12009 class for creating presentations.
12010 The file in the menu
12015 ile\SpecialChar menuseparator
12017 \begin_inset space ~
12025 \begin_inset space ~
12028 Template\SpecialChar menuseparator
12029 Presentations\SpecialChar menuseparator
12033 \change_inserted -712698321 1673257500
12036 Help\SpecialChar menuseparator
12037 Specific Manuals\SpecialChar menuseparator
12038 Beamer Presentations
12041 \change_inserted 564990737 1671617655
12042 offers guidance on its use.
12043 The documentation is available from
12044 \begin_inset CommandInset href
12047 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
12055 \begin_layout Subsection
12057 \change_deleted -712698321 1673255766
12062 Foil\SpecialChar TeX
12064 \change_deleted -712698321 1673255767
12070 \begin_inset CommandInset label
12079 \begin_layout Standard
12081 \change_inserted 564990737 1672743383
12087 updated by the \SpecialChar LyX
12091 \begin_layout Subsubsection
12093 \change_inserted 564990737 1672743383
12097 \begin_layout Standard
12099 \change_inserted 564990737 1672743396
12101 \change_deleted -712698321 1673255761
12105 \begin_inset space \thinspace{}
12109 \change_inserted 564990737 1672743396
12110 Foil\SpecialChar TeX
12112 \change_deleted -712698321 1673255763
12114 \change_inserted 564990737 1672743396
12121 document class to make slides for overhead projectors.
12122 There are two document classes that can do this:
12124 \change_deleted -712698321 1673256124
12128 \begin_inset space \thinspace{}
12132 \change_inserted -712698321 1673256124
12134 \change_inserted 564990737 1672743396
12136 \change_deleted -712698321 1673256130
12138 \change_inserted 564990737 1672743396
12141 document class (section
12142 \begin_inset space ~
12146 \begin_inset CommandInset ref
12148 reference "sec:slitex"
12158 Foil\SpecialChar TeX
12162 As of 2023 the former has continued to be maintained whereas
12164 Foil\SpecialChar TeX
12167 has not been maintained since 2008.
12168 This section documents the latter.
12169 If your machine doesn’t have the
12170 \change_deleted -712698321 1673256264
12174 \begin_inset space \thinspace{}
12178 \change_inserted 564990737 1672743396
12179 Foil\SpecialChar TeX
12181 \change_deleted -712698321 1673256265
12183 \change_inserted 564990737 1672743396
12186 document class installed,
12187 you’ll probably have to use the
12188 \change_deleted -712698321 1673256271
12192 \begin_inset space \thinspace{}
12196 \change_inserted -712698321 1673256271
12198 \change_inserted 564990737 1672743396
12200 \change_deleted -712698321 1673256273
12202 \change_inserted 564990737 1672743396
12206 If you want to install the
12211 it is available from
12212 \begin_inset CommandInset href
12215 target "https://www.ctan.org/pkg/foiltex"
12221 You should also read the
12223 Installing New Document Classes
12230 \change_deleted 564990737 1672743436
12236 \begin_layout Standard
12238 \change_deleted 564990737 1672743383
12242 \begin_layout Standard
12244 \change_deleted 564990737 1672743383
12245 This section describes how to use \SpecialChar LyX
12246 to make slides for overhead projectors.
12247 There are two document classes that can do this:
12248 the default slides class and the
12250 Foil\SpecialChar TeX
12254 This section documents the latter.
12257 \begin_layout Standard
12259 \change_deleted 564990737 1672743383
12260 I'm going to say this again,
12262 so that there's no misunderstanding:
12265 \begin_layout Standard
12267 \change_deleted 564990737 1672743383
12268 \begin_inset VSpace bigskip
12274 \begin_layout Standard
12277 \change_deleted 564990737 1672743383
12280 This section documents the class
12281 \begin_inset Quotes eld
12289 \begin_inset Quotes erd
12297 \begin_layout Standard
12299 \change_deleted 564990737 1672743383
12300 \begin_inset VSpace bigskip
12306 \begin_layout Standard
12308 \change_deleted 564990737 1672743383
12309 If you're looking for the documentation for
12310 \begin_inset Quotes eld
12318 \begin_inset Quotes erd
12323 \begin_inset space ~
12327 \begin_inset CommandInset ref
12329 reference "sec:slitex"
12335 If your machine doesn't have the
12344 you'll probably have to use the default
12349 which isn't quite as good as
12354 \begin_layout Standard
12356 \change_deleted 564990737 1672743383
12361 class is designed for use with version
12362 \begin_inset space ~
12370 class file which is now an integral part of \SpecialChar LaTeX2e
12376 \begin_layout Subsubsection
12380 \begin_layout Standard
12382 to use this document class,
12394 \begin_inset space ~
12400 There are some settings in the
12403 \begin_inset space ~
12408 dialog that you should know about that are specific to this class:
12411 \begin_layout Itemize
12412 Don't change the options
12423 \begin_inset space ~
12429 They're ignored by the
12436 \begin_layout Itemize
12437 The default font size is 20
12438 \begin_inset space \thinspace{}
12441 pt with the other options being 17
12442 \begin_inset space \thinspace{}
12447 \begin_inset space \thinspace{}
12451 \begin_inset space \thinspace{}
12457 \begin_layout Itemize
12458 The default font is
12466 but all math equations are still typeset in the usual roman font.
12469 \begin_layout Itemize
12472 Foil\SpecialChar TeX
12475 supports A4 and Letter paper sizes as well as a special size for working with 35
12476 \begin_inset space \thinspace{}
12480 It doesn't support A5,
12482 legal or executive paper sizes.
12485 \begin_layout Itemize
12486 Don't bother changing the
12490 settings because they are ignored anyway.
12491 All floats appear where they are defined in the text.
12494 \begin_layout Itemize
12499 setting behaves a bit differently for this class.
12502 Foil\SpecialChar TeX
12505 provides extensive footer and header capabilities including a user-defined logo.
12507 \begin_inset space ~
12511 \begin_inset CommandInset ref
12513 reference "sec:foilfoot"
12519 The title page is treated differently to all other pages in the document and is
12527 has the logo centered at the bottom of the page (if one is defined).
12528 The possible page style choices and what they do are as follows:
12532 \begin_layout Labeling
12533 \labelwidthstring MMMMMMM
12540 The final output contains no page numbers,
12541 or other headers or footers (except footnotes of course).
12545 \begin_layout Labeling
12546 \labelwidthstring MMMMMMM
12553 The final output contains page numbers centered at the bottom of the page.
12554 No other headings or footers (other than footnotes).
12557 \begin_layout Labeling
12558 \labelwidthstring MMMMMMM
12563 Page numbers in lower right corner.
12564 Additional headers and footers are also shown.
12565 This is also the default.
12568 \begin_layout Labeling
12569 \labelwidthstring MMMMMMM
12574 Gives you access to the
12578 package although its use with
12580 Foil\SpecialChar TeX
12583 is discouraged by the writer of the
12585 Foil\SpecialChar TeX
12588 package because of some potential page layout clashes.
12592 \begin_layout Paragraph
12596 \begin_layout Standard
12597 The following options may be used in the extra class options in the
12599 Document\SpecialChar menuseparator
12605 \begin_layout Labeling
12606 \labelwidthstring MMMMMMx
12611 This sets up the page layout for 7.33
12612 \begin_inset space \thinspace{}
12616 \begin_inset space \thinspace{}
12620 which is about the same aspect ratio as a 35
12621 \begin_inset space \thinspace{}
12625 making it a bit easier to work with this medium.
12628 \begin_layout Labeling
12629 \labelwidthstring MMMMMMx
12634 Places a rule across the page below the header on every page except the title page.
12637 \begin_layout Labeling
12638 \labelwidthstring MMMMMMx
12643 Places a rule across the page above the footer on every page except the title page.
12646 \begin_layout Labeling
12647 \labelwidthstring MMMMMMx
12652 This is automatically set each time you create a new
12659 Foil\SpecialChar TeX
12662 to use the dvips driver to rotate those pages that are set as landscape foils.
12665 \begin_layout Labeling
12666 \labelwidthstring MMMMMMx
12671 Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
12672 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.
12673 Note that this option effectively reverses the roles of the
12681 environments (don't worry these are described in the next section).
12684 \begin_layout Labeling
12685 \labelwidthstring MMMMMMx
12690 Equation numbers on the left.
12693 \begin_layout Labeling
12694 \labelwidthstring MMMMMMx
12699 Flush-left equations.
12702 \begin_layout Subsubsection
12703 Supported Environments
12706 \begin_layout Standard
12707 Most of the environments commonly supported in other classes are also supported by the
12708 \change_deleted -712698321 1673256683
12712 \change_inserted -712698321 1673256683
12713 Foil\SpecialChar TeX
12719 There are several additional environments provided by
12721 Foil\SpecialChar TeX
12724 as well as a couple added by \SpecialChar LyX
12726 The following environments are shared with other classes:
12729 \begin_layout Standard
12730 \begin_inset Flex Multiple Columns
12733 \begin_layout Itemize
12739 \begin_layout Itemize
12745 \begin_layout Itemize
12751 \begin_layout Itemize
12757 \begin_layout Itemize
12763 \begin_layout Itemize
12770 \begin_layout Itemize
12776 \begin_layout Itemize
12782 \begin_layout Itemize
12788 \begin_layout Itemize
12792 \change_inserted -712698321 1673256734
12796 \begin_layout Itemize
12802 \begin_layout Itemize
12808 \begin_layout Itemize
12814 \begin_layout Itemize
12820 \begin_layout Itemize
12826 \begin_layout Itemize
12837 \begin_layout Standard
12839 all the major environments apart from the sectioning environments.
12840 Since foils are essentially self-contained sections,
12841 with a title and body,
12844 Foil\SpecialChar TeX
12847 provides specific commands for starting new foils and these are:
12850 \begin_layout Itemize
12856 \begin_layout Itemize
12862 \begin_layout Standard
12864 also provides slightly modified versions of these two environments called:
12867 \begin_layout Itemize
12873 \begin_layout Itemize
12876 ShortRotatefoilhead
12879 \begin_layout Standard
12880 and the differences will be explained in the next section.
12883 \begin_layout Standard
12884 Since foils are often used in presenting ideas or new theorems and such
12886 Foil\SpecialChar TeX
12889 also provides a comprehensive box of goodies for presenting them:
12892 \begin_layout Standard
12893 \begin_inset Flex Multiple Columns
12896 \begin_layout Itemize
12902 \begin_layout Itemize
12908 \begin_layout Itemize
12914 \begin_layout Itemize
12920 \begin_layout Itemize
12926 \begin_layout Itemize
12932 \begin_layout Itemize
12938 \begin_layout Itemize
12944 \begin_layout Itemize
12950 \begin_layout Itemize
12956 \begin_layout Itemize
12967 \begin_layout Standard
12968 The starred versions are unnumbered while the unstarred versions are numbered.
12969 There are also two list environments added by \SpecialChar LyX
12973 \begin_layout Itemize
12979 \begin_layout Itemize
12985 \begin_layout Standard
12988 Foil\SpecialChar TeX
12991 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.
12992 If you want to change these settings in your document the best place to do so is at the very top of a foil,
12994 \begin_inset space \thinspace{}
13000 \begin_inset space \space{}
13005 straight after the foilhead.
13008 \begin_layout Standard
13010 the following command styles are provided [
13017 \begin_layout Standard
13018 \begin_inset Flex Multiple Columns
13021 \begin_layout Itemize
13025 \begin_inset space ~
13031 \begin_layout Itemize
13037 \begin_layout Itemize
13041 \begin_inset space ~
13047 \begin_layout Itemize
13051 \begin_inset space ~
13057 \begin_layout Itemize
13061 \begin_inset space ~
13068 \begin_layout Plain Layout
13069 \begin_inset space ~
13081 \begin_layout Standard
13082 There are also a few commands provided by
13084 Foil\SpecialChar TeX
13087 that aren't directly supported by \SpecialChar LyX
13088 but I'll tell you what they do and how to use them in section
13089 \begin_inset space ~
13093 \begin_inset CommandInset ref
13095 reference "sec:unsuppfoils"
13103 \begin_layout Subsubsection
13104 Building a Set of Foils
13107 \begin_layout Standard
13108 This section will give a simple introduction to using the different environments to build a set of foils.
13109 If you want to see an example set of foils,
13111 \change_deleted 564990737 1671643085
13116 file you find in \SpecialChar LyX
13122 \change_inserted 564990737 1671643099
13125 File\SpecialChar menuseparator
13126 Open Example\SpecialChar menuseparator
13127 Presentations\SpecialChar menuseparator
13135 \begin_layout Paragraph
13136 Give It a Title Page
13139 \begin_layout Standard
13140 Unlike other classes that provide
13160 \change_deleted -712698321 1673256940
13164 \change_inserted -712698321 1673256940
13172 creates the title on a page of its own.
13173 If you leave out the
13177 environment \SpecialChar LaTeX
13178 will substitute the current date (every time you regenerate the output).
13181 \begin_layout Paragraph
13185 \begin_layout Standard
13186 As I mentioned earlier,
13187 there are four ways of starting a new foil.
13188 For portrait foils you should use
13197 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.
13200 \begin_layout Standard
13201 Landscape foils are generated using the
13207 ShortRotatefoilhead
13210 Again the only difference is the spacing between foilhead and body.
13211 Both of the short versions have 0.5
13212 \begin_inset space ~
13215 inches less separation between the foilhead and the body.
13219 \begin_layout Standard
13220 One problem with the support for landscape foils is the requirement that you have to use the
13224 driver to generate the PostScript output otherwise the foils won't be rotated.
13225 It is possible to get landscape foils even if you haven't got the
13229 driver provided you can feed your foils sideways through your printer ;-)
13232 \begin_layout Paragraph
13238 \begin_layout Standard
13239 You can't have two of the same type of these environments directly following each other.
13240 If you use a normal paragraph break,
13242 you will just be extending the previous environment as if you had merged the two environments together.
13244 you need to insert a so-called separator.
13245 Please refer to the section entitled
13256 \begin_layout Paragraph
13260 \begin_layout Standard
13261 You get all the commonly supported list styles found in other classes as well as two new ones.
13262 I'll only describe the new ones here.
13263 If you want to find out more about the other list environments check out the
13268 If you intend to use itemized lists you might also want to read about the
13271 \begin_inset space ~
13275 \begin_inset space ~
13280 dialog described above in section
13281 \begin_inset space ~
13285 \change_inserted 564990737 1671355684
13287 \begin_inset CommandInset ref
13289 reference "chap:bullets"
13295 \change_deleted 564990737 1671355684
13297 \begin_inset CommandInset ref
13299 reference "sec:bullet"
13309 \begin_layout Standard
13310 The two new list styles,
13320 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.
13321 These lists are in fact dedicated variants of the
13326 They do however require that you have the
13330 packages installed.
13333 \begin_layout Paragraph
13337 \begin_layout Standard
13340 Foil\SpecialChar TeX
13343 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.
13344 In fact if you change the float placement settings they are simply ignored.
13347 \begin_layout Paragraph
13348 Page Headers and Footers
13349 \begin_inset CommandInset label
13351 name "sec:foilfoot"
13358 \begin_layout Standard
13362 \begin_inset space ~
13371 are two commands used to control the left-footer text string.
13372 The first is meant to allow you to include a graphic logo on your foils and defaults to
13373 \begin_inset Quotes eld
13378 Foil\SpecialChar TeX
13382 \begin_inset Quotes erd
13386 While the second is meant to provide a classification for the audience,
13390 \begin_inset space \thinspace{}
13396 \begin_inset space \space{}
13400 It is empty by default.
13403 \begin_layout Standard
13404 The remaining page corners can be filled by
13407 \begin_inset space ~
13412 (which defaults to page numbers),
13416 \begin_inset space ~
13424 \begin_inset space ~
13432 \begin_layout Subsubsection
13435 Foil\SpecialChar TeX
13439 \begin_inset CommandInset label
13441 name "sec:unsuppfoils"
13448 \begin_layout Standard
13449 All the commands mentioned below need to be set in a
13459 within another environment.
13462 \begin_layout Paragraph
13466 \begin_layout Standard
13467 All lengths are adjusted using the
13490 should be replaced by the name given to the length you want to change and
13494 is the length value.
13495 All lengths should be specified in units of length such as inches (
13508 ) or relative to some document or font-based length such as
13518 \begin_layout Standard
13519 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
13532 \begin_inset space \space{}
13535 in closer to their bodies put the following in the preamble:
13542 foilheadskip}{-0.5in}
13545 \begin_layout Standard
13546 The spacings around floats can be adjusted by setting these lengths:
13549 \begin_layout Labeling
13550 \labelwidthstring MMMMMMMMMMM
13557 Separation between the text and the top of the float
13560 \begin_layout Labeling
13561 \labelwidthstring MMMMMMMMMMM
13568 Separation between the float and the caption
13571 \begin_layout Labeling
13572 \labelwidthstring MMMMMMMMMMM
13579 Separation between the caption and the following text
13582 \begin_layout Labeling
13583 \labelwidthstring MMMMMMMMMMM
13590 You can make the captions narrower than the surrounding text by adjusting this length.
13591 Best done relative to
13600 \begin_layout Standard
13601 There are also several title page related lengths that you may find useful if you have a long title or several authors:
13604 \begin_layout Labeling
13605 \labelwidthstring MMMMMMMMMMM
13612 Separation from headers to
13617 \begin_layout Labeling
13618 \labelwidthstring MMMMMMMMMMM
13636 \begin_layout Labeling
13637 \labelwidthstring MMMMMMMMMMM
13651 \begin_layout Labeling
13652 \labelwidthstring MMMMMMMMMMM
13668 \begin_layout Labeling
13669 \labelwidthstring MMMMMMMMMMM
13685 \begin_layout Standard
13686 The last length related command affects all the list environments.
13697 a list environment then all the vertical spacing between the list items is removed.
13698 Note that this is a command not a length so it doesn't require
13704 like the stuff mentioned above.
13707 \begin_layout Paragraph
13708 Headers and Footers
13711 \begin_layout Standard
13724 commands control whether the logo in the
13728 definition appear on a given page.
13735 in the preamble then none of the foils will have the logo on them.
13736 If you don't want the logo on a particular page place the
13742 directly after the foilhead of that page and the
13748 directly after the next foilhead.
13751 \begin_layout Standard
13752 If you decide to use the
13756 page style setting in the
13759 \begin_inset space ~
13764 dialog you should probably add
13774 to your preamble so headers and footers on landscape pages are correctly placed when rotated.
13775 This is due to some clashes between the page layouts provided by the
13780 \change_deleted -712698321 1673257120
13784 \change_inserted -712698321 1673257120
13795 \begin_layout Subsection
13797 \change_inserted 564990737 1671459032
13801 \begin_layout Standard
13803 \change_inserted 564990737 1671643165
13805 \change_deleted -712698321 1673257152
13809 \begin_inset space \thinspace{}
13813 \change_inserted -712698321 1673257152
13815 \change_inserted 564990737 1671643165
13817 \change_deleted -712698321 1673257154
13819 \change_inserted 564990737 1671643165
13827 \change_deleted -712698321 1673257280
13829 \change_inserted -712698321 1673257280
13832 \change_inserted 564990737 1671643165
13833 class for creating presentations.
13836 File\SpecialChar menuseparator
13837 Open Example\SpecialChar menuseparator
13838 Presentations\SpecialChar menuseparator
13841 offers guidance on its use.
13842 The documentation is available from
13843 \begin_inset CommandInset href
13846 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
13854 \begin_layout Subsection
13856 \change_inserted 564990737 1671459032
13857 \begin_inset CommandInset label
13859 name "subsec:Seminar"
13868 \begin_layout Standard
13870 \change_inserted 564990737 1671643194
13872 \change_deleted -712698321 1673257295
13876 \begin_inset space \thinspace{}
13880 \change_inserted -712698321 1673257295
13882 \change_inserted 564990737 1671643194
13884 \change_deleted -712698321 1673257296
13886 \change_inserted 564990737 1671643194
13893 document class for creating presentations.
13896 File\SpecialChar menuseparator
13897 Open Example\SpecialChar menuseparator
13898 Presentations\SpecialChar menuseparator
13901 offers guidance on its use.
13902 The documentation is available from
13903 \begin_inset CommandInset href
13906 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
13914 \begin_layout Subsection
13917 Sli\SpecialChar TeX
13921 \begin_inset CommandInset label
13930 \begin_layout Standard
13932 \change_inserted 564990737 1672743492
13938 updated by the \SpecialChar LyX
13942 \begin_layout Subsubsection
13944 \change_inserted 564990737 1672743492
13948 \begin_layout Standard
13950 \change_inserted 564990737 1672743492
13951 This section describes how to use \SpecialChar LyX
13952 to make slides for overhead projectors.
13953 There are two document classes that can do this:
13955 \change_deleted -712698321 1673257697
13959 \begin_inset space \thinspace{}
13963 \change_inserted -712698321 1673257697
13967 \change_inserted 564990737 1672743492
13969 \change_deleted -712698321 1673257698
13973 \change_inserted 564990737 1672743492
13976 document class and the
13977 \change_deleted -712698321 1673257705
13981 \begin_inset space \thinspace{}
13985 \change_inserted 564990737 1672743492
13986 Foil\SpecialChar TeX
13988 \change_deleted -712698321 1673257707
13990 \change_inserted 564990737 1672743492
13994 This section documents the former.
13995 If you’re looking for the documentation for
13996 \change_deleted -712698321 1673257759
14000 \begin_inset space \thinspace{}
14004 \change_inserted 564990737 1672743492
14005 Foil\SpecialChar TeX
14007 \change_deleted -712698321 1673257760
14009 \change_inserted 564990737 1672743492
14014 \begin_inset space ~
14018 \change_inserted -712698321 1673257749
14020 \begin_inset CommandInset ref
14022 reference "sec:foiltex"
14031 \change_deleted -712698321 1673257749
14033 \begin_inset CommandInset ref
14035 reference "sec:Foiltex"
14041 \change_inserted 564990737 1672743492
14044 \change_deleted -712698321 1673257899
14046 \change_inserted -712698321 1673257899
14050 \change_inserted 564990737 1672743492
14053 has continued to be maintained whereas
14055 Foil\SpecialChar TeX
14058 has not been maintained since 2008.
14060 \change_deleted 564990737 1672743492
14068 \begin_layout Standard
14070 \change_deleted 564990737 1672743492
14074 \begin_layout Standard
14076 \change_deleted 564990737 1672743492
14077 This section describes how to use \SpecialChar LyX
14078 to make slides for overhead projectors.
14079 There are two document classes that can do this:
14080 the default slides class and the
14082 Foil\SpecialChar TeX
14086 This section documents the former.
14089 \begin_layout Standard
14091 \change_deleted 564990737 1672743492
14092 I'm going to say this again,
14094 so that there's no misunderstanding:
14097 \begin_layout Standard
14099 \change_deleted 564990737 1672743492
14100 \begin_inset VSpace bigskip
14106 \begin_layout Standard
14109 \change_deleted 564990737 1672743492
14112 This section documents the class
14113 \begin_inset Quotes eld
14121 \begin_inset Quotes erd
14129 \begin_layout Standard
14131 \change_deleted 564990737 1672743492
14132 \begin_inset VSpace bigskip
14138 \begin_layout Standard
14140 \change_deleted 564990737 1672743492
14141 If you're looking for the documentation for
14142 \begin_inset Quotes eld
14147 slides (Foil\SpecialChar TeX
14151 \begin_inset Quotes erd
14156 \begin_inset space ~
14160 \begin_inset CommandInset ref
14162 reference "sec:foiltex"
14173 \begin_inset Quotes eld
14178 slides (Foil\SpecialChar TeX
14182 \begin_inset Quotes erd
14185 ] is actually somewhat better than the default
14193 \begin_layout Plain Layout
14195 or so I've been told repeatedly by its advocates.
14196 Having never used it,
14197 I have no idea if this claim is true or not.
14202 which this section documents.
14205 \begin_layout Standard
14207 \change_deleted 564990737 1672743492
14208 This class is the \SpecialChar LaTeX2e
14209 improvement of the old
14211 Sli\SpecialChar TeX
14215 Every \SpecialChar LaTeX2e
14216 distribution includes this class [which I'll just refer to as
14217 \begin_inset Quotes eld
14225 \begin_inset Quotes erd
14229 so you're bound to have it.
14230 As I noted earlier,
14231 there are other classes,
14237 which also produce slides for overhead projectors and do a better job at it.
14239 there are some things which
14243 can do which the others can't,
14244 such as generate overlays.
14245 Read on to learn more!
14250 \begin_layout Subsubsection
14252 \begin_inset CommandInset label
14254 name "sec:slidesetup"
14261 \begin_layout Standard
14263 to use this document class,
14265 \begin_inset Quotes eld
14269 \change_deleted -712698321 1673257922
14273 \change_inserted -712698321 1673257922
14277 \change_deleted -712698321 1673257925
14283 \begin_inset Quotes erd
14286 from the class list in the
14288 Document\SpecialChar menuseparator
14292 There are some other special things you should know about this class:
14295 \begin_layout Itemize
14296 Don't bother changing the options
14301 They're not supported by the
14302 \change_deleted -712698321 1673257960
14306 \change_inserted -712698321 1673257960
14315 \begin_layout Itemize
14319 \begin_inset space ~
14324 behaves a bit differently for this class.
14325 The possible choices and what they do are as follows:
14329 \begin_layout Description
14334 The final output contains page numbers in the lower right corner.
14337 \begin_layout Description
14347 but also prints out any time markers you've put in.
14348 This is the default.
14351 \begin_layout Description
14356 The final output contains no page numbers,
14358 or alignment markers.
14362 \begin_layout Itemize
14364 \change_deleted -712698321 1673257971
14368 \change_inserted -712698321 1673257971
14373 class has an extra option:
14381 \begin_inset Quotes eld
14389 \begin_inset Quotes erd
14392 in the extra class options.
14396 \begin_layout Standard
14397 Using this options allows you to add time markers to
14403 \begin_inset space ~
14407 \begin_inset CommandInset ref
14409 reference "sec:slideNote"
14418 \begin_layout Standard
14419 You can also use the template file
14420 \change_deleted 564990737 1671617694
14422 \begin_inset Quotes eld
14430 \begin_inset Quotes erd
14435 to automatically set up a document to use the
14440 \change_deleted 564990737 1671617699
14445 File\SpecialChar menuseparator
14447 \begin_inset space ~
14451 \begin_inset space ~
14455 \change_inserted 564990737 1671617723
14456 \SpecialChar menuseparator
14457 Presentations\SpecialChar menuseparator
14462 to open your new document
14463 \change_deleted 564990737 1671617728
14467 The template file also contains some examples of the special paragraph environments used by this class.
14468 I'll describe those next.
14471 \begin_layout Subsubsection
14472 Paragraph Environments
14475 \begin_layout Paragraph
14476 Supported Environments
14479 \begin_layout Standard
14480 The first thing you'll notice when you start up a new
14481 \change_deleted -712698321 1673258063
14485 \change_inserted -712698321 1673258063
14490 document is the font size and type:
14491 it's the equivalent of the size
14492 \begin_inset Quotes eld
14500 \begin_inset Quotes erd
14506 \begin_inset space ~
14512 This is also what's used in the output.
14514 \begin_inset Quotes eld
14518 \begin_inset Quotes erd
14521 to remind you that this is a slide.
14522 Your final slides will use a larger font;
14524 you'll have less space.
14526 the larger default screen font isn't WYSIWYG,
14530 \begin_layout Standard
14531 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
14532 Most of the paragraph environments you're used to seeing are missing.
14533 There are also five new ones.
14535 \change_deleted -712698321 1673258093
14539 \change_inserted -712698321 1673258093
14544 class itself only supports certain paragraph environments:
14547 \begin_layout Standard
14549 \change_inserted -712698321 1673258082
14552 \begin_inset Flex Multiple Columns
14555 \begin_layout Itemize
14557 \change_inserted -712698321 1673258082
14563 \begin_layout Itemize
14565 \change_inserted -712698321 1673258082
14571 \begin_layout Itemize
14573 \change_inserted -712698321 1673258082
14579 \begin_layout Itemize
14581 \change_inserted -712698321 1673258082
14587 \begin_layout Itemize
14589 \change_inserted -712698321 1673258082
14595 \begin_layout Itemize
14597 \change_inserted -712698321 1673258082
14603 \begin_layout Itemize
14605 \change_inserted -712698321 1673258082
14611 \begin_layout Itemize
14613 \change_inserted -712698321 1673258082
14619 \begin_layout Itemize
14621 \change_inserted -712698321 1673258082
14627 \begin_layout Itemize
14629 \change_inserted -712698321 1673258082
14641 \change_deleted -712698321 1673258082
14645 \begin_layout Itemize
14647 \change_deleted -712698321 1673258082
14653 \begin_layout Itemize
14655 \change_deleted -712698321 1673258082
14661 \begin_layout Itemize
14663 \change_deleted -712698321 1673258082
14669 \begin_layout Itemize
14671 \change_deleted -712698321 1673258082
14677 \begin_layout Itemize
14679 \change_deleted -712698321 1673258082
14685 \begin_layout Itemize
14687 \change_deleted -712698321 1673258082
14693 \begin_layout Itemize
14695 \change_deleted -712698321 1673258082
14701 \begin_layout Itemize
14703 \change_deleted -712698321 1673258082
14709 \begin_layout Itemize
14711 \change_deleted -712698321 1673258082
14720 \begin_layout Standard
14721 All of the other standard environments,
14722 including the section-heading environments,
14724 \change_deleted -712698321 1673258102
14728 \change_inserted -712698321 1673258102
14736 \begin_layout Standard
14738 you'll notice the following new environments:
14741 \begin_layout Standard
14743 \change_inserted -712698321 1673258111
14746 \begin_inset Flex Multiple Columns
14749 \begin_layout Itemize
14751 \change_inserted -712698321 1673258111
14757 \begin_layout Itemize
14759 \change_inserted -712698321 1673258111
14765 \begin_layout Itemize
14767 \change_inserted -712698321 1673258111
14773 \begin_layout Itemize
14775 \change_inserted -712698321 1673258111
14781 \begin_layout Itemize
14783 \change_inserted -712698321 1673258119
14790 \begin_layout Plain Layout
14792 \change_inserted -712698321 1673258133
14793 \begin_inset space ~
14805 \change_deleted -712698321 1673258111
14809 \begin_layout Itemize
14811 \change_deleted -712698321 1673258111
14817 \begin_layout Itemize
14819 \change_deleted -712698321 1673258111
14825 \begin_layout Itemize
14827 \change_deleted -712698321 1673258111
14833 \begin_layout Itemize
14835 \change_deleted -712698321 1673258111
14843 \begin_layout Standard
14844 These five are kind of quirky,
14846 \begin_inset Quotes eld
14850 \begin_inset Quotes erd
14853 in \SpecialChar LyX
14857 doesn't permit you to nest any other paragraph environment into an empty environment.
14859 that's fine and dandy,
14860 but it means that you wouldn't be able to start a slide with anything except plain text.
14862 I've performed a little
14863 \begin_inset Quotes eld
14868 \begin_inset Quotes erd
14874 \begin_layout Paragraph
14875 Quirks of the New Environments
14876 \begin_inset CommandInset label
14878 name "sec:slideQuirk"
14885 \begin_layout Standard
14886 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
14888 As I just mentioned,
14890 forbids environments that begin with another environment.
14891 To get around this,
14896 environment isn't a paragraph environment as described in the
14904 \begin_layout Standard
14905 You should consider
14920 \begin_inset Quotes eld
14923 pseudo-environments.
14924 \begin_inset Quotes erd
14927 They look like a section heading or a
14928 \begin_inset Quotes eld
14936 \begin_inset Quotes erd
14939 but really begin a [and,
14941 end the previous] paragraph environment.
14952 \begin_inset Quotes eld
14956 \begin_inset Quotes erd
14959 These two perform some action.
14962 \begin_layout Standard
14963 A common feature of all five environments,
14988 is a rather long-ish label.
14989 The text following this label —
14990 ordinarily the contents of the paragraph environment —
14991 is utterly irrelevant for
15016 completely ignores it.
15018 you can leave these five environments completely empty.
15022 \begin_layout Standard
15027 to put any text after the rather long-ish label,
15029 This could be a short description of the contents of the
15036 enter your descriptive comment and hit
15040 as you normally would.
15043 \begin_layout Standard
15045 \change_deleted -712698321 1673258321
15048 you don't want to enter any descriptive text,
15049 you'll hit another \SpecialChar LyX
15055 and will not let you start a new paragraph environment until you put something in the old one.
15060 \begin_layout Itemize
15062 \change_deleted -712698321 1673258321
15063 Start entering the text that will
15094 \begin_layout Itemize
15096 \change_deleted -712698321 1673258321
15097 Now move to the beginning of that paragraph.
15101 \begin_layout Itemize
15103 \change_deleted -712698321 1673258321
15113 \begin_layout Itemize
15115 \change_deleted -712698321 1673258321
15118 empty paragraph to a
15145 \begin_layout Standard
15147 \change_deleted -712698321 1673258321
15148 Some future version of \SpecialChar LyX
15151 resolve this quirkiness\SpecialChar ldots
15157 \begin_layout Subsubsection
15158 Making a Presentation with
15172 \begin_layout Paragraph
15180 \begin_layout Standard
15181 If you're expecting this section to teach you how to actually make a presentation,
15182 you'll be sorely disappointed.
15184 I'll describe all of the ways the
15185 \change_deleted -712698321 1673258368
15189 \change_inserted -712698321 1673258368
15194 class can assist you in preparing the materials for a presentation.
15195 Filling in the contents,
15203 the \SpecialChar LyX
15207 \begin_layout Standard
15212 environment [in the manner described in section
15213 \begin_inset space ~
15217 \begin_inset CommandInset ref
15219 reference "sec:slideQuirk"
15224 ] tells \SpecialChar LyX
15225 to begin a new slide [duh].
15226 The label for this environment/
15227 \change_inserted -712698321 1673258390
15229 \begin_inset Quotes eld
15233 \change_deleted -712698321 1673258391
15235 \begin_inset Quotes erd
15241 \begin_inset Quotes erd
15245 \begin_inset Quotes eld
15249 \begin_inset Quotes erd
15253 followed by the label,
15255 \begin_inset Quotes eld
15259 \begin_inset Quotes erd
15263 Any text or paragraph environments that follow this one go on the new slide.
15267 \begin_layout Standard
15268 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
15269 (this can be specified in the
15276 once you finish entering the contents of one slide.
15277 If you've entered more text than can physically fit on a slide,
15278 the extra overflows onto a new slide.
15279 I don't recommend doing this,
15281 since the overflow slide won't have any page number on it.
15283 it may interfere with any
15287 you've made to accompany the oversized
15294 \begin_layout Standard
15303 environments work the same way as the
15308 They both create an
15309 \begin_inset Quotes eld
15313 \begin_inset Quotes erd
15316 followed by a label [
15317 \begin_inset Quotes eld
15321 \begin_inset Quotes erd
15325 \begin_inset Quotes eld
15329 \begin_inset Quotes erd
15334 The color is a stunning magenta instead of blue,
15336 \begin_inset Quotes eld
15340 \begin_inset Quotes erd
15343 will look different,
15344 in style and in length.
15345 The label fonts of all three also differ from one another.
15348 \begin_layout Standard
15354 if the contents of a
15362 exceed the physical size of a slide or sheet of paper,
15363 the extra will overflow onto a new sheet.
15365 you should avoid this.
15366 It defeats the whole purpose of
15377 \begin_layout Paragraph
15387 \begin_layout Standard
15392 is a slide that sits atop another slide.
15393 Perhaps you wish to discuss a figure on the main
15397 before displaying the text associated with it.
15398 One way to accomplish this is tape a flap of dark paper over the part of the
15402 you want to display later.
15405 if you wish to overlap one graph with another,
15407 You would then have to fumble while speaking to align the two separate,
15412 s to align the two graphs.
15417 environment in both cases makes life much easier.
15420 \begin_layout Standard
15425 receives the page number of its
15426 \begin_inset Quotes eld
15430 \begin_inset Quotes erd
15439 \begin_inset Quotes eld
15447 \begin_inset Quotes erd
15454 \begin_layout Plain Layout
15461 \begin_inset Quotes eld
15469 \begin_inset Quotes erd
15474 \begin_inset Quotes eld
15482 \begin_inset Quotes erd
15487 \begin_inset Quotes eld
15495 \begin_inset Quotes erd
15500 \begin_inset space ~
15503 appended to the page number of the parent
15514 you want the contents of both the
15522 to each fit on a single physical slide!
15523 You should probably consider an
15528 \begin_inset Quotes eld
15532 \begin_inset Quotes erd
15541 the \SpecialChar LyX
15546 class provides a visual cue for this:
15547 the label at the start of an
15551 is shorter than that at the start of a
15557 when you generate printable output,
15558 you'll find alignment markers in all four corners of both the
15562 page and its parent
15567 These will assist you in lining up the two physical slides.
15570 \begin_layout Standard
15571 The major problem in overlaying two slides is aligning the contents of the two transparencies.
15572 How much space should you leave for that graph on the second slide?
15574 what if you want a graph and a sentence on second slide,
15575 but there is text on the main transparency that goes in between them?
15576 You could try and insert vertical space of the right size.
15577 The better way is to use
15588 \begin_layout Standard
15589 As their names imply,
15598 are two command-like paragraph environments that make all subsequent text invisible and visible,
15601 \begin_inset space ~
15605 \begin_inset CommandInset ref
15607 reference "sec:slideQuirk"
15612 that you don't place anything
15616 these two environments,
15623 it inserts a centered,
15624 sky-blue label into the page reading
15625 \begin_inset Quotes eld
15628 <Invisible Text Follows>
15629 \begin_inset Quotes erd
15633 For paragraphs following this label,
15643 it doesn't matter which] where they would be contain instead blank space.
15647 \begin_layout Standard
15653 the corresponding centered label is
15654 \begin_inset Quotes eld
15657 <Visible Text Follows>
15658 \begin_inset Quotes erd
15662 Paragraphs following this label behave normally.
15663 Note that the beginning of a new
15677 automatically shuts off an
15682 It's therefore not necessary to use
15693 \begin_layout Standard
15695 it should be obvious how to create overlay transparencies using the proper combination of
15714 \begin_layout Enumerate
15720 including everything that will appear on it,
15721 whether on the main slide or on the
15728 \begin_layout Enumerate
15729 Before each figure or paragraph that will appear only on the
15744 environment after the
15751 \begin_layout Enumerate
15756 immediately following the
15763 \begin_layout Enumerate
15764 Copy the contents of this
15775 \begin_layout Enumerate
15792 \begin_layout Standard
15794 You've just made an
15801 \begin_layout Standard
15802 There's one problem with the way I've designed the \SpecialChar LyX
15808 you can't make text in the middle of a paragraph invisible,
15809 nor make text in the middle of an invisible paragraph visible again.
15810 To accomplish this feat,
15811 you'll need to use some inlined \SpecialChar LaTeX
15816 \begin_layout Plain Layout
15817 The commands of interest are:
15821 \begin_layout Itemize
15826 invisible \SpecialChar ldots
15830 \begin_layout Itemize
15835 visible \SpecialChar ldots
15839 \begin_layout Plain Layout
15841 and need to be marked as \SpecialChar TeX
15844 \begin_inset Quotes eld
15848 \begin_inset Quotes erd
15851 you wish to change goes in between the brackets [and after the
15864 If you don't know how to mark text as \SpecialChar TeX
15866 see the appropriate section of the
15878 \begin_layout Paragraph
15888 \begin_inset CommandInset label
15890 name "sec:slideNote"
15897 \begin_layout Standard
15907 is associated with a
15908 \begin_inset Quotes eld
15912 \begin_inset Quotes erd
15922 the \SpecialChar LyX
15927 class provides visual cues.
15932 is shorter than that of a
15936 [yet longer than that of an
15941 like the label of an
15945 is shockingly magenta.
15951 has the page number of its
15952 \begin_inset Quotes eld
15956 \begin_inset Quotes erd
15965 \begin_inset Quotes eld
15973 \begin_inset Quotes erd
15978 \begin_inset Quotes eld
15986 \begin_inset Quotes erd
15991 \begin_inset Quotes eld
15999 \begin_inset Quotes erd
16004 You can have multiple
16008 s associated with a single
16023 you'll probably want to break up long
16027 s so that they fit on a single sheet of paper.
16030 \begin_layout Standard
16036 it contains anything additional you might want to say about a
16041 It could also be used as a sheet of reminders for a particular
16046 In the case of the latter,
16047 you might want to make use of time markers.
16049 the \SpecialChar LyX
16055 \begin_inset Quotes eld
16059 \begin_inset Quotes erd
16062 support for time markers,
16065 Sli\SpecialChar TeX
16070 you'll have to resort to using the \SpecialChar LaTeX
16074 \begin_layout Standard
16075 To use time markers,
16076 you'll need to specify the extra class option
16077 \begin_inset Quotes eld
16085 \begin_inset Quotes erd
16089 \begin_inset space ~
16093 \begin_inset CommandInset ref
16095 reference "sec:slidesetup"
16101 This option turns on timing marks,
16102 which will appear in the lower-left-hand corner of every
16107 To set what appears in the time marker,
16108 you use the \SpecialChar LaTeX
16110 \begin_inset Quotes eld
16120 \begin_inset Quotes erd
16124 \begin_inset Quotes eld
16134 \begin_inset Quotes erd
16138 The arguments of both commands are time measured in seconds.
16140 \begin_inset Quotes eld
16150 \begin_inset Quotes erd
16153 sets the time marker to a given time.
16155 \begin_inset Quotes eld
16165 \begin_inset Quotes erd
16168 increments the time marker by the specified amount.
16169 Using time markers and
16174 you can remind yourself how much time to spend on a particular
16181 \begin_layout Standard
16182 There's one last feature to describe.
16184 you'd like to print out all of your
16192 s on transparencies while printing all of your
16210 with which it is associated.
16211 What's a person to do?
16214 \begin_layout Standard
16216 there are two \SpecialChar LaTeX
16217 commands that allow you to select what to print out.
16218 Both must be placed into the preamble of your document.
16220 \begin_inset Quotes eld
16232 \begin_inset Quotes erd
16235 will cause the output to contain only the
16246 \begin_inset Quotes eld
16258 \begin_inset Quotes erd
16261 prevents the output of anything but
16266 I'd advise placing both commands in the preamble and initially comment both out.
16267 You can then preview your entire presentation as you write.
16268 When you're done writing,
16269 you can then uncomment one of the two to select what you want to print.
16270 I like to uncomment
16271 \begin_inset Quotes eld
16283 \begin_inset Quotes erd
16287 print to a file with
16288 \begin_inset Quotes eld
16296 \begin_inset Quotes erd
16300 comment it back out,
16302 \begin_inset Quotes eld
16314 \begin_inset Quotes erd
16318 \begin_inset Quotes eld
16326 \begin_inset Quotes erd
16330 I can then send either file to a printer,
16331 loading transparencies or plain paper as appropriate.
16334 \begin_layout Standard
16335 You can also provide other arguments to the
16336 \begin_inset Quotes eld
16346 \begin_inset Quotes erd
16350 \begin_inset Quotes eld
16360 \begin_inset Quotes erd
16364 See a good \SpecialChar LaTeX
16368 \begin_layout Subsubsection
16373 Class Template File
16376 \begin_layout Standard
16377 I have also provided a template file
16378 \change_deleted 564990737 1671617750
16381 \begin_inset Quotes eld
16389 \begin_inset Quotes erd
16401 begin your new presentation with
16403 File\SpecialChar menuseparator
16405 \begin_inset space ~
16409 \begin_inset space ~
16413 \change_inserted 564990737 1671616988
16414 \SpecialChar menuseparator
16415 Presentations\SpecialChar menuseparator
16421 Your new \SpecialChar LyX
16422 presentation file will contain an example
16443 additionally contain an example of the use of
16453 the preamble will contain:
16456 \begin_layout LyX-Code
16457 % Uncomment to print out only slides and overlays
16460 \begin_layout LyX-Code
16464 \begin_layout LyX-Code
16470 \begin_inset Newline newline
16476 \begin_layout LyX-Code
16477 % Uncomment to print out only notes
16480 \begin_layout LyX-Code
16484 \begin_layout LyX-Code
16492 \begin_layout Standard
16494 I created this class to support the \SpecialChar LaTeX2e
16496 \begin_inset Quotes eld
16501 Sli\SpecialChar TeX
16505 \begin_inset Quotes erd
16509 one of the built-in \SpecialChar LaTeX2e
16511 Neither I nor the rest of the \SpecialChar LyX
16512 Team endorse or oppose the use of this built-in slide class.
16513 It's here if you want it or need it.
16514 There exist other \SpecialChar LaTeX2e
16515 classes for creating presentations,
16517 \change_deleted -712698321 1673258708
16525 \change_deleted -712698321 1673258709
16527 \change_inserted -712698321 1673258699
16529 \change_deleted -712698321 1673258700
16533 \begin_inset space ~
16537 \begin_inset CommandInset ref
16539 reference "sec:foiltex"
16545 \change_deleted -712698321 1673258703
16547 \change_inserted -712698321 1673258705
16551 \change_deleted -712698321 1673258714
16553 \begin_inset Quotes eld
16561 \begin_inset Quotes erd
16564 package [present on some \SpecialChar TeX
16566 The latter is not yet supported under \SpecialChar LyX
16571 \begin_layout Plain Layout
16572 Perhaps you can take on the task\SpecialChar ldots
16579 \change_inserted -712698321 1673258738
16585 \begin_inset space ~
16589 \begin_inset CommandInset ref
16591 reference "subsec:Seminar"
16603 \change_deleted -712698321 1673258749
16604 I know nothing about these other classes.
16607 Try them out to see what sort of alternative they provide.
16610 \begin_layout Section
16612 \change_inserted 564990737 1670439661
16616 \begin_layout Subsection
16618 \change_inserted 564990737 1670439661
16622 \begin_layout Standard
16624 \change_inserted -712698321 1673689969
16625 Report classes are sort of a hybrid between book and article classes:
16628 \change_deleted -712698321 1673689899
16637 document class for preparing reports.
16644 \change_inserted 564990737 1670439661
16646 \change_deleted -712698321 1673689904
16648 \change_inserted 564990737 1670439661
16650 chapters and sections but does not provide
16651 \change_deleted -712698321 1673690062
16652 the paragraph styles needed for a book
16653 \change_inserted -712698321 1673690073
16657 \change_inserted 564990737 1670439661
16660 \change_deleted -712698321 1673690088
16666 \change_inserted -712698321 1673690083
16668 \change_inserted 564990737 1670439661
16670 \change_inserted -712698321 1673690085
16672 \change_inserted 564990737 1670439661
16675 \change_deleted -712698321 1673690094
16677 \change_inserted -712698321 1673690094
16679 \change_inserted 564990737 1670439661
16681 \change_deleted -712698321 1673690097
16683 \change_inserted 564990737 1670439661
16685 \change_deleted -712698321 1673690101
16687 \change_inserted 564990737 1670439661
16688 abstract paragraph style
16689 \change_inserted -712698321 1673690514
16690 s and are one-sided by default.
16692 \change_deleted -712698321 1673690134
16696 \change_inserted -712698321 1673690520
16699 \change_inserted 564990737 1670439661
16700 not start a new chapter on the right hand page
16701 \change_inserted -712698321 1673690150
16702 (even in two-side mode)
16703 \change_inserted 564990737 1670439661
16707 \begin_layout Standard
16709 \change_deleted -712698321 1673690173
16711 \change_inserted -712698321 1673690287
16712 All externally maintained
16713 \change_inserted 564990737 1672743528
16719 \change_inserted -712698321 1673690678
16720 that are officially supported by \SpecialChar LyX
16722 \change_inserted 564990737 1672743528
16723 are described in the Collections (section
16724 \begin_inset space ~
16728 \begin_inset CommandInset ref
16730 reference "sec:Collections"
16736 \change_inserted -712698321 1673690301
16738 \change_deleted -712698321 1673690300
16740 \change_inserted 564990737 1672743528
16744 \begin_layout Itemize
16746 \change_inserted 564990737 1672743530
16748 \change_deleted -712698321 1673690794
16752 \begin_inset space \thinspace{}
16755 (Japanese in vertical writing)
16756 \change_inserted -712698321 1675851188
16757 Japanese Report (Standard Class,
16759 \change_inserted 564990737 1672743530
16763 \change_deleted -712698321 1673690762
16767 \begin_inset space \thinspace{}
16771 \change_inserted -712698321 1673690762
16772 Japanese Report (Standard Class)
16773 \change_inserted 564990737 1672743530
16778 \begin_inset space ~
16782 \begin_inset CommandInset ref
16784 reference "subsec:Japanese"
16792 \begin_layout Itemize
16794 \change_inserted 564990737 1672743530
16796 \change_deleted -712698321 1673690718
16800 \begin_inset space \thinspace{}
16804 \change_inserted -712698321 1673690718
16806 \change_inserted 564990737 1672743530
16811 \begin_inset space ~
16815 \begin_inset CommandInset ref
16817 reference "subsec:KOMA-Script"
16825 \begin_layout Itemize
16827 \change_inserted 564990737 1672743530
16829 \change_deleted -712698321 1673690815
16833 \begin_inset space \thinspace{}
16836 (with extra font sizes)
16837 \change_inserted -712698321 1673690815
16838 Report (Standard Class with Extra Font Sizes)
16839 \change_inserted 564990737 1672743530
16844 \begin_inset space ~
16848 \begin_inset CommandInset ref
16850 reference "subsec:Extra-font-sizes"
16858 \begin_layout Itemize
16860 \change_inserted 564990737 1672743569
16862 \change_deleted -712698321 1673690833
16866 \begin_inset space \thinspace{}
16869 (Polish version by M.
16870 \begin_inset space \thinspace{}
16874 \change_inserted -712698321 1673690833
16875 Polish Report (MW Bundle)
16876 \change_inserted 564990737 1672743569
16881 \begin_inset space ~
16885 \begin_inset CommandInset ref
16887 reference "subsec:Polish-M.W.collection"
16898 \begin_layout Section
16900 \change_inserted 564990737 1670439674
16902 \change_deleted -712698321 1673691106
16904 \change_inserted -712698321 1673691108
16908 \begin_layout Standard
16910 \change_inserted -712698321 1673691276
16916 we assemble document classes that help to write drama or movie scripts.
16917 The category is also open for other scripts,
16918 such as lecture scripts,
16919 for which no classes are officially supported yet by \SpecialChar LyX
16921 \change_inserted 564990737 1670439674
16925 \begin_layout Subsection
16929 \begin_layout Standard
16935 \begin_layout Subsubsection
16939 \begin_layout Standard
16944 is for writing plays.
16945 The format is more decorative than
16948 \change_inserted -712698321 1673691568
16952 \begin_inset space ~
16956 \begin_inset CommandInset ref
16958 reference "subsec:Hollywood"
16965 and much less standardized.
16966 This format should be suitable for workshops.
16969 \begin_layout Subsubsection
16973 \begin_layout Standard
16977 \change_inserted -712698321 1673691609
16981 \begin_inset space ~
16985 \begin_inset CommandInset ref
16987 reference "subsec:Special-problems-Hollywood"
16996 \begin_layout Subsubsection
17000 \begin_layout Standard
17005 names as labels then cross-reference the label to insert the name.
17006 The cross-reference dialog will show the current cast of characters.
17009 \begin_layout Subsubsection
17010 Paper size and Margins
17013 \begin_layout Standard
17021 \begin_layout Subsubsection
17025 \begin_layout Standard
17026 The following environments are available.
17031 to get the bind keys shown at the right.
17034 \begin_layout Itemize
17038 \begin_inset Newline newline
17043 You should not have to use this,
17044 but it is here for anything that does not fit otherwise.
17047 \begin_layout Itemize
17051 \begin_inset space \hfill{}
17055 \begin_inset Newline newline
17060 Used to describe stage setting and the action.
17061 First use of speaker names in all CAPs.
17064 \begin_layout Itemize
17068 \begin_inset space \hfill{}
17072 \begin_inset Newline newline
17077 Automatically numbered.
17078 On screen it will be arabic,
17079 but will print as Roman.
17082 \begin_layout Itemize
17086 \begin_inset space \hfill{}
17090 \begin_inset Newline newline
17100 It is just centered text.
17103 \begin_layout Itemize
17107 \begin_inset space \hfill{}
17111 \begin_inset Newline newline
17116 Not automatically numbered.
17117 You supply the number.
17118 This is because I couldn't figure out how.
17121 \begin_layout Itemize
17125 \begin_inset space \hfill{}
17129 \begin_inset Newline newline
17134 A special case of Narrative to describe the setting and action as the curtain rises.
17137 \begin_layout Itemize
17141 \begin_inset space \hfill{}
17145 \begin_inset Newline newline
17150 The speaker's (actor's) title,
17151 centered in all CAPS.
17154 \begin_layout Itemize
17158 \begin_inset space \hfill{}
17162 \begin_inset Newline newline
17167 Instructions to the speaker.
17168 The parentheses are automatically inserted.
17169 The ( will appear on screen,
17170 but both will be in the printed play.
17171 This environment is only used within
17178 \begin_layout Itemize
17182 \begin_inset space \hfill{}
17186 \begin_inset Newline newline
17191 What the Speaker says.
17194 \begin_layout Itemize
17198 \begin_inset space \hfill{}
17202 \begin_inset Newline newline
17207 The curtain comes down.
17210 \begin_layout Itemize
17214 \begin_inset space \hfill{}
17220 \begin_layout Itemize
17224 \begin_inset space \hfill{}
17230 \begin_layout Itemize
17234 \begin_inset space \hfill{}
17240 \begin_layout Standard
17244 \begin_layout Subsection
17246 \change_inserted -712698321 1673691551
17247 \begin_inset CommandInset label
17249 name "subsec:Hollywood"
17255 Hollywood (Hollywood spec scripts)
17258 \begin_layout Standard
17264 \begin_layout Subsubsection
17268 \begin_layout Standard
17269 Getting the format of a Hollywood script right is a
17270 \begin_inset Quotes eld
17274 \begin_inset Quotes erd
17277 It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
17278 Each page of a script should be one minute of film.
17279 Nothing goes in a script that you cannot see or hear on screen.
17280 The courier 12 pt font should be used throughout.
17284 \begin_layout Subsubsection
17286 \change_inserted -712698321 1673691597
17287 \begin_inset CommandInset label
17289 name "subsec:Special-problems-Hollywood"
17298 \begin_layout Standard
17299 Speakers' lines should
17300 \change_deleted -712698321 1673691805
17304 \change_inserted -712698321 1673691805
17309 break in mid-sentence.
17310 If a speaker's lines continue over a page break,
17315 title followed by (Cont'd).
17318 \begin_layout Subsubsection
17322 \begin_layout Standard
17327 names as labels then cross-reference the label to insert the name.
17328 The cross-reference dialog will show the current cast of characters.
17329 You can use this to insert the speaker name in narratives also.
17332 \begin_layout Subsubsection
17333 Paper size and Margins
17336 \begin_layout Standard
17344 \begin_layout Subsubsection
17348 \begin_layout Standard
17349 The following environments are available.
17354 to get the bind keys shown at the right.
17357 \begin_layout Itemize
17361 \begin_inset Newline newline
17366 Used where nothing else works.
17370 \begin_layout Itemize
17376 \begin_inset space \hfill{}
17384 \begin_inset Newline newline
17387 Usually followed by something like
17388 \begin_inset Quotes eld
17391 on Sally waking up.
17392 \begin_inset Quotes erd
17398 \begin_layout Itemize
17402 \begin_inset space \hfill{}
17406 \begin_inset Newline newline
17411 Introduces a new INTERIOR camera set-up.
17412 Always followed by DAY or NIGHT,
17413 or something similar to define the lighting required.
17414 Everthing on this line in CAPS.
17417 \begin_layout Itemize
17421 \begin_inset space \hfill{}
17425 \begin_inset Newline newline
17430 Introduces a new EXTERIOR camera set-up.
17431 Everthing on this line in CAPS.
17434 \begin_layout Itemize
17438 \begin_inset space \hfill{}
17442 \begin_inset Newline newline
17447 The character speaking.
17450 \begin_layout Itemize
17454 \begin_inset space \hfill{}
17458 \begin_inset Newline newline
17463 Instructions to the speaker.
17464 The () are automatically inserted.
17467 \begin_layout Itemize
17471 \begin_inset space \hfill{}
17475 \begin_inset Newline newline
17487 \begin_layout Itemize
17491 \begin_inset space \hfill{}
17495 \begin_inset Newline newline
17500 Camera movement instruction.
17502 \begin_inset space \thinspace{}
17506 \begin_inset space \space{}
17512 \begin_layout Itemize
17516 \begin_inset space \hfill{}
17522 \begin_layout Itemize
17526 \begin_inset space \hfill{}
17532 \begin_layout Itemize
17536 \begin_inset space \hfill{}
17542 \begin_layout Itemize
17546 \begin_inset space \hfill{}
17552 \begin_layout Subsubsection
17556 \begin_layout Itemize
17561 \begin_layout Itemize
17566 \begin_layout Itemize
17568 \begin_inset space \thinspace{}
17576 \begin_layout Itemize
17582 \begin_layout Itemize
17587 \begin_layout Itemize
17592 \begin_layout Chapter
17594 \change_inserted 564990737 1671185876
17598 \begin_layout Section
17600 \change_inserted 564990737 1671716212
17601 Academic Field Specifics
17604 \begin_layout Subsection
17606 \change_inserted 564990737 1671716212
17608 Hazard and Precautionary Statements
17611 \begin_layout Standard
17613 \change_inserted 564990737 1671716212
17614 This module provides two insets
17615 \change_inserted -712698321 1673779038
17616 and a paragraph style
17617 \change_inserted 564990737 1671716212
17618 to typeset numbers and phrases of chemical hazard and precautionary statements.
17619 For a description see
17621 File\SpecialChar menuseparator
17622 Open Example\SpecialChar menuseparator
17623 Modules\SpecialChar menuseparator
17624 Hazard and Precautionary Statements
17628 Help\SpecialChar menuseparator
17629 Specific Manuals\SpecialChar menuseparator
17630 Hazard and Precautionary Statements
17635 \begin_layout Subsection
17637 \change_inserted 564990737 1671716212
17641 Risk and Safety Statements
17644 \begin_layout Standard
17646 \change_inserted 564990737 1671716212
17647 This module provides two insets,
17657 accessible via the menu
17662 nsert\SpecialChar menuseparator
17664 \begin_inset space ~
17669 and an environment to typeset numbers and phrases of chemical risk and safety statements.
17672 \begin_layout Subsection
17674 \change_inserted 564990737 1671716212
17678 \begin_layout Standard
17680 \change_inserted 564990737 1671716212
17682 \change_deleted -712698321 1673779847
17688 \change_inserted -712698321 1673779869
17690 \change_inserted 564990737 1671716212
17691 environments useful for linguistics (numbered examples,
17695 \change_inserted -712698321 1673779891
17697 \change_inserted 564990737 1671716212
17699 You can obtain information about this module in
17704 elp\SpecialChar menuseparator
17710 \begin_inset space ~
17713 Manuals\SpecialChar menuseparator
17722 File\SpecialChar menuseparator
17723 Open Example\SpecialChar menuseparator
17724 Modules\SpecialChar menuseparator
17730 \begin_layout Section
17732 \change_inserted 564990737 1671788778
17736 \begin_layout Subsection
17738 \change_inserted 564990737 1671788778
17742 \begin_layout Standard
17744 \change_inserted 564990737 1671788778
17745 This module supports the Braille
17746 \change_deleted -712698321 1673779995
17748 \change_inserted -712698321 1673779996
17750 \change_inserted 564990737 1671788778
17752 It requires the \SpecialChar LaTeX
17758 This and its documentation can be obtained from
17759 \begin_inset CommandInset href
17762 target "https://www.ctan.org/pkg/braille"
17769 \change_deleted -712698321 1673780105
17770 You do not have to reconfigure your system after installing it.
17772 \change_inserted 564990737 1671788778
17778 elp\SpecialChar menuseparator
17784 \begin_inset space ~
17787 Manuals\SpecialChar menuseparator
17796 File\SpecialChar menuseparator
17797 Open Example\SpecialChar menuseparator
17798 Modules\SpecialChar menuseparator
17804 \begin_layout Section
17806 \change_inserted 564990737 1671788778
17807 Annotation & Revision
17810 \begin_layout Subsection
17812 \change_inserted 564990737 1671788778
17816 \begin_layout Standard
17818 \change_inserted 564990737 1671788778
17819 This module provides “FiXme” (marginal) annotations for document revision purposes.
17820 A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
17821 The annotations are customizable via the LaTeX preamble.
17823 \change_inserted -712698321 1673780478
17827 \change_deleted -712698321 1673780479
17829 \change_inserted 564990737 1671788778
17832 documentation which can be obtained from
17833 \begin_inset CommandInset href
17836 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
17845 \begin_layout Paragraph
17847 \change_inserted 564990737 1671788778
17851 \begin_layout Standard
17853 \change_inserted 564990737 1671788778
17855 the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
17857 Document\SpecialChar menuseparator
17858 Settings\SpecialChar menuseparator
17859 Document Class\SpecialChar menuseparator
17860 Class Options\SpecialChar menuseparator
17864 To display them always,
17873 Document\SpecialChar menuseparator
17874 Settings\SpecialChar menuseparator
17882 \begin_layout Subsection
17884 \change_inserted 564990737 1671788778
17888 \begin_layout Standard
17890 \change_inserted 564990737 1671788778
17891 This module provides various kinds of annotations for PDF output.
17894 Help\SpecialChar menuseparator
17895 Specific Manuals\SpecialChar menuseparator
17900 File\SpecialChar menuseparator
17901 Open Example\SpecialChar menuseparator
17902 Modules\SpecialChar menuseparator
17908 \begin_layout Subsection
17910 \change_inserted 564990737 1671788778
17916 \begin_layout Standard
17918 \change_inserted 564990737 1671788778
17919 This module provides fields and buttons for PDF forms.
17921 \begin_inset CommandInset href
17923 name "hyperref documentation"
17924 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
17932 Help\SpecialChar menuseparator
17933 Specific Manuals\SpecialChar menuseparator
17938 File\SpecialChar menuseparator
17939 Open Example\SpecialChar menuseparator
17940 Modules\SpecialChar menuseparator
17946 \begin_layout Subsection
17948 \change_inserted 564990737 1671788778
17954 \begin_layout Standard
17956 \change_inserted 564990737 1671788778
17957 This module defines an inset to typeset reading aids (ruby,
17958 furigana) to Chinese characters.
17960 \change_deleted -712698321 1673781076
17962 \change_inserted 564990737 1671788778
17968 \change_deleted -712698321 1673781078
17970 \change_inserted 564990737 1671788778
17972 \change_deleted -712698321 1673781079
17974 \change_inserted 564990737 1671788778
17978 \change_deleted -712698321 1673781080
17982 \change_inserted 564990737 1671788778
17984 \change_deleted -712698321 1673781082
17986 \change_inserted 564990737 1671788778
17990 \change_deleted -712698321 1673781083
17994 \change_inserted 564990737 1671788778
17995 package (depending on the TeX engine) or a fallback definition.
17999 \begin_layout Subsection
18001 \change_inserted 564990737 1671788778
18007 \begin_layout Standard
18009 \change_inserted 564990737 1671788778
18010 This module provides custom insets to insert TODO items in your document.
18011 In order to generate a “List of TODOs,” the module provides a paragraph style.
18013 \change_deleted -712698321 1673781223
18015 \change_inserted 564990737 1671788778
18019 \change_deleted -712698321 1673781224
18023 \change_inserted 564990737 1671788778
18026 Document\SpecialChar menuseparator
18027 Settings\SpecialChar menuseparator
18028 Document Class\SpecialChar menuseparator
18029 Class Options\SpecialChar menuseparator
18032 ) suppresses the output of TODO notes.
18034 \begin_inset CommandInset href
18036 name "todonotes documentation"
18037 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
18045 \begin_layout Section
18047 \change_inserted 564990737 1671829045
18051 \begin_layout Subsection
18053 \change_inserted 564990737 1671829045
18055 \change_deleted -712698321 1673781454
18057 \change_inserted -712698321 1673781454
18059 \change_inserted 564990737 1671829045
18063 \begin_layout Standard
18065 \change_inserted 564990737 1671829045
18066 This module adds support for using natbib together with apacite (the bibliography style need not be
18081 or any bibliography that works with both the natbib and apacite packages.)
18084 \begin_layout Section
18086 \change_inserted 564990737 1671829045
18090 \begin_layout Subsection
18092 \change_inserted 564990737 1671829045
18093 Fancy Colored Boxes
18096 \begin_layout Standard
18098 \change_inserted 564990737 1671829045
18099 This module adds ten custom insets that support colored boxes via the
18106 Help\SpecialChar menuseparator
18107 Specific Manuals\SpecialChar menuseparator
18113 File\SpecialChar menuseparator
18114 Open Example\SpecialChar menuseparator
18115 Modules\SpecialChar menuseparator
18119 \change_inserted -712698321 1673854244
18121 \change_inserted 564990737 1671829045
18123 \begin_inset CommandInset href
18125 name "tcolorbox documentation"
18126 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
18135 \begin_layout Subsection
18137 \change_inserted 564990737 1671829045
18141 \begin_layout Standard
18143 \change_inserted 564990737 1671829045
18144 This provides the custom insets
18162 to scale and rotate its content.
18165 \begin_layout Standard
18167 \change_inserted 564990737 1671829045
18172 is a simple way of reversing text without any other enhancement:
18175 \begin_layout Standard
18177 \change_inserted 564990737 1671829045
18178 \begin_inset Flex Reflectbox
18181 \begin_layout Plain Layout
18183 \change_inserted 564990737 1671829045
18184 Great Western Railway
18194 \begin_layout Standard
18196 \change_inserted 564990737 1671829045
18197 (You will need to use Ctrl-R to see any of these examples.)
18200 \begin_layout Standard
18202 \change_inserted 564990737 1671829045
18207 allows you to specify the dimensions of the text or image;
18208 permissible units are em,
18230 it scales by the width factor:
18233 \begin_layout Standard
18235 \change_inserted 564990737 1671829045
18236 \begin_inset Flex Resizebox
18239 \begin_layout Plain Layout
18241 \change_inserted 564990737 1671829045
18242 \begin_inset Argument 1
18245 \begin_layout Plain Layout
18247 \change_inserted 564990737 1671829045
18256 \begin_inset Argument 2
18259 \begin_layout Plain Layout
18261 \change_inserted 564990737 1671829045
18269 Great Western Railway
18279 \begin_layout Standard
18281 \change_inserted 564990737 1671829045
18286 allows you to rotate
18287 \change_deleted -712698321 1673856297
18289 \change_inserted -712698321 1673856302
18291 \change_inserted 564990737 1671829045
18292 around the reference point of the box.
18293 If you wish to rotate the box around a different origin,
18294 place the cursor inside the box and select Insert\SpecialChar menuseparator
18324 or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
18328 \begin_layout Standard
18330 \change_inserted 564990737 1671829045
18331 \begin_inset Flex Rotatebox
18334 \begin_layout Plain Layout
18336 \change_inserted 564990737 1671829045
18337 \begin_inset Argument 1
18340 \begin_layout Plain Layout
18342 \change_inserted 274215730 1672888693
18344 \change_inserted 564990737 1671829045
18353 \begin_inset Argument 2
18356 \begin_layout Plain Layout
18358 \change_inserted 564990737 1671829045
18366 Great Western Railway
18376 \begin_layout Standard
18378 \change_inserted 564990737 1671829045
18379 You can combine boxes as in:
18382 \begin_layout Standard
18384 \change_inserted 564990737 1671829045
18385 \begin_inset Flex Rotatebox
18388 \begin_layout Plain Layout
18390 \change_inserted 564990737 1671829045
18391 \begin_inset Argument 1
18394 \begin_layout Plain Layout
18396 \change_inserted 274215730 1672888702
18398 \change_inserted 564990737 1671829045
18407 \begin_inset Argument 2
18410 \begin_layout Plain Layout
18412 \change_inserted 564990737 1671829045
18421 \begin_inset Flex Resizebox
18424 \begin_layout Plain Layout
18426 \change_inserted 564990737 1671829045
18427 \begin_inset Argument 1
18430 \begin_layout Plain Layout
18432 \change_inserted 564990737 1671829045
18441 \begin_inset Argument 2
18444 \begin_layout Plain Layout
18446 \change_inserted 564990737 1671829045
18455 \begin_inset Flex Reflectbox
18458 \begin_layout Plain Layout
18460 \change_inserted 564990737 1671829045
18461 Great Western Railway
18485 \begin_layout Standard
18487 \change_inserted 564990737 1671829045
18493 \change_deleted -712698321 1673856306
18495 \change_inserted -712698321 1673856308
18497 \change_inserted 564990737 1671829045
18499 select Insert\SpecialChar menuseparator
18500 V-Factor to add a vertical factor.
18501 If the vertical factor is omitted,
18502 the horizontal is used.
18503 Adding different horizontal and vertical values creates distortion as in
18506 \begin_layout Standard
18508 \change_inserted 564990737 1671829045
18511 \begin_inset Flex Scalebox
18514 \begin_layout Plain Layout
18516 \change_inserted 564990737 1671829045
18517 \begin_inset Argument 1
18520 \begin_layout Plain Layout
18522 \change_inserted 564990737 1671829045
18531 \begin_inset Argument 2
18534 \begin_layout Plain Layout
18536 \change_inserted 564990737 1671829045
18546 Great Western Railway
18556 \begin_layout Standard
18558 \change_inserted 564990737 1671829045
18559 A negative horizontal value reverses the text
18560 \change_inserted -712698321 1673856686
18561 on the horizontal axis,
18563 \change_deleted -712698321 1673856688
18565 \change_inserted 564990737 1671829045
18566 a negative vertical value
18567 \change_deleted -712698321 1673856694
18569 \change_inserted -712698321 1673856702
18570 on the vertical axis,
18572 \change_inserted 564990737 1671829045
18574 \change_deleted -712698321 1673856704
18576 \change_inserted 564990737 1671829045
18580 \begin_layout Standard
18582 \change_inserted 564990737 1671829045
18583 \begin_inset Flex Scalebox
18586 \begin_layout Plain Layout
18588 \change_inserted 564990737 1671829045
18589 \begin_inset Argument 1
18592 \begin_layout Plain Layout
18594 \change_inserted 564990737 1671829045
18603 \begin_inset Argument 2
18606 \begin_layout Plain Layout
18608 \change_inserted 564990737 1671829045
18616 Great Western Railway
18624 \begin_inset Flex Scalebox
18627 \begin_layout Plain Layout
18629 \change_inserted 564990737 1671829045
18630 \begin_inset Argument 1
18633 \begin_layout Plain Layout
18635 \change_inserted 564990737 1671829045
18644 \begin_inset Argument 2
18647 \begin_layout Plain Layout
18649 \change_inserted 564990737 1671829045
18657 Great Western Railway
18667 \begin_layout Subsection
18669 \change_inserted 564990737 1671884699
18673 \begin_layout Standard
18675 \change_inserted 564990737 1671884699
18676 This module defines Boxes with section header.
18677 It is mainly intended for the SciPoster Document class.
18681 \begin_layout Subsection
18683 \change_inserted 564990737 1671884699
18684 Variable-width Minipages
18687 \begin_layout Standard
18689 \change_inserted 564990737 1671884699
18693 \begin_inset space \thinspace{}
18700 Insert\SpecialChar menuseparator
18712 package provides a variable-width minipage,
18713 whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
18714 The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
18716 Insert\SpecialChar menuseparator
18718 \begin_inset space \thinspace{}
18729 Insert\SpecialChar menuseparator
18731 \begin_inset space \thinspace{}
18745 File\SpecialChar menuseparator
18746 Open Example\SpecialChar menuseparator
18747 Variable-width Minipages
18753 \begin_layout Section
18755 \change_inserted 564990737 1671884699
18759 \begin_layout Subsection
18761 \change_inserted 564990737 1671884699
18762 Fix Computer Modern Fonts
18765 \begin_layout Standard
18767 \change_inserted 564990737 1671884699
18768 This module uses the
18772 package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
18774 \begin_inset CommandInset href
18776 name "fix-cm documentation"
18777 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
18786 \begin_layout Subsection
18788 \change_inserted 564990737 1671884699
18790 Kernel Fixes (Obsolete)
18793 \begin_layout Standard
18795 \change_inserted 564990737 1671884699
18796 This module loads the \SpecialChar LaTeX
18801 which contains some bug fixes for \SpecialChar LaTeX
18803 If you use this module your typeset document may look different when you process it,
18804 depending on the respective version of
18812 \begin_layout Paragraph
18814 \change_inserted 564990737 1671884699
18818 \begin_layout Standard
18820 \change_inserted 564990737 1671884699
18821 recent \SpecialChar LaTeX
18822 kernels (as of 2015/01/01) include the functionality of
18831 module is obsolete with newer \SpecialChar LaTeX
18834 \change_deleted -712698321 1673857809
18836 \change_inserted 564990737 1671884699
18840 \begin_layout Subsection
18842 \change_inserted 564990737 1671884699
18843 Minimalistic Insets
18846 \begin_layout Standard
18848 \change_inserted 564990737 1671884699
18849 This module redefines several insets (Index,
18851 URL) as being Minimalistic.
18854 \begin_layout Subsection
18856 \change_inserted 564990737 1671884699
18857 Title and Preamble Hacks
18860 \begin_layout Standard
18862 \change_inserted 564990737 1671884699
18863 This module provides two new paragraph styles:
18867 \begin_layout Enumerate
18869 \change_inserted 564990737 1671884699
18874 which puts whatever is entered into it into the preamble.
18877 to include preamble code in the body of a LyX document.
18881 \begin_layout Enumerate
18883 \change_inserted 564990737 1671884699
18888 which that will put its contents into the body of the LaTeX document,
18896 This is useful for making branches and notes in title-related material.
18898 if you put these in a
18903 this signals to LyX to output
18910 which may then come too early.)
18913 \begin_layout Section
18915 \change_inserted 564990737 1672081439
18919 \begin_layout Subsection
18921 \change_inserted 564990737 1672081439
18925 \begin_layout Standard
18927 \change_inserted 564990737 1672081439
18928 This module uses the
18932 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
18933 Use the Algorithm paragraph style to enter and indent the algorithm.
18935 \begin_inset CommandInset href
18937 name "algorithm2e documentation"
18938 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
18946 \begin_layout Subsection
18948 \change_inserted 564990737 1672081439
18949 Bilingual Captions AKA Multilingual Captions
18952 \begin_layout Standard
18954 \change_inserted 564990737 1672081439
18955 This module provides the paragraph style
18958 \begin_inset space ~
18963 with which to typeset
18964 \change_deleted -712698321 1673859156
18966 \change_inserted -712698321 1673859156
18968 \change_inserted 564990737 1672081439
18970 Within this paragraph style
18972 Insert\SpecialChar menuseparator
18975 allows you to enter the desired
18976 \change_inserted -712698321 1673859387
18978 \change_inserted 564990737 1672081439
18979 language using one of the babel names.
18982 File\SpecialChar menuseparator
18983 Open Example\SpecialChar menuseparator
18985 \change_inserted -712698321 1673859558
18986 Modules\SpecialChar menuseparator
18988 \change_inserted 564990737 1672081439
18989 Multilingual Captions
18993 Help\SpecialChar menuseparator
18994 Specific Manuals\SpecialChar menuseparator
18995 Multilingual Captions
18997 further information on its use.
19000 \begin_layout Subsection
19002 \change_inserted 564990737 1672081439
19003 Number Figures by Section
19006 \begin_layout Standard
19008 \change_inserted 564990737 1672081439
19009 This module resets the figure number at section start and prepends the section number to the figure number,
19010 as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
19013 \begin_layout Subsection
19015 \change_inserted 564990737 1672081439
19016 Number Tables by Section
19019 \begin_layout Standard
19021 \change_inserted 564990737 1672081439
19022 This module resets the table number at section start and prepends the section number to the table number,
19023 as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
19026 \begin_layout Section
19028 \change_inserted 564990737 1672081439
19032 \begin_layout Subsection
19034 \change_inserted 564990737 1672081439
19038 \begin_layout Standard
19040 \change_inserted 564990737 1672081439
19041 This module adds an endnote inset,
19042 in addition to footnotes.
19048 which has some limitations but works with older
19049 \change_deleted -712698321 1673861636
19051 \change_inserted -712698321 1673861636
19054 \change_inserted 564990737 1672081439
19055 distributions as well.
19058 Insert\SpecialChar menuseparator
19059 Custom Inset\SpecialChar menuseparator
19062 to insert an endnote and
19064 Insert\SpecialChar menuseparator
19065 List/Contents/References\SpecialChar menuseparator
19068 to insert the endnotes list where you want the endnotes to appear.
19071 Help\SpecialChar menuseparator
19073 \change_deleted -712698321 1673861792
19074 \SpecialChar menuseparator
19076 \change_inserted 564990737 1672081439
19078 \change_deleted -712698321 1673861963
19079 \SpecialChar menuseparator
19080 Notes\SpecialChar menuseparator
19082 \change_inserted -712698321 1673861963
19089 \change_inserted 564990737 1672081439
19095 \begin_layout Subsection
19097 \change_inserted 564990737 1672081439
19098 Endnotes (Extended)
19101 \begin_layout Standard
19103 \change_inserted 564990737 1672081439
19104 This module adds an endnote inset,
19105 in addition to footnotes.
19110 package which is more powerful and customizable than the
19115 but requires a fairly modern
19116 \change_deleted -712698321 1673861643
19118 \change_inserted -712698321 1673861643
19121 \change_inserted 564990737 1672081439
19123 \change_deleted -712698321 1673861645
19125 \change_inserted -712698321 1673861645
19128 \change_inserted 564990737 1672081439
19132 Insert\SpecialChar menuseparator
19133 Custom Inset\SpecialChar menuseparator
19136 to insert an endnote and
19138 Insert\SpecialChar menuseparator
19139 List/Contents/References\SpecialChar menuseparator
19142 to insert the endnotes list where you want the endnotes to appear.
19145 Help\SpecialChar menuseparator
19147 \change_deleted -712698321 1673861798
19148 \SpecialChar menuseparator
19150 \change_inserted 564990737 1672081439
19152 \change_inserted -712698321 1673861924
19161 \change_deleted -712698321 1673861927
19164 \SpecialChar menuseparator
19165 Notes\SpecialChar menuseparator
19167 \change_inserted 564990737 1672081439
19173 \begin_layout Subsection
19175 \change_inserted 564990737 1672081439
19176 Footnotes as Endnotes (Basic)
19179 \begin_layout Standard
19181 \change_inserted 564990737 1672081439
19182 This module sets all footnotes as endnotes.
19188 which has some limitations but works with older
19189 \change_deleted -712698321 1673861650
19191 \change_inserted -712698321 1673861650
19194 \change_inserted 564990737 1672081439
19195 distributions as well.
19198 Insert\SpecialChar menuseparator
19199 List/Contents/References\SpecialChar menuseparator
19202 to insert the endnotes list where you want the endnotes to appear.
19205 Help\SpecialChar menuseparator
19207 \change_deleted -712698321 1673861805
19208 \SpecialChar menuseparator
19210 \change_inserted 564990737 1672081439
19212 \change_deleted -712698321 1673861947
19213 \SpecialChar menuseparator
19214 Notes\SpecialChar menuseparator
19216 \change_inserted -712698321 1673861947
19223 \change_inserted 564990737 1672081439
19229 \begin_layout Subsection
19231 \change_inserted 564990737 1672081439
19232 Footnotes as Endnotes (Extended)
19235 \begin_layout Standard
19237 \change_inserted 564990737 1672081439
19238 This module sets all footnotes as endnotes.
19243 package which is more powerful and customizable than then
19248 but requires a fairly modern
19249 \change_deleted -712698321 1673861654
19251 \change_inserted -712698321 1673861654
19254 \change_inserted 564990737 1672081439
19256 \change_deleted -712698321 1673861656
19258 \change_inserted -712698321 1673861656
19261 \change_inserted 564990737 1672081439
19265 Insert\SpecialChar menuseparator
19266 List/Contents/References\SpecialChar menuseparator
19269 to insert the endnotes list where you want the endnotes to appear.
19272 Help\SpecialChar menuseparator
19274 \change_deleted -712698321 1673861808
19275 \SpecialChar menuseparator
19277 \change_inserted 564990737 1672081439
19279 \change_deleted -712698321 1673861955
19280 \SpecialChar menuseparator
19281 Notes\SpecialChar menuseparator
19283 \change_inserted -712698321 1673861989
19292 \change_deleted -712698321 1673861956
19294 \change_inserted 564990737 1672081439
19298 \begin_layout Section
19300 \change_inserted 564990737 1672081439
19305 \begin_layout Subsection
19307 \change_inserted 564990737 1672081439
19311 \begin_layout Standard
19313 \change_inserted 564990737 1672081439
19314 This module provides support for the
19318 package to print chess games.
19321 File\SpecialChar menuseparator
19322 Open Example\SpecialChar menuseparator
19323 Articles\SpecialChar menuseparator
19326 where you will find
19335 \begin_inset CommandInset href
19337 name "chessboard documentation"
19338 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
19346 \begin_layout Subsection
19348 \change_inserted 564990737 1672081439
19349 Lilypond Music Notation
19352 \begin_layout Standard
19354 \change_inserted 564990737 1672081439
19355 This module provides an inset via
19360 nsert\SpecialChar menuseparator
19361 Custom Inset\SpecialChar menuseparator
19364 in which to enter code for the LilyPond music editor.
19365 It will then be processed in the output.
19368 Help\SpecialChar menuseparator
19369 Specific Manuals\SpecialChar menuseparator
19374 File\SpecialChar menuseparator
19375 Open Example\SpecialChar menuseparator
19376 Modules\SpecialChar menuseparator
19380 It cannot be used if the modules
19383 \begin_inset space \thinspace{}
19395 \begin_layout Section
19397 \change_inserted 564990737 1672138150
19401 \begin_layout Subsection
19403 \change_inserted 564990737 1672138150
19405 \begin_inset CommandInset label
19407 name "subsec:Customizable-Lists"
19414 \begin_layout Standard
19416 \change_inserted 564990737 1672138150
19417 This module uses the
19421 package to enable the customization of various list environments.
19424 \begin_layout Subsubsection
19426 \change_inserted 564990737 1672138150
19427 Custom Enumerate Lists
19430 \begin_layout Standard
19433 \change_inserted 564990737 1672138150
19434 The default numbering of numbered lists can be changed by adding an optional argument (menu
19439 nsert\SpecialChar menuseparator
19446 ) to the first item of each level in the list.
19447 There you add the command
19450 \begin_layout Standard
19452 \change_inserted 564990737 1672138150
19460 \begin_layout Standard
19462 \change_inserted 564990737 1672138150
19463 in \SpecialChar TeX
19473 \begin_layout Standard
19475 \change_inserted 564990737 1672138150
19480 is the first level counter of the enumeration.
19481 To change the numbering for the list sublevels,
19486 ” in the command by the small Roman numeral of the level (
19508 \begin_layout Standard
19510 \change_inserted 564990737 1672138150
19517 outputs the counter as a small Roman numeral.
19518 For capital Roman numerals replace
19530 in the command above.
19531 For Arabic numerals use
19539 \begin_inset Quotes eld
19543 \begin_inset Quotes erd
19546 items with capital or small Latin letters use
19562 \begin_layout Standard
19565 \change_inserted 564990737 1672138150
19566 \begin_inset Note Greyedout
19569 \begin_layout Plain Layout
19571 \change_inserted 564990737 1672138150
19577 You can only number 26
19578 \begin_inset space ~
19581 items with Latin letters,
19582 because this numbering is limited to single letters.
19590 \begin_layout Standard
19592 \change_inserted 564990737 1672138150
19593 Here is a list with custom numbering:
19596 \begin_layout Enumerate
19598 \change_inserted 564990737 1672138150
19599 \begin_inset Argument 1
19602 \begin_layout Plain Layout
19604 \change_inserted 564990737 1672138150
19608 \begin_layout Plain Layout
19610 \change_inserted 564990737 1672138150
19631 \begin_inset Separator latexpar
19638 \begin_layout Enumerate
19640 \change_inserted 564990737 1672138150
19641 \begin_inset Argument 1
19644 \begin_layout Plain Layout
19646 \change_inserted 564990737 1672138150
19650 \begin_layout Plain Layout
19652 \change_inserted 564990737 1672138150
19673 \begin_layout Enumerate
19675 \change_inserted 564990737 1672138150
19677 \begin_inset Separator latexpar
19684 \begin_layout Enumerate
19686 \change_inserted 564990737 1672138150
19687 \begin_inset Argument 1
19690 \begin_layout Plain Layout
19692 \change_inserted 564990737 1672138150
19696 \begin_layout Plain Layout
19698 \change_inserted 564990737 1672138150
19701 \change_deleted 274215730 1672889016
19705 \change_inserted 274215730 1672889016
19709 \change_inserted 564990737 1672138150
19725 \begin_inset Separator latexpar
19732 \begin_layout Enumerate
19734 \change_inserted 564990737 1672138150
19735 \begin_inset Argument 1
19738 \begin_layout Plain Layout
19740 \change_inserted 564990737 1672138150
19744 \begin_layout Plain Layout
19746 \change_inserted 564990737 1672138150
19770 \begin_layout Standard
19772 \change_inserted 564990737 1672138150
19773 For this list these commands were used:
19776 \begin_layout Standard
19779 \change_inserted 564990737 1672138150
19789 \begin_inset Newline newline
19797 \begin_inset Newline newline
19801 \change_deleted 274215730 1672889037
19805 \change_inserted 274215730 1672889037
19809 \change_inserted 564990737 1672138150
19813 \begin_inset Newline newline
19823 \begin_layout Standard
19825 \change_inserted 564990737 1672138150
19832 makes the label emphasized and
19833 \change_deleted 274215730 1672889045
19839 \change_inserted 274215730 1672889046
19843 \change_inserted 564990737 1672138150
19849 \begin_layout Standard
19851 \change_inserted 564990737 1672138150
19852 \begin_inset Note Greyedout
19855 \begin_layout Plain Layout
19857 \change_inserted 564990737 1672138150
19863 When you change the label of a list level,
19864 it will be used for all following lists until you change the definition.
19872 \begin_layout Standard
19874 \change_inserted 564990737 1672138150
19878 \begin_layout Plain Layout
19880 \change_inserted 564990737 1672138150
19898 \begin_layout Subsubsection
19900 \change_inserted 564990737 1672138150
19901 Numbered Paragraphs in Reports
19904 \begin_layout Enumerate
19906 \change_inserted 564990737 1672138213
19907 Official reports often include numbered paragraphs;
19908 you can achieve this with a variation on the approach outlined in
19909 \change_deleted -712698321 1674916429
19911 \change_inserted 564990737 1672138213
19913 \change_deleted -712698321 1674916431
19915 \change_inserted -712698321 1674916432
19917 \change_inserted 564990737 1672138213
19919 \begin_inset space ~
19923 \change_inserted -712698321 1674916425
19925 \begin_inset CommandInset ref
19927 reference "sec:How-to-use"
19932 \change_deleted -712698321 1674916426
19934 \begin_inset CommandInset ref
19936 reference "fn:If-you-really"
19945 \change_inserted 564990737 1672138213
19951 in each command with
19958 \begin_layout Enumerate
19960 \change_inserted 564990737 1672138150
19961 These numbered paragraphs were generated by inserting the \SpecialChar TeX
19963 \begin_inset Separator latexpar
19970 \begin_layout Standard
19972 \change_inserted 564990737 1672138150
19986 \begin_layout Standard
19988 \change_inserted 564990737 1672138150
19989 before the start of the section;
19996 uses the \SpecialChar LaTeX
19997 section counter to generate the first part of the number.
20001 \begin_layout Enumerate
20003 \change_inserted 564990737 1672138150
20004 I have ignored the subsection heading in this example because,
20005 with paragraphs numbered in this way,
20006 subsections are less likely to be used.
20009 \begin_layout Subsubsection
20011 \change_inserted 564990737 1672138150
20012 Resumed Enumeration
20015 \begin_layout Standard
20017 \change_inserted 564990737 1672138150
20021 \begin_layout Plain Layout
20023 \change_inserted 564990737 1672138150
20039 \begin_layout Standard
20041 \change_inserted 564990737 1672138150
20042 Enumerations can be resumed after intermediate paragraphs:
20045 \begin_layout Enumerate
20047 \change_inserted 564990737 1672138150
20048 \begin_inset Argument 1
20051 \begin_layout Plain Layout
20053 \change_inserted 564990737 1672138150
20057 \begin_layout Plain Layout
20059 \change_inserted 564990737 1672138150
20076 \begin_inset Note Note
20079 \begin_layout Plain Layout
20081 \change_inserted 564990737 1672138150
20082 goes back to default numbering
20090 \begin_layout Enumerate
20092 \change_inserted 564990737 1672138150
20096 \begin_layout Standard
20098 \change_inserted 564990737 1672138150
20102 \begin_layout Enumerate-Resume
20104 \change_inserted 564990737 1672138150
20108 \begin_layout Standard
20110 \change_inserted 564990737 1672138150
20111 To resume an enumeration,
20118 \change_deleted -712698321 1673882803
20119 Its numbering appears in blue within \SpecialChar LyX
20120 to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
20123 \change_inserted 564990737 1672138150
20127 \begin_layout Standard
20129 \change_inserted 564990737 1672138150
20130 \begin_inset Note Greyedout
20133 \begin_layout Plain Layout
20135 \change_inserted 564990737 1672138150
20141 If there is no previous enumeration to resume,
20142 you will get a \SpecialChar LaTeX
20151 \begin_layout Standard
20153 \change_inserted 564990737 1672138150
20154 Perhaps you might want to resume the list with a different number from the next one.
20155 Or you want to start a new enumeration with a defined number.
20156 This is possible by adding an optional argument to the first list item of a normal enumeration.
20161 \begin_layout Standard
20163 \change_inserted 564990737 1672138150
20169 \begin_layout Standard
20171 \change_inserted 564990737 1672138150
20176 is the number with which you want to resume the list.
20180 \begin_layout Enumerate
20182 \change_inserted 564990737 1672138150
20186 \begin_layout Enumerate
20188 \change_inserted 564990737 1672138150
20192 \begin_layout Standard
20194 \change_inserted 564990737 1672138150
20195 Enumeration starting at a given value:
20198 \begin_layout Enumerate
20200 \change_inserted 564990737 1672138150
20201 \begin_inset Argument 1
20204 \begin_layout Plain Layout
20206 \change_inserted 564990737 1672138150
20210 \begin_layout Plain Layout
20212 \change_inserted 564990737 1672138150
20226 This enumeration starts at 4
20229 \begin_layout Subsubsection
20231 \change_inserted 564990737 1672138150
20233 \begin_inset Index idx
20238 \begin_layout Plain Layout
20240 \change_inserted 564990737 1672138150
20252 \begin_layout Standard
20254 \change_inserted 564990737 1672138150
20255 In some cases you might want less or more vertical space between the items of a list.
20256 For example if the default space is too much in your opinion in this case:
20259 \begin_layout Itemize
20261 \change_inserted 564990737 1672138150
20265 \begin_layout Itemize
20267 \change_inserted 564990737 1672138150
20268 with standard spacing
20271 \begin_layout Standard
20273 \change_inserted 564990737 1672138150
20274 You can decrease the space by adding an optional argument to the first item of the list.
20275 Add there the command
20279 to get no additional list space like in this example:
20282 \begin_layout Itemize
20284 \change_inserted 564990737 1672138150
20285 \begin_inset Argument 1
20288 \begin_layout Plain Layout
20290 \change_inserted 564990737 1672138150
20294 \begin_layout Plain Layout
20296 \change_inserted 564990737 1672138150
20313 \begin_layout Itemize
20315 \change_inserted 564990737 1672138150
20319 \begin_layout Itemize
20321 \change_inserted 564990737 1672138150
20325 \begin_layout Standard
20327 \change_inserted 564990737 1672138150
20328 To add space you can use several other commands provided by the
20333 \begin_inset Index idx
20338 \begin_layout Plain Layout
20340 \change_inserted 564990737 1672138150
20351 For more information see the
20352 \begin_inset CommandInset href
20354 name "enumitem documentation"
20355 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
20363 \begin_layout Standard
20365 \change_inserted 564990737 1672138150
20366 There are also many commands available to change the horizontal spacing and indentation.
20367 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
20368 \begin_inset space \thinspace{}
20371 cm so that the number is in the page margin:
20374 \begin_layout Enumerate
20376 \change_inserted 564990737 1672138150
20377 \begin_inset Argument 1
20380 \begin_layout Plain Layout
20382 \change_inserted 564990737 1672138150
20386 \begin_layout Plain Layout
20388 \change_inserted 564990737 1672138150
20408 \begin_layout Enumerate
20410 \change_inserted 564990737 1672138150
20411 with negative indentation
20414 \begin_layout Subsubsection
20416 \change_inserted 564990737 1672138150
20417 Further Customization
20418 \begin_inset Index idx
20423 \begin_layout Plain Layout
20425 \change_inserted 564990737 1672138150
20437 \begin_layout Standard
20439 \change_inserted 564990737 1672138150
20440 You can also change the style of description lists.
20444 \begin_layout Standard
20446 \change_inserted 564990737 1672138150
20452 \begin_layout Standard
20454 \change_inserted 564990737 1672138150
20455 changes the description label font,
20459 \begin_layout Standard
20461 \change_inserted 564990737 1672138150
20470 \begin_layout Standard
20472 \change_inserted 564990737 1672138150
20473 sets the list style.
20476 \begin_layout Standard
20478 \change_inserted 564990737 1672138150
20479 An example where the command
20482 \begin_layout Standard
20484 \change_inserted 564990737 1672138150
20493 \begin_layout Standard
20495 \change_inserted 564990737 1672138150
20499 \begin_layout Description
20501 \change_inserted 564990737 1672138150
20503 \begin_inset space ~
20508 \begin_inset Argument 1
20511 \begin_layout Plain Layout
20513 \change_inserted 564990737 1672138150
20517 \begin_layout Plain Layout
20519 \change_inserted 564990737 1672138150
20538 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
20539 therefore ionizing them.
20542 \begin_layout Description
20544 \change_inserted 564990737 1672138150
20546 \begin_inset space ~
20550 In computer science,
20551 reference counting is a technique of storing the number of references,
20553 or handles to a resource such as an object,
20555 disk space or other resource.
20558 \begin_layout Standard
20560 \change_inserted 564990737 1672138150
20561 There are many more commands and features provided by the
20566 \begin_inset Index idx
20571 \begin_layout Plain Layout
20573 \change_inserted 564990737 1672138150
20584 For more information see the
20585 \begin_inset CommandInset href
20587 name "enumitem documentation"
20588 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
20596 \begin_layout Subsection
20598 \change_inserted 564990737 1672138150
20604 \begin_layout Standard
20606 \change_inserted 564990737 1672138150
20607 This module uses the package
20611 to provide nine new list environments.
20612 Itemized and enumerated lists can be typeset within paragraphs,
20613 as paragraphs and in a compact version.
20614 Most environments have optional arguments to format the labels.
20616 the \SpecialChar LaTeX
20617 list environments itemize and enumerate are extended to use a similar optional argument.
20618 For further details see
20620 File\SpecialChar menuseparator
20621 Open Example\SpecialChar menuseparator
20622 Modules\SpecialChar menuseparator
20623 Paragraph Lists (paralist)
20628 Help\SpecialChar menuseparator
20629 Specific Manuals\SpecialChar menuseparator
20633 \begin_inset CommandInset href
20635 name "paralist documentation"
20636 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
20644 \begin_layout Section
20646 \change_inserted 564990737 1672161542
20647 Literate Programming
20648 \change_deleted -712698321 1673885680
20650 \change_inserted 564990737 1672161542
20654 \begin_layout Subsection
20656 \change_inserted 564990737 1672161542
20660 \begin_layout Standard
20662 \change_inserted 564990737 1672161542
20663 This module allows the use of Noweb as a literate programming tool.
20664 The files and the documentation for Noweb can be obtained from
20665 \begin_inset CommandInset href
20668 target "https://www.ctan.org/pkg/noweb"
20674 Literate programming is described in section
20675 \begin_inset space ~
20679 \begin_inset CommandInset ref
20681 reference "sec:Literate-Programming"
20686 and there are three example files:
20689 File\SpecialChar menuseparator
20690 Open Example\SpecialChar menuseparator
20691 Modules\SpecialChar menuseparator
20697 File\SpecialChar menuseparator
20698 Open Example\SpecialChar menuseparator
20699 Modules\SpecialChar menuseparator
20704 File\SpecialChar menuseparator
20705 Open Example\SpecialChar menuseparator
20706 Modules\SpecialChar menuseparator
20707 Noweb2\SpecialChar LyX
20713 \begin_layout Subsection
20715 \change_inserted 564990737 1672161542
20719 \begin_layout Standard
20721 \change_inserted 564990737 1672161542
20722 This module uses the
20732 \begin_inset Flex Code
20735 \begin_layout Plain Layout
20737 \change_inserted 564990737 1672161542
20745 package in R for dynamic report generation has to be installed for this module to work:
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20752 \change_inserted 564990737 1672161542
20753 install.packages(“knitr”)
20764 \begin_layout Paragraph
20766 \change_inserted 564990737 1672161542
20770 \begin_layout Itemize
20772 \change_inserted 564990737 1672161542
20773 it depends on R >= 2.14.1.
20775 \begin_inset Flex URL
20778 \begin_layout Plain Layout
20780 \change_inserted 564990737 1672161542
20782 http://yihui.name/knitr
20791 \change_deleted -712698321 1673886383
20793 \change_inserted 564990737 1672161542
20797 \begin_layout Itemize
20799 \change_inserted 564990737 1672161542
20804 also has to be installed.
20806 \change_inserted -712698321 1673886396
20810 \begin_layout Itemize
20812 \change_inserted 564990737 1672161542
20813 It cannot be used if the modules
20816 \begin_inset space ~
20827 \change_deleted -712698321 1673886383
20829 \change_inserted -712698321 1673886376
20833 \begin_layout Standard
20835 \change_inserted 564990737 1672161542
20838 Help\SpecialChar menuseparator
20839 Specific Manuals\SpecialChar menuseparator
20845 File\SpecialChar menuseparator
20846 Open Example\SpecialChar menuseparator
20847 Modules\SpecialChar menuseparator
20851 \begin_inset space ~
20855 \begin_inset CommandInset ref
20857 reference "sec:Literate-Programming"
20862 for information about literate programming.
20865 \begin_layout Subsection
20867 \change_inserted 564990737 1672161542
20871 \begin_layout Standard
20873 \change_inserted 564990737 1672161542
20874 This module allows the use of the statistical language S/R as a literate programming tool.
20885 \begin_inset CommandInset href
20888 target "https://www.ctan.org/pkg/includernw"
20894 \begin_inset CommandInset href
20897 target "https://www.ctan.org/pkg/fancyvrb"
20902 are available from CTAN.
20903 It cannot be used if the module
20906 \begin_inset space ~
20914 Help\SpecialChar menuseparator
20915 Specific Manuals\SpecialChar menuseparator
20921 File\SpecialChar menuseparator
20922 Open Example\SpecialChar menuseparator
20923 Modules\SpecialChar menuseparator
20927 \begin_inset space ~
20931 \begin_inset CommandInset ref
20933 reference "sec:Literate-Programming"
20938 for information about literate programming.
20941 \begin_layout Section
20943 \change_inserted 564990737 1672224959
20947 \begin_layout Subsection
20949 \change_inserted 564990737 1672224959
20953 \begin_layout Standard
20955 \change_inserted 564990737 1672224959
20956 This modules defines theorem environments and the proof environment using the extended AMS machinery.
20957 Both numbered and unnumbered types are provided.
20959 the theorems are numbered consecutively throughout the document.
20960 This can be changed by loading one of the
20962 AMS Theorems (Numbered by \SpecialChar ldots
20966 It cannot be used if the modules
20972 Standard Theorems (Unnumbered)
20977 \begin_layout Subsection
20979 \change_inserted 564990737 1672224959
20980 AMS Theorems (Extended)
20983 \begin_layout Standard
20985 \change_inserted 564990737 1672224959
20986 This module defines some additional theorem environments for use with the
20990 package (which must be loaded).
21027 \change_deleted -712698321 1675594790
21034 \change_inserted 564990737 1672224959
21058 in both numbered and unnumbered forms.
21061 \begin_layout Subsection
21063 \change_inserted 564990737 1672224959
21064 AMS Theorems (Extended,
21065 Numbered by Type within Chapters)
21068 \begin_layout Standard
21070 \change_inserted 564990737 1672224959
21071 This module defines some additional theorem environments for use with the
21073 AMS Theorems (Numbered by Type within Chapters)
21076 \change_deleted -712698321 1674898102
21078 \change_inserted -712698321 1674898103
21080 \change_inserted 564990737 1672224959
21081 (which must be loaded).
21118 \change_deleted -712698321 1675594800
21125 \change_inserted 564990737 1672224959
21139 in both numbered and unnumbered forms.
21141 \change_inserted -712698321 1674898226
21145 \begin_layout Standard
21147 \change_inserted 564990737 1672224959
21150 AMS Theorems (Extended)
21153 the different theorem types provided here each have a separate counter,
21154 restarted with each new chapter (e.g.,
21156 \change_deleted -712698321 1674898319
21160 \change_inserted -712698321 1674898319
21162 \change_inserted 564990737 1672224959
21167 \change_deleted -712698321 1674898320
21171 \change_inserted -712698321 1674898321
21173 \change_inserted 564990737 1672224959
21178 \change_deleted -712698321 1674898322
21182 \change_inserted -712698321 1674898322
21184 \change_inserted 564990737 1672224959
21189 \change_deleted -712698321 1674898325
21193 \change_inserted -712698321 1674898325
21195 \change_inserted 564990737 1672224959
21200 \change_deleted -712698321 1674898327
21204 \change_inserted -712698321 1674898327
21206 \change_inserted 564990737 1672224959
21211 \change_deleted -712698321 1674898329
21215 \change_inserted -712698321 1674898329
21217 \change_inserted 564990737 1672224959
21224 \change_deleted -712698321 1674898339
21226 \change_inserted -712698321 1674898339
21228 \change_inserted 564990737 1672224959
21230 \change_inserted -712698321 1674898336
21235 \change_inserted 564990737 1672224959
21239 \change_deleted -712698321 1674898342
21241 \change_inserted -712698321 1674898342
21245 \change_inserted 564990737 1672224959
21250 \change_deleted -712698321 1674898344
21252 \change_inserted -712698321 1674898344
21256 \change_inserted 564990737 1672224959
21261 \change_deleted -712698321 1674898346
21263 \change_inserted -712698321 1674898347
21267 \change_inserted 564990737 1672224959
21272 \change_deleted -712698321 1674898348
21274 \change_inserted -712698321 1674898348
21278 \change_inserted 564990737 1672224959
21280 \change_inserted -712698321 1674898350
21285 \change_deleted -712698321 1674898352
21287 \change_inserted -712698321 1674898353
21290 \change_inserted 564990737 1672224959
21294 \begin_layout Subsection
21296 \change_inserted 564990737 1672224959
21297 AMS Theorems (Extended,
21301 \begin_layout Standard
21303 \change_inserted 564990737 1672224959
21304 This module defines some additional theorem environments for use with the
21306 AMS Theorems (Numbered by Type)
21308 package (which must be loaded).
21345 \change_deleted -712698321 1675594806
21352 \change_inserted 564990737 1672224959
21366 in both numbered and unnumbered forms.
21368 \change_inserted -712698321 1674898455
21372 \begin_layout Standard
21374 \change_inserted 564990737 1672224959
21377 AMS Theorems (Extended)
21380 the different theorem types provided here each have a separate counter (e.g.,
21382 \change_deleted -712698321 1674898821
21384 \change_inserted -712698321 1674898821
21388 \change_inserted 564990737 1672224959
21393 \change_deleted -712698321 1674898823
21395 \change_inserted -712698321 1674898823
21399 \change_inserted 564990737 1672224959
21404 \change_deleted -712698321 1674898825
21406 \change_inserted -712698321 1674898825
21410 \change_inserted 564990737 1672224959
21415 \change_deleted -712698321 1674898827
21417 \change_inserted -712698321 1674898827
21421 \change_inserted 564990737 1672224959
21426 \change_deleted -712698321 1674898830
21428 \change_inserted -712698321 1674898830
21432 \change_inserted 564990737 1672224959
21439 \change_deleted -712698321 1674898832
21441 \change_inserted -712698321 1674898832
21445 \change_inserted 564990737 1672224959
21450 \change_deleted -712698321 1674898834
21452 \change_inserted -712698321 1674898834
21456 \change_inserted 564990737 1672224959
21461 \change_deleted -712698321 1674898836
21463 \change_inserted -712698321 1674898836
21467 \change_inserted 564990737 1672224959
21472 \change_deleted -712698321 1674898838
21474 \change_inserted -712698321 1674898838
21478 \change_inserted 564990737 1672224959
21486 \begin_layout Subsection
21488 \change_inserted 564990737 1672224959
21489 AMS Theorems (Numbered by Type within Chapters)
21492 \begin_layout Standard
21494 \change_inserted 564990737 1672224959
21495 This module defines theorem environments and the proof environment using the extended AMS machinery.
21496 Both numbered and unnumbered types are provided.
21498 \change_inserted -712698321 1674901718
21502 \begin_layout Standard
21504 \change_inserted 564990737 1672224959
21510 the different theorem types provided here each have a separate counter (e.g.,
21512 \change_deleted -712698321 1674901843
21514 \change_inserted -712698321 1674901843
21518 \change_inserted 564990737 1672224959
21523 \change_deleted -712698321 1674901845
21525 \change_inserted -712698321 1674901845
21529 \change_inserted 564990737 1672224959
21534 \change_deleted -712698321 1674901847
21538 \change_inserted -712698321 1674901847
21540 \change_inserted 564990737 1672224959
21545 \change_inserted -712698321 1674901849
21549 \change_deleted -712698321 1674901849
21551 \change_inserted 564990737 1672224959
21556 \change_inserted -712698321 1674901852
21560 \change_deleted -712698321 1674901852
21562 \change_inserted 564990737 1672224959
21567 \change_inserted -712698321 1674901854
21571 \change_deleted -712698321 1674901854
21573 \change_inserted 564990737 1672224959
21580 \change_deleted -712698321 1674901859
21582 \change_inserted -712698321 1674901859
21586 \change_inserted 564990737 1672224959
21591 \change_deleted -712698321 1674901861
21593 \change_inserted -712698321 1674901861
21597 \change_inserted 564990737 1672224959
21602 \change_deleted -712698321 1674901863
21604 \change_inserted -712698321 1674901863
21608 \change_inserted 564990737 1672224959
21613 \change_deleted -712698321 1674901868
21615 \change_inserted -712698321 1674901868
21619 \change_inserted 564990737 1672224959
21625 The numbering restarts for each chapter:
21627 \change_deleted -712698321 1674901871
21629 \change_inserted -712698321 1674901871
21633 \change_inserted 564990737 1672224959
21638 \change_deleted -712698321 1674901873
21640 \change_inserted -712698321 1674901873
21644 \change_inserted 564990737 1672224959
21650 \change_inserted -712698321 1674901725
21654 \begin_layout Standard
21656 \change_inserted 564990737 1672224959
21657 It cannot be used if the modules
21669 Standard Theorems (Numbered by Type)
21673 Standard Theorems (Unnumbered)
21678 \begin_layout Subsection
21680 \change_inserted 564990737 1672224959
21681 AMS Theorems (Numbered by Type)
21684 \begin_layout Standard
21686 \change_inserted 564990737 1672224959
21687 This module defines theorem environments and the proof environment using the extended AMS machinery.
21688 Both numbered and unnumbered types are provided.
21694 the different theorem types provided here each have a separate counter (e.g.,
21696 \change_deleted -712698321 1674902051
21698 \change_inserted -712698321 1674902051
21702 \change_inserted 564990737 1672224959
21707 \change_deleted -712698321 1674902053
21709 \change_inserted -712698321 1674902053
21713 \change_inserted 564990737 1672224959
21718 \change_deleted -712698321 1674902055
21720 \change_inserted -712698321 1674902055
21724 \change_inserted 564990737 1672224959
21729 \change_inserted -712698321 1674902058
21733 \change_deleted -712698321 1674902058
21735 \change_inserted 564990737 1672224959
21740 \change_inserted -712698321 1674902061
21744 \change_deleted -712698321 1674902060
21746 \change_inserted 564990737 1672224959
21751 \change_deleted -712698321 1674902063
21753 \change_inserted -712698321 1674902063
21757 \change_inserted 564990737 1672224959
21764 \change_deleted -712698321 1674902066
21766 \change_inserted -712698321 1674902067
21770 \change_inserted 564990737 1672224959
21775 \change_deleted -712698321 1674902069
21777 \change_inserted -712698321 1674902069
21781 \change_inserted 564990737 1672224959
21786 \change_deleted -712698321 1674902071
21788 \change_inserted -712698321 1674902071
21792 \change_inserted 564990737 1672224959
21797 \change_deleted -712698321 1674902075
21799 \change_inserted -712698321 1674902075
21803 \change_inserted 564990737 1672224959
21809 The numbering’s scope is the whole document.
21810 For chapter- and section-wide numbering,
21811 use one of the ‘within Sections’/‘within Chapters’ modules,
21814 \change_inserted -712698321 1674902047
21818 \begin_layout Standard
21820 \change_inserted 564990737 1672224959
21821 It cannot be used if the modules
21833 Standard Theorems (Numbered by Type)
21837 Standard Theorems (Unnumbered)
21842 \begin_layout Subsection
21844 \change_inserted 564990737 1672224959
21845 Number Equations by Section
21848 \begin_layout Standard
21850 \change_inserted 564990737 1672224959
21851 This module resets the equation number at section start and prepends the section number to the equation number,
21853 \change_deleted -712698321 1674902160
21855 \change_inserted 564990737 1672224959
21861 \change_deleted -712698321 1674902162
21863 \change_inserted 564990737 1672224959
21867 \begin_layout Subsection
21869 \change_inserted 564990737 1672224959
21873 \begin_layout Standard
21875 \change_inserted 564990737 1672224959
21876 This module defines some theorem environments for use with non-AMS classes.
21878 the theorems are numbered consecutively throughout the document.
21879 This can be changed by loading one of the
21881 Standard Theorems (Numbered by \SpecialChar ldots
21886 \change_inserted -712698321 1674902414
21890 \begin_layout Standard
21892 \change_inserted 564990737 1672224959
21893 It cannot be used if the modules
21899 Standard Theorems (Unnumbered)
21905 \begin_layout Subsection
21907 \change_inserted 564990737 1672224959
21908 Standard Theorems (Nameable)
21911 \begin_layout Standard
21913 \change_inserted 564990737 1672224959
21914 This module facilitates the use of named theorems.
21915 The name of the theorem
21916 \change_deleted -712698321 1674902805
21918 \change_inserted -712698321 1674902825
21919 can be inserted via
21921 Insert\SpecialChar menuseparator
21923 \change_deleted -712698321 1674902827
21925 \change_inserted 564990737 1672224959
21926 Additional Theorem Text
21927 \change_deleted -712698321 1674902831
21931 \change_inserted 564990737 1672224959
21936 \begin_layout Subsection
21938 \change_inserted 564990737 1672224959
21939 Standard Theorems (Numbered by Chapter)
21942 \begin_layout Standard
21944 \change_inserted 564990737 1672224959
21945 This module numbers theorems and the like by chapter (i.e.,
21946 the counter is reset at each chapter start).
21947 Use this module only with document classes that provide a chapter environment.
21949 \change_inserted -712698321 1674903079
21953 \begin_layout Standard
21955 \change_inserted 564990737 1672224959
21966 \change_inserted -712698321 1674903082
21970 \begin_layout Standard
21972 \change_inserted 564990737 1672224959
21973 It cannot be used if the module
21975 Standard Theorems (Numbered by Section)
21980 \begin_layout Subsection
21982 \change_inserted 564990737 1672224959
21983 Standard Theorems (Numbered by Section)
21986 \begin_layout Standard
21988 \change_inserted 564990737 1672224959
21989 This module numbers theorems and the like by section (i.e.,
21990 the counter is reset at each section start).
22000 It cannot be used if the module
22002 Standard Theorems (Numbered by Chapter)
22007 \begin_layout Subsection
22009 \change_inserted 564990737 1672224959
22010 Standard Theorems (Numbered by Type within Chapters)
22013 \begin_layout Standard
22015 \change_inserted 564990737 1672224959
22016 This module defines some theorem environments for use with non-AMS classes.
22026 the different theorem types provided here each have a separate counter (e.g.,
22028 \change_deleted -712698321 1674903338
22030 \change_inserted -712698321 1674903338
22034 \change_inserted 564990737 1672224959
22039 \change_deleted -712698321 1674903340
22041 \change_inserted -712698321 1674903340
22045 \change_inserted 564990737 1672224959
22050 \change_deleted -712698321 1674903343
22052 \change_inserted -712698321 1674903343
22056 \change_inserted 564990737 1672224959
22061 \change_deleted -712698321 1674903346
22063 \change_inserted -712698321 1674903346
22067 \change_inserted 564990737 1672224959
22072 \change_deleted -712698321 1674903348
22074 \change_inserted -712698321 1674903348
22078 \change_inserted 564990737 1672224959
22083 \change_deleted -712698321 1674903351
22085 \change_inserted -712698321 1674903351
22089 \change_inserted 564990737 1672224959
22096 \change_deleted -712698321 1674903354
22098 \change_inserted -712698321 1674903354
22102 \change_inserted 564990737 1672224959
22107 \change_deleted -712698321 1674903356
22109 \change_inserted -712698321 1674903356
22113 \change_inserted 564990737 1672224959
22118 \change_deleted -712698321 1674903359
22120 \change_inserted -712698321 1674903359
22124 \change_inserted 564990737 1672224959
22129 \change_deleted -712698321 1674903361
22131 \change_inserted -712698321 1674903361
22135 \change_inserted 564990737 1672224959
22141 The numbering is reset at each chapter start.
22143 \change_inserted -712698321 1674902715
22147 \begin_layout Standard
22149 \change_inserted 564990737 1672224959
22152 AMS Theorems (Numbered by Type)
22156 Standard Theorems (Numbered by Type)
22160 \change_inserted -712698321 1674902717
22164 \begin_layout Standard
22166 \change_inserted 564990737 1672224959
22167 It cannot be used if any of the modules
22179 Standard Theorems (Unnumbered)
22184 Standard Theorems (Numbered by Sections)
22188 Standard Theorems (Numbered by Type within Sections)
22193 \begin_layout Subsection
22195 \change_inserted 564990737 1672224959
22196 Standard Theorems (Numbered by Type within Sections)
22199 \begin_layout Standard
22201 \change_inserted 564990737 1672224959
22202 This module defines some theorem environments for use with non-AMS classes.
22212 the different theorem types provided here each have a separate counter (e.g.,
22214 \change_deleted -712698321 1674902520
22216 \change_inserted -712698321 1674902520
22220 \change_inserted 564990737 1672224959
22225 \change_deleted -712698321 1674902522
22227 \change_inserted -712698321 1674902522
22231 \change_inserted 564990737 1672224959
22236 \change_deleted -712698321 1674902527
22238 \change_inserted -712698321 1674902527
22242 \change_inserted 564990737 1672224959
22247 \change_inserted -712698321 1674902529
22251 \change_deleted -712698321 1674902529
22253 \change_inserted 564990737 1672224959
22258 \change_deleted -712698321 1674902532
22260 \change_inserted -712698321 1674902532
22264 \change_inserted 564990737 1672224959
22269 \change_inserted -712698321 1674902535
22273 \change_deleted -712698321 1674902534
22275 \change_inserted 564990737 1672224959
22282 \change_deleted -712698321 1674902538
22284 \change_inserted -712698321 1674902538
22288 \change_inserted 564990737 1672224959
22293 \change_deleted -712698321 1674902540
22295 \change_inserted -712698321 1674902540
22299 \change_inserted 564990737 1672224959
22304 \change_deleted -712698321 1674902543
22306 \change_inserted -712698321 1674902543
22310 \change_inserted 564990737 1672224959
22315 \change_inserted -712698321 1674902545
22319 \change_deleted -712698321 1674902545
22321 \change_inserted 564990737 1672224959
22327 The numbering is reset at each section start.
22329 \change_inserted -712698321 1674902574
22333 \begin_layout Standard
22335 \change_inserted 564990737 1672224959
22338 AMS Theorems (Numbered by Type)
22342 Standard Theorems (Numbered by Type)
22346 \change_inserted -712698321 1674902609
22350 \begin_layout Standard
22352 \change_inserted 564990737 1672224959
22353 It cannot be used if any of the modules
22365 Standard Theorems (Unnumbered)
22370 Standard Theorems (Numbered by Chapters)
22374 Standard Theorems (Numbered by Type within Chapters)
22379 \begin_layout Subsection
22381 \change_inserted 564990737 1672224959
22382 Standard Theorems (Numbered by Type)
22385 \begin_layout Standard
22387 \change_inserted 564990737 1672224959
22388 This module defines some theorem environments for use with non-AMS classes.
22398 the different theorem types provided here each have a separate counter (e.g.,
22400 \change_deleted -712698321 1674903220
22402 \change_inserted -712698321 1674903220
22406 \change_inserted 564990737 1672224959
22411 \change_deleted -712698321 1674903221
22413 \change_inserted -712698321 1674903221
22417 \change_inserted 564990737 1672224959
22422 \change_deleted -712698321 1674903225
22424 \change_inserted -712698321 1674903226
22428 \change_inserted 564990737 1672224959
22433 \change_inserted -712698321 1674903228
22437 \change_deleted -712698321 1674903228
22439 \change_inserted 564990737 1672224959
22444 \change_deleted -712698321 1674903231
22446 \change_inserted -712698321 1674903232
22450 \change_inserted 564990737 1672224959
22455 \change_inserted -712698321 1674903261
22459 \change_deleted -712698321 1674903233
22461 \change_inserted 564990737 1672224959
22468 \change_deleted -712698321 1674903237
22470 \change_inserted -712698321 1674903237
22474 \change_inserted 564990737 1672224959
22479 \change_deleted -712698321 1674903240
22481 \change_inserted -712698321 1674903240
22485 \change_inserted 564990737 1672224959
22490 \change_deleted -712698321 1674903242
22492 \change_inserted -712698321 1674903242
22496 \change_inserted 564990737 1672224959
22501 \change_deleted -712698321 1674903246
22503 \change_inserted -712698321 1674903246
22507 \change_inserted 564990737 1672224959
22513 The numbering’s scope is the whole document.
22514 For chapter- and section-wide numbering,
22515 use one of the “within Chapters”/“within Sections” modules,
22518 \change_inserted -712698321 1674903280
22522 \begin_layout Standard
22524 \change_inserted 564990737 1672224959
22525 It cannot be used if any of the modules
22537 Standard Theorems (Unnumbered)
22541 AMS Theorems (Numbered by Type)
22546 \begin_layout Subsection
22548 \change_inserted 564990737 1672224959
22549 Standard Theorems (Unnumbered)
22552 \begin_layout Standard
22554 \change_inserted 564990737 1672224959
22555 This module defines only unnumbered theorem environments and the proof environment,
22556 using the extended AMS machinery.
22557 It cannot be used if either of the modules
22568 \begin_layout Subsection
22570 \change_inserted 564990737 1672224959
22574 \begin_layout Standard
22576 \change_inserted 564990737 1672224959
22577 This module provides a straightforward way to segregate subequations in LyX.
22580 Help\SpecialChar menuseparator
22581 Math\SpecialChar menuseparator
22588 \begin_layout Section
22590 \change_inserted 564990737 1672236008
22594 \begin_layout Subsection
22596 \change_inserted 564990737 1672236008
22597 Custom Header/Footer Text
22600 \begin_layout Standard
22602 \change_inserted 564990737 1672236008
22603 This module requires the
22606 \begin_inset space ~
22620 ocument\SpecialChar menuseparator
22625 ettings\SpecialChar menuseparator
22627 \begin_inset space ~
22632 dialog to be set to
22637 It adds six environments to document classes which support the
22644 \begin_layout Itemize
22646 \change_inserted 564990737 1672236008
22652 \begin_layout Itemize
22654 \change_inserted 564990737 1672236008
22660 \begin_layout Itemize
22662 \change_inserted 564990737 1672236008
22668 \begin_layout Itemize
22670 \change_inserted 564990737 1672236008
22676 \begin_layout Itemize
22678 \change_inserted 564990737 1672236008
22684 \begin_layout Itemize
22686 \change_inserted 564990737 1672236008
22692 \begin_layout Subsubsection
22694 \change_inserted 564990737 1672236008
22695 Fancy Headers and Footers
22698 \begin_layout Standard
22700 \change_inserted 564990737 1672236008
22701 The default page layout is rather plain;
22703 \change_deleted -712698321 1674910295
22705 \begin_inset Flex Code
22708 \begin_layout Plain Layout
22710 \change_inserted 564990737 1672236008
22719 \change_inserted 564990737 1672236008
22721 \change_inserted -712698321 1674910328
22724 Article (Standard Class)
22727 \change_inserted 564990737 1672236008
22729 all you get is a centered page number at the bottom of the page.
22731 \change_inserted -712698321 1674910381
22733 \change_inserted 564990737 1672236008
22735 \change_deleted -712698321 1674910376
22737 \change_inserted -712698321 1674910376
22741 \change_inserted 564990737 1672236008
22745 so it appears to be a bit fancier.
22747 \change_inserted -712698321 1674910455
22751 \begin_layout Standard
22753 \change_inserted 564990737 1672236008
22757 \begin_inset space ~
22771 ocument\SpecialChar menuseparator
22776 ettings\SpecialChar menuseparator
22780 \begin_inset Quotes eld
22784 \begin_inset Quotes erd
22788 you will find that the page header is divided into three fields,
22789 not surprisingly labeled
22790 \begin_inset Quotes eld
22794 \begin_inset Quotes erd
22799 \begin_inset Quotes eld
22803 \begin_inset Quotes erd
22808 \begin_inset Quotes eld
22812 \begin_inset Quotes erd
22816 The footer is also divided into these three fields.
22817 The \SpecialChar LaTeX
22818 commands to set these fields in the simplest manner are
22847 Suppose you wish to put your name in the upper left hand corner of each page.
22848 Simply insert the following command in the preamble:
22852 \begin_layout LyX-Code
22854 \change_inserted 564990737 1672236008
22861 \begin_layout Standard
22863 \change_inserted 564990737 1672236008
22864 You will now see your name in the upper left.
22865 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,
22867 \begin_inset space \thinspace{}
22873 \begin_layout LyX-Code
22875 \change_inserted 564990737 1672236008
22881 \begin_layout Standard
22883 \change_inserted 564990737 1672236008
22886 an easier way to make simple changes.
22892 ocument\SpecialChar menuseparator
22897 ettings\SpecialChar menuseparator
22898 Modules\SpecialChar menuseparator
22899 Page Layout\SpecialChar menuseparator
22900 Custom Header/Footer Text
22903 you will find you have six new environments corresponding to the six fields described above.
22906 \begin_layout Standard
22908 \change_inserted 564990737 1672236008
22909 Let's get really fancy:
22910 lets put the section number with the word
22911 \begin_inset Quotes eld
22915 \begin_inset Quotes erd
22919 \begin_inset space \thinspace{}
22923 \begin_inset space \space{}
22926 Section 3) in the upper left,
22927 the page number (e.
22928 \begin_inset space \thinspace{}
22932 \begin_inset space \space{}
22935 Page 4) in the upper right,
22936 your name in the lower left,
22937 and the date in the lower right.
22938 Use your newly enabled environments to add these entries:
22941 \begin_layout Standard
22943 \change_deleted -712698321 1674910975
22944 \begin_inset VSpace defskip
22948 \change_inserted 564990737 1672236008
22952 \begin_layout LyX-Code
22954 \change_inserted 564990737 1672236008
22958 \begin_inset space ~
22977 \begin_layout LyX-Code
22979 \change_inserted 564990737 1672236008
22985 \begin_layout LyX-Code
22987 \change_inserted 564990737 1672236008
23004 \begin_layout LyX-Code
23006 \change_inserted 564990737 1672236008
23018 \begin_layout LyX-Code
23020 \change_inserted 564990737 1672236008
23026 \begin_layout LyX-Code
23028 \change_inserted 564990737 1672236008
23042 \begin_layout Standard
23044 \change_deleted -712698321 1674910976
23045 \begin_inset VSpace defskip
23049 \change_inserted 564990737 1672236008
23053 \begin_layout Standard
23055 \change_inserted 564990737 1672236008
23056 Make sure you enter the commands
23075 as \SpecialChar TeX
23093 access \SpecialChar LaTeX
23094 ’s section and page counters,
23095 and so print out the current section and page numbers.
23102 simply prints out today’s date.
23105 \begin_layout Standard
23107 \change_inserted 564990737 1672236008
23108 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
23109 If you don't want one of the rules,
23110 set its thickness to 0.
23111 The header rule has a default thickness of 0.4pt,
23112 the footer rule is 0pt.
23113 For this you will need to use \SpecialChar TeX
23117 \begin_layout Standard
23119 \change_inserted 564990737 1672236008
23126 headrulewidth}{0.4pt}
23131 \begin_layout Standard
23133 \change_inserted 564990737 1672236008
23140 footrulewidth}{0.4pt}
23142 to set the thicknesses.
23145 \begin_layout Standard
23147 \change_inserted 564990737 1672236008
23148 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
23153 thispagestyle{empty}
23160 thispagestyle{plain}
23167 thispagestyle{fancy}
23170 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
23173 title pages are marked as plain by default,
23174 while following pages are marked fancy when using the global fancy setting.
23178 \begin_layout Standard
23180 \change_inserted 564990737 1672236008
23181 If you want a header or footer to be on the outer side of a two sided document,
23182 you need to use something like:
23185 \begin_layout LyX-Code
23187 \change_deleted -712698321 1674911361
23190 \begin_inset Flex Strong
23193 \begin_layout Plain Layout
23195 \change_inserted 564990737 1672236008
23209 \change_inserted -712698321 1674911361
23219 \begin_layout LyX-Code
23221 \change_deleted -712698321 1674911364
23224 \begin_inset Flex Strong
23227 \begin_layout Plain Layout
23229 \change_inserted 564990737 1672236008
23245 \change_inserted -712698321 1674911364
23257 \begin_layout Standard
23259 \change_inserted 564990737 1672236008
23260 The first command clears all existing footers avoiding any conflicts with your new command.
23263 \begin_layout Standard
23265 \change_inserted 564990737 1672236008
23266 You can enter any of these commands,
23267 the simpler ones in any of your new environments,
23268 the more complex ones as \SpecialChar TeX
23270 at any point in your document and they will take effect on the next page.
23273 \begin_layout Standard
23275 \change_inserted 564990737 1672236008
23276 As a final example,
23277 it is possible to include an image in the header or footer.
23278 Suppose you want to put a company logo in the upper left hand corner.
23279 You might try something like
23280 \change_inserted -712698321 1674911745
23283 Document\SpecialChar menuseparator
23284 Settings\SpecialChar menuseparator
23288 \change_inserted 564990737 1672236008
23292 \begin_layout LyX-Code
23294 \change_inserted 564990737 1672236008
23301 includegraphics{logo.
23302 \change_deleted -712698321 1674911807
23304 \change_inserted -712698321 1674911807
23306 \change_inserted 564990737 1672236008
23310 \begin_layout Standard
23313 \change_deleted -712698321 1674911836
23315 \change_inserted -712698321 1674911837
23317 \change_inserted 564990737 1672236008
23318 ou may need to preface this with
23322 usepackage{graphics}
23324 if you don't include graphics elsewhere in your document
23325 \change_deleted -712698321 1674911839
23327 \change_inserted 564990737 1672236008
23331 \begin_layout Standard
23333 \change_inserted 564990737 1672236008
23334 For more information on fancy headers,
23336 \begin_inset Flex Code
23339 \begin_layout Plain Layout
23341 \change_inserted 564990737 1672236008
23350 \begin_inset CommandInset href
23353 target "http://www.ctan.org/pkg/fancyhdr"
23362 \begin_layout Subsection
23364 \change_inserted 564990737 1672236008
23365 Landscape Document Parts
23368 \begin_layout Standard
23370 \change_inserted 564990737 1672236008
23371 This module outputs parts of the document in landscape mode using
23373 Insert\SpecialChar menuseparator
23374 Custom Insets\SpecialChar menuseparator
23379 Insert\SpecialChar menuseparator
23380 Custom Insets\SpecialChar menuseparator
23381 Landscape (Floating)
23386 \begin_layout Subsection
23388 \change_inserted 564990737 1672236008
23389 \begin_inset CommandInset label
23391 name "sec:Multiple-Columns"
23398 \begin_layout Standard
23400 \change_inserted 564990737 1672236008
23401 This module uses the
23406 \begin_inset Index idx
23411 \begin_layout Plain Layout
23413 \change_inserted 564990737 1672236008
23423 package and is independent of the option
23436 ocument\SpecialChar menuseparator
23441 ettings\SpecialChar menuseparator
23443 \begin_inset space ~
23449 If you want to have two columns for the whole document,
23450 you are recommended to use the
23459 For all other cases use this module.
23460 \change_deleted 564990737 1672236008
23461 Multiple Text Columns
23464 \begin_layout Standard
23466 \change_deleted 564990737 1672236008
23467 This feature is independent of the option
23469 Two-column document
23471 in the document settings under
23476 If you want to have 2
23477 \begin_inset space ~
23480 columns for the whole document,
23481 it is recommended to use the
23483 Two-column document
23486 For all other cases use this feature.
23489 \begin_layout Standard
23491 \change_deleted 564990737 1672236008
23492 To use multiple text columns in your document,
23493 you have to load the module
23499 Document\SpecialChar menuseparator
23500 Settings\SpecialChar menuseparator
23503 ) and must have the \SpecialChar LaTeX
23505 \begin_inset Flex Code
23508 \begin_layout Plain Layout
23519 \begin_layout Standard
23520 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
23521 Within the different columns you can use everything,
23522 with the limitation that for floats you need to
23523 \change_deleted 564990737 1672236179
23524 use the float option
23527 \change_inserted 564990737 1672236179
23536 \begin_inset space ~
23546 dit\SpecialChar menuseparator
23552 \begin_inset space ~
23562 \begin_layout Subsubsection
23566 \begin_layout Standard
23567 If you want to have
23568 \change_deleted -712698321 1674912320
23570 \change_inserted -712698321 1674912321
23572 \change_deleted -712698321 1674912322
23574 \begin_inset space ~
23578 \change_inserted -712698321 1674912322
23581 columns in your text,
23582 insert a multicolumn inset via the menu
23584 Insert\SpecialChar menuseparator
23586 \begin_inset space ~
23589 Insets\SpecialChar menuseparator
23591 \begin_inset space ~
23596 where the columns should start.
23597 Write all text that should be printed in 2
23598 \begin_inset space ~
23601 columns into this inset.
23604 \begin_layout Standard
23605 Here is an example:
23608 \begin_layout Standard
23610 \begin_inset Flex Multiple Columns
23613 \begin_layout Plain Layout
23618 The Adventure of the Empty House
23621 \begin_inset Newline newline
23626 Sir Arthur Conan Doyle
23629 \begin_layout Plain Layout
23632 It was in the spring of the year 1894 that all London was interested,
23633 and the fashionable world dismayed,
23634 by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
23635 The public has already learned those particulars of the crime which came out in the police investigation,
23636 but a good deal was suppressed upon that occasion,
23637 since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
23639 at the end of nearly ten years,
23640 am I allowed to supply those missing links which make up the whole of that remarkable chain.
23641 The crime was of interest in itself,
23642 but that interest was as nothing to me compared to the inconceivable sequel,
23643 which afforded me the greatest shock and surprise of any event in my adventurous life.
23645 after this long interval,
23646 I find myself thrilling as I think of it,
23647 and feeling once more that sudden flood of joy,
23649 and incredulity which utterly submerged my mind.
23650 Let me say to that public,
23651 which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
23652 that they are not to blame me if I have not shared my knowledge with them,
23653 for I should have considered it my first duty to do so,
23654 had I not been barred by a positive prohibition from his own lips,
23655 which was only withdrawn upon the third of last month.
23663 \begin_layout Standard
23664 To get 3 or more columns,
23665 set the cursor into the multicolumn inset and use the menu
23667 Insert\SpecialChar menuseparator
23669 \begin_inset space ~
23673 \begin_inset space ~
23679 The number of the desired columns is written into that inset (for 3
23680 \begin_inset space ~
23684 \begin_inset Quotes eld
23688 \begin_inset Quotes erd
23692 \begin_inset Newline newline
23695 Here is an example with 3
23696 \begin_inset space ~
23702 \begin_layout Standard
23703 \begin_inset Flex Multiple Columns
23706 \begin_layout Plain Layout
23709 \begin_inset Argument 1
23712 \begin_layout Plain Layout
23719 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
23720 and that after his disappearance I never failed to read with care the various problems which came before the public.
23721 And I even attempted,
23723 for my own private satisfaction,
23724 to employ his methods in their solution,
23725 though with indifferent success.
23728 which appealed to me like this tragedy of Ronald Adair.
23729 As I read the evidence at the inquest,
23730 which led up to a verdict of willful murder against some person or persons unknown,
23731 I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
23732 There were points about this strange business which would,
23734 have specially appealed to him,
23735 and the efforts of the police would have been supplemented,
23736 or more probably anticipated,
23737 by the trained observation and the alert mind of the first criminal agent in Europe.
23739 as I drove upon my round,
23740 I turned over the case in my mind and found no explanation which appeared to me to be adequate.
23741 At the risk of telling a twice-told tale,
23742 I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
23750 \begin_layout Standard
23751 You can have up to 10
23752 \begin_inset space ~
23755 columns if you want to,
23756 but that might not be very pleasant for the readers of your document.
23759 \begin_layout Standard
23761 \change_deleted 564990737 1672236245
23762 \begin_inset Newpage newpage
23770 \begin_layout Subsubsection
23771 Columns inside Columns
23774 \begin_layout Standard
23775 You can also have columns inside columns:
23778 \begin_layout Standard
23779 \begin_inset Flex Multiple Columns
23782 \begin_layout Plain Layout
23785 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
23786 at that time governor of one of the Australian colonies.
23787 Adair's mother had returned from Australia to undergo the operation for cataract,
23790 and her daughter Hilda were living together at 427 Park Lane.
23793 \begin_layout Plain Layout
23794 \begin_inset Flex Multiple Columns
23797 \begin_layout Plain Layout
23800 The youth moved in the best society
23801 \begin_inset space ~
23805 so far as was known,
23806 no enemies and no particular vices.
23807 He had been engaged to Miss Edith Woodley,
23809 but the engagement had been broken off by mutual consent some months before,
23810 and there was no sign that it had left any very profound feeling behind it.
23811 For the rest {sic} the man's life moved in a narrow and conventional circle,
23812 for his habits were quiet and his nature unemotional.
23813 Yet it was upon this easy-going young aristocrat that death came,
23814 in most strange and unexpected form,
23815 between the hours of ten and eleven-twenty on the night of March 30,
23824 \begin_layout Plain Layout
23827 Ronald Adair was fond of cards
23828 \begin_inset space ~
23831 – playing continually,
23832 but never for such stakes as would hurt him.
23833 He was a member of the Baldwin,
23835 and the Bagatelle card clubs.
23837 after dinner on the day of his death,
23838 he had played a rubber of whist at the latter club.
23839 He had also played there in the afternoon.
23844 The evidence of those who had played with him
23845 \begin_inset space ~
23852 \begin_inset space ~
23855 – showed that the game was whist,
23856 and that there was a fairly equal fall of the cards.
23857 Adair might have lost five pounds,
23859 His fortune was a considerable one,
23860 and such a loss could not in any way affect him.
23861 He had played nearly every day at one club or other,
23862 but he was a cautious player,
23863 and usually rose a winner.
23864 It came out in evidence that,
23865 in partnership with Colonel Moran,
23866 he had actually won as much as four hundred and twenty pounds in a sitting,
23868 from Godfrey Milner and Lord Balmoral.
23869 So much for his recent history as it came out at the inquest.
23877 \begin_layout Subsubsection
23881 \begin_layout Standard
23882 The examples in this section show some more special features of multiple columns.
23885 \begin_layout Standard
23886 For more features of multiple columns,
23888 \begin_inset CommandInset href
23890 name "documentation"
23891 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
23896 of the \SpecialChar LaTeX
23898 \begin_inset Flex Code
23901 \begin_layout Plain Layout
23910 \begin_layout Paragraph
23914 \begin_layout Standard
23915 To add a preface text for multiple columns,
23916 set the cursor into the multicolumn inset and use the menu
23918 Insert\SpecialChar menuseparator
23922 Write your preface text into that inset.
23923 \begin_inset Newline newline
23926 This is an example with some preface text:
23929 \begin_layout Standard
23930 \begin_inset VSpace bigskip
23936 \begin_layout Standard
23937 \begin_inset Flex Multiple Columns
23940 \begin_layout Plain Layout
23941 \begin_inset Argument 2
23944 \begin_layout Plain Layout
23945 And the story continues and continues and continues and continues\SpecialChar ldots
23953 On the evening of the crime,
23954 he returned from the club exactly at ten.
23955 His mother and sister were out spending the evening with a relation.
23956 The servant deposed that she heard him enter the front room on the second floor,
23957 generally used as his sitting-room.
23958 She had lit a fire there,
23959 and as it smoked she had opened the window.
23960 No sound was heard from the room until eleven-twenty,
23961 the hour of the return of Lady Maynooth and her daughter.
23962 Desiring to say good-night,
23963 she attempted to enter her son's room.
23964 The door was locked on the inside,
23965 and no answer could be got to their cries and knocking.
23967 and the door forced.
23968 The unfortunate young man was found lying near the table.
23969 His head had been horribly mutilated by an expanding revolver bullet,
23970 but no weapon of any sort was to be found in the room.
23978 \begin_layout Standard
23979 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
23981 For example the command
23984 \begin_layout LyX-Code
23987 subsection{subsection title}
23990 \begin_layout Standard
23991 creates a subsection.
23992 In this example the preface is a subsubsection:
23995 \begin_layout Standard
23996 \begin_inset Flex Multiple Columns
23999 \begin_layout Plain Layout
24000 \begin_inset Argument 2
24003 \begin_layout Plain Layout
24007 \begin_layout Plain Layout
24016 This is a subsubsection heading as a preface
24020 \begin_layout Plain Layout
24034 A minute examination of the circumstances served only to make the case more complex.
24035 In the first place,
24036 no reason could be given why the young man should have fastened the door upon the inside.
24037 There was the possibility that the murderer had done this,
24038 and had afterwards escaped by the window.
24039 The drop was at least twenty feet,
24041 and a bed of crocuses in full bloom lay beneath.
24042 Neither the flowers nor the earth showed any sign of having been disturbed,
24043 nor were there any marks upon the narrow strip of grass which separated the house from the road.
24046 it was the young man himself who had fastened the door.
24047 But how did he come by his death?
24048 No one could have climbed up to the window without leaving traces.
24049 Suppose a man had fired through the window,
24050 he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
24052 Park Lane is a frequented thoroughfare;
24053 there is a cab stand within a hundred yards of the house.
24054 No one had heard a shot.
24062 \begin_layout Standard
24063 If there is less vertical space than
24064 \change_deleted -712698321 1674913194
24066 \begin_inset space ~
24070 \change_inserted -712698321 1674913195
24073 text lines is left on the page at the beginning of the multiple columns,
24074 a page break will be inserted before the multiple columns.
24075 Depending on the number of lines of the preface text,
24076 you might want to change this space.
24077 This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
24079 Insert\SpecialChar menuseparator
24081 \begin_inset space ~
24085 \begin_inset space ~
24089 \begin_inset space ~
24095 Insert into that inset the amount of space like e.
24096 \begin_inset space \thinspace{}
24100 \begin_inset space \space{}
24104 \begin_inset Quotes eld
24108 \begin_inset Quotes erd
24112 \begin_inset Newline newline
24115 In this example the space is set to 7
24116 \begin_inset space ~
24119 text lines by using
24120 \begin_inset Flex Code
24123 \begin_layout Plain Layout
24132 \begin_inset Flex Code
24135 \begin_layout Plain Layout
24143 needs to be inserted as \SpecialChar TeX
24147 \begin_layout Standard
24148 \begin_inset Flex Multiple Columns
24151 \begin_layout Plain Layout
24152 \begin_inset Argument 3
24155 \begin_layout Plain Layout
24160 \begin_layout Plain Layout
24176 On the evening of the crime,
24177 he returned from the club exactly at ten.
24178 His mother and sister were out spending the evening with a relation.
24179 The servant deposed that she heard him enter the front room on the second floor,
24180 generally used as his sitting-room.
24181 She had lit a fire there,
24182 and as it smoked she had opened the window.
24183 No sound was heard from the room until eleven-twenty,
24184 the hour of the return of Lady Maynooth and her daughter.
24185 Desiring to say good-night,
24186 she attempted to enter her son's room.
24187 The door was locked on the inside,
24188 and no answer could be got to their cries and knocking.
24190 and the door forced.
24191 The unfortunate young man was found lying near the table.
24192 His head had been horribly mutilated by an expanding revolver bullet,
24193 but no weapon of any sort was to be found in the room.
24201 \begin_layout Paragraph
24205 \begin_layout Standard
24206 The amount of space before and after multiple columns can be changed by changing the length
24207 \begin_inset Flex Code
24210 \begin_layout Plain Layout
24219 For example the command
24222 \begin_layout LyX-Code
24230 \begin_layout Standard
24231 in \SpecialChar TeX
24232 Code changes its value to 3
24233 \begin_inset space \thinspace{}
24237 The change must be made before the multiple columns' start.
24238 The predefined value is 13
24239 \begin_inset space \thinspace{}
24245 \begin_layout Standard
24247 \begin_inset Flex Code
24250 \begin_layout Plain Layout
24259 \begin_inset space \thinspace{}
24265 \begin_layout Standard
24269 \begin_layout Plain Layout
24275 multicolsep}{2.5cm}
24283 \begin_layout Standard
24284 \begin_inset Flex Multiple Columns
24287 \begin_layout Plain Layout
24290 All day I turned these facts over in my mind,
24291 endeavouring to hit upon some theory which could reconcile them all,
24292 and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
24293 I confess that I made little progress.
24294 In the evening I strolled across the Park,
24295 and found myself about six o'clock at the Oxford Street end of Park Lane.
24296 A group of loafers upon the pavements,
24297 all staring up at a particular window,
24298 directed me to the house which I had come to see.
24300 thin man with coloured glasses,
24301 whom I strongly suspected of being a plain-clothes detective,
24302 was pointing out some theory of his own,
24303 while the others crowded round to listen to what he said.
24304 I got as near him as I could,
24305 but his observations seemed to me to be absurd,
24306 so I withdrew again in some disgust.
24307 As I did so I struck against an elderly,
24309 who had been behind me,
24310 and I knocked down several books which he was carrying.
24318 \begin_layout Standard
24319 \begin_inset Note Greyedout
24322 \begin_layout Plain Layout
24328 The values you set with
24329 \begin_inset Flex Code
24332 \begin_layout Plain Layout
24340 will be used for all following multiple columns until you change them again.
24348 \begin_layout Standard
24352 \begin_layout Plain Layout
24364 \begin_inset Note Note
24367 \begin_layout Plain Layout
24368 go back to the default
24376 \begin_layout Standard
24378 \change_deleted 564990737 1672236355
24379 \begin_inset Newpage newpage
24387 \begin_layout Paragraph
24391 \begin_layout Standard
24392 A column break can be forced by inserting the command
24393 \begin_inset Flex Code
24396 \begin_layout Plain Layout
24404 as \SpecialChar TeX
24405 Code to that position in the text where the column should be broken.
24406 Note that this leads in most cases to whitespace in the text.
24407 \begin_inset Newline newline
24410 Here is an example:
24413 \begin_layout Standard
24414 \begin_inset Flex Multiple Columns
24417 \begin_layout Plain Layout
24420 \begin_inset Quotes eld
24423 You're surprised to see me,
24425 \begin_inset Quotes erd
24433 \begin_layout Plain Layout
24436 I acknowledged that I was.
24439 \begin_layout Plain Layout
24442 \begin_inset Quotes eld
24448 and when I chanced to see you go into this house,
24449 as I came hobbling after you,
24450 I thought to myself,
24451 I'll just step in and see that kind gentleman,
24452 and tell him that if I was a bit gruff in my manner there was not any harm meant,
24453 and that I am much obliged to him for picking up my books.
24454 \begin_inset Quotes erd
24460 \begin_layout Plain Layout
24463 \begin_inset Quotes eld
24466 You make too much of a trifle,
24467 \begin_inset Quotes erd
24472 \begin_inset Quotes eld
24475 May I ask how you knew who I was?
24476 \begin_inset Quotes erd
24479 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
24483 \begin_layout Plain Layout
24495 \begin_layout Plain Layout
24498 \begin_inset Quotes eld
24503 if it isn't too great a liberty,
24504 I am a neighbour of yours,
24505 for you'll find my little bookshop at the corner of Church Street,
24506 and very happy to see you,
24508 Maybe you collect yourself,
24513 \begin_inset space ~
24529 \begin_inset space ~
24534 With five volumes you could just fill that gap on that second shelf.
24538 \begin_inset Quotes erd
24549 \begin_layout Paragraph
24553 \begin_layout Standard
24554 The width of the columns is automatically calculated,
24555 but you can modify the space between the columns.
24556 This is done by changing the length
24557 \begin_inset Flex Code
24560 \begin_layout Plain Layout
24569 Its predefined value is 10
24570 \begin_inset space \thinspace{}
24574 Here is an example where
24575 \begin_inset Flex Code
24578 \begin_layout Plain Layout
24587 \begin_inset space \thinspace{}
24593 \begin_layout Standard
24597 \begin_layout Plain Layout
24611 \begin_layout Standard
24612 \begin_inset Flex Multiple Columns
24615 \begin_layout Plain Layout
24618 My observations of No.
24619 \begin_inset space \space{}
24622 427 Park Lane did little to clear up the problem in which I was interested.
24623 The house was separated from the street by a low wall and railing,
24624 the whole not more than five feet high.
24625 It was perfectly easy,
24627 for anyone to get into the garden,
24628 but the window was entirely inaccessible,
24629 since there was no water pipe or anything which could help the most active man to climb it.
24630 More puzzled than ever,
24631 I retraced my steps to Kensington.
24632 I had not been in my study five minutes when the maid entered to say that a person desired to see me.
24633 To my astonishment it was none other than my strange old book collector,
24635 wizened face peering out from a frame of white hair,
24636 and his precious volumes,
24637 a dozen of them at least,
24638 wedged under his right arm.
24646 \begin_layout Standard
24650 \begin_layout Plain Layout
24662 \begin_inset Note Note
24665 \begin_layout Plain Layout
24666 go back to the default
24674 \begin_layout Paragraph
24678 \begin_layout Standard
24679 Between the columns a rule with a width of the length
24680 \begin_inset Flex Code
24683 \begin_layout Plain Layout
24692 If this rule width is set to 0
24693 \begin_inset space \thinspace{}
24696 pt (this is the default),
24697 the rule is suppressed.
24698 In the following example the rule is 2
24699 \begin_inset space \thinspace{}
24705 \begin_layout Standard
24709 \begin_layout Plain Layout
24715 columnseprule}{2pt}
24723 \begin_layout Standard
24724 \begin_inset Flex Multiple Columns
24727 \begin_layout Plain Layout
24730 \begin_inset Quotes eld
24733 You're surprised to see me,
24735 \begin_inset Quotes erd
24743 \begin_layout Plain Layout
24746 I acknowledged that I was.
24749 \begin_layout Plain Layout
24752 \begin_inset Quotes eld
24758 and when I chanced to see you go into this house,
24759 as I came hobbling after you,
24760 I thought to myself,
24761 I'll just step in and see that kind gentleman,
24762 and tell him that if I was a bit gruff in my manner there was not any harm meant,
24763 and that I am much obliged to him for picking up my books.
24764 \begin_inset Quotes erd
24770 \begin_layout Plain Layout
24773 \begin_inset Quotes eld
24776 You make too much of a trifle,
24777 \begin_inset Quotes erd
24782 \begin_inset Quotes eld
24785 May I ask how you knew who I was?
24786 \begin_inset Quotes erd
24792 \begin_layout Plain Layout
24795 \begin_inset Quotes eld
24800 if it isn't too great a liberty,
24801 I am a neighbour of yours,
24802 for you'll find my little bookshop at the corner of Church Street,
24803 and very happy to see you,
24805 Maybe you collect yourself,
24810 \begin_inset space ~
24826 \begin_inset space ~
24831 With five volumes you could just fill that gap on that second shelf.
24835 \begin_inset Quotes erd
24846 \begin_layout Standard
24847 \begin_inset VSpace defskip
24853 \begin_layout Standard
24854 The rule can be colored by redefining the command
24855 \begin_inset Flex Code
24858 \begin_layout Plain Layout
24867 This is done by inserting the command
24870 \begin_layout LyX-Code
24875 columnseprulecolor}{
24880 \begin_layout Standard
24881 as \SpecialChar TeX
24882 Code before the multicolumn inset.
24884 \begin_inset Flex Code
24887 \begin_layout Plain Layout
24893 in this command by a color of your choice.
24894 You can use all pre- and self-defined colors.
24903 \begin_inset space ~
24908 for more information about pre- and self-defined colors.
24909 To go back to the default color insert the command
24912 \begin_layout LyX-Code
24917 columnseprulecolor}{
24922 \begin_layout Standard
24923 Here is the example with a cyan rule and 1
24924 \begin_inset space \thinspace{}
24927 cm column separation:
24930 \begin_layout Standard
24934 \begin_layout Plain Layout
24943 \begin_layout Plain Layout
24949 columnseprulecolor}{
24959 \begin_layout Standard
24960 \begin_inset Flex Multiple Columns
24963 \begin_layout Plain Layout
24966 \begin_inset Quotes eld
24969 You're surprised to see me,
24971 \begin_inset Quotes erd
24979 \begin_layout Plain Layout
24982 I acknowledged that I was.
24985 \begin_layout Plain Layout
24988 \begin_inset Quotes eld
24994 and when I chanced to see you go into this house,
24995 as I came hobbling after you,
24996 I thought to myself,
24997 I'll just step in and see that kind gentleman,
24998 and tell him that if I was a bit gruff in my manner there was not any harm meant,
24999 and that I am much obliged to him for picking up my books.
25000 \begin_inset Quotes erd
25006 \begin_layout Plain Layout
25009 \begin_inset Quotes eld
25012 You make too much of a trifle,
25013 \begin_inset Quotes erd
25018 \begin_inset Quotes eld
25021 May I ask how you knew who I was?
25022 \begin_inset Quotes erd
25028 \begin_layout Plain Layout
25031 \begin_inset Quotes eld
25036 if it isn't too great a liberty,
25037 I am a neighbour of yours,
25038 for you'll find my little bookshop at the corner of Church Street,
25039 and very happy to see you,
25041 Maybe you collect yourself,
25046 \begin_inset space ~
25062 \begin_inset space ~
25067 With five volumes you could just fill that gap on that second shelf.
25071 \begin_inset Quotes erd
25082 \begin_layout Standard
25086 \begin_layout Plain Layout
25092 columnseprule}{0pt}
25095 \begin_layout Plain Layout
25101 columnseprulecolor}{
25109 \begin_inset Note Note
25112 \begin_layout Plain Layout
25113 go back to the default
25121 \begin_layout Section
25123 \change_inserted 564990737 1671270380
25127 \begin_layout Subsection
25129 \change_inserted 564990737 1671270398
25131 \change_deleted 564990737 1671270396
25137 \begin_layout Standard
25140 as well as any other text processor uses by default rectangular paragraphs.
25141 For special cases like for example posters,
25142 invitation cards or poems you can modify the paragraph shape to one of your choice.
25144 \change_deleted 564990737 1672311802
25145 This can be done by using the \SpecialChar LaTeX
25147 \begin_inset Flex Code
25150 \begin_layout Plain Layout
25156 which is loaded by using in the document settings the module
25158 Custom paragraph shapes
25161 \change_inserted 564990737 1672311802
25162 This module uses the
25166 package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
25172 \begin_layout Subsubsection
25176 \begin_layout Standard
25178 \change_inserted -712698321 1674913874
25189 \change_inserted -712698321 1674913877
25192 provides the following shapes:
25195 \begin_layout Standard
25196 \begin_inset Tabular
25197 <lyxtabular version="3" rows="13" columns="3">
25198 <features booktabs="true" islongtable="true" longtabularalignment="center">
25199 <column alignment="left" valignment="middle" width="16col%">
25200 <column alignment="left" valignment="middle" width="40col%">
25201 <column alignment="left" valignment="middle" width="35col%">
25202 <row endhead="true">
25203 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25206 \begin_layout Plain Layout
25215 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25218 \begin_layout Plain Layout
25227 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25230 \begin_layout Plain Layout
25240 <row interlinespace="default">
25241 <cell alignment="left" valignment="top" usebox="none">
25244 \begin_layout Plain Layout
25252 <cell alignment="left" valignment="top" usebox="none">
25255 \begin_layout Plain Layout
25258 Circle with circular hole (in the size of a CD/DVD)
25263 <cell alignment="left" valignment="top" usebox="none">
25266 \begin_layout Plain Layout
25270 take care there is not too much text
25276 <row interlinespace="default">
25277 <cell alignment="left" valignment="top" usebox="none">
25280 \begin_layout Plain Layout
25288 <cell alignment="left" valignment="top" usebox="none">
25291 \begin_layout Plain Layout
25299 <cell alignment="left" valignment="top" usebox="none">
25302 \begin_layout Plain Layout
25306 calculation might fail
25312 <row interlinespace="default">
25313 <cell alignment="left" valignment="top" usebox="none">
25316 \begin_layout Plain Layout
25324 <cell alignment="left" valignment="top" usebox="none">
25327 \begin_layout Plain Layout
25330 Rhomboid (symbolizing a
25331 \begin_inset Quotes eld
25335 \begin_inset Quotes erd
25343 <cell alignment="left" valignment="top" usebox="none">
25346 \begin_layout Plain Layout
25355 <row interlinespace="default">
25356 <cell alignment="left" valignment="top" usebox="none">
25359 \begin_layout Plain Layout
25367 <cell alignment="left" valignment="top" usebox="none">
25370 \begin_layout Plain Layout
25378 <cell alignment="left" valignment="top" usebox="none">
25381 \begin_layout Plain Layout
25390 <row interlinespace="default">
25391 <cell alignment="left" valignment="top" usebox="none">
25394 \begin_layout Plain Layout
25402 <cell alignment="left" valignment="top" usebox="none">
25405 \begin_layout Plain Layout
25413 <cell alignment="left" valignment="top" usebox="none">
25416 \begin_layout Plain Layout
25425 <row interlinespace="default">
25426 <cell alignment="left" valignment="top" usebox="none">
25429 \begin_layout Plain Layout
25437 <cell alignment="left" valignment="top" usebox="none">
25440 \begin_layout Plain Layout
25443 Nut for bolt (hexagon with circular hole)
25448 <cell alignment="left" valignment="top" usebox="none">
25451 \begin_layout Plain Layout
25460 <row interlinespace="default">
25461 <cell alignment="left" valignment="top" usebox="none">
25464 \begin_layout Plain Layout
25472 <cell alignment="left" valignment="top" usebox="none">
25475 \begin_layout Plain Layout
25483 <cell alignment="left" valignment="top" usebox="none">
25486 \begin_layout Plain Layout
25495 <row interlinespace="default">
25496 <cell alignment="left" valignment="top" usebox="none">
25499 \begin_layout Plain Layout
25507 <cell alignment="left" valignment="top" usebox="none">
25510 \begin_layout Plain Layout
25518 <cell alignment="left" valignment="top" usebox="none">
25521 \begin_layout Plain Layout
25530 <row interlinespace="default">
25531 <cell alignment="left" valignment="top" usebox="none">
25534 \begin_layout Plain Layout
25542 <cell alignment="left" valignment="top" usebox="none">
25545 \begin_layout Plain Layout
25553 <cell alignment="left" valignment="top" usebox="none">
25556 \begin_layout Plain Layout
25565 <row interlinespace="default">
25566 <cell alignment="left" valignment="top" usebox="none">
25569 \begin_layout Plain Layout
25577 <cell alignment="left" valignment="top" usebox="none">
25580 \begin_layout Plain Layout
25583 Normal/reversed rain drop
25588 <cell alignment="left" valignment="top" usebox="none">
25591 \begin_layout Plain Layout
25595 calculation might fail
25601 <row interlinespace="default">
25602 <cell alignment="left" valignment="top" usebox="none">
25605 \begin_layout Plain Layout
25614 <cell alignment="left" valignment="top" usebox="none">
25617 \begin_layout Plain Layout
25620 The \SpecialChar TeX
25626 <cell alignment="left" valignment="top" usebox="none">
25629 \begin_layout Plain Layout
25638 <row interlinespace="default">
25639 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25642 \begin_layout Plain Layout
25646 \begin_inset Newline newline
25654 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25657 \begin_layout Plain Layout
25660 Triangles in different orientations
25665 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
25668 \begin_layout Plain Layout
25684 \begin_layout Standard
25685 To use a shape for your paragraph,
25686 simply select it in \SpecialChar LyX
25687 's pull-down box for environments in the toolbar.
25690 \begin_layout Standard
25691 \begin_inset Newpage newpage
25697 \begin_layout Standard
25698 Here is an example paragraph in the shape of a nut:
25701 \begin_layout Standard
25702 \begin_inset VSpace bigskip
25711 Lorem ipsum dolor sit amet,
25712 consetetur sadipscing elitr,
25713 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25715 At vero eos et accusam et justo duo dolores et ea rebum.
25716 Stet clita kasd gubergren,
25717 no sea takimata sanctus est Lorem ipsum dolor sit amet.
25718 Lorem ipsum dolor sit amet,
25719 consetetur sadipscing elitr,
25720 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25724 \begin_layout Standard
25725 \begin_inset VSpace bigskip
25731 \begin_layout Standard
25732 \begin_inset Note Greyedout
25735 \begin_layout Plain Layout
25745 paragraphs cannot run over a page break.
25753 \begin_layout Standard
25754 \begin_inset VSpace bigskip
25760 \begin_layout Standard
25762 \begin_inset Flex Code
25765 \begin_layout Plain Layout
25771 takes care that the shape will always be preserved,
25772 no matter how much text is in the paragraph.
25773 Therefore the paragraph size changes with the amount of contained text.
25774 This can lead to paragraph sizes exceeding the page margins.
25775 To demonstrate the size scaling,
25776 here is the same example paragraph but with twice as much text:
25779 \begin_layout Standard
25780 \begin_inset Newpage newpage
25789 Lorem ipsum dolor sit amet,
25790 consetetur sadipscing elitr,
25791 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25793 At vero eos et accusam et justo duo dolores et ea rebum.
25794 Stet clita kasd gubergren,
25795 no sea takimata sanctus est Lorem ipsum dolor sit amet.
25796 Lorem ipsum dolor sit amet,
25797 consetetur sadipscing elitr,
25798 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25800 Lorem ipsum dolor sit amet,
25801 consetetur sadipscing elitr,
25802 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25804 At vero eos et accusam et justo duo dolores et ea rebum.
25805 Stet clita kasd gubergren,
25806 no sea takimata sanctus est Lorem ipsum dolor sit amet.
25807 Lorem ipsum dolor sit amet,
25808 consetetur sadipscing elitr,
25809 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25813 \begin_layout Standard
25814 \begin_inset VSpace bigskip
25820 \begin_layout Standard
25821 An exception is the shape
25826 It cannot be scaled because it must fit the size of a CD/DVD.
25827 Therefore the amount of text that fits into the shape is limited.
25828 \change_deleted -712698321 1674914001
25830 \begin_inset Newline newline
25834 \change_inserted -712698321 1674914001
25838 \begin_layout Standard
25848 meaning that the calculation of their size can fail,
25849 depending on the amount of text.
25850 You will then get the \SpecialChar LaTeX
25852 \begin_inset Quotes eld
25855 Arithmetic overflow
25856 \begin_inset Quotes erd
25860 In this case one can try to remove or add some text;
25861 if nothing works one has to use another shape.
25864 \begin_layout Standard
25866 \change_deleted -712698321 1674914021
25867 \begin_inset VSpace bigskip
25875 \begin_layout Standard
25876 For shapes with tips you will maybe see that \SpecialChar LaTeX
25877 's hyphenation routine fails for text in the tips.
25878 Therefore it is often necessary to add hyphenation points
25883 arg "specialchar-insert hyphenation"
25888 ) to the corresponding text parts.
25891 \begin_layout Standard
25893 \change_deleted -712698321 1674914022
25894 \begin_inset VSpace bigskip
25902 \begin_layout Standard
25903 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
25904 You can therefore not use the paragraph dialog to align such paragraphs.
25905 A solution is to put the paragraph into a minipage or parbox and align the box.
25906 The problem is hereby to find the right width for the box.
25907 Because if it is too wide and you center the box,
25908 the paragraph is not centered too because it sticks at the left side of the box.
25909 So you might have to play a bit with the width until it fits.
25910 Here are two heart-shaped paragraphs,
25911 the first one is not aligned,
25912 the second one is right-aligned:
25915 \begin_layout Standard
25916 \begin_inset Newpage newpage
25922 \begin_layout Heart
25926 Lo\SpecialChar softhyphen
25927 rem ipsum dolor sit amet,
25928 consetetur sadipscing elitr,
25929 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25931 At vero eos et accusam et justo duo dolores et ea rebum.
25932 Stet clita kasd gubergren,
25933 no sea takimata sanctus est Lorem ipsum dolor sit amet.
25936 \begin_layout Standard
25937 \begin_inset VSpace bigskip
25943 \begin_layout Standard
25946 \begin_inset Box Frameless
25956 height_special "totalheight"
25961 backgroundcolor "none"
25964 \begin_layout Heart
25968 Lo\SpecialChar softhyphen
25969 rem ipsum dolor sit amet,
25970 consetetur sadipscing elitr,
25971 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
25973 At vero eos et accusam et justo duo dolores et ea rebum.
25974 Stet clita kasd gubergren,
25975 no sea takimata sanctus est Lorem ipsum dolor sit amet.
25983 \begin_layout Subsubsection
25987 \begin_layout Standard
25988 You can define any shape you want.
25989 Doing this manually is a lot of work because every coordinate must be specified.
25990 But there is a way to let the computer calculate the coordinates:
25993 \begin_layout Enumerate
25994 Install the program
25995 \begin_inset CommandInset href
25998 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26006 \begin_layout Enumerate
26013 TeX/LaTeX\SpecialChar menuseparator
26014 Settings\SpecialChar menuseparator
26017 and select the font size you are using in your document.
26018 For example this document uses the size 12
26019 \begin_inset space \thinspace{}
26025 \begin_layout Enumerate
26029 \begin_layout Enumerate
26032 TeX/LaTeX\SpecialChar menuseparator
26035 to export the shape to coordinates.
26036 In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
26040 \begin_layout Plain Layout
26041 For more information see
26042 \begin_inset CommandInset href
26044 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26057 \begin_layout Standard
26058 The coordinates are written into a \SpecialChar TeX
26060 To use it for your \SpecialChar LyX
26064 \begin_layout Enumerate
26065 Place the cursor before the first character of your paragraph (or into a new empty one).
26068 \begin_layout Enumerate
26069 Open in \SpecialChar LyX
26072 Insert\SpecialChar menuseparator
26073 File\SpecialChar menuseparator
26075 \begin_inset space ~
26081 select the file and use
26090 \begin_layout Standard
26091 \begin_inset VSpace defskip
26097 \begin_layout Standard
26098 \begin_inset Note Greyedout
26101 \begin_layout Plain Layout
26107 The changed shape only applies to the current paragraph;
26108 everything is reset to normal for the next paragraph.
26109 Therefore the shape definition file must be input into every paragraph with the desired shape.
26117 \begin_layout Standard
26118 \begin_inset VSpace bigskip
26124 \begin_layout Standard
26125 Here is an example:
26128 \begin_layout Standard
26129 \begin_inset VSpace bigskip
26135 \begin_layout Standard
26136 \begin_inset CommandInset include
26138 filename "SpecialParagraphShape.tex"
26145 Lorem ipsum dolor sit amet,
26146 consetetur sadipscing elitr,
26147 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26149 At vero eos et accusam et justo duo dolores et ea rebum.
26150 Stet clita kasd gubergren,
26151 no sea takimata sanctus est Lorem ipsum dolor sit amet.
26152 Lorem ipsum dolor sit amet,
26153 consetetur sadipscing elitr,
26154 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
26158 \begin_layout Standard
26159 \begin_inset VSpace bigskip
26165 \begin_layout Standard
26171 to draw complexer shapes in
26175 you can draw the shape in a program of your choice and import the resulting image to
26180 Then you only need to draw a line or spline along the outline of the image.
26183 \begin_layout Standard
26185 \change_deleted -712698321 1674914114
26186 \begin_inset VSpace bigskip
26194 \begin_layout Standard
26197 Custom paragraph shapes
26199 also provides the two commands
26207 which can be used to define custom shapes coordinate by coordinate.
26211 \begin_layout Plain Layout
26212 These commands are internally used for all shapes described here.
26217 For information how these styles are used and about further customization possibilities,
26219 \begin_inset CommandInset href
26221 name "documentation"
26222 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26228 \begin_inset Flex Code
26231 \begin_layout Plain Layout
26240 \begin_layout Subsection
26242 \change_inserted 564990737 1672311925
26246 \begin_layout Hanging
26248 \change_inserted 564990737 1672311925
26249 This module adds the
26255 one where all but the first line of the paragraph is indented.
26256 This may not appear in your \SpecialChar LyX
26257 document but will appear in the final output.
26260 \begin_layout Subsection
26262 \change_inserted 564990737 1672311925
26263 \begin_inset CommandInset label
26265 name "subsec:Initials"
26269 Initials (Drop Caps)
26272 \begin_layout Initial
26274 \change_inserted 564990737 1672311925
26275 \begin_inset Argument 2
26278 \begin_layout Plain Layout
26280 \change_inserted 564990737 1672311925
26289 \begin_inset Argument 3
26292 \begin_layout Plain Layout
26294 \change_inserted 564990737 1672311925
26302 module adds a drop capitals paragraph style
26306 for paragraph environments which you can use wherever you want to have drop capitals.
26307 You then have three more items in the
26314 \begin_layout Itemize
26316 \change_inserted 564990737 1672311925
26321 which creates an inset for the drop capital
26324 \begin_layout Itemize
26326 \change_inserted 564990737 1672311925
26331 which creates an inset for the rest of the word
26334 \begin_layout Itemize
26336 \change_inserted 564990737 1672311925
26341 which allow you configure the formatting of the drop capital.
26344 \begin_layout Standard
26346 \change_inserted 564990737 1672311925
26347 To customize the appearance of the style,
26350 Help\SpecialChar menuseparator
26351 Embedded Objects\SpecialChar menuseparator
26352 Objects Surrounded by Text\SpecialChar menuseparator
26358 \begin_layout Section
26360 \change_inserted 564990737 1672312011
26364 \begin_layout Subsection
26366 \change_inserted 564990737 1672312011
26367 Hyphenatable Text Markup
26368 \change_inserted -712698321 1674915075
26370 \change_inserted 564990737 1672312011
26374 \begin_layout Standard
26376 \change_inserted 564990737 1672312011
26378 \change_deleted -712698321 1674915086
26380 \change_inserted -712698321 1674915087
26382 \change_inserted 564990737 1672312011
26383 defines text styles to highlight,
26386 underline and capitalize/small-cap text by means of the
26392 \change_inserted -712698321 1674915141
26396 \begin_layout Standard
26398 \change_inserted 564990737 1672312011
26399 As opposed to the markup provided by the Text Properties dialog,
26400 words marked-up with
26406 \begin_inset CommandInset href
26408 name "soul documentation"
26409 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
26417 \begin_layout Subsection
26419 \change_inserted 564990737 1672312011
26423 \begin_layout Standard
26425 \change_inserted 564990737 1672312011
26426 This module defines some character styles for logical markup:
26430 \begin_inset Flex Noun
26433 \begin_layout Plain Layout
26435 \change_inserted 564990737 1672312011
26451 \begin_inset Flex Emph
26454 \begin_layout Plain Layout
26456 \change_inserted 564990737 1672312011
26470 \begin_inset Flex Strong
26473 \begin_layout Plain Layout
26475 \change_inserted 564990737 1672312011
26485 \begin_inset Flex Code
26488 \begin_layout Plain Layout
26490 \change_inserted 564990737 1672312011
26498 which are accessed via the
26503 dit\SpecialChar menuseparator
26505 \begin_inset space ~
26509 \begin_inset space ~
26521 \begin_layout Chapter
26523 \change_deleted 564990737 1671304317
26527 \change_inserted 564990737 1671304322
26529 \change_deleted 564990737 1671304331
26530 ies with Bib\SpecialChar TeX
26536 \begin_layout Standard
26537 The most basic information about how to use Bib\SpecialChar TeX
26542 with \SpecialChar LyX
26543 is contained in the section
26545 Bibliography databases
26552 The following subsections explain special bibliography features supported by \SpecialChar LyX
26556 \begin_layout Section
26557 Alternative Citation Styles
26560 \begin_layout Standard
26561 Standard Bib\SpecialChar TeX
26563 \begin_inset space \thinspace{}
26567 \begin_inset space \space{}
26571 \begin_inset Quotes eld
26575 \begin_inset Quotes erd
26578 ) to refer to a cited work.
26580 in many scientific disciplines,
26581 other citation styles are in use.
26582 The most common one is the author-year style (e.
26583 \begin_inset space \thinspace{}
26587 \begin_inset space \space{}
26591 \begin_inset Quotes eld
26595 \begin_inset Quotes erd
26600 supports three packages that provide this style,
26602 \begin_inset Flex Code
26605 \begin_layout Plain Layout
26613 \begin_inset Flex Code
26616 \begin_layout Plain Layout
26624 \begin_inset Flex Code
26627 \begin_layout Plain Layout
26634 Each of these packages has their pros and cons,
26635 which cannot be listed in detail.
26636 If you only want to have simple author-year (or author-numerical) style,
26637 or if you want to use one of the countless style files for
26638 \begin_inset Flex Code
26641 \begin_layout Plain Layout
26648 then the established
26649 \begin_inset Flex Code
26652 \begin_layout Plain Layout
26658 package is probably your choice.
26659 If you look for specific citation styles common in law studies,
26660 you might consider the
26661 \begin_inset Flex Code
26664 \begin_layout Plain Layout
26671 If you want to have full control over the formatting or look for advanced features such as ibidem,
26672 footnote citations,
26673 full title citations,
26674 advanced date formats (such as 400 BC) or full localization to other languages than English,
26675 you should definitely consider
26676 \begin_inset Flex Code
26679 \begin_layout Plain Layout
26686 which exceeds all other packages in terms of features,
26687 but is also quite heavy and more resource-hungry.
26690 \begin_layout Standard
26691 The handling of these packages in \SpecialChar LyX
26692 is basically the same.
26694 \change_deleted -712698321 1674917685
26696 \begin_inset Flex Noun
26699 \begin_layout Plain Layout
26700 Document\SpecialChar menuseparator
26707 \change_inserted -712698321 1674917685
26710 Document\SpecialChar menuseparator
26716 \change_deleted -712698321 1674917692
26718 \begin_inset Flex Noun
26721 \begin_layout Plain Layout
26728 \change_inserted -712698321 1674917692
26736 \change_deleted -712698321 1674917696
26738 \begin_inset Flex Noun
26741 \begin_layout Plain Layout
26748 \change_inserted -712698321 1674917696
26756 \change_deleted -712698321 1674917703
26758 \begin_inset Flex Noun
26761 \begin_layout Plain Layout
26768 \change_inserted -712698321 1674917703
26777 \change_deleted -712698321 1674917708
26779 \begin_inset Flex Noun
26782 \begin_layout Plain Layout
26789 \change_inserted -712698321 1674917708
26798 \change_deleted -712698321 1674917712
26800 \begin_inset Flex Noun
26803 \begin_layout Plain Layout
26804 Biblatex (Natbib mode)
26810 \change_inserted -712698321 1674917712
26813 Biblatex (Natbib mode)
26819 \change_deleted -712698321 1674917718
26821 \begin_inset Flex Noun
26824 \begin_layout Plain Layout
26831 \change_inserted -712698321 1674917718
26839 \change_deleted -712698321 1674917724
26841 \begin_inset Flex Noun
26844 \begin_layout Plain Layout
26851 \change_inserted -712698321 1674917724
26859 \begin_inset space ~
26862 6.5.3 in the User's Guide for more information on these choices).
26863 With all these packages,
26864 you will get some extra features in the citation dialog and you can select the style of the reference (
26865 \begin_inset Quotes eld
26869 \begin_inset Quotes erd
26874 \begin_inset Quotes eld
26878 \begin_inset Quotes erd
26883 \begin_inset Quotes eld
26888 \begin_inset Quotes erd
26893 \begin_inset Quotes eld
26897 \begin_inset Quotes erd
26901 Note that either package needs specifically designed style files.
26902 They all ship their own,
26903 but there are lots of additional style files,
26904 and there is even an interactive style file builder
26908 \begin_layout Plain Layout
26910 \begin_inset Flex URL
26913 \begin_layout Plain Layout
26915 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
26926 \begin_inset Flex Code
26929 \begin_layout Plain Layout
26938 \begin_layout Section
26939 Subdivided Bibliographies
26942 \begin_layout Standard
26943 Sometimes you might need to divide your bibliography into several sections.
26944 If you are for instance a historian,
26945 the possibility to separate sources and scientific works is most likely a
26946 \begin_inset Quotes eld
26950 \begin_inset Quotes erd
26955 Bib\SpecialChar TeX
26956 itself does not allow you to do this.
26957 But with the help of some \SpecialChar LaTeX
26959 Bib\SpecialChar TeX
26960 can be extended to fit your needs.
26963 \begin_layout Standard
26965 provides native support for one of these packages,
26974 \begin_layout Plain Layout
26976 \begin_inset Flex URL
26979 \begin_layout Plain Layout
26981 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
26991 The advantage of this package (compared to other packages such as
26995 ) is that you don't need to define new citation commands.
26997 you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
26999 If you want to divide your bibliography into the sections
27000 \begin_inset Quotes eld
27004 \begin_inset Quotes erd
27008 \begin_inset Quotes eld
27012 \begin_inset Quotes erd
27016 you first need to create two bibliographic databases,
27018 \begin_inset space \thinspace{}
27022 \begin_inset space \space{}
27026 \begin_inset Flex Code
27029 \begin_layout Plain Layout
27036 \begin_inset Flex Code
27039 \begin_layout Plain Layout
27049 \begin_layout Standard
27051 \change_deleted -712698321 1674917736
27053 \begin_inset Flex Noun
27056 \begin_layout Plain Layout
27057 Document\SpecialChar menuseparator
27064 \change_inserted -712698321 1674917736
27067 Document\SpecialChar menuseparator
27073 \change_deleted -712698321 1674917752
27075 \begin_inset Flex Noun
27078 \begin_layout Plain Layout
27085 \change_inserted -712698321 1674917752
27093 \change_deleted -712698321 1674917741
27097 \begin_inset Flex Noun
27100 \begin_layout Plain Layout
27103 Subdivided bibliography
27109 \change_inserted -712698321 1674917741
27110 Subdivided bibliography
27115 Now you can insert multiple Bib\SpecialChar TeX
27117 one for each section of your bibliography.
27118 Returning to our example:
27119 Insert the Bib\SpecialChar TeX
27121 \begin_inset Flex Code
27124 \begin_layout Plain Layout
27130 and a second one for the database
27131 \begin_inset Flex Code
27134 \begin_layout Plain Layout
27141 You are free to use the same or different styles for each section.
27143 you can choose if the bibliography section should contain
27144 \begin_inset Quotes eld
27147 all cited references
27148 \begin_inset Quotes erd
27151 of the specified database(s) (which is the default),
27153 \begin_inset Quotes eld
27156 all uncited references
27157 \begin_inset Quotes erd
27161 \begin_inset Quotes eld
27165 \begin_inset Quotes erd
27169 This might be useful if you would like to separate your bibliography into three sections:
27171 \begin_inset Quotes eld
27175 \begin_inset Quotes erd
27180 \begin_inset Quotes eld
27184 \begin_inset Quotes erd
27189 \begin_inset Quotes eld
27193 \begin_inset Quotes erd
27197 The titles for the sections can be added as ordinary sections or subsections.
27199 \begin_inset Flex Code
27202 \begin_layout Plain Layout
27208 removes the bibliography title,
27209 you have to manually re-add that,
27210 too (as a chapter* or section*,
27214 \begin_layout Standard
27220 the procedure is a bit different.
27231 \begin_inset Flex Noun
27234 \begin_layout Plain Layout
27235 Subdivided bibliography
27240 option is disabled if you use
27250 provides its own means to generate subdivided bibliographies.
27251 You can either add keywords to bibliography entries via the
27252 \begin_inset Flex Code
27255 \begin_layout Plain Layout
27261 entry option and then filter bibliography sections by keyword (by adding
27262 \begin_inset Flex Code
27265 \begin_layout Plain Layout
27272 \begin_inset Flex Noun
27275 \begin_layout Plain Layout
27281 field of the dialog that opens if you left-click on the
27282 \begin_inset Flex Noun
27285 \begin_layout Plain Layout
27286 Biblatex Generated Bibliography
27292 or you can filter by entry types (such as
27301 \begin_inset space \thinspace{}
27306 \begin_inset Flex Code
27309 \begin_layout Plain Layout
27316 \begin_inset Flex Code
27319 \begin_layout Plain Layout
27326 \begin_inset Flex Noun
27329 \begin_layout Plain Layout
27336 or you can create so-called
27337 \begin_inset Quotes eld
27340 Bibliography Categories
27341 \begin_inset Quotes erd
27344 to which you can assign individual entries.
27345 Please refer to the Biblatex manual,
27348 Subdivided Bibliographies
27354 \begin_layout Section
27355 Multiple Bibliographies
27356 \begin_inset CommandInset label
27358 name "subsec:Multiple-Bibliographies"
27365 \begin_layout Standard
27366 Multiple bibliographies,
27368 \begin_inset space \thinspace{}
27372 \begin_inset space \space{}
27375 a bibliography for each part,
27378 subsection or child (sub-document) of the document,
27379 are also supported by \SpecialChar LyX
27381 In order to enable it,
27383 \change_deleted -712698321 1674917759
27385 \begin_inset Flex Noun
27388 \begin_layout Plain Layout
27389 Document\SpecialChar menuseparator
27390 Settings\SpecialChar menuseparator
27397 \change_inserted -712698321 1674917759
27400 Document\SpecialChar menuseparator
27401 Settings\SpecialChar menuseparator
27406 and select the relevant unit (e.
27407 \begin_inset space \thinspace{}
27412 \begin_inset Quotes eld
27416 \begin_inset Quotes erd
27420 \begin_inset Flex Noun
27423 \begin_layout Plain Layout
27424 Multiple Bibliographies
27430 Then add a Bib(la)\SpecialChar TeX
27431 bibliography to each unit (e.
27432 \begin_inset space \thinspace{}
27436 section) of your document.
27438 a separate bibliography,
27439 containing only the references done in the current unit is generated.
27442 \begin_layout Standard
27443 If you use Bib\SpecialChar TeX
27446 \begin_inset Flex Code
27449 \begin_layout Plain Layout
27456 \begin_inset Flex Code
27459 \begin_layout Plain Layout
27465 package is used to create multiple bibliographies.
27466 The former package is used if you select
27467 \begin_inset Quotes eld
27471 \begin_inset Quotes erd
27479 \begin_inset Flex Noun
27482 \begin_layout Plain Layout
27483 Sectioned Bibliography
27489 In all other cases,
27491 \begin_inset Flex Code
27494 \begin_layout Plain Layout
27504 \begin_layout Plain Layout
27505 An alternative approach,
27506 if you are willing to use some
27507 \begin_inset Flex Noun
27510 \begin_layout Plain Layout
27518 \begin_inset space ~
27522 \begin_inset CommandInset ref
27524 reference "sec:Inserting-TeX-Code"
27531 \begin_inset Flex Code
27534 \begin_layout Plain Layout
27546 \begin_inset Flex Code
27549 \begin_layout Plain Layout
27557 encloses the specified units in
27558 \begin_inset Flex Code
27561 \begin_layout Plain Layout
27568 \begin_inset Flex Code
27571 \begin_layout Plain Layout
27580 \begin_inset Flex Code
27583 \begin_layout Plain Layout
27591 in order to create the units.
27592 Note that this approach has some limitations.
27594 every citation reference has to be inside some
27595 \begin_inset Flex Code
27598 \begin_layout Plain Layout
27605 So citations outside a defined unit (e.
27606 \begin_inset space \thinspace{}
27610 before the first section if you use
27611 \begin_inset Quotes eld
27615 \begin_inset Quotes erd
27619 \begin_inset Quotes eld
27623 \begin_inset Quotes erd
27627 You can also create your own units by entering
27628 \begin_inset Flex Code
27631 \begin_layout Plain Layout
27640 \begin_inset Flex Code
27643 \begin_layout Plain Layout
27651 as \SpecialChar TeX
27652 code (for instance to work around the mentioned limitation).
27656 \begin_inset Flex Code
27659 \begin_layout Plain Layout
27665 s cannot be nested.
27666 A second limitation is that
27667 \begin_inset Flex Code
27670 \begin_layout Plain Layout
27676 always processes all references of a bibliography database,
27677 even if they are not cited.
27678 This can result in odd labels (e.
27679 \begin_inset space \thinspace{}
27684 \begin_inset Quotes eld
27688 \begin_inset Quotes erd
27691 if two works of this author from 2014 are in the database,
27692 even if only one is cited).
27695 \begin_layout Standard
27702 \begin_inset Flex Code
27705 \begin_layout Plain Layout
27711 option is used instead.
27712 If you need specific units,
27713 you can start them with the \SpecialChar TeX
27715 \begin_inset Flex Code
27718 \begin_layout Plain Layout
27727 \begin_inset Flex Code
27730 \begin_layout Plain Layout
27740 If you also want to control the end of the unit,
27741 use the environment
27742 \begin_inset Flex Code
27745 \begin_layout Plain Layout
27755 \begin_inset Flex Code
27758 \begin_layout Plain Layout
27770 \begin_inset Flex Code
27773 \begin_layout Plain Layout
27779 s cannot be nested.
27780 In addition to the individual bibliography of the current unit,
27785 also provides an easy way to output all bibliographies,
27788 \begin_inset space \thinspace{}
27792 at the end of the document).
27794 \begin_inset Quotes eld
27797 all reference units
27798 \begin_inset Quotes erd
27801 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
27802 Please refer to the
27806 manual for more information on this topic.
27809 \begin_layout Chapter
27811 \change_deleted 564990737 1671355654
27815 \change_inserted 564990737 1671355667
27817 \change_deleted 564990737 1671355661
27819 \change_inserted 564990737 1671355684
27821 \begin_inset CommandInset label
27823 name "chap:bullets"
27828 \change_deleted 564990737 1671355684
27830 \begin_inset CommandInset label
27841 \begin_layout Standard
27847 \begin_layout Section
27851 \begin_layout Standard
27853 provides 216 bullet shapes that can be accessed from a simple dialog.
27854 Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
27855 These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
27859 \begin_layout Plain Layout
27861 actually you can but you'll have to do it by hand.
27869 \begin_layout Section
27873 \begin_layout Standard
27874 Open the dialog by selecting the
27875 \change_deleted -712698321 1674916009
27877 \begin_inset Flex Noun
27880 \begin_layout Plain Layout
27881 Document\SpecialChar menuseparator
27888 \change_inserted -712698321 1674916009
27891 Document\SpecialChar menuseparator
27896 menu item and then select the
27897 \begin_inset Flex Noun
27900 \begin_layout Plain Layout
27909 \begin_layout Standard
27910 The dialog provides you with a table of bullet shapes.
27911 A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
27912 The row of buttons across the top is used to select which bullet depth you are changing.
27913 \change_inserted -712698321 1674916033
27917 \begin_layout Standard
27919 \change_inserted -712698321 1674916177
27926 \change_deleted -712698321 1674916065
27928 \change_inserted -712698321 1674916067
27931 text entry under the table
27932 \change_inserted -712698321 1674916074
27934 \change_deleted -712698321 1674916096
27935 shows the currently selected
27936 \change_inserted -712698321 1674916101
27937 in which you can enter a
27939 bullet shape's \SpecialChar LaTeX
27941 \change_deleted -712698321 1674916109
27942 and this can be edited if desired
27945 If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
27949 \begin_layout Standard
27950 The six panels are divided up by the packages they require.
27951 The following table shows the mappings from button name to \SpecialChar LaTeX
27955 \begin_layout Standard
27957 \begin_inset Tabular
27958 <lyxtabular version="3" rows="7" columns="2">
27959 <features tabularvalignment="middle">
27960 <column alignment="center" valignment="top" width="0pt">
27961 <column alignment="center" valignment="top" width="0pt">
27963 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27966 \begin_layout Plain Layout
27981 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27984 \begin_layout Plain Layout
28001 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28004 \begin_layout Plain Layout
28019 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28022 \begin_layout Plain Layout
28031 base \SpecialChar LaTeX
28039 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28042 \begin_layout Plain Layout
28057 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28060 \begin_layout Plain Layout
28077 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28080 \begin_layout Plain Layout
28095 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28098 \begin_layout Plain Layout
28115 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28118 \begin_layout Plain Layout
28133 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28136 \begin_layout Plain Layout
28153 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
28156 \begin_layout Plain Layout
28171 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28174 \begin_layout Plain Layout
28191 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28194 \begin_layout Plain Layout
28209 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28212 \begin_layout Plain Layout
28235 \begin_layout Standard
28237 doesn't stop you using bullets from packages you don't have.
28238 If you get errors from \SpecialChar LaTeX
28239 when you try to view or print the file,
28240 then it is likely you are missing a package.
28244 \begin_layout Plain Layout
28246 doesn't restrict your use since you may be editing locally and exporting elsewhere.
28254 \begin_layout Section
28256 \change_inserted -712698321 1674916414
28257 \begin_inset CommandInset label
28259 name "sec:How-to-use"
28268 \begin_layout Standard
28269 Select which bullet depth you want to change then select the bullet shape and size.
28270 Any changes will not be visible in \SpecialChar LyX
28272 but are visible when viewing the document.
28275 \begin_layout Standard
28276 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
28277 \change_deleted -712698321 1674916288
28282 \begin_layout Plain Layout
28284 \change_deleted -712698321 1674916287
28285 \begin_inset CommandInset label
28287 name "fn:If-you-really"
28297 want to have multiple sets of paragraphs with different sets of bullets in each,
28298 then you're going to have to get your hands dirty with \SpecialChar TeX
28300 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
28301 code for a wide range of bullet shapes.
28302 To make your own custom paragraphs you have the following options:
28305 \begin_layout Plain Layout
28309 \begin_layout Plain Layout
28325 \begin_layout Plain Layout
28329 \begin_layout Plain Layout
28351 \begin_layout Itemize
28352 Use the \SpecialChar LaTeX
28354 \begin_inset Flex Code
28357 \begin_layout Plain Layout
28365 to specify a new bullet shape for a given depth.
28366 You'll also need to save the current bullet shape so you can restore it again afterwards.
28367 In this itemized list the following \SpecialChar LaTeX
28368 code was used to change the bullet used for the first depth.
28372 \begin_layout LyX-Code
28382 \begin_layout LyX-Code
28399 \begin_layout Itemize
28400 Note that the itemize depth is specified in Roman numerals as part of the
28409 \begin_layout Itemize
28410 \begin_inset Argument item:1
28413 \begin_layout Plain Layout
28417 \begin_layout Plain Layout
28435 Specify each individual entry by starting each item with the bullet shape enclosed in a
28436 \begin_inset Quotes eld
28440 \begin_inset Quotes erd
28443 inset (available at
28445 Insert\SpecialChar menuseparator
28449 \begin_inset Flex Noun
28452 \begin_layout Plain Layout
28461 this item was started with
28462 \begin_inset Flex Code
28465 \begin_layout Plain Layout
28480 \begin_layout Plain Layout
28484 \begin_layout Plain Layout
28500 \begin_layout Plain Layout
28501 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
28502 The way used here was:
28505 \begin_layout LyX-Code
28518 \change_inserted -712698321 1674916331
28520 \begin_inset CommandInset label
28522 name "fn:If-you-really"
28529 \begin_layout Standard
28531 \change_inserted -712698321 1674916288
28536 want to have multiple sets of paragraphs with different sets of bullets in each,
28537 then you're going to have to get your hands dirty with \SpecialChar TeX
28539 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
28540 code for a wide range of bullet shapes.
28541 To make your own custom paragraphs you have the following options:
28544 \begin_layout Standard
28546 \change_inserted -712698321 1674916288
28550 \begin_layout Plain Layout
28552 \change_inserted -712698321 1674916288
28568 \begin_layout Standard
28570 \change_inserted -712698321 1674916288
28574 \begin_layout Plain Layout
28576 \change_inserted -712698321 1674916288
28598 \begin_layout Itemize
28600 \change_inserted -712698321 1674916288
28601 Use the \SpecialChar LaTeX
28603 \begin_inset Flex Code
28606 \begin_layout Plain Layout
28608 \change_inserted -712698321 1674916288
28618 to specify a new bullet shape for a given depth.
28619 You'll also need to save the current bullet shape so you can restore it again afterwards.
28620 In this itemized list the following \SpecialChar LaTeX
28621 code was used to change the bullet used for the first depth.
28625 \begin_layout LyX-Code
28627 \change_inserted -712698321 1674916288
28637 \begin_layout LyX-Code
28639 \change_inserted -712698321 1674916288
28656 \begin_layout Itemize
28658 \change_inserted -712698321 1674916288
28659 Note that the itemize depth is specified in Roman numerals as part of the
28668 \begin_layout Itemize
28670 \change_inserted -712698321 1674916288
28671 \begin_inset Argument item:1
28674 \begin_layout Plain Layout
28676 \change_inserted -712698321 1674916288
28680 \begin_layout Plain Layout
28682 \change_inserted -712698321 1674916288
28702 Specify each individual entry by starting each item with the bullet shape enclosed in a
28703 \begin_inset Quotes eld
28707 \begin_inset Quotes erd
28710 inset (available at
28712 Insert\SpecialChar menuseparator
28716 \begin_inset Flex Noun
28719 \begin_layout Plain Layout
28721 \change_inserted -712698321 1674916288
28732 this item was started with
28733 \begin_inset Flex Code
28736 \begin_layout Plain Layout
28738 \change_inserted -712698321 1674916288
28755 \begin_layout Standard
28757 \change_inserted -712698321 1674916288
28761 \begin_layout Plain Layout
28763 \change_inserted -712698321 1674916288
28779 \begin_layout Standard
28781 \change_inserted -712698321 1674916288
28782 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
28783 The way used here was:
28786 \begin_layout LyX-Code
28788 \change_inserted -712698321 1674916288
28800 \begin_layout Chapter
28804 \begin_layout Section
28805 Multipart Documents
28808 \begin_layout Subsection
28812 \begin_layout Standard
28813 When you are working on a large file with many sections,
28814 it is often convenient to break up the document into several files,
28815 or perhaps you have something where a table may change from time to time,
28816 but the preceding text does not.
28818 you should seriously consider using multipart documents.
28820 scientific papers often have five major sections:
28826 Each of these could be its own separate \SpecialChar LyX
28829 \begin_inset Quotes eld
28833 \begin_inset Quotes erd
28836 file which contains the title,
28841 plus the five included files.
28842 It is important to note that each of these files is a full \SpecialChar LyX
28843 file which can be formatted and printed on its own,
28844 as well as included in a master file.
28845 Each of these files must have the same document class,
28847 don't attempt to mix book classes with article classes.
28848 You may also include \SpecialChar LaTeX
28851 these files must not have their own preamble (i.
28852 \begin_inset space \thinspace{}
28856 \begin_inset space \space{}
28859 everything up to and including the
28860 \begin_inset Flex Code
28863 \begin_layout Plain Layout
28871 line as well as the
28872 \begin_inset Flex Code
28875 \begin_layout Plain Layout
28883 line must be deleted) or else errors will be generated when you try to make a DVI file.
28886 \begin_layout Standard
28888 allows you to include files quite easily with
28889 \change_deleted -712698321 1674917774
28891 \begin_inset Flex Noun
28894 \begin_layout Plain Layout
28895 Insert\SpecialChar menuseparator
28897 \begin_inset space ~
28906 \change_inserted -712698321 1674917774
28909 Insert\SpecialChar menuseparator
28911 \begin_inset space ~
28919 When you click on this selection a small box is inserted into the file at the current cursor location.
28920 Clicking on the box raises a dialog which allows you to select the file to be included,
28921 and the method of its inclusion.
28925 \begin_layout Standard
28926 The file selection box should by now be obvious.
28927 The three inclusion methods are
28928 \begin_inset Quotes eld
28932 \begin_inset Quotes erd
28937 \begin_inset Quotes eld
28941 \begin_inset Quotes erd
28946 \begin_inset Quotes eld
28950 \begin_inset Quotes erd
28955 \begin_inset Quotes eld
28959 \begin_inset Quotes erd
28963 \begin_inset Quotes eld
28967 \begin_inset Quotes erd
28970 are similar in many ways,
28971 but there are also some notable differences:
28974 \begin_layout Enumerate
28976 \begin_inset Quotes eld
28980 \begin_inset Quotes erd
28983 are typeset beginning on a new page,
28984 while files that are
28985 \begin_inset Quotes eld
28989 \begin_inset Quotes erd
28992 are typeset starting on the current page.
28995 \begin_layout Enumerate
28996 \begin_inset Quotes eld
29000 \begin_inset Quotes erd
29003 files cannot themselves
29004 \begin_inset Quotes eld
29008 \begin_inset Quotes erd
29012 \begin_inset Quotes eld
29016 \begin_inset Quotes erd
29021 \begin_inset Quotes eld
29025 \begin_inset Quotes erd
29030 infinite sub-inputting is possible.
29033 \begin_layout Enumerate
29034 \begin_inset Quotes eld
29038 \begin_inset Quotes erd
29041 allow for the output of only selected
29042 \begin_inset Quotes eld
29046 \begin_inset Quotes erd
29050 while maintaining the actual counters (pagination etc.) and references (please refer to the section
29053 \begin_inset space ~
29061 \begin_inset space ~
29066 manual for details).
29069 \begin_layout Standard
29072 \begin_inset Quotes eld
29076 \begin_inset Quotes erd
29079 is the preferred method for chapters that are outsourced to child documents,
29081 \begin_inset Quotes eld
29085 \begin_inset Quotes erd
29088 is more suitable for arbitrary file inheritance.
29091 \begin_layout Standard
29093 \begin_inset Quotes eld
29097 \begin_inset Quotes erd
29100 included file allows you to include a file typeset exactly as it appears in the file,
29102 \begin_inset space \thinspace{}
29106 \begin_inset space \space{}
29110 \begin_inset Flex Code
29113 \begin_layout Plain Layout
29120 with the characters set in a fixed-width typewriter font.
29122 spaces in this file are invisible,
29123 though two consecutive spaces are conserved,
29124 unlike \SpecialChar LyX
29125 's normal treatment of spaces.
29128 \begin_inset Flex Noun
29131 \begin_layout Plain Layout
29133 \begin_inset space ~
29137 \begin_inset space ~
29141 \begin_inset space ~
29149 checkbox typesets a mark to unambiguously define the presence of a space.
29153 \begin_layout Standard
29155 the master file is converted into a full \SpecialChar LaTeX
29156 file before typesetting,
29157 while the included files are converted to \SpecialChar LaTeX
29158 files that do not have all the preamble information.
29161 \begin_layout Subsection
29162 Cross-References Between Files
29165 \begin_layout Standard
29166 \begin_inset Box Shadowbox
29176 height_special "totalheight"
29181 backgroundcolor "none"
29184 \begin_layout Plain Layout
29185 This section is somewhat out of date.
29186 Need to describe default master documents and how children are opened when the master is.
29195 \begin_layout Standard
29196 It is possible to set up cross-references between the different files.
29198 open all the files in question:
29199 let's call them A and B in a two file example,
29200 where B is included in A.
29201 Let's say you insert a label in A,
29202 then want to reference it in B.
29203 Open the cross-reference dialog whilst in document B,
29204 and you can select the
29205 \begin_inset Quotes eld
29209 \begin_inset Quotes erd
29215 \begin_layout Subsection
29216 Bibliography Lists in all Subdocuments
29219 \begin_layout Standard
29220 If you work with child documents,
29221 you might want to have only one main bibliography at the end,
29222 but still be able to have a selected bibliography for the child if you output it on its own.
29223 Here is how to achieve this.
29226 \begin_layout Standard
29227 For the main document,
29228 you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
29229 If the bibliography inset is in the master file,
29230 the references will be inherited by all children,
29231 so they are available in the citation dialog within each child.
29234 \begin_layout Standard
29235 For child-specific bibliographies,
29236 insert bibliography insets within the child documents,
29237 at the place where the bibliography should appear when the child is compiled separately.
29239 the trick is to insert them into a branch (
29241 Insert\SpecialChar menuseparator
29242 Branch\SpecialChar menuseparator
29243 Insert New Branch...
29247 \begin_inset space \thinspace{}
29252 \begin_inset Quotes eld
29256 \begin_inset Quotes erd
29260 Within the children,
29261 activate the branch (
29263 Document\SpecialChar menuseparator
29264 Settings...\SpecialChar menuseparator
29269 deactivate the branch (
29271 Document\SpecialChar menuseparator
29272 Settings...\SpecialChar menuseparator
29276 Now the child's bibliography will be ignored by the master,
29277 but considered by the child.
29280 \begin_layout Standard
29281 If you need multiple bibliographies (e.
29282 \begin_inset space \thinspace{}
29286 one per child in the
29291 please refer to sec.
29292 \begin_inset space ~
29296 \begin_inset CommandInset ref
29298 reference "subsec:Multiple-Bibliographies"
29306 \begin_layout Section
29311 \begin_layout Standard
29312 Users sometimes need to be able to
29313 \begin_inset Quotes eld
29317 \begin_inset Quotes erd
29321 file together with all the images (and other files) on which it depends,
29322 either for sending to a publisher or for sharing with a co-author.
29324 includes a Python script (
29325 \begin_inset Flex Code
29328 \begin_layout Plain Layout
29334 ) that automates this process.
29336 you must have either the
29337 \begin_inset Flex Code
29340 \begin_layout Plain Layout
29347 \begin_inset Flex Code
29350 \begin_layout Plain Layout
29356 python modules installed on your system.
29358 the script prefers the
29359 \begin_inset Flex Code
29362 \begin_layout Plain Layout
29369 \begin_inset Flex Code
29372 \begin_layout Plain Layout
29378 format on Unix-like systems and the
29379 \begin_inset Flex Code
29382 \begin_layout Plain Layout
29391 \begin_layout Standard
29393 's configuration process will set the script up to export a `\SpecialChar LyX
29395 and this format will then be available under
29396 \change_deleted -712698321 1674917789
29398 \begin_inset Flex Code
29401 \begin_layout Plain Layout
29402 File\SpecialChar menuseparator
29409 \change_inserted -712698321 1674917789
29412 File\SpecialChar menuseparator
29420 \begin_layout Standard
29421 Independently of the platform,
29422 the generation of a particular archive format can be forced by adding either the
29423 \begin_inset Flex Code
29426 \begin_layout Plain Layout
29433 \begin_inset Flex Code
29436 \begin_layout Plain Layout
29443 \begin_inset Flex Code
29446 \begin_layout Plain Layout
29453 \begin_inset Flex Code
29456 \begin_layout Plain Layout
29462 format) switch to the
29463 \begin_inset Flex Code
29466 \begin_layout Plain Layout
29469 \change_deleted -712698321 1674918890
29470 \SpecialChar menuseparator
29472 \change_inserted -712698321 1674918890
29482 \change_deleted -712698321 1674917814
29484 \begin_inset Flex Code
29487 \begin_layout Plain Layout
29488 Tools\SpecialChar menuseparator
29489 Preferences\SpecialChar menuseparator
29490 File Handling\SpecialChar menuseparator
29497 \change_inserted -712698321 1674917814
29500 Tools\SpecialChar menuseparator
29501 Preferences\SpecialChar menuseparator
29502 File Handling\SpecialChar menuseparator
29508 (Make sure you add the switch after the script name,
29512 \begin_layout Section
29514 \change_deleted -712698321 1674910251
29515 Fancy Headers and Footers
29518 \begin_layout Standard
29520 \change_deleted -712698321 1674910251
29521 The default page layout is rather plain;
29523 \begin_inset Flex Code
29526 \begin_layout Plain Layout
29533 all you get is a centered page number at the bottom of the page.
29534 This document uses KOMA-script's book class,
29535 so it appears to be a bit fancier.
29536 But to really put on a show,
29537 you need to set the document page style to
29538 \begin_inset Quotes eld
29542 \begin_inset Quotes erd
29546 as mentioned in the
29551 This section describes the \SpecialChar LaTeX
29552 code you need to insert in your \SpecialChar LaTeX
29553 preamble in order to get the desired effects.
29556 \begin_layout Standard
29558 \change_deleted -712698321 1674910251
29559 For more information on fancy headers,
29561 \begin_inset Flex Code
29564 \begin_layout Plain Layout
29570 package documentation.
29572 \begin_inset Flex URL
29575 \begin_layout Plain Layout
29577 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
29585 \begin_layout Standard
29587 \change_deleted -712698321 1674910251
29588 The page header is divided into three fields,
29589 not surprisingly labeled
29590 \begin_inset Quotes eld
29594 \begin_inset Quotes erd
29599 \begin_inset Quotes eld
29603 \begin_inset Quotes erd
29608 \begin_inset Quotes eld
29612 \begin_inset Quotes erd
29616 The footer is also divided into these three fields.
29617 The \SpecialChar LaTeX
29618 commands to set these fields in the simplest manner are
29619 \begin_inset Flex Code
29622 \begin_layout Plain Layout
29632 \begin_inset Flex Code
29635 \begin_layout Plain Layout
29645 \begin_inset Flex Code
29648 \begin_layout Plain Layout
29658 \begin_inset Flex Code
29661 \begin_layout Plain Layout
29671 Suppose you wish to put your name in the upper left hand corner of each page.
29672 Simply insert the following command in the preamble:
29676 \begin_layout Standard
29678 \change_deleted -712698321 1674910251
29687 \begin_layout Standard
29689 \change_deleted -712698321 1674910251
29690 You will now see your name in the upper left.
29691 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,
29693 \begin_inset space \thinspace{}
29699 \begin_layout Standard
29701 \change_deleted -712698321 1674910251
29709 \begin_layout Standard
29711 \change_deleted -712698321 1674910251
29712 Let's get really fancy:
29713 lets put the section number with the word
29714 \begin_inset Quotes eld
29718 \begin_inset Quotes erd
29722 \begin_inset space \thinspace{}
29726 \begin_inset space \space{}
29729 Section 3) in the upper left,
29730 the page number (e.
29731 \begin_inset space \thinspace{}
29735 \begin_inset space \space{}
29738 Page 4) in the upper right,
29739 your name in the lower left,
29740 and the date in the lower right.
29741 The following commands should now appear in the preamble:
29744 \begin_layout Standard
29746 \change_deleted -712698321 1674910251
29756 \begin_layout Standard
29758 \change_deleted -712698321 1674910251
29766 \begin_layout Standard
29768 \change_deleted -712698321 1674910251
29778 \begin_layout Standard
29780 \change_deleted -712698321 1674910251
29789 \begin_layout Standard
29791 \change_deleted -712698321 1674910251
29799 \begin_layout Standard
29801 \change_deleted -712698321 1674910251
29811 \begin_layout Standard
29813 \change_deleted -712698321 1674910251
29815 \begin_inset Flex Code
29818 \begin_layout Plain Layout
29827 \begin_inset Flex Code
29830 \begin_layout Plain Layout
29838 access \SpecialChar LaTeX
29839 's section and page counters,
29840 and so print out the current section and page number.
29842 \begin_inset Flex Code
29845 \begin_layout Plain Layout
29853 simply prints out today's date.
29856 \begin_layout Standard
29858 \change_deleted -712698321 1674910251
29859 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
29860 If you don't want one of the rules,
29861 set its thickness to 0.
29862 The header rule has a default thickness of 0.4pt,
29863 the footer rule is 0pt.
29869 \begin_inset Flex Code
29872 \begin_layout Plain Layout
29877 headrulewidth}{0.4pt}
29883 \begin_inset Flex Code
29886 \begin_layout Plain Layout
29891 footrulewidth}{0.4pt}
29896 to set the thicknesses.
29899 \begin_layout Standard
29901 \change_deleted -712698321 1674910251
29902 You can switch the header/footer settings on and off for individual pages using commands like
29903 \begin_inset Flex Code
29906 \begin_layout Plain Layout
29909 thispagestyle{empty}
29916 \begin_inset Flex Code
29919 \begin_layout Plain Layout
29922 thispagestyle{plain}
29929 \begin_inset Flex Code
29932 \begin_layout Plain Layout
29935 thispagestyle{fancy}
29941 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
29944 title pages are marked as plain by default,
29945 while following pages are marked fancy when using the global fancy setting.
29948 \begin_layout Standard
29950 \change_deleted -712698321 1674910251
29951 As a final example,
29952 it is possible to include an image in the header or footer.
29953 Suppose you want to put a company logo in the upper lefthand corner.
29954 You might try something like
29957 \begin_layout Standard
29959 \change_deleted -712698321 1674910251
29968 includegraphics{logo.eps}}}
29971 \begin_layout Standard
29974 \change_deleted -712698321 1674910251
29975 (you may need to preface this with
29976 \begin_inset Flex Code
29979 \begin_layout Plain Layout
29982 usepackage{graphics}
29987 if you don't include graphics elsewhere in your document).
29992 \begin_layout Chapter
29994 and the World Wide Web
29997 \begin_layout Standard
29999 has long supported the export of documents to various web-friendly formats,
30001 Before version 2.0,
30003 HTML export was always accomplished by the use of external converters.
30007 \begin_layout Plain Layout
30008 For details on the use of external converters with \SpecialChar LyX
30014 section of the Customization manual.
30019 These fall into two large groups:
30020 there are converters that use \SpecialChar LaTeX
30021 as an intermediate format,
30023 \begin_inset Flex Code
30026 \begin_layout Plain Layout
30034 \begin_inset Flex Code
30037 \begin_layout Plain Layout
30045 \begin_inset Flex Code
30048 \begin_layout Plain Layout
30055 relying upon \SpecialChar LyX
30056 to produce the \SpecialChar LaTeX
30058 and there is a converter that works directly on \SpecialChar LyX
30061 \begin_inset Flex Code
30064 \begin_layout Plain Layout
30072 All of these have different advantages and disadvantages.
30076 \begin_layout Standard
30077 The \SpecialChar LaTeX
30078 -based converters have the advantage that,
30080 they know everything about the exported document that \SpecialChar LaTeX
30082 Such converters do not care,
30084 if a certain block of code was produced by \SpecialChar LyX
30085 or was Evil Red Text.
30086 These converters know about
30087 \begin_inset Flex Code
30090 \begin_layout Plain Layout
30099 and can often make use of the
30100 \begin_inset Flex Code
30103 \begin_layout Plain Layout
30109 files generated by Bib\SpecialChar TeX
30113 is a very hard language to parse—
30114 it is sometimes said that only \SpecialChar TeX
30115 itself understands \SpecialChar TeX
30117 and \SpecialChar LaTeX
30118 -based converters will often choke on what seem to be quite simple constructs;
30119 complex ones can throw them completely,
30120 and as of this writing,
30126 manual will not export with
30127 \begin_inset Flex Code
30130 \begin_layout Plain Layout
30137 though the others will.
30138 The other issue concerns how math is handled.
30139 These converters typically convert the formulae into little pictures that are then linked from the HTML document.
30140 Since these are actually generated by \SpecialChar LaTeX
30143 But they do not scale well,
30144 and just getting them to look as if they are actually meant to be in your document—
30145 so that the font sizes seem to be roughly the same—
30146 can be a challenge.
30149 \begin_layout Standard
30151 \begin_inset Flex Code
30154 \begin_layout Plain Layout
30162 \begin_inset CommandInset href
30164 name "http://pinchito.es/elyxer/"
30165 target "http://pinchito.es/elyxer/"
30170 ) solves some of these problems.
30172 the formulae it produces scale perfectly,
30173 since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
30174 But even moderately complex formula are rendered less well than with
30175 \begin_inset Flex Code
30178 \begin_layout Plain Layout
30185 this reflects the limitations of HTML.
30189 \begin_layout Plain Layout
30192 \begin_inset Flex Code
30195 \begin_layout Plain Layout
30202 can also use jsMath and MathJax for equations,
30203 but this setting is only available globally and requires one to have access to a server that runs the backend.
30208 More importantly (as of version 1.1.1,
30211 \begin_inset Flex Code
30214 \begin_layout Plain Layout
30221 has limited support for math macros and no support for user-defined paragraph or character styles.
30222 These limitations make
30223 \begin_inset Flex Code
30226 \begin_layout Plain Layout
30233 unsuitable for many of the documents \SpecialChar LyX
30237 these problems could be solved,
30238 but the \SpecialChar LyX
30239 developers have decided to follow a different path and have made \SpecialChar LyX
30240 itself capable of writing XHTML,
30241 just as it is capable of writing \SpecialChar LaTeX
30247 \begin_layout Standard
30248 As of this writing,
30249 XHTML output remains under development and should probably be regarded as
30250 \begin_inset Quotes eld
30254 \begin_inset Quotes erd
30261 \begin_layout Plain Layout
30263 \begin_inset Flex Code
30266 \begin_layout Plain Layout
30267 development/HTML/HTML.notes
30273 which can be found in the \SpecialChar LyX
30275 \begin_inset CommandInset href
30277 name "accessed online"
30278 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
30284 usually contains up-to-date information about the state of XHTML output.
30285 See also the list of XHTML bugs on
30286 \begin_inset CommandInset href
30288 name "the bug tracker"
30289 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"
30300 the developers have chosen this approach because it has several potential advantages over the other two.
30303 \begin_layout Standard
30304 These advantages are primarily due to the fact that the XHTML output routines,
30305 since they are part of \SpecialChar LyX
30307 know everything \SpecialChar LyX
30308 knows about the document being exported.
30312 \begin_layout Plain Layout
30313 Another advantage is that,
30314 since these routines are internal to \SpecialChar LyX
30316 they are immune to changes in \SpecialChar LyX
30318 or to changes in the semantics of existing insets.
30323 So they know about the table of contents (as displayed in the outline),
30324 about the counters associated with different paragraph styles,
30325 and about user-defined styles.
30326 The XHTML output routines know what \SpecialChar LyX
30327 knows about internationalization,
30329 so they will output
30330 \begin_inset Quotes eld
30334 \begin_inset Quotes erd
30338 \begin_inset Quotes eld
30346 \begin_inset Quotes erd
30350 depending upon the language in effect at the time.
30354 \begin_layout Standard
30356 the output routines know what \SpecialChar LyX
30357 knows about document layout,
30359 about how the document is to be rendered on screen.
30360 We use this information when we output the document as XHTML.
30367 generates CSS style information corresponding to the layout information it uses to render the document on screen:
30368 if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
30370 then (by default) they will be sans-serif and bold when viewed in a web browser,
30372 And this is true not just for pre-defined styles,
30375 including user-defined styles.
30377 the XHTML output routines make no distinction between user-defined paragraph and
30378 \change_deleted 244031559 1603876931
30380 \change_inserted 244031559 1603876940
30383 styles and \SpecialChar LyX
30384 's own pre-defined styles:
30386 everything \SpecialChar LyX
30387 knows about the styles is contained in the layout files.
30388 And much the same is true as regards pre-defined textual insets,
30390 and various custom insets.
30394 \begin_layout Standard
30395 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
30396 output can be customized and extended:
30397 through layout files and modules.
30398 See chapter five of the
30402 manual for the details.
30405 \begin_layout Standard
30406 The remainder of this chapter contains more detailed information on XHTML output,
30408 and ways to work around those limitations.
30411 \begin_layout Section
30412 Math Output in XHTML
30415 \begin_layout Standard
30417 offers four choices for how math is rendered.
30418 These have various advantages and disadvantages:
30421 \begin_layout Itemize
30423 \begin_inset Newline newline
30426 MathML is a dialect of XML designed specifically for mathematics on the web,
30427 and it typically renders very well in browsers that support it.
30428 The disadvantage is that not all browsers support MathML,
30429 and support is not complete even in the Gecko-based browsers,
30431 \begin_inset Newline newline
30434 If \SpecialChar LyX
30435 is unable to render a formula as MathML—
30437 if the formula uses the
30438 \begin_inset Flex Code
30441 \begin_layout Plain Layout
30448 then it will instead output the formula as an image.
30452 \begin_layout Itemize
30454 \begin_inset Newline newline
30457 As mentioned above,
30459 \begin_inset Flex Code
30462 \begin_layout Plain Layout
30468 outputs math as HTML,
30473 \begin_layout Plain Layout
30475 has borrowed some of the CSS for its HTML output from
30476 \begin_inset Flex Code
30479 \begin_layout Plain Layout
30490 For simple formulae,
30491 this can work quite well,
30492 though with more complicated formulae it tends to break down.
30494 this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
30495 fairly simple math.
30496 \begin_inset Newline newline
30499 If Lyx is unable to render a formula as HTML—
30501 if the formula uses the
30502 \begin_inset Flex Code
30505 \begin_layout Plain Layout
30512 then it will instead output the formula as an image.
30516 \begin_layout Itemize
30518 \begin_inset Newline newline
30522 \begin_inset Flex Code
30525 \begin_layout Plain Layout
30533 will output formulae as images,
30534 the very same images,
30536 that are used for instant preview.
30540 \begin_layout Plain Layout
30541 Instant preview does
30545 have to be on for images to be output,
30551 The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
30553 so they are very accurate.
30555 as mentioned earlier,
30556 is that these are bitmapped images,
30557 so they do not scale terribly well,
30558 and one cannot copy them,
30560 \begin_inset Newline newline
30563 The size of the images can be controlled by setting the
30564 \begin_inset Quotes eld
30567 Math Images Scaling
30568 \begin_inset Quotes erd
30572 \change_deleted -712698321 1674917822
30574 \begin_inset Flex Noun
30577 \begin_layout Plain Layout
30578 Document\SpecialChar menuseparator
30579 Settings\SpecialChar menuseparator
30586 \change_inserted -712698321 1674917822
30589 Document\SpecialChar menuseparator
30590 Settings\SpecialChar menuseparator
30599 \begin_layout Plain Layout
30600 For those who want to know,
30601 this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
30607 \begin_inset Newline newline
30610 If \SpecialChar LyX
30611 for some reason fails to create an image for a formula (e.g.,
30612 if a required \SpecialChar LaTeX
30613 package is not installed),
30614 then it will fall back to outputing the raw \SpecialChar LaTeX
30618 \begin_layout Itemize
30621 \begin_inset Newline newline
30626 will happily output math as \SpecialChar LaTeX
30628 As well as being the output of last resort,
30629 this method can be used with such tools as
30630 \begin_inset CommandInset href
30633 target "http://www.math.union.edu/~dpvc/jsMath/"
30639 which uses JavaScript to render \SpecialChar LaTeX
30640 embedded in HTML documents.
30642 wraps the \SpecialChar LaTeX
30644 \begin_inset Flex Code
30647 \begin_layout Plain Layout
30653 (for inline formulas) or
30654 \begin_inset Flex Code
30657 \begin_layout Plain Layout
30663 (for displayed formulas) with
30664 \begin_inset Flex Code
30667 \begin_layout Plain Layout
30674 as is required for jsMath.
30677 \begin_layout Standard
30678 One of these output methods must be selected under
30679 \change_deleted -712698321 1674917830
30681 \begin_inset Flex Noun
30684 \begin_layout Plain Layout
30685 Document\SpecialChar menuseparator
30686 Settings\SpecialChar menuseparator
30693 \change_inserted -712698321 1674917830
30696 Document\SpecialChar menuseparator
30697 Settings\SpecialChar menuseparator
30706 This is a document-wide setting,
30710 \begin_layout Standard
30713 will offer the user the option to select an alternate output method for a particular inset,
30715 one that isn't being rendered very well by MathML.
30719 \begin_layout Plain Layout
30721 since \SpecialChar LyX
30722 falls back to images if the inset contains ERT,
30723 then one can force output as an image by putting some harmless ERT into the math,
30726 \begin_inset Formula $a=b\relax$
30737 \begin_layout Section
30738 Bibliography and Citations
30741 \begin_layout Standard
30742 XHTML output fully supports bibliographies and citations.
30746 \begin_layout Standard
30747 Citation labels are generated by the same machinery that generates \SpecialChar LyX
30748 's on-screen labels,
30749 so the labels will look in the output much as they do in \SpecialChar LyX
30752 If you are using numerical citations,
30753 then \SpecialChar LyX
30754 will output numerical labels,
30755 such as [1] or [17],
30756 rather than simply showing the citation key in square brackets,
30757 as it does on-screen.
30758 If you are using author-year citations,
30759 then \SpecialChar LyX
30760 will add lowercase letters to the years,
30761 just as Bib\SpecialChar TeX
30763 if it finds more than one citation for a given author-year combination.
30764 The labels will be printed with the bibliography entries.
30765 Note that there is,
30767 no way to customize the appearance of the labels,
30769 to choose between square brackets and parentheses.
30772 \begin_layout Standard
30773 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
30774 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.
30775 The formatting can be customized in your layout file or,
30782 manual for the details.
30785 \begin_layout Standard
30786 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
30787 So you can see things like this:
30790 \begin_layout Quote
30793 \begin_inset Quotes eld
30796 Context and Logical Form
30797 \begin_inset Quotes erd
30803 Language in Context:
30807 Oxford University Press,
30813 \begin_layout Quote
30816 \begin_inset Quotes eld
30819 Semantics in Context
30820 \begin_inset Quotes erd
30826 Language in Context:
30830 Oxford University Press,
30836 \begin_layout Standard
30837 This should be fixed before long.
30840 \begin_layout Standard
30841 There is no support at present for sectioned bibliographies.
30842 If you have multiple bibliographies,
30843 then \SpecialChar LyX
30844 will print the same bibliography over and over.
30847 \begin_layout Section
30851 \begin_layout Standard
30853 will happily export indexes as XHTML,
30854 but with certain limitations at the moment.
30857 \begin_layout Standard
30858 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
30866 \begin_layout Plain Layout
30867 The main issue here is that \SpecialChar LyX
30868 itself does not really handle these.
30869 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
30875 We'll describe how they are handled using the subsection headings from that section.
30878 \begin_layout Itemize
30879 Grouping Index Entries (aka,
30882 makes an effort to support these,
30883 but the entries must be separated by
30884 \begin_inset Quotes eld
30889 \begin_inset Quotes erd
30894 there must be spaces around the exclamation point.
30895 This is because it is otherwise too difficult to check for escaped exclamation points,
30900 \begin_layout Itemize
30902 There is no support at all for page ranges,
30903 since these make no sense with XHMTL.
30905 you will just get two index entries,
30909 \begin_layout Itemize
30911 There is no support for cross-referencing.
30912 If \SpecialChar LyX
30913 finds an entry containing the
30914 \begin_inset Quotes eld
30917 |see\SpecialChar ldots
30919 \begin_inset Quotes erd
30923 it is just dropped,
30924 and the rest is treated as an ordinary index entry.
30927 \begin_layout Itemize
30930 does support attempts to fix the sorting order.
30931 It will take what is before the first `@' it finds and use that for sorting,
30932 taking what follows the first `@' to be the actual entry.
30935 does not check for escaped `@',
30936 so do not try to index email addresses.
30939 \begin_layout Itemize
30940 Index Entry Layout:
30941 You can format entries by using the text style dialog,
30942 or by using any other method available within \SpecialChar LyX
30944 There is no support for constructs like:
30946 \begin_inset Quotes eld
30950 \begin_inset Quotes erd
30955 if \SpecialChar LyX
30956 finds a pipe symbol,
30959 it will delete it and everything that follows it.
30962 \begin_layout Itemize
30964 There is no support for multiple indexes.
30966 all index entries will be printed as one large index.
30967 To avoid our printing several versions of the index,
30968 we print only the main index,
30969 so make sure you have one.
30972 \begin_layout Section
30973 Nomenclature and Glossary
30976 \begin_layout Standard
30977 There is at present no support for glossaries.
30978 Adding it would be fairly trivial,
30982 \begin_layout Chapter
30984 \change_inserted 1075283030 1616534180
30988 \begin_layout Standard
30990 \change_inserted 1075283030 1616534386
30993 can generate documents in the DocBook XML vocabulary.
30994 With versions 2.3 and before,
30995 only select templates could be used to generate DocBook documents (only version 4).
30996 Starting with \SpecialChar LyX
30998 most \SpecialChar LyX
30999 layouts can generate valid DocBook documents (only version 5).
31000 This feature is built into \SpecialChar LyX
31001 and does not require the use of external tools.
31004 \begin_layout Standard
31006 \change_inserted 1075283030 1616534437
31007 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
31008 output can be customized and extended:
31009 through layout files and modules.
31010 See chapter five of the
31014 manual for the details.
31017 \begin_layout Standard
31019 \change_inserted 1075283030 1616534475
31020 Most \SpecialChar LyX
31021 features are supported with DocBook,
31025 \begin_layout Itemize
31027 \change_inserted 1075283030 1616534741
31028 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
31032 All formulae are also available in raw \SpecialChar TeX
31033 in the DocBook output for further processing.
31036 \begin_layout Itemize
31038 \change_inserted 1075283030 1616534852
31039 Bibliographies and citations are implemented,
31040 including with an external BibTeX file.
31041 Bibliography entries are not prerendered when the detailed information are available,
31042 but rather output with the standard DocBook constructs.
31043 The external DocBook processor is expected to handle the rendering of entries.
31046 \begin_layout Itemize
31048 \change_inserted 1075283030 1616534863
31049 Indexes are supported,
31050 including multiple indices.
31057 and cross-references (
31062 with the exception of the same symbols escaped.
31071 ) are not supported.
31072 There is no support for escaping of index entries.
31075 \begin_layout Itemize
31077 \change_inserted 1075283030 1616534884
31078 Glossaries are implemented.
31081 \begin_layout Standard
31083 \change_inserted 1075283030 1616534894
31084 Two major parameters can be set at the document level.
31087 \begin_layout Itemize
31089 \change_inserted 1075283030 1616534948
31092 can generate tables either as HTML (default value) or CALS,
31093 depending on the user's requirements.
31094 Most DocBook processors accept both formats.
31097 \begin_layout Itemize
31099 \change_inserted 1075283030 1616535006
31102 MathML is included within its own name space,
31104 The implication is that there must be an indication of the tags belonging to the MathML standard.
31105 Three choices are offered:
31110 \begin_layout Itemize
31112 \change_inserted 1075283030 1616535044
31114 the MathML name space is defined for each formula (using the
31118 attribute on each formula)
31121 \begin_layout Itemize
31123 \change_inserted 1075283030 1616535090
31129 the MathML name space is defined at the document level (using the
31133 attribute on the root element).
31134 Each MathML is prefixed with
31145 \begin_layout Itemize
31147 \change_inserted 1075283030 1616620405
31163 \begin_layout Standard
31165 \change_inserted 1075283030 1616620470
31166 This option is especially useful if you want \SpecialChar LyX
31167 to match your personal style or to work with buggy software that only accepts one prefix for MathML.
31173 \begin_layout Chapter
31174 The \SpecialChar LyX
31178 \begin_layout Section
31182 \begin_layout Standard
31183 The `\SpecialChar LyX
31184 server' allows other programs to talk to \SpecialChar LyX
31186 invoke \SpecialChar LyX
31188 and retrieve information about the \SpecialChar LyX
31190 This is only intended for advanced users,
31191 but they should find it useful.
31192 It is by writing to the \SpecialChar LyX
31195 that bibliography managers,
31198 \begin_inset Quotes eld
31202 \begin_inset Quotes erd
31205 citations to \SpecialChar LyX
31209 \begin_layout Section
31210 Starting the \SpecialChar LyX
31212 \begin_inset CommandInset label
31214 name "sec:Starting-the-Server"
31221 \begin_layout Standard
31222 The \SpecialChar LyX
31223 server works through the use of a pair of named pipes.
31224 These are usually located in
31225 \begin_inset Flex Code
31228 \begin_layout Plain Layout
31235 (except on Windows,
31240 named pipes are special objects located in
31241 \begin_inset Flex Code
31244 \begin_layout Plain Layout
31256 ) and have the names
31257 \begin_inset Quotes eld
31261 \begin_inset Flex Code
31264 \begin_layout Plain Layout
31271 \begin_inset Quotes erd
31275 \begin_inset Quotes eld
31279 \begin_inset Flex Code
31282 \begin_layout Plain Layout
31289 \begin_inset Quotes erd
31293 External programs write into
31294 \begin_inset Flex Code
31297 \begin_layout Plain Layout
31303 and read back data from
31304 \begin_inset Flex Code
31307 \begin_layout Plain Layout
31314 The stem of the pipe names can be defined in the
31315 \change_deleted -712698321 1674917840
31317 \begin_inset Flex Noun
31320 \begin_layout Plain Layout
31321 Tools\SpecialChar menuseparator
31328 \change_inserted -712698321 1674917840
31331 Tools\SpecialChar menuseparator
31338 \begin_inset Flex Code
31341 \begin_layout Plain Layout
31342 "/home/myhome/lyxpipe"
31349 \begin_inset Flex Code
31352 \begin_layout Plain Layout
31366 on Windows (where any working path instead of lyxpipe can be used,
31368 \begin_inset Flex Code
31371 \begin_layout Plain Layout
31394 configure this manually in order for the server to start.
31397 \begin_layout Standard
31400 \begin_inset Flex Code
31403 \begin_layout Plain Layout
31410 \begin_inset Flex Code
31413 \begin_layout Plain Layout
31419 ' to create the pipes.
31420 If one of the pipes already exists,
31422 will assume that another \SpecialChar LyX
31423 process is already running and will not start the server.
31424 On POSIX (Unix like) systems,
31425 if for some other reason,
31427 \begin_inset Quotes eld
31431 \begin_inset Quotes erd
31434 pipe is left in existence when \SpecialChar LyX
31436 then \SpecialChar LyX
31437 will try to delete it.
31438 If this fails for some reason,
31439 you will need to delete the pipes manually and then restart \SpecialChar LyX
31442 pipes are deleted by the OS on program termination or crash,
31444 \begin_inset Quotes eld
31448 \begin_inset Quotes erd
31451 pipes should not be possible.
31454 \begin_layout Standard
31455 To have several \SpecialChar LyX
31456 processes with servers at the same time,
31457 you have to use different configurations,
31458 perhaps by using separate user directories,
31460 \begin_inset Flex Code
31463 \begin_layout Plain Layout
31473 \begin_layout Standard
31474 If you are developing a client program,
31475 you might find it useful to enable debugging information from the \SpecialChar LyX
31477 Do this by starting \SpecialChar LyX
31479 \begin_inset Flex Code
31482 \begin_layout Plain Layout
31491 \begin_layout Standard
31492 You can find a complete example client written in C++ in the source distribution as
31493 \begin_inset Flex Code
31496 \begin_layout Plain Layout
31497 development/lyxserver/server_monitor.cpp
31505 \begin_layout Standard
31506 Another useful tool is the command-line based client found in
31507 \begin_inset Flex Code
31510 \begin_layout Plain Layout
31511 src/client/lyxclient
31519 \begin_layout Section
31520 Normal communication
31523 \begin_layout Standard
31524 To issue a \SpecialChar LyX
31526 the client writes a line of ASCII text into the input pipe.
31527 This line has the following format:
31530 \begin_layout Quote
31544 \begin_layout Description
31545 clientname is a name that the client can choose arbitrarily.
31546 Its only use is that \SpecialChar LyX
31547 will echo it if it sends an answer—
31548 so a client can dispatch results from different requesters.
31551 \begin_layout Description
31552 function is the function you want \SpecialChar LyX
31554 It is the same as the commands you'd use in the minibuffer.
31557 \begin_layout Description
31558 argument is an optional argument which is meaningful only to some functions (for instance,
31560 \begin_inset Quotes eld
31564 \begin_inset Quotes erd
31567 LFUN will insert the argument as text at the cursor position).
31570 \begin_layout Standard
31571 The answer from \SpecialChar LyX
31572 will arrive in the output pipe and be of the form
31575 \begin_layout Quote
31589 \begin_layout Standard
31598 are just echoed from the command request,
31603 is more or less useful information filled according to how the command execution worked out.
31606 \begin_inset Quotes eld
31610 \begin_inset Quotes erd
31614 will return information about the internal state of \SpecialChar LyX
31616 while other will return an empty data-response.
31617 This means that the command execution went fine.
31620 \begin_layout Standard
31622 the response from \SpecialChar LyX
31623 will have this form
31626 \begin_layout Quote
31640 \begin_layout Standard
31645 should contain an explanation of why the command failed.
31648 \begin_layout Standard
31652 \begin_layout LyX-Code
31653 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
31654 \begin_inset Newline newline
31657 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
31658 \begin_inset Newline newline
31661 read a <~/.lyxpipe.out
31662 \begin_inset Newline newline
31668 \begin_layout Subsection
31669 AppleScript (Mac OS X)
31672 \begin_layout Standard
31673 Since \SpecialChar LyX
31676 supports basic interactions with AppleScript for normal communication through the command run.
31677 This command takes a direct argument (the
31681 to perform) and an optional argument.
31682 It either returns the output of the function or triggers an error with the error message and code.
31685 \begin_layout Standard
31689 \begin_layout LyX-Code
31690 tell application "\SpecialChar LyX
31694 \begin_layout LyX-Code
31698 \begin_layout LyX-Code
31699 -- Stores the current file name into f
31702 \begin_layout LyX-Code
31703 set f to (run "server-get-filename" with argument "")
31706 \begin_layout LyX-Code
31707 on error the error_message number the error_number
31710 \begin_layout LyX-Code
31711 display dialog "Error:
31712 " & the error_number & ".
31716 \begin_layout LyX-Code
31717 & the error_message buttons {"OK"} default button 1
31720 \begin_layout LyX-Code
31724 \begin_layout LyX-Code
31728 \begin_layout Section
31732 \begin_layout Standard
31734 can notify clients of events going on asynchronously.
31735 Currently it will only do this if the user binds a key sequence with the function
31736 \begin_inset Quotes eld
31740 \begin_inset Quotes erd
31744 The format of the string \SpecialChar LyX
31745 sends is as follows:
31748 \begin_layout Quote
31749 \begin_inset Flex Code
31752 \begin_layout Plain Layout
31763 \begin_layout Standard
31768 is the printed representation of the key sequence that was actually typed by the user.
31771 \begin_layout Standard
31772 This mechanism can be used to extend \SpecialChar LyX
31773 's command set and implement macros.
31774 Bind some key sequence to
31775 \begin_inset Quotes eld
31779 \begin_inset Quotes erd
31783 Then start a client that listens on the output pipe,
31784 dispatches the command according to the sequence,
31785 and starts a function that may use \SpecialChar LyX
31786 calls and \SpecialChar LyX
31787 requests to issue a command or a series of commands to \SpecialChar LyX
31791 \begin_layout Section
31792 The simple \SpecialChar LyX
31796 \begin_layout Standard
31798 implements a simple protocol that can be used for session management.
31799 All messages are of the form
31802 \begin_layout Quote
31812 \begin_layout Standard
31818 \begin_inset Quotes eld
31822 \begin_inset Quotes erd
31826 \begin_inset Quotes eld
31830 \begin_inset Quotes erd
31835 \begin_inset Quotes eld
31839 \begin_inset Quotes erd
31842 is received from a client,
31844 will report back to inform the client that it's listening to it's messages,
31846 \begin_inset Quotes eld
31850 \begin_inset Quotes erd
31853 sent from \SpecialChar LyX
31854 will inform clients that \SpecialChar LyX
31858 \begin_layout Section
31859 Reverse DVI/PDF search
31862 \begin_layout Standard
31863 Some DVI/PDF viewers
31867 \begin_layout Plain Layout
31868 The following viewers offer the reverse PDF search feature:
31869 Okular on KDE/Linux,
31871 Skim on Mac OSX and SumatraPDF on Windows.
31880 facility (also called
31885 This means that you can tell \SpecialChar LyX
31886 to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
31888 the viewer must be able to communicate with \SpecialChar LyX
31890 This is done via the \SpecialChar LyX
31891 server either by using the named pipe (
31896 or the UNIX domain socket (
31900 ) that \SpecialChar LyX
31901 creates in its temporary directory (this is the way the
31902 \begin_inset Flex Code
31905 \begin_layout Plain Layout
31911 program communicates with \SpecialChar LyX
31914 you need a helper script that mediates between the viewer and \SpecialChar LyX
31917 the viewer can communicate with \SpecialChar LyX
31919 This depends on the selected viewer and on your operating system.
31920 The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
31922 we will thus describe how to setup reverse search for specific viewers.
31923 Before we turn to this,
31925 we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
31928 \begin_layout Subsection
31930 \begin_inset CommandInset label
31932 name "subsec:rev-search"
31939 \begin_layout Standard
31940 In most cases \SpecialChar LyX
31941 will do the work for you by pressing the following button in the toolbar:
31945 arg "buffer-toggle-output-sync"
31950 you can also enable the feature by checking
31952 Synchronize with Output
31955 \change_deleted -712698321 1674917848
31957 \begin_inset Flex Noun
31960 \begin_layout Plain Layout
31961 Document\SpecialChar menuseparator
31962 Settings\SpecialChar menuseparator
31969 \change_inserted -712698321 1674917848
31972 Document\SpecialChar menuseparator
31973 Settings\SpecialChar menuseparator
31979 In such a case \SpecialChar LyX
31980 will automatically insert the necessary Sync\SpecialChar TeX
31981 macro (for PDF) or load the srcltx package (for DVI) respectively.
31982 This option can be easily reached also on
31983 \begin_inset Flex Code
31986 \begin_layout Plain Layout
31995 \begin_layout Standard
31996 If you need a different setting,
31997 you can select or input a custom macro from the drop down box just below
31998 \change_deleted -712698321 1674917855
32000 \begin_inset Flex Noun
32003 \begin_layout Plain Layout
32004 Document\SpecialChar menuseparator
32005 Settings\SpecialChar menuseparator
32006 Output\SpecialChar menuseparator
32007 Synchronize with Output
32013 \change_inserted -712698321 1674917855
32016 Document\SpecialChar menuseparator
32017 Settings\SpecialChar menuseparator
32018 Output\SpecialChar menuseparator
32019 Synchronize with Output
32026 \begin_layout Standard
32027 Note that the method
32028 \begin_inset Flex Code
32031 \begin_layout Plain Layout
32039 enables gzip compression.
32040 If your viewer does not support it,
32041 you should instead use
32042 \begin_inset Flex Code
32045 \begin_layout Plain Layout
32056 \begin_layout Standard
32057 Please also note that including the
32058 \begin_inset Flex Code
32061 \begin_layout Plain Layout
32068 \begin_inset Flex Code
32071 \begin_layout Plain Layout
32077 sometimes has an undesired impact on the typesetting.
32079 you should switch output synchronization off for the final typesetting if you use the
32080 \begin_inset Flex Code
32083 \begin_layout Plain Layout
32090 \begin_inset Flex Code
32093 \begin_layout Plain Layout
32103 \begin_layout Standard
32104 In case you need some more special settings that are not covered by the automatic settings,
32105 read the next section about how to set up output synchronization manually.
32106 If the automatic setup suits your needs,
32107 you can readily jump to section
32108 \begin_inset space ~
32112 \begin_inset CommandInset ref
32114 reference "subsec:configuring-viewers"
32120 where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
32123 \begin_layout Subsection
32127 \begin_layout Standard
32129 provides several different methods for reverse search.
32130 Some are built-in in the
32131 \begin_inset Flex Code
32134 \begin_layout Plain Layout
32141 some are provided by external packages.
32142 Your choice depends on whether your \SpecialChar LaTeX
32143 distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
32144 The available methods are described in the following.
32147 \begin_layout Subsubsection*
32148 Built-in DVI-search via src-specials (DVI only)
32151 \begin_layout Standard
32152 This method provides the DVI file with the necessary information for reverse search.
32153 It is available in \SpecialChar LaTeX
32154 since quite some time (any somewhat recent \SpecialChar LaTeX
32155 distribution should include it),
32156 and it works reliably.
32159 \begin_inset Flex Noun
32162 \begin_layout Plain Layout
32173 \begin_inset Flex Noun
32176 \begin_layout Plain Layout
32187 \change_deleted -712698321 1674917875
32189 \begin_inset Flex Noun
32192 \begin_layout Plain Layout
32193 Preferences\SpecialChar menuseparator
32194 File Handling\SpecialChar menuseparator
32201 \change_inserted -712698321 1674917875
32204 Preferences\SpecialChar menuseparator
32205 File Handling\SpecialChar menuseparator
32211 \begin_inset Flex Code
32214 \begin_layout Plain Layout
32215 latex -src-specials $$i
32221 If this doesn't work,
32222 check if your \SpecialChar TeX
32223 engine needs different options (the syntax might differ in some distributions).
32226 \begin_layout Subsubsection*
32227 External Packages (PDFSync and scrltx)
32230 \begin_layout Standard
32239 provide reverse search facility for PDF output (via pdflatex) and DVI output,
32241 In order to enable it,
32242 load the packages in the \SpecialChar LyX
32247 \begin_layout Itemize
32248 \begin_inset Flex Code
32251 \begin_layout Plain Layout
32254 usepackage{pdfsync}
32259 for reverse PDF search,
32262 \begin_layout Itemize
32263 \begin_inset Flex Code
32266 \begin_layout Plain Layout
32269 usepackage[active]{srcltx}
32274 for reverse DVI search.
32277 \begin_layout Standard
32278 If you want to be able to perform both DVI and PDF reverse searches,
32279 you can also insert in the preamble the following lines
32282 \begin_layout LyX-Code
32286 \begin_inset Newline newline
32292 \begin_inset Newline newline
32297 usepackage{pdfsync}
32298 \begin_inset Newline newline
32304 \begin_inset Newline newline
32309 usepackage[active]{srcltx}
32310 \begin_inset Newline newline
32318 \begin_layout Standard
32320 you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
32323 \begin_layout Standard
32324 Note that PDFSync might affect the output layout of your document.
32325 It is therefore advised to disable PDFsync for final documents.
32328 \begin_layout Subsubsection*
32329 Built-in reverse search via Sync\SpecialChar TeX
32333 \begin_layout Standard
32335 \begin_inset Flex Code
32338 \begin_layout Plain Layout
32344 have built-in support for both PDF and DVI reverse search.
32347 Sync\SpecialChar TeX
32350 facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
32355 You need at least \SpecialChar TeX
32356 Live 2008 or a recent Mik\SpecialChar TeX
32357 distribution in order to use it.
32361 \begin_layout Plain Layout
32363 Mik\SpecialChar TeX
32364 does not understand/obey the command \SpecialChar LyX
32365 inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
32368 \begin_layout Plain Layout
32369 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
32370 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
32371 by adding the -synctex=1 switch).
32376 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
32378 SumatraPDF on Windows;
32379 see the next section for details) already provide Sync\SpecialChar TeX
32383 \begin_layout Standard
32384 To enable Sync\SpecialChar TeX
32387 \begin_inset Flex Noun
32390 \begin_layout Plain Layout
32401 \begin_inset Flex Noun
32404 \begin_layout Plain Layout
32409 (plain) -> DraftDVI
32415 \change_deleted -712698321 1674917887
32417 \begin_inset Flex Noun
32420 \begin_layout Plain Layout
32421 Preferences\SpecialChar menuseparator
32422 File Handling\SpecialChar menuseparator
32429 \change_inserted -712698321 1674917887
32432 Preferences\SpecialChar menuseparator
32433 File Handling\SpecialChar menuseparator
32439 \begin_inset Flex Code
32442 \begin_layout Plain Layout
32443 latex -synctex=1 $$i
32449 and for PDF output,
32451 \begin_inset Flex Noun
32454 \begin_layout Plain Layout
32459 (pdflatex) -> PDF (pdflatex)
32465 \begin_inset Flex Code
32468 \begin_layout Plain Layout
32469 pdflatex -synctex=1 $$i
32475 Should your viewer not be considered in the following description,
32476 or in case of missing success,
32477 please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
32482 \begin_layout Plain Layout
32483 Note that the option
32484 \begin_inset Flex Code
32487 \begin_layout Plain Layout
32493 option enables gzip compression.
32494 If your viewer does not support it,
32495 you should instead use
32496 \begin_inset Flex Code
32499 \begin_layout Plain Layout
32513 \begin_layout Subsection
32514 Configuring and using specific viewers
32515 \begin_inset CommandInset label
32517 name "subsec:configuring-viewers"
32524 \begin_layout Subsubsection*
32525 Xdvi (all platforms)
32528 \begin_layout Standard
32530 \begin_inset Flex Code
32533 \begin_layout Plain Layout
32540 you don't need to do anything else for performing a reverse DVI search,
32541 as \SpecialChar LyX
32542 already provides the necessary hooks for automatically using the
32543 \begin_inset Flex Code
32546 \begin_layout Plain Layout
32553 Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
32557 \begin_layout Standard
32559 if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
32561 simply change the DVI viewer in
32562 \change_deleted -712698321 1674917897
32564 \begin_inset Flex Noun
32567 \begin_layout Plain Layout
32568 Preferences\SpecialChar menuseparator
32569 File Handling\SpecialChar menuseparator
32576 \change_inserted -712698321 1674917897
32579 Preferences\SpecialChar menuseparator
32580 File Handling\SpecialChar menuseparator
32589 \begin_layout Plain Layout
32590 On Mac OSX you have to use
32591 \begin_inset Flex Code
32594 \begin_layout Plain Layout
32595 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
32606 \begin_inset Flex Code
32609 \begin_layout Plain Layout
32610 xdvi -editor "lyxeditor.sh %f %l"
32617 \begin_inset Flex Code
32620 \begin_layout Plain Layout
32626 is a suitable script.
32628 a minimal shell script is the following one:
32631 \begin_layout LyX-Code
32633 \begin_inset Newline newline
32636 LYXPIPE="/path/to/lyxpipe"
32637 \begin_inset Newline newline
32640 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
32641 \begin_inset Newline newline
32644 echo "$COMMAND" > "${LYXPIPE}".in || exit
32645 \begin_inset Newline newline
32648 read TMP < "${LYXPIPE}".out || exit
32651 \begin_layout Standard
32653 \begin_inset Flex Code
32656 \begin_layout Plain Layout
32662 is the LyXServer pipe path specified in
32663 \change_deleted -712698321 1674917907
32665 \begin_inset Flex Noun
32668 \begin_layout Plain Layout
32669 Preferences\SpecialChar menuseparator
32676 \change_inserted -712698321 1674917907
32679 Preferences\SpecialChar menuseparator
32688 \begin_layout Plain Layout
32690 \begin_inset Flex Code
32693 \begin_layout Plain Layout
32699 folder of a source distribution you can find a
32700 \begin_inset Flex Code
32703 \begin_layout Plain Layout
32709 script which is able to locate the
32713 based on your preferences.
32721 \begin_layout Subsubsection*
32725 \begin_layout Standard
32727 \begin_inset Flex Code
32730 \begin_layout Plain Layout
32731 /Applications/MacDviX_Folder/calleditor.script
32737 add the following lines:
32740 \begin_layout LyX-Code
32741 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
32742 \begin_inset Newline newline
32748 \begin_layout Standard
32749 Modify the lines accordingly if you install \SpecialChar LyX
32750 somewhere else than in the Applications folder.
32753 \begin_layout Standard
32754 Reverse search is triggered by Alt-click (OPTION-click).
32757 \begin_layout Subsubsection*
32761 \begin_layout Standard
32763 \begin_inset Flex Code
32766 \begin_layout Plain Layout
32767 open -a Skim.app $$i
32772 to the viewer setting in
32773 \change_deleted -712698321 1674917916
32775 \begin_inset Flex Noun
32778 \begin_layout Plain Layout
32779 Preferences\SpecialChar menuseparator
32780 File Handling\SpecialChar menuseparator
32781 File formats\SpecialChar menuseparator
32788 \change_inserted -712698321 1674917916
32791 Preferences\SpecialChar menuseparator
32792 File Handling\SpecialChar menuseparator
32793 File formats\SpecialChar menuseparator
32800 \change_deleted -712698321 1674917924
32802 \begin_inset Flex Noun
32805 \begin_layout Plain Layout
32806 Skim\SpecialChar menuseparator
32807 Preferences\SpecialChar menuseparator
32814 \change_inserted -712698321 1674917924
32817 Skim\SpecialChar menuseparator
32818 Preferences\SpecialChar menuseparator
32824 \change_deleted -712698321 1674917931
32826 \begin_inset Flex Noun
32829 \begin_layout Plain Layout
32836 \change_inserted -712698321 1674917931
32843 preset and enter command
32844 \begin_inset Flex Noun
32847 \begin_layout Plain Layout
32848 /Applications/\SpecialChar LyX
32849 .app/Contents/MacOS/lyxeditor
32857 \begin_layout Standard
32858 Reverse search is triggered by COMMAND-SHIFT-click
32861 \begin_layout Subsubsection*
32865 \begin_layout Standard
32866 Reverse search with evince does not work out of the box,
32867 but it can be achieved by means of some third party helper scripts.
32869 \begin_inset CommandInset href
32871 target "https://wiki.lyx.org/LyX/SyncTeX"
32879 \begin_layout Subsubsection*
32883 \begin_layout Standard
32885 \change_deleted -712698321 1674917941
32887 \begin_inset Flex Noun
32890 \begin_layout Plain Layout
32891 Settings\SpecialChar menuseparator
32892 Configure Okular\SpecialChar menuseparator
32899 \change_inserted -712698321 1674917941
32902 Settings\SpecialChar menuseparator
32903 Configure Okular\SpecialChar menuseparator
32909 \begin_inset Quotes erd
32913 This inserts the appropriate command (
32914 \begin_inset Flex Code
32917 \begin_layout Plain Layout
32926 \begin_layout Standard
32927 Reverse search is triggered by SHIFT-click.
32929 \change_inserted -712698321 1578211026
32930 Note that this only works if Okular is in
32931 \begin_inset Quotes eld
32935 \begin_inset Quotes erd
32939 \begin_inset space \thinspace{}
32943 the hand symbol is clicked).
32948 \begin_layout Subsubsection*
32952 \begin_layout Standard
32953 Qpdfview supports Sync\SpecialChar TeX
32954 since version 0.3.5.
32956 \change_deleted -712698321 1674917949
32958 \begin_inset Flex Noun
32961 \begin_layout Plain Layout
32962 Edit\SpecialChar menuseparator
32963 Settings\SpecialChar menuseparator
32970 \change_inserted -712698321 1674917949
32973 Edit\SpecialChar menuseparator
32974 Settings\SpecialChar menuseparator
32980 click on the input field of the
32981 \begin_inset Quotes eld
32985 \begin_inset Quotes erd
32988 item and add the command
32989 \begin_inset Flex Code
32992 \begin_layout Plain Layout
33001 \begin_layout Standard
33002 Reverse search is triggered by double-click or,
33003 in more recent versions,
33007 \begin_layout Subsubsection*
33011 \begin_layout Standard
33014 \change_deleted -712698321 1674917958
33016 \begin_inset Flex Noun
33019 \begin_layout Plain Layout
33020 View\SpecialChar menuseparator
33027 \change_inserted -712698321 1674917958
33030 View\SpecialChar menuseparator
33035 menu and select the
33036 \begin_inset Quotes eld
33040 \begin_inset Quotes erd
33045 \begin_inset Quotes eld
33048 New\SpecialChar ldots
33050 \begin_inset Quotes erd
33054 in the window that opens,
33056 \begin_inset Quotes eld
33061 \begin_inset Quotes erd
33064 (or any other name you like) in the
33065 \begin_inset Quotes eld
33069 \begin_inset Quotes erd
33073 Now click on the button labeled
33074 \begin_inset Quotes eld
33079 \begin_inset Quotes erd
33082 to open a file dialog and navigate to the directory containing the batch file
33083 \begin_inset Flex Code
33086 \begin_layout Plain Layout
33094 \begin_inset Flex Code
33097 \begin_layout Plain Layout
33103 and then specify the program arguments as
33104 \begin_inset Flex Code
33107 \begin_layout Plain Layout
33115 \begin_inset Flex Code
33118 \begin_layout Plain Layout
33124 wrapper is used for communicating with \SpecialChar LyX
33132 \begin_layout LyX-Code
33134 \begin_inset Newline newline
33137 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
33146 \begin_inset Newline newline
33160 \begin_layout Standard
33161 Make sure that the \SpecialChar LyX
33162 Server pipe path you specified in \SpecialChar LyX
33164 \begin_inset Flex Code
33167 \begin_layout Plain Layout
33182 otherwise change the
33183 \begin_inset Flex Code
33186 \begin_layout Plain Layout
33192 wrapper accordingly.
33195 \begin_layout Standard
33197 reverse search is triggered by double-click.
33200 \begin_layout Subsubsection*
33201 SumatraPDF (Windows)
33204 \begin_layout Standard
33205 In order to use SumatraPDF for inverse search,
33207 \begin_inset Flex Code
33210 \begin_layout Plain Layout
33211 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
33216 in the viewer setting in
33217 \change_deleted -712698321 1674917965
33219 \begin_inset Flex Noun
33222 \begin_layout Plain Layout
33223 Preferences\SpecialChar menuseparator
33224 File Handling\SpecialChar menuseparator
33225 File formats\SpecialChar menuseparator
33232 \change_inserted -712698321 1674917965
33235 Preferences\SpecialChar menuseparator
33236 File Handling\SpecialChar menuseparator
33237 File formats\SpecialChar menuseparator
33244 \begin_inset Flex Code
33247 \begin_layout Plain Layout
33253 is the previous wrapper.
33254 If SumatraPDF.exe is not in your command PATH,
33255 use its full file name.
33258 \begin_layout Standard
33259 Reverse search is triggered by double-click.
33262 \begin_layout Subsubsection*
33266 \begin_layout Standard
33268 make sure that yap is your default DVI viewer in the Windows environment,
33271 \change_deleted -712698321 1674917973
33273 \begin_inset Flex Noun
33276 \begin_layout Plain Layout
33277 View\SpecialChar menuseparator
33284 \change_inserted -712698321 1674917973
33287 View\SpecialChar menuseparator
33292 menu and select the
33293 \begin_inset Quotes eld
33297 \begin_inset Quotes erd
33302 \begin_inset Quotes eld
33305 New\SpecialChar ldots
33307 \begin_inset Quotes erd
33311 in the window that opens,
33313 \begin_inset Quotes eld
33318 \begin_inset Quotes erd
33321 (or any other name you like) in the
33322 \begin_inset Quotes eld
33326 \begin_inset Quotes erd
33330 Now click on the button labeled
33331 \begin_inset Quotes eld
33336 \begin_inset Quotes erd
33339 to open a file dialog and navigate to the directory containing the
33340 \begin_inset Flex Code
33343 \begin_layout Plain Layout
33349 program (which is installed by default on Cygwin along with the \SpecialChar LyX
33352 \begin_inset Flex Code
33355 \begin_layout Plain Layout
33361 and then specify the program arguments as
33362 \begin_inset Flex Code
33365 \begin_layout Plain Layout
33373 you will be using the
33377 for communicating with \SpecialChar LyX
33380 for whatever reason,
33381 you want to use the
33387 \begin_inset Flex Code
33390 \begin_layout Plain Layout
33396 option and be sure to specify the \SpecialChar LyX
33397 Server pipe path in the \SpecialChar LyX
33401 \begin_layout Standard
33403 reverse search is triggered by double-click.
33406 \begin_layout Subsubsection*
33407 SumatraPDF (Cygwin)
33410 \begin_layout Standard
33411 In order to use SumatraPDF for inverse search,
33413 \begin_inset Flex Code
33416 \begin_layout Plain Layout
33417 SumatraPDF -inverse-search "lyxeditor -g %f %l"
33422 in the viewer setting in
33423 \change_deleted -712698321 1674917986
33425 \begin_inset Flex Noun
33428 \begin_layout Plain Layout
33429 Preferences\SpecialChar menuseparator
33430 File Handling\SpecialChar menuseparator
33431 File formats\SpecialChar menuseparator
33438 \change_inserted -712698321 1674917986
33441 Preferences\SpecialChar menuseparator
33442 File Handling\SpecialChar menuseparator
33443 File formats\SpecialChar menuseparator
33449 If SumatraPDF.exe is not in your command PATH,
33450 use its full posix path.
33452 \begin_inset Flex Code
33455 \begin_layout Plain Layout
33461 enables communication via the
33468 \begin_inset Flex Code
33471 \begin_layout Plain Layout
33477 option if you want to use the
33482 and be sure to specify the \SpecialChar LyX
33483 Server pipe path in the \SpecialChar LyX
33487 \begin_layout Standard
33488 Reverse search is triggered by double-click.
33491 \begin_layout Section
33495 \begin_layout Standard
33497 as the name implies,
33499 \begin_inset Quotes eld
33503 \begin_inset Quotes erd
33507 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
33509 If forward search is set up (as described in what follows),
33510 you can put the cursor anywhere in your \SpecialChar LyX
33513 \change_deleted -712698321 1674917994
33515 \begin_inset Flex Noun
33518 \begin_layout Plain Layout
33519 Navigate\SpecialChar menuseparator
33526 \change_inserted -712698321 1674917994
33529 Navigate\SpecialChar menuseparator
33535 \change_deleted -712698321 1674918002
33539 \begin_inset Flex Noun
33542 \begin_layout Plain Layout
33551 \change_inserted -712698321 1674918002
33556 in the context menu via right mouse click),
33557 and then the viewer will jump to that position as well.
33560 that your viewer supports this function.
33563 \begin_layout Standard
33564 To make forward search possible,
33565 you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
33567 This can be done via the methods described in the section
33568 \begin_inset CommandInset ref
33570 reference "subsec:rev-search"
33578 \begin_layout Standard
33580 you need to configure \SpecialChar LyX
33581 for using your viewers in
33582 \change_deleted -712698321 1674918011
33584 \begin_inset Flex Noun
33587 \begin_layout Plain Layout
33588 Tools\SpecialChar menuseparator
33589 Preferences\SpecialChar menuseparator
33590 Output\SpecialChar menuseparator
33597 \change_inserted -712698321 1674918011
33600 Tools\SpecialChar menuseparator
33601 Preferences\SpecialChar menuseparator
33602 Output\SpecialChar menuseparator
33608 We provide a range of tested configurations for some viewers,
33609 which you can select from the drop down list.
33610 If none of these configurations suits you,
33611 you have to find out and enter a suitable configuration yourself.
33612 The definition syntax uses the following placeholders:
33615 \begin_layout Itemize
33617 \begin_inset Flex Code
33620 \begin_layout Plain Layout
33630 \begin_layout Itemize
33632 \begin_inset Flex Code
33635 \begin_layout Plain Layout
33642 name of the (temporary) exported .tex file (without path)
33645 \begin_layout Itemize
33647 \begin_inset Flex Code
33650 \begin_layout Plain Layout
33657 name of the (temporary) exported .tex file (including path)
33660 \begin_layout Itemize
33662 \begin_inset Flex Code
33665 \begin_layout Plain Layout
33672 name of the exported output file (either dvi or pdf,
33673 depending on which one exists in the temporary directory)
33676 \begin_layout Standard
33677 Note that only some of the viewers provide full and usable forward search functionality out of the box,
33684 \begin_layout Plain Layout
33685 You might want to set
33686 \begin_inset Flex Code
33689 \begin_layout Plain Layout
33696 \change_deleted -712698321 1674918020
33698 \begin_inset Flex Noun
33701 \begin_layout Plain Layout
33702 Tools\SpecialChar menuseparator
33703 Preferences\SpecialChar menuseparator
33704 File Handling\SpecialChar menuseparator
33706 \begin_inset space ~
33715 \change_inserted -712698321 1674918020
33718 Tools\SpecialChar menuseparator
33719 Preferences\SpecialChar menuseparator
33720 File Handling\SpecialChar menuseparator
33722 \begin_inset space ~
33738 \begin_layout Plain Layout
33739 SumatraPDF can also use DDE commands through the external program CMCDDE —
33741 \begin_inset CommandInset href
33743 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
33759 \begin_layout Plain Layout
33760 Forward search with evince can be achieved by means of third party helper scripts.
33762 \begin_inset CommandInset href
33764 target "https://wiki.lyx.org/LyX/SyncTeX"
33775 require some extra tools in order to use forward search.
33776 While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
33777 some other viewers – e.
33778 \begin_inset space \thinspace{}
33782 xpdf – allow at least to reload the document and jump to a specific page of the file,
33783 so you can at least navigate
33784 \begin_inset Quotes eld
33788 \begin_inset Quotes erd
33792 This latter functionality is provided by an external call of synctex (see the predefined example configurations).
33796 \begin_layout Standard
33797 Forward search works both with DVI and PDF output.
33799 simply checks which preview format you have used before (i.
33800 \begin_inset space \thinspace{}
33804 which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
33805 \change_deleted 564990737 1672743015
33809 \begin_layout Standard
33811 \change_deleted 564990737 1672743015
33812 Special Document Classes
33815 \begin_layout Standard
33817 \change_deleted 564990737 1669742044
33821 \begin_layout Standard
33823 \change_deleted 564990737 1669742044
33829 \begin_layout Standard
33831 \change_deleted 564990737 1669742044
33835 \begin_layout Standard
33837 \change_deleted 564990737 1669742044
33838 This section describes how \SpecialChar LyX
33839 can be used to write articles for submission to the scientific journal
33841 Astronomy and Astrophysics
33844 \begin_inset Flex URL
33847 \begin_layout Plain Layout
33849 https://www.aanda.org/
33854 ) using Version 5.01 of the document class
33859 This package can be downloaded from the ftp site
33862 \begin_layout Standard
33864 \change_deleted 564990737 1669742044
33865 \begin_inset VSpace medskip
33871 \begin_layout Standard
33874 \change_deleted 564990737 1669742044
33875 \begin_inset Flex URL
33878 \begin_layout Plain Layout
33880 ftp://ftp.edpsciences.org/pub/aa/readme.html
33888 \begin_layout Standard
33890 \change_deleted 564990737 1669742044
33891 \begin_inset VSpace medskip
33897 \begin_layout Standard
33899 \change_deleted 564990737 1669742044
33900 A manual comes together with that package,
33901 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.
33905 \begin_layout Standard
33907 \change_deleted 564990737 1669742044
33908 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
33910 That change involved also some slight changes to the style files,
33911 namely the removal of the thesaurus command.
33912 The \SpecialChar LyX
33913 class aa supports the newest version of these style files,
33915 If you have an older version installed,
33918 the old (version 4) layout has been kept as
33923 Please refer to the comments in
33926 Dir/layouts/aapaper.layout
33931 \begin_layout Standard
33933 \change_deleted 564990737 1669742044
33937 \begin_layout Standard
33939 \change_deleted 564990737 1669742044
33940 It is recommended you start from the example template distributed with \SpecialChar LyX
33942 If you are not using a template,
33943 note the following settings:
33946 \begin_layout Itemize
33948 \change_deleted 564990737 1669742044
33955 Document\SpecialChar menuseparator
33959 that one was obvious).
33962 \begin_layout Itemize
33964 \change_deleted 564990737 1669742044
33965 Don't change the option
33968 \begin_inset space ~
33979 The whole layout is done by the macros,
33980 you shouldn't change anything.
33983 \begin_layout Standard
33985 \change_deleted 564990737 1669742044
33989 \begin_layout Standard
33991 \change_deleted 564990737 1669742044
33992 First thing to enter is the header information.
33993 It consists of seven entries,
33994 of which some are optional.
33998 \begin_layout Itemize
34000 \change_deleted 564990737 1669742044
34009 \begin_layout Itemize
34011 \change_deleted 564990737 1669742044
34020 \begin_layout Itemize
34022 \change_deleted 564990737 1669742044
34031 \begin_layout Itemize
34033 \change_deleted 564990737 1669742044
34042 \begin_layout Itemize
34044 \change_deleted 564990737 1669742044
34050 [optional] if more than one author:
34051 whom to contact for offprint requests.
34054 \begin_layout Itemize
34056 \change_deleted 564990737 1669742044
34062 [optional] mail address for contacts.
34065 \begin_layout Itemize
34067 \change_deleted 564990737 1669742044
34074 Suggested format is
34081 \begin_layout Standard
34083 \change_deleted 564990737 1669742044
34084 There is no need to issue the
34091 this is done automatically by \SpecialChar LyX
34092 when the header is finished.
34093 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
34094 just to get the best optics and meets the layout of the real document.
34097 \begin_layout Standard
34099 \change_deleted 564990737 1669742044
34100 If you want to place footnotes in the header block,
34102 \begin_inset space \thinspace{}
34106 \begin_inset space \space{}
34109 to state your present address,
34110 just use the standard footnote via the menu
34112 Insert\SpecialChar menuseparator
34117 will automagically use the term
34126 \begin_layout Standard
34128 \change_deleted 564990737 1669742044
34131 Edit\SpecialChar menuseparator
34135 you'll find two insets which are relevant for the titling:
34138 \begin_layout Itemize
34140 \change_deleted 564990737 1669742044
34147 to mark corresponding author\SpecialChar breakableslash
34149 The institutes are numbered sequentially as they appear in the
34154 so you have to put a marker to each author.
34157 \begin_layout Itemize
34159 \change_deleted 564990737 1669742044
34164 to supply an email address for fast contact.
34167 \begin_layout Standard
34169 \change_deleted 564990737 1669742044
34170 In addition to these topics,
34171 the macros use one additional \SpecialChar LaTeX
34172 command that has no counterpart in \SpecialChar LyX
34176 \begin_layout Itemize
34178 \change_deleted 564990737 1669742044
34185 to separate different names for more than one author and institute,
34189 \begin_layout Standard
34191 \change_deleted 564990737 1669742044
34192 The appropriate command has to be entered in \SpecialChar LyX
34193 and marked as \SpecialChar LaTeX
34199 \begin_layout Standard
34201 \change_deleted 564990737 1669742044
34205 \begin_layout Standard
34207 \change_deleted 564990737 1669742044
34208 The abstract should immediately follow the header block.
34209 With version 5 the abstract environment was changed to a command,
34210 and there is now a restriction to only one paragraph.
34212 it should contain an entry with the keywords.
34213 This is done via the paragraph style
34218 Refer to the example paper.
34221 \begin_layout Standard
34223 \change_deleted 564990737 1669742044
34224 Supported environments
34227 \begin_layout Standard
34229 \change_deleted 564990737 1669742044
34230 The A&A paper layout supports the following environments for structuring your text:
34233 \begin_layout Itemize
34235 \change_deleted 564990737 1669742044
34241 \begin_layout Itemize
34243 \change_deleted 564990737 1669742044
34249 \begin_layout Itemize
34251 \change_deleted 564990737 1669742044
34257 \begin_layout Itemize
34259 \change_deleted 564990737 1669742044
34265 \begin_layout Itemize
34267 \change_deleted 564990737 1669742044
34273 \begin_layout Itemize
34275 \change_deleted 564990737 1669742044
34281 \begin_layout Itemize
34283 \change_deleted 564990737 1669742044
34289 \begin_layout Itemize
34291 \change_deleted 564990737 1669742044
34297 \begin_layout Itemize
34299 \change_deleted 564990737 1669742044
34305 \begin_layout Itemize
34307 \change_deleted 564990737 1669742044
34313 \begin_layout Itemize
34315 \change_deleted 564990737 1669742044
34321 \begin_layout Itemize
34323 \change_deleted 564990737 1669742044
34330 \begin_layout Standard
34332 \change_deleted 564990737 1669742044
34333 Commands not supported by \SpecialChar LyX
34337 \begin_layout Standard
34339 \change_deleted 564990737 1669742044
34340 Some commands are not yet supported by the
34344 layout for \SpecialChar LyX
34346 Some have already been mentioned.
34347 For the sake of completeness,
34348 they are listed all together here:
34351 \begin_layout Itemize
34353 \change_deleted 564990737 1669742044
34361 \begin_layout Itemize
34363 \change_deleted 564990737 1669742044
34371 \begin_layout Itemize
34373 \change_deleted 564990737 1669742044
34381 \begin_layout Itemize
34383 \change_deleted 564990737 1669742044
34391 \begin_layout Standard
34393 \change_deleted 564990737 1669742044
34394 If you want to use any of these commands,
34395 you have to enter them yourself.
34398 Do not forget to mark them as \SpecialChar LaTeX
34402 \begin_layout Standard
34404 \change_deleted 564990737 1669742044
34405 Figure and Table Floats
34408 \begin_layout Standard
34410 \change_deleted 564990737 1669742044
34412 provides support for the necessary float environments
34423 therefore we won't tell much about it here.
34427 \begin_inset space ~
34433 Just remember that tables should be left-aligned.
34435 select the table and change the alignment in
34437 Edit\SpecialChar menuseparator
34439 \begin_inset space ~
34445 \begin_layout Standard
34447 \change_deleted 564990737 1669742044
34448 There is only one special thing:
34449 the figures with caption besides the figure.
34450 To create such a figure,
34451 you have to do the following:
34454 \begin_layout Enumerate
34456 \change_deleted 564990737 1669742044
34457 Create a wide figure float:
34460 Insert\SpecialChar menuseparator
34461 Float\SpecialChar menuseparator
34465 then right click in the figure and select
34468 \begin_inset space ~
34476 \begin_layout Enumerate
34478 \change_deleted 564990737 1669742044
34479 Enter your caption text.
34482 \begin_layout Enumerate
34484 \change_deleted 564990737 1669742044
34489 to move the cursor above the caption.
34492 \begin_layout Enumerate
34494 \change_deleted 564990737 1669742044
34498 \begin_layout Enumerate
34500 \change_deleted 564990737 1669742044
34501 Position the cursor behind the figure and insert a horizontal fill:
34504 Insert\SpecialChar menuseparator
34506 \begin_inset space ~
34509 Character\SpecialChar menuseparator
34511 \begin_inset space ~
34519 \begin_layout Enumerate
34521 \change_deleted 564990737 1669742044
34522 Switch to \SpecialChar LaTeX
34527 \begin_inset space ~
34535 \begin_layout Enumerate
34537 \change_deleted 564990737 1669742044
34547 Do not close the brace!
34550 \begin_layout Enumerate
34552 \change_deleted 564990737 1669742044
34553 Position the cursor behind the caption text,
34554 switch to \SpecialChar LaTeX
34555 mode and insert the closing brace:
34559 \begin_inset space ~
34571 \begin_layout Standard
34573 \change_deleted 564990737 1669742044
34575 refer to the figures in the example paper.
34578 \begin_layout Standard
34580 \change_deleted 564990737 1669742044
34584 \begin_layout Standard
34586 \change_deleted 564990737 1669742044
34588 the paper has to be formated in a special double-spacing layout.
34590 you have to give the option
34594 to the document class.
34595 This must be done using the custom class options field in the
34597 Document\SpecialChar menuseparator
34601 Just enter the string
34608 \begin_layout Standard
34610 \change_deleted 564990737 1669742044
34614 \begin_layout Standard
34616 \change_deleted 564990737 1669742044
34621 directory contains an example paper written with \SpecialChar LyX
34623 It is the example paper from the original macro package,
34624 translated to \SpecialChar LyX
34626 Use it for inspiration,
34627 and compare the original \SpecialChar LaTeX
34628 code with \SpecialChar LyX
34632 \begin_layout Standard
34634 \change_deleted 564990737 1671097429
34638 \begin_layout Standard
34640 \change_deleted 564990737 1671097429
34645 can be used to type letters according to German conventions.
34646 A template file is included in
34648 .../lyx/share/templates
34650 for you to use as a starting point.
34653 \begin_layout Standard
34655 \change_deleted 564990737 1671097429
34659 \begin_layout Standard
34661 \change_deleted 564990737 1671097429
34662 See the \SpecialChar LyX
34668 It contains all infos you need.
34671 \begin_layout Standard
34673 \change_deleted 564990737 1669755802
34677 \begin_layout Standard
34679 \change_deleted 564990737 1669755802
34682 Panayotis Papasotiriou
34685 \begin_layout Standard
34687 \change_deleted 564990737 1669755802
34691 \begin_layout Standard
34693 \change_deleted 564990737 1669755802
34694 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
34696 International Journal of Modern Physics C
34700 the ijmpd package is for creating manuscripts to be submitted to the
34702 International Journal of Modern Physics D
34705 Both journals are published by World Scientific.
34706 The corresponding document classes are named
34717 together with instructions for the authors,
34718 can be downloaded from the sites
34719 \begin_inset Flex URL
34722 \begin_layout Plain Layout
34724 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
34730 \begin_inset Flex URL
34733 \begin_layout Plain Layout
34735 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
34741 Both packages are modified versions of the standard
34742 \begin_inset Quotes eld
34746 \begin_inset Quotes erd
34750 and they are almost (but not exactly) identical.
34751 Most of their features are supported by \SpecialChar LyX
34753 I have used \SpecialChar LyX
34754 successfully to write articles submitted to both journals without any problem.
34757 \begin_layout Standard
34759 \change_deleted 564990737 1669755802
34763 \begin_layout Standard
34765 \change_deleted 564990737 1669755802
34767 the easiest way to write a paper is to start with a template.
34770 File\SpecialChar menuseparator
34787 This will give an (almost) empty document that includes the most common fields found in a manuscript.
34788 Simply overwrite the existing text (including the brackets,
34794 You should keep in mind the following remarks.
34797 \begin_layout Enumerate
34799 \change_deleted 564990737 1669755802
34801 won't let you change the font size and the page style of the document,
34802 because such modifications are not allowed by both packages.
34805 \begin_layout Enumerate
34807 \change_deleted 564990737 1669755802
34808 The language of the document should not be changed.
34809 Before previewing your paper,
34810 be sure that the babel package is not used.
34815 arg "dialog-show document"
34820 \SpecialChar menuseparator
34825 \begin_inset Quotes eld
34829 \begin_inset Quotes erd
34839 \begin_layout Enumerate
34841 \change_deleted 564990737 1669755802
34843 \begin_inset Quotes eld
34847 \begin_inset Quotes erd
34850 style must be used to define keywords.
34853 \begin_layout Enumerate
34855 \change_deleted 564990737 1669755802
34856 The ijmpc package provides a style named
34857 \begin_inset Quotes eld
34860 Classification Codes
34861 \begin_inset Quotes erd
34865 which can be used to define classification codes,
34866 such as PACS numbers.
34867 Note that this facility is not supported by the ijmpd package.
34870 \begin_layout Enumerate
34872 \change_deleted 564990737 1669755802
34873 Several new environments are available:
34875 \begin_inset Quotes eld
34879 \begin_inset Quotes erd
34884 \begin_inset Quotes eld
34888 \begin_inset Quotes erd
34893 \begin_inset Quotes eld
34897 \begin_inset Quotes erd
34902 \begin_inset Quotes eld
34906 \begin_inset Quotes erd
34911 \begin_inset Quotes eld
34915 \begin_inset Quotes erd
34920 \begin_inset Quotes eld
34924 \begin_inset Quotes erd
34929 \begin_inset Quotes eld
34933 \begin_inset Quotes erd
34938 \begin_inset Quotes eld
34942 \begin_inset Quotes erd
34947 \begin_inset Quotes eld
34951 \begin_inset Quotes erd
34956 \begin_inset Quotes eld
34960 \begin_inset Quotes erd
34965 \begin_inset Quotes eld
34969 \begin_inset Quotes erd
34974 \begin_inset Quotes eld
34978 \begin_inset Quotes erd
34983 \begin_inset Quotes eld
34987 \begin_inset Quotes erd
34992 \begin_inset Quotes eld
34996 \begin_inset Quotes erd
35000 Their use is more or less obvious.
35002 supports all these environments;
35003 it will use the proper label,
35005 and numbering scheme for each of them.
35008 \begin_layout Enumerate
35010 \change_deleted 564990737 1669755802
35011 Both packages use basic citations;
35012 the natbib package should not be used.
35013 In \SpecialChar LyX
35015 citation references are shown as usual;
35017 citations are shown as superscripts.
35018 If you want to use a citation as normal text,
35025 \begin_inset space \thinspace{}
35029 \begin_inset space \space{}
35033 \begin_inset Quotes eld
35037 \begin_inset space \space{}
35047 \begin_inset Quotes erd
35053 \begin_layout Enumerate
35055 \change_deleted 564990737 1669755802
35057 \begin_inset Quotes eld
35061 \begin_inset Quotes erd
35064 section in both packages.
35065 To put acknowledgments,
35067 \begin_inset Quotes eld
35071 \begin_inset Quotes erd
35077 \begin_layout Enumerate
35079 \change_deleted 564990737 1669755802
35080 Appendices may be added to the paper,
35085 the Acknowledgments and
35091 provides a special environment,
35093 \begin_inset Quotes eld
35097 \begin_inset Quotes erd
35100 which marks the beginning of the appendices.
35101 This environment should be left blank;
35102 it just sends a \SpecialChar LaTeX
35104 but nothing is really printed.
35105 In \SpecialChar LyX
35108 \begin_inset Quotes eld
35112 \begin_inset Quotes erd
35115 is printed with blue letters,
35116 as a signal that all sections after that point are appendices.
35117 To write an appendix,
35119 \begin_inset Quotes eld
35123 \begin_inset Quotes erd
35128 will number each appendix with capital letters,
35129 as required by both journals.
35131 \begin_inset Quotes eld
35135 \begin_inset Quotes erd
35142 be present before the first appendix;
35144 all appendices will be numbered as normal sections in the output.
35147 \begin_layout Enumerate
35149 \change_deleted 564990737 1669755802
35150 The ijmpc and the ijmpd packages use the
35154 command to implement table captions.
35156 a table created by \SpecialChar LyX
35157 is printed correctly,
35158 but its caption is ignored.
35160 you can use some \SpecialChar TeX
35161 code to overcome this problem,
35162 so that captions are printed as expected.
35164 create a float table as usual,
35165 remove the caption,
35166 and replace it with the \SpecialChar TeX
35178 you must also the \SpecialChar TeX
35183 immediately after the tabular material.
35184 Study the example table included in the template files to see how this trick is implemented.
35186 If you need table captions,
35187 you should implement the whole table float in a
35192 then include this file to the \SpecialChar LyX
35195 Insert\SpecialChar menuseparator
35196 File\SpecialChar menuseparator
35198 \begin_inset space ~
35204 Details on how to create a table float can be found in the files
35213 included in the corresponding packages.
35216 \begin_layout Standard
35218 \change_deleted 564990737 1669755802
35219 Preparing a paper for submission
35222 \begin_layout Standard
35224 \change_deleted 564990737 1669755802
35225 Before you submit your paper you must export the \SpecialChar LyX
35226 document as a \SpecialChar LaTeX
35229 File\SpecialChar menuseparator
35230 Export\SpecialChar menuseparator
35238 \begin_layout Plain Layout
35239 Actually you have the choice between \SpecialChar LaTeX
35240 (plain) and pdflatex.
35241 If you intend to use pdflatex to prepare the paper,
35242 you should use the pdflatex option so that included graphics are converted to PDF format,
35243 ready for use by pdflatex.
35249 then make the following changes to the resulting
35256 \begin_layout Enumerate
35258 \change_deleted 564990737 1669755802
35259 Remove the comment lines before the
35268 \begin_layout Enumerate
35270 \change_deleted 564990737 1669755802
35271 Remove everything between (and including) the
35284 except for any commands you specifically put into the \SpecialChar LaTeX
35288 \begin_layout Standard
35290 \change_deleted 564990737 1672743015
35295 file should be saved and processed through \SpecialChar LaTeX
35296 as many times as necessary.
35297 You may also want to check the resulting
35304 \begin_layout Standard
35306 \change_deleted 564990737 1669801478
35310 \begin_layout Standard
35312 \change_deleted 564990737 1669801478
35318 \begin_layout Standard
35320 \change_deleted 564990737 1669801478
35324 \begin_layout Standard
35326 \change_deleted 564990737 1669801478
35327 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
35328 Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
35329 \begin_inset Flex URL
35332 \begin_layout Plain Layout
35334 ftp://ftp.iop.org/pub/journals/latex2e
35342 \begin_layout Standard
35344 \change_deleted 564990737 1669801478
35348 \begin_layout Standard
35350 \change_deleted 564990737 1669801478
35351 The easiest way to write a paper is to start with the template
35355 that is available via
35357 File\SpecialChar menuseparator
35360 The template explains how to use the special text environments.
35361 Here are the most important advices:
35364 \begin_layout Itemize
35366 \change_deleted 564990737 1669801478
35367 To be able to compile your document to a PDF,
35370 ensure that the no AMS packages are loaded in
35372 Document\SpecialChar menuseparator
35373 Settings\SpecialChar menuseparator
35379 \begin_layout Itemize
35381 \change_deleted 564990737 1669801478
35384 The title environment defines the kind of your paper.
35385 So use one of the following environments for the title:
35389 \begin_layout Itemize
35391 \change_deleted 564990737 1669801478
35400 \begin_layout Itemize
35402 \change_deleted 564990737 1669801478
35411 \begin_layout Itemize
35413 \change_deleted 564990737 1669801478
35419 for a Topical review
35422 \begin_layout Itemize
35424 \change_deleted 564990737 1669801478
35433 \begin_layout Itemize
35435 \change_deleted 564990737 1669801478
35444 \begin_layout Itemize
35446 \change_deleted 564990737 1669801478
35452 for a Paper (same as Title)
35455 \begin_layout Itemize
35457 \change_deleted 564990737 1669801478
35463 for a Preliminary communication
35466 \begin_layout Itemize
35468 \change_deleted 564990737 1669801478
35474 for a Rapid communication
35477 \begin_layout Itemize
35479 \change_deleted 564990737 1669801478
35485 for a Letter to the editor
35489 \begin_layout Itemize
35491 \change_deleted 564990737 1669801478
35494 All title environments except of
35498 can have an optional short title.
35501 \begin_layout Itemize
35503 \change_deleted 564990737 1669801478
35504 There is a general title environment
35508 which is not directly supported by \SpecialChar LyX
35510 This can be used as \SpecialChar TeX
35511 code when your document doesn't fit into one of the other title types.
35514 \begin_layout Standard
35516 \change_deleted 564990737 1672743015
35517 For more informations like hints for special table and formula formatting,
35518 look at the IOP author guidelines.
35521 \begin_layout Standard
35523 \change_deleted 564990737 1670317155
35527 \begin_layout Standard
35529 \change_deleted 564990737 1670317155
35532 Panayotis Papasotiriou
35535 \begin_layout Standard
35537 \change_deleted 564990737 1670317155
35541 \begin_layout Standard
35543 \change_deleted 564990737 1670317155
35544 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
35545 Most known of them (at least in my domain of interest) are
35547 Astrophysics and Space Science
35554 but there are many others (see a complete list at
35555 \begin_inset Flex URL
35558 \begin_layout Plain Layout
35560 http://www.wkap.nl/jrnllist.htm/JRNLHOME
35566 The Kluwer package may be downloaded from the site
35567 \begin_inset Flex URL
35570 \begin_layout Plain Layout
35572 http://www.wkap.nl/kaphtml.htm/STYLEFILES
35578 A complete user guide is contained in that package (but it can also be downloaded separately).
35581 \begin_layout Standard
35583 \change_deleted 564990737 1670317155
35585 supports many features of the package but not everything.
35587 the \SpecialChar TeX
35588 code needed is reduced to some
35589 \begin_inset Quotes eld
35593 \begin_inset Quotes erd
35596 commands of the package (see
35597 \begin_inset space ~
35601 \begin_inset CommandInset ref
35603 reference "subsec:kluwer_peculiarities"
35609 I have recently used \SpecialChar LyX
35610 to write an article submitted to the
35612 Astrophysics and Space Science
35614 without any problem.
35617 \begin_layout Standard
35619 \change_deleted 564990737 1670317155
35623 \begin_layout Standard
35625 \change_deleted 564990737 1670317155
35626 The easiest way to write a paper is to start with the Kluwer template file.
35629 File\SpecialChar menuseparator
35642 This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
35643 As in most templates,
35644 simply overwrite the existing text (including the brackets,
35649 ) with the correct information.
35652 \begin_layout Standard
35654 \change_deleted 564990737 1670317155
35655 Preparing a paper for submission
35658 \begin_layout Standard
35660 \change_deleted 564990737 1670317155
35661 As in the AAS\SpecialChar TeX
35663 before you submit your paper to a journal you must
35664 \begin_inset Quotes eld
35668 \begin_inset Quotes erd
35674 \begin_layout Enumerate
35676 \change_deleted 564990737 1670317155
35677 Export your paper as a \SpecialChar LaTeX
35682 File\SpecialChar menuseparator
35683 Export\SpecialChar menuseparator
35691 \begin_layout Enumerate
35693 \change_deleted 564990737 1670317155
35698 file with a text editor and make the following changes
35702 \begin_layout Enumerate
35704 \change_deleted 564990737 1670317155
35705 remove the comment lines before the
35714 \begin_layout Enumerate
35716 \change_deleted 564990737 1670317155
35717 remove everything between (and including) the
35730 except for any commands you specifically put into the \SpecialChar LaTeX
35734 \begin_layout Standard
35736 \change_deleted 564990737 1670317155
35745 \begin_layout Enumerate
35747 \change_deleted 564990737 1670317155
35752 file through \SpecialChar LaTeX
35753 as many times as necessary (usually up to three).
35756 \begin_layout Enumerate
35758 \change_deleted 564990737 1670317155
35765 \begin_inset space \thinspace{}
35769 \begin_inset space \space{}
35777 and check if everything is OK (it should,
35778 if you didn't make any mistake).
35781 \begin_layout Standard
35783 \change_deleted 564990737 1670317155
35784 \begin_inset Quotes eld
35788 \begin_inset Quotes erd
35791 of the Kluwer package
35792 \begin_inset CommandInset label
35794 name "subsec:kluwer_peculiarities"
35801 \begin_layout Standard
35803 \change_deleted 564990737 1670317155
35804 The Kluwer package has the following
35805 \begin_inset Quotes eld
35809 \begin_inset Quotes erd
35815 \begin_layout Enumerate
35817 \change_deleted 564990737 1670317155
35818 It is possible to write multiple articles in the same \SpecialChar LaTeX
35823 \begin_layout Plain Layout
35824 I can't imagine any good reason to do this.
35830 Each article must be included in the environment
35831 \begin_inset Quotes eld
35835 \begin_inset Quotes erd
35840 this environment cannot be omitted,
35841 even if you write just one article.
35843 each article starts with the command
35851 ends with the command
35858 Although this can be implemented in \SpecialChar LyX
35860 I didn't included it,
35861 since it looks ugly and can confuse the novice user.
35863 you need to enter them directly and mark them as \SpecialChar LaTeX
35864 code (the well-known
35865 \begin_inset Quotes eld
35870 \begin_inset Quotes erd
35876 \begin_layout Enumerate
35878 \change_deleted 564990737 1670317155
35879 Information given at the beginning of the article (i.
35880 \begin_inset space \thinspace{}
35884 \begin_inset space \space{}
35893 abstract and keywords) must be included in an environment called
35894 \begin_inset Quotes eld
35898 \begin_inset Quotes erd
35902 This is not implemented in \SpecialChar LyX
35904 so you must enter title,
35906 \begin_inset space ~
35909 between two \SpecialChar TeX
35925 \begin_layout Enumerate
35927 \change_deleted 564990737 1670317155
35928 According to the user manual,
35929 the label of each bibliography item must be written as
35952 \begin_layout Standard
35954 \change_deleted 564990737 1670317155
35959 template takes care of all these
35960 \begin_inset Quotes eld
35964 \begin_inset Quotes erd
35968 If you start a new paper using this template you don't need to do anything special.
35972 \begin_layout Enumerate
35974 \change_deleted 564990737 1670317155
35975 don't delete the \SpecialChar TeX
35976 code included in the template,
35980 \begin_layout Enumerate
35982 \change_deleted 564990737 1670317155
35983 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
35986 \begin_layout Standard
35988 \change_deleted 564990737 1671097446
35992 \begin_layout Standard
35994 \change_deleted 564990737 1671097446
35999 provides an alternative to the standard
36004 It provides similar functionality,
36005 but you might prefer this layout with sans serif sections,
36010 \begin_layout Standard
36012 \change_deleted 564990737 1671097446
36013 Springer Journals (
36020 \begin_layout Standard
36022 \change_deleted 564990737 1671097446
36028 \begin_layout Standard
36030 \change_deleted 564990737 1671097446
36034 \begin_layout Standard
36036 \change_deleted 564990737 1671097446
36037 These are the layout files for some of the journal formats used by Springer Verlag and listed on
36038 \begin_inset Flex URL
36041 \begin_layout Plain Layout
36043 http://www.springer.de/author/tex/help-journals.html
36049 where you should also go to fetch the class files (yes,
36050 these are \SpecialChar LaTeX2e
36052 It is a modular system:
36053 the things common to all journals are implemented in
36058 which journal-specific layout files (such as,
36060 \begin_inset space \thinspace{}
36064 \begin_inset space \space{}
36071 for Journal of Geodesy) can include.
36074 \begin_layout Standard
36076 \change_deleted 564990737 1671097446
36077 This means that implementing support for any other Springer journal on this list is as simple as writing your own
36085 file following the outline given in
36093 \begin_layout Standard
36095 \change_deleted 564990737 1671097446
36096 It is reasonably well tested only for the Journal of Geodesy.
36105 come with the standard \SpecialChar LyX
36107 Install the relevant class file (downloaded from Springer) in a proper directory,
36108 reconfigure \SpecialChar LaTeX
36109 (in the te\SpecialChar TeX
36115 as root if necessary —
36116 doesn't \SpecialChar LyX
36117 take care of this?),
36118 reconfigure \SpecialChar LyX
36119 and it should work.
36122 \begin_layout Standard
36124 \change_deleted 564990737 1671097446
36128 \begin_layout Standard
36130 \change_deleted 564990737 1671097446
36131 A large number of theorem-like styles —
36146 \begin_layout Standard
36148 \change_deleted 564990737 1671097446
36154 Running_\SpecialChar LaTeX
36165 See the Springer class file documentation for details.
36168 \begin_layout Standard
36170 \change_deleted 564990737 1671097446
36174 \begin_layout Itemize
36176 \change_deleted 564990737 1671097446
36190 \begin_layout Itemize
36192 \change_deleted 564990737 1671097446
36195 Probability Theory and Related Fields
36203 Jean-Marc Lasgouttes
36206 \begin_layout Standard
36208 \change_deleted 564990737 1671097446
36213 \begin_layout Standard
36215 \change_deleted 564990737 1671097446
36219 \begin_layout Standard
36221 \change_deleted 564990737 1671097446
36222 These files are partly based on the older
36227 which was again based on a tinkered-with version of an old \SpecialChar LaTeX
36228 2.09 style file from Springer.
36236 Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
36237 layout file mechanism.
36240 \begin_layout Standard
36242 \change_deleted 564990737 1671097446
36246 \begin_layout Standard
36248 \change_deleted 564990737 1671097446
36250 But probably less than in the old hacked-\SpecialChar LaTeX
36258 \begin_layout Chapter
36260 Features needing Extra Software
36263 \begin_layout Section
36264 Checking \SpecialChar TeX
36268 \begin_layout Standard
36274 \begin_layout Subsection
36278 \begin_layout Standard
36287 \begin_layout Plain Layout
36292 is not yet available when you are using the \SpecialChar LaTeX
36293 distribution MiK\SpecialChar TeX
36308 \begin_inset space ~
36319 \begin_inset Newline newline
36323 \begin_inset CommandInset href
36325 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
36333 \begin_layout Standard
36336 Chk\SpecialChar TeX
36339 package is a program that was written by
36340 \begin_inset Flex Noun
36343 \begin_layout Plain Layout
36345 \begin_inset space ~
36353 in frustration because some constructs in \SpecialChar LaTeX
36354 are sometimes non-intuitive,
36355 and easy to forget.
36356 The program runs over your \SpecialChar LaTeX
36358 checks the integrity of the file,
36359 and flags some common errors.
36360 In other technical words,
36365 for \SpecialChar LaTeX
36369 \begin_layout Standard
36371 what is a syntax checker doing in \SpecialChar LyX
36372 which is supposed to produce correct \SpecialChar LaTeX
36374 The answer is simple:
36379 not only checks the
36388 checks for type-errors,
36391 Chk\SpecialChar TeX
36394 catches some common
36399 in addition to the syntactical ones.
36403 Chk\SpecialChar TeX
36406 is capable of detecting several common errors,
36410 \begin_layout Itemize
36411 Ellipsis detection:
36412 \begin_inset Newline newline
36415 Use \SpecialChar ldots
36419 \begin_layout Itemize
36420 No space in front of/after parenthesis:
36421 \begin_inset Newline newline
36427 \begin_layout Itemize
36428 Enforcement of normal space after common abbreviations:
36429 \begin_inset Newline newline
36433 \begin_inset space \thinspace{}
36437 \begin_inset space \space{}
36440 is too wide spacing.
36443 \begin_layout Itemize
36444 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
36445 \begin_inset Newline newline
36449 And this is wrong spacing.
36452 \begin_layout Itemize
36453 Space in front of labels and similar commands:
36454 \begin_inset Newline newline
36457 The label should stick right up to the text to avoid falling to a wrong page.
36459 \begin_inset CommandInset label
36469 \begin_layout Plain Layout
36470 This footnote is in danger of falling off to a wrong page
36475 The label is separated too much.
36478 \begin_layout Itemize
36479 Space in front of references,
36480 instead of hard spaces:
36481 \begin_inset Newline newline
36484 If you have bad luck,
36485 the text will break right between the referenced text and reference number,
36488 \begin_inset CommandInset ref
36490 reference "sec:chktex"
36498 \begin_layout Itemize
36500 \begin_inset Quotes eld
36504 \begin_inset Quotes erd
36508 \begin_inset Formula $\times$
36512 \begin_inset Newline newline
36515 2x2 looks cheap compared to
36516 \begin_inset Formula $2\times2$
36522 \begin_layout Standard
36523 and more \SpecialChar ldots
36524 It is an invaluable tool when you are
36525 \begin_inset Quotes eld
36529 \begin_inset Quotes erd
36532 your document before printing,
36533 and you should run it right after the obligatory spelling check,
36534 and before you go fine tuning the typesetting.
36537 \begin_layout Subsection
36541 \begin_layout Standard
36542 If you have the program installed,
36543 usage is as simple as choosing
36545 Tools\SpecialChar menuseparator
36547 \begin_inset space ~
36553 This will make \SpecialChar LyX
36554 generate a \SpecialChar LaTeX
36555 file of your document,
36558 Chk\SpecialChar TeX
36562 and then make \SpecialChar LyX
36564 \begin_inset Quotes eld
36568 \begin_inset Quotes erd
36571 with the warnings from
36573 Chk\SpecialChar TeX
36578 The warnings will be placed close to the point of the mistake,
36579 and you can quickly find them by using the
36581 Navigate\SpecialChar menuseparator
36585 or the shortcut key
36594 Open the error boxes by clicking on them with the mouse,
36595 or use the shortcut key
36604 or the corresponding
36613 Read the warning and correct the mistake,
36614 if it is a mistake.
36615 If you have trouble understanding what the warning is about,
36616 you can safely ignore it.
36617 Remember that there is a hidden layer between the document on screen and the technical details in invoking
36619 Chk\SpecialChar TeX
36623 and this gap can make some warnings seem arcane or just plain silly.
36626 \begin_layout Standard
36627 This document is an excellent testing bed for the feature,
36628 and it should provide quite a few warnings for you to fiddle with.
36629 Since computers are only so smart,
36630 expect most of the warnings to be false alarms,
36634 \begin_layout Subsection
36635 How to fine tune it
36638 \begin_layout Standard
36642 Chk\SpecialChar TeX
36645 makes more noise than suits your mood.
36646 Then you can choose not to use it,
36647 wait until your mood changes,
36648 or try to customize
36650 Chk\SpecialChar TeX
36653 to get better along with you.
36656 \begin_layout Standard
36659 Chk\SpecialChar TeX
36666 very configurable and extensible,
36667 you should not expect to solve all problems with
36669 Chk\SpecialChar TeX
36672 in \SpecialChar LyX
36674 Since \SpecialChar LyX
36675 has to generate a somewhat special \SpecialChar LaTeX
36676 file to be able to match the line numbers from the
36678 Chk\SpecialChar TeX
36685 \begin_layout Plain Layout
36686 You can inspect the specific output from
36692 Document\SpecialChar menuseparator
36695 \begin_inset space ~
36709 to the internal document structure,
36710 some of the warnings will not appear correctly.
36711 There are two things you can do about this:
36714 \begin_layout Itemize
36717 Chk\SpecialChar TeX
36720 invocation command line in
36721 \change_deleted -712698321 1674918035
36723 \begin_inset Flex Noun
36726 \begin_layout Plain Layout
36727 Tools\SpecialChar menuseparator
36728 Preferences\SpecialChar menuseparator
36729 Output\SpecialChar menuseparator
36730 LaTeX\SpecialChar menuseparator
36737 \change_inserted -712698321 1674918035
36740 Tools\SpecialChar menuseparator
36741 Preferences\SpecialChar menuseparator
36742 Output\SpecialChar menuseparator
36743 LaTeX\SpecialChar menuseparator
36751 Chk\SpecialChar TeX
36754 installation configuration file (usually with the file
36759 See below to learn what warnings can be enabled and disabled on the command line.
36762 \begin_layout Itemize
36763 Export your document as a raw \SpecialChar LaTeX
36766 File\SpecialChar menuseparator
36767 Export\SpecialChar menuseparator
36776 Invoked in this way,
36777 it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
36779 but with a little patience,
36780 you should be able to do it.
36783 \begin_layout Standard
36784 Here follows the warning messages that can be enabled and disabled in
36793 to disable a warning,
36798 to enable a warning.
36799 The emphasized entries are disabled by default,
36800 because the default is "
36802 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
36807 \begin_layout Standard
36808 Notice that you should only use the options that enable and disable warnings,
36809 because \SpecialChar LyX
36810 relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
36817 \begin_layout Enumerate
36821 Command terminated with space.
36824 \begin_layout Enumerate
36827 Non-breaking space (
36828 \begin_inset Quotes eld
36836 \begin_inset Quotes erd
36839 ) should have been used.
36842 \begin_layout Enumerate
36846 You should enclose the previous parenthesis with
36847 \begin_inset Quotes eld
36855 \begin_inset Quotes erd
36861 \begin_layout Enumerate
36864 Italic correction (
36865 \begin_inset Quotes eld
36875 \begin_inset Quotes erd
36878 ) found in non-italic buffer.
36881 \begin_layout Enumerate
36884 Italic correction (
36885 \begin_inset Quotes eld
36895 \begin_inset Quotes erd
36898 ) found more than once.
36901 \begin_layout Enumerate
36905 No italic correction (
36906 \begin_inset Quotes eld
36916 \begin_inset Quotes erd
36922 \begin_layout Enumerate
36926 \begin_inset Quotes eld
36934 \begin_inset Quotes erd
36938 \begin_inset Quotes eld
36946 \begin_inset Quotes erd
36952 \begin_layout Enumerate
36955 Wrong length of dash may have been used.
36958 \begin_layout Enumerate
36962 \begin_inset Quotes eld
36970 \begin_inset Quotes erd
36975 \begin_inset Quotes eld
36983 \begin_inset Quotes erd
36989 \begin_layout Enumerate
36993 \begin_inset Quotes eld
37001 \begin_inset Quotes erd
37007 \begin_layout Enumerate
37011 \begin_inset Quotes eld
37019 \begin_inset Quotes erd
37022 to achieve an ellipsis.
37025 \begin_layout Enumerate
37028 Inter-word spacing (
37029 \begin_inset Quotes eld
37039 \begin_inset Quotes eld
37042 ) should perhaps be used.
37045 \begin_layout Enumerate
37048 Inter-sentence spacing (
37049 \begin_inset Quotes eld
37059 \begin_inset Quotes erd
37062 ) should perhaps be used.
37065 \begin_layout Enumerate
37068 Could not find argument for command.
37071 \begin_layout Enumerate
37075 \begin_inset Quotes eld
37083 \begin_inset Quotes erd
37089 \begin_layout Enumerate
37092 Math mode still on at end of \SpecialChar LaTeX
37096 \begin_layout Enumerate
37100 \begin_inset Quotes eld
37108 \begin_inset Quotes erd
37111 doesn't match the number of
37112 \begin_inset Quotes eld
37120 \begin_inset Quotes erd
37126 \begin_layout Enumerate
37129 You should use either
37132 \begin_inset Quotes eld
37140 \begin_inset Quotes erd
37145 as an alternative to
37146 \begin_inset Quotes eld
37154 \begin_inset Quotes erd
37160 \begin_layout Enumerate
37167 " (ASCII 39) instead of "
37174 \begin_layout Enumerate
37177 User-specified pattern found.
37180 \begin_layout Enumerate
37183 This command might not be intended.
37186 \begin_layout Enumerate
37193 \begin_layout Enumerate
37211 \begin_layout Enumerate
37214 Delete this space to maintain correct page references.
37217 \begin_layout Enumerate
37221 You might wish to put this between a pair of
37222 \begin_inset Quotes eld
37230 \begin_inset Quotes erd
37236 \begin_layout Enumerate
37239 You ought to remove spaces in front of punctuation.
37242 \begin_layout Enumerate
37245 Could not execute \SpecialChar LaTeX
37249 \begin_layout Enumerate
37258 in front of small punctuation.
37261 \begin_layout Enumerate
37269 may look prettier here.
37272 \begin_layout Enumerate
37276 Multiple spaces detected in output.
37279 \begin_layout Enumerate
37282 This text may be ignored.
37285 \begin_layout Enumerate
37291 \begin_inset Quotes eld
37296 to begin quotation,
37304 \begin_layout Enumerate
37315 \begin_inset Quotes eld
37323 \begin_layout Enumerate
37329 \begin_layout Enumerate
37332 You should perhaps use
37333 \begin_inset Quotes eld
37341 \begin_inset Quotes erd
37347 \begin_layout Enumerate
37350 You should put a space in front of/after parenthesis.
37353 \begin_layout Enumerate
37356 You should avoid spaces in front of/after parenthesis.
37359 \begin_layout Enumerate
37363 You should not use punctuation in front of/after quotes.
37366 \begin_layout Enumerate
37369 Double space found.
37372 \begin_layout Enumerate
37375 You should put punctuation outside inner/inside display math mode.
37378 \begin_layout Enumerate
37381 You ought to not use primitive \SpecialChar TeX
37382 in \SpecialChar LaTeX
37386 \begin_layout Enumerate
37389 You should remove spaces in front of
37390 \begin_inset Quotes eld
37398 \begin_inset Quotes erd
37404 \begin_layout Enumerate
37407 \begin_inset Quotes eld
37415 \begin_inset Quotes erd
37418 is normally not followed by
37419 \begin_inset Quotes eld
37427 \begin_inset Quotes erd
37433 \begin_layout Standard
37434 In later versions of \SpecialChar LyX
37436 we hope to provide a more complete interface to this tool (and it's smaller cousin
37440 ) to exploit the full power of it.
37441 But it's not exactly useless as it is now:
37442 go try it on one of your existing documents of a certain length and be surprised.
37445 \begin_layout Section
37446 Version Control in \SpecialChar LyX
37450 \begin_layout Standard
37453 Lars Gullik Bjønnes
37460 \begin_layout Subsection
37464 \begin_layout Standard
37466 supports some of the most basic RCS/CVS/SVN/GIT commands.
37467 If you need something a bit more sophisticated you will have to do that manually in a terminal.
37470 \begin_layout Standard
37471 Also note that CVS support is not as good as subversion support,
37472 so we advise using SVN instead.
37473 A good place to start learning Subversion is the SVN Book
37477 \begin_layout Plain Layout
37478 \begin_inset CommandInset href
37480 target "http://svnbook.red-bean.com/"
37491 In the case of RCS you should read
37492 \begin_inset Quotes eld
37496 \begin_inset Quotes erd
37505 This file describes all the basic features of RCS.
37506 You should especially notice the comment about a RCS directory,
37507 and the notion of a master RCS file (the file ending in
37514 \begin_layout Standard
37515 Before you begin to use the version control features in \SpecialChar LyX
37517 you should be familiar with RCS/CVS/SVN/GIT usage.
37518 The implementation in \SpecialChar LyX
37519 assumes a recent version of the GNU RCS or CVS/SVN package —
37520 no guarantees are made for older versions.
37521 Most of the log messages are not currently displayed after operations —
37522 you can check them in the Messages pane if you are unsure.
37523 Regular users of version control will appreciate the VC toolbar,
37524 which can be enabled via
37526 View\SpecialChar menuseparator
37527 Toolbars\SpecialChar menuseparator
37529 \begin_inset space ~
37537 \begin_layout Standard
37538 For introducing your own external commands consult
37539 \begin_inset Flex Code
37542 \begin_layout Plain Layout
37556 \begin_layout Standard
37557 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
37559 Document\SpecialChar menuseparator
37563 Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
37564 Compressed LyX documents are binary files,
37565 which cannot be merged by version control systems.
37568 \begin_layout Subsection
37569 RCS commands in \SpecialChar LyX
37573 \begin_layout Standard
37574 The following sections describe the RCS commands supported by \SpecialChar LyX
37576 You can find them in the
37578 File\SpecialChar menuseparator
37580 \begin_inset space ~
37587 was tested against RCS 5.7/5.8.
37590 \begin_layout Subsubsection
37596 \begin_layout Standard
37597 If your document is not under revision control,
37598 this is the only item shown in the menu.
37599 And if it is under revision control,
37604 item is not visible.
37608 \begin_layout Standard
37609 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
37610 You are asked interactively to supply an initial description of the document.
37611 The document is now set in Read-Only mode and you have to
37614 \begin_inset space ~
37618 \begin_inset space ~
37622 \begin_inset space ~
37628 before making any changes to it.
37629 A document under revision control has a
37630 \begin_inset Quotes eld
37633 [RCS:<version> <locker>]
37634 \begin_inset Quotes erd
37637 item tagged to the filename in the minibuffer.
37640 \begin_layout Standard
37641 RCS command that is run:
37644 \begin_layout LyX-Code
37647 ci -q -u -i -t-"<initial description>" <file-name>
37650 \begin_layout Standard
37655 to understand the switches.
37659 \begin_layout Subsubsection
37665 \begin_layout Standard
37666 When you are finished editing a file,
37667 you check in your changes.
37669 you are asked for a description of the changes.
37670 This is stored in the history log.
37671 The version number is bumped,
37672 your changes are applied to the master RCS file,
37673 the document is unlocked and set to Read-Only mode.
37676 \begin_layout Itemize
37680 ci -q -u -m"<description>" <file-name>
37683 \begin_layout Subsubsection
37689 \begin_layout Standard
37690 By doing this you lock the document so that only you can edit it.
37691 This will also make the document Read-Write only for you.
37692 You will usually continue editing for a while and when you are finished you check in your changes.
37693 The status line is changed to reflect that you have locked the file.
37696 \begin_layout Itemize
37700 co -q -l <file-name>
37703 \begin_layout Subsubsection
37706 Revert To Repository Version
37709 \begin_layout Standard
37710 This will discard all changes made to the document since the last check in.
37711 You get a warning before changes are discarded.
37714 \begin_layout Itemize
37718 co -f -u<version> <file-name>
37721 \begin_layout Subsubsection
37727 \begin_layout Standard
37728 This will create a copy of the current document.
37729 Since RCS does not support copy operations natively,
37730 the version history is not preserved,
37731 and the copy is added as a new file.
37732 It requires a clean document without any changes since the last checkin.
37733 You are asked for a file name and a description of the copy operation.
37734 After that the copy is created,
37735 both locally and in the repository.
37736 If the parent directories of the copied and original document differ,
37737 all relative paths of included files of the copy are adjusted (like in
37739 File\SpecialChar menuseparator
37745 the copy is loaded instead of the original document.
37748 \begin_layout Labeling
37749 \labelwidthstring 00.00.0000
37751 \begin_inset space ~
37756 \begin_inset space ~
37760 \begin_inset Newline newline
37764 \begin_inset Flex Code
37767 \begin_layout Plain Layout
37770 \begin_inset Quotes qld
37774 \begin_inset Quotes qld
37783 \begin_inset Flex Code
37786 \begin_layout Plain Layout
37789 \begin_inset Quotes qld
37793 \begin_inset Quotes qld
37802 \begin_inset Newline newline
37806 \begin_inset Flex Code
37809 \begin_layout Plain Layout
37813 \begin_inset Quotes qld
37817 \begin_inset Quotes qld
37828 \begin_layout Subsubsection
37834 \begin_layout Standard
37835 This makes as if the last check in never happened.
37836 No changes are made to the document loaded into \SpecialChar LyX
37838 but the last version is removed from the master RCS file.
37841 \begin_layout Itemize
37845 rcs -o<version> <file-name>
37848 \begin_layout Subsubsection
37854 \begin_layout Standard
37855 This shows the complete history of the RCS document.
37860 is shown in a browser.
37868 \begin_layout Subsubsection
37872 \begin_layout Standard
37874 supports RCS version number,
37876 date and time of last commit.
37877 All those are extracted from
37879 rlog -r <file-name>
37883 \begin_inset CommandInset ref
37885 reference "subsec:VCS-Revision-Information"
37893 \begin_layout Subsection
37894 CVS commands in \SpecialChar LyX
37898 \begin_layout Standard
37899 A subset of CVS operations is supported by \SpecialChar LyX
37901 You can find the commands in the
37903 File\SpecialChar menuseparator
37905 \begin_inset space ~
37911 The version control system SVN is more powerful,
37912 so please use it instead of CVS if possible.
37915 \begin_layout Subsubsection
37921 \begin_layout Standard
37922 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
37923 If you're using a client-server setup you may need to login before doing the first repository checkout.
37926 \begin_layout Standard
37927 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.
37928 Standard CVS repositories don't operate with a file locking mechanism.
37929 This may be surprising,
37930 but conflicts only occur if people disagree on the proper content of the same part of a document.
37932 if co-workers are used to communicate regularly,
37933 these conflicts occur rarely.
37934 If they don't communicate they have a fundamental problem anyway.
37935 Nevertheless some people like to work with so called
37936 \begin_inset Quotes eld
37940 \begin_inset Quotes erd
37944 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.
37945 When the changes are checked in the working copy returns to readonly state.
37946 With \SpecialChar LyX
37947 one has to edit the
37948 \begin_inset Flex Code
37951 \begin_layout Plain Layout
37957 file and add the line
37958 \begin_inset Flex Code
37961 \begin_layout Plain Layout
37967 to work with reserved checkouts.
37968 The benefit is the possibility to see who is using a writable copy of some document.
37969 It's not guaranteed only one user makes a copy writable.
37972 \begin_layout Standard
37974 tries to guess if you're using reserved or non-reserved checkouts.
37975 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.
37976 When a reserved checkout is detected you have to use
37977 \begin_inset Flex Noun
37980 \begin_layout Plain Layout
37986 to make your working copy writable if it's readonly.
37988 \begin_inset Flex Noun
37991 \begin_layout Plain Layout
37997 operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
38000 \begin_layout Standard
38001 More information about CVS can be found here
38002 \begin_inset Flex URL
38005 \begin_layout Plain Layout
38007 http://www.nongnu.org/cvs
38013 \begin_inset Flex URL
38016 \begin_layout Plain Layout
38018 http://ximbiot.com/cvs
38026 \begin_layout Standard
38031 to understand the sub-commands and the switches mentioned below.
38034 \begin_layout Subsubsection
38040 \begin_layout Standard
38041 If your document is not under revision control,
38042 this is the only item shown in the menu.
38043 And if it is under revision control,
38048 item is not visible.
38052 \begin_layout Standard
38053 This command registers in CVS your document
38054 \begin_inset Flex Strong
38057 \begin_layout Plain Layout
38065 in the case you have already the documents directory under CVS control (in particular
38070 This means you have to create or checkout the archive by yourself using external tools.
38071 (In case you forget that step \SpecialChar LyX
38072 registers the document with RCS.)
38075 \begin_layout Standard
38076 Then you are asked interactively to supply an initial description of the document.
38077 Don't forget that registered file is not yet checked in.
38080 \begin_layout Standard
38081 CVS command that is run:
38084 cvs -q add -m"<entered message>" "<file-name>"
38087 \begin_layout Standard
38092 above and for all other CVS commands is an abbreviation for
38093 \begin_inset Quotes eld
38096 change the current working directory to file location and use the file name without path component as argument
38097 \begin_inset Quotes erd
38103 \begin_layout Subsubsection
38109 \begin_layout Standard
38110 When you are finished editing a file,
38111 you commit your changes.
38112 When you do this and you had changed the document,
38113 you are asked for a description of the changes.
38114 After that changes are written to the repository.
38115 In case you didn't change the document and a reserved checkout is detected the reservation made on
38116 \begin_inset Flex Noun
38119 \begin_layout Plain Layout
38128 \begin_layout Labeling
38129 \labelwidthstring 00.00.0000
38131 \begin_inset space ~
38136 \begin_inset space ~
38140 \begin_inset Newline newline
38144 \begin_inset Flex Code
38147 \begin_layout Plain Layout
38150 -q commit -m"<description>" "<file-name>"
38156 \begin_inset Newline newline
38160 \begin_inset Flex Code
38163 \begin_layout Plain Layout
38174 \begin_layout Subsubsection
38180 \begin_layout Standard
38181 When you are sharing a repository with others,
38182 you may have to incorporate their changes into your working copy.
38185 \begin_layout Standard
38189 cvs -q update "<file-name>"
38192 \begin_layout Standard
38193 If a readonly checkout is detected the working copy is made writable and reserved.
38196 \begin_layout Standard
38200 cvs -q edit "<file-name>"
38203 \begin_layout Subsubsection
38206 Revert To Repository Version
38209 \begin_layout Standard
38210 This will discard all changes made to the document since the last check in.
38211 You get a warning before changes are discarded.
38212 Firstly the file is deleted,
38213 secondly CVS update command is run.
38216 \begin_layout Standard
38220 cvs -q update "<file-name>"
38223 \begin_layout Standard
38224 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
38227 \begin_layout Standard
38231 cvs -q unedit "<file-name>"
38234 \begin_layout Subsubsection
38240 \begin_layout Standard
38241 This will create a copy of the current document.
38242 Since CVS does not support copy operations natively,
38243 the version history is not preserved,
38244 and the copy is added as a new file.
38245 It requires a clean document without any changes since the last checkin.
38246 You are asked for a file name and a description of the copy operation.
38247 After that the copy is created,
38248 both locally and in the repository.
38249 If the parent directories of the copied and original document differ,
38250 all relative paths of included files of the copy are adjusted (like in
38252 File\SpecialChar menuseparator
38258 the copy is loaded instead of the original document.
38261 \begin_layout Labeling
38262 \labelwidthstring 00.00.0000
38264 \begin_inset space ~
38269 \begin_inset space ~
38273 \begin_inset Newline newline
38277 \begin_inset Flex Code
38280 \begin_layout Plain Layout
38287 \begin_inset Flex Code
38290 \begin_layout Plain Layout
38297 \begin_inset Newline newline
38301 \begin_inset Flex Code
38304 \begin_layout Plain Layout
38305 cvs -q add "<new-file-name>"
38313 \begin_layout Subsubsection
38319 \begin_layout Standard
38320 This will rename the current document.
38321 Since CVS does not support rename operations natively,
38322 the version history is not preserved,
38323 the renamed document is added as a new file,
38324 and the original document is deleted.
38325 It requires a clean document without any changes since the last checkin.
38326 You are asked for a file name and a description of the rename operation.
38327 After that the document is renamed,
38328 both locally and in the repository.
38329 If the parent directories of the new and old file names differ,
38330 all relative paths of included files are adjusted (like in
38332 File\SpecialChar menuseparator
38338 the document is reloaded using the new name.
38341 \begin_layout Labeling
38342 \labelwidthstring 00.00.0000
38344 \begin_inset space ~
38349 \begin_inset space ~
38353 \begin_inset Newline newline
38357 \begin_inset Flex Code
38360 \begin_layout Plain Layout
38367 \begin_inset Flex Code
38370 \begin_layout Plain Layout
38377 \begin_inset Newline newline
38381 \begin_inset Flex Code
38384 \begin_layout Plain Layout
38385 cvs -q add "<new-file-name>"
38391 \begin_inset Newline newline
38395 \begin_inset Flex Code
38398 \begin_layout Plain Layout
38399 cvs -q remove "<file-name>"
38407 \begin_layout Subsubsection
38408 Update of the local directory checkout from repository
38411 \begin_layout Standard
38412 Once your documents gets more complex,
38413 containing sub-documents and pictures,
38415 \begin_inset Flex Code
38418 \begin_layout Plain Layout
38424 files and so on using version control becomes more complicated.
38426 supports updating the whole tree in which resides the document.
38427 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.
38428 You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
38429 It's good practice anyway to store multipart documents in an extra directory.
38432 \begin_layout Standard
38434 \begin_inset Flex Code
38437 \begin_layout Plain Layout
38438 Update local directory from repository
38443 command updates the whole directory.
38444 If local changes are detected user is warned before update starts.
38445 In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
38446 You have to review and correct the result of the merge.
38447 You'll find the conflicts enclosed in pairs of
38448 \begin_inset Flex Code
38451 \begin_layout Plain Layout
38458 \begin_inset Flex Code
38461 \begin_layout Plain Layout
38468 \begin_inset Flex Code
38471 \begin_layout Plain Layout
38478 The first part is your version as before the update operation with the document name prepended.
38479 The second one is the repository version with the version number after the sequence of
38480 \begin_inset Flex Code
38483 \begin_layout Plain Layout
38492 \begin_layout Labeling
38493 \labelwidthstring 00.00.0000
38495 \begin_inset space ~
38500 \begin_inset space ~
38504 \begin_inset Newline newline
38508 \begin_inset Flex Code
38511 \begin_layout Plain Layout
38520 (Ask if changes are detected.)
38521 \begin_inset Newline newline
38525 \begin_inset Flex Code
38528 \begin_layout Plain Layout
38540 \begin_layout Standard
38542 \begin_inset Flex Code
38545 \begin_layout Plain Layout
38551 stands for the path to the document.
38554 \begin_layout Subsubsection
38560 \begin_layout Standard
38561 This shows the complete history of the CVS document.
38564 cvs log "<file-name>"
38566 is shown in a browser.
38569 \begin_layout Subsubsection
38573 \begin_layout Standard
38575 supports CVS version number,
38577 date and time of last commit.
38578 All those are extracted from
38580 cvs log -r <file-name>
38584 \begin_inset CommandInset ref
38586 reference "subsec:VCS-Revision-Information"
38594 \begin_layout Subsection
38595 SVN commands in \SpecialChar LyX
38599 \begin_layout Standard
38600 SVN is now partially supported by \SpecialChar LyX
38602 You can find the commands in the
38604 File\SpecialChar menuseparator
38606 \begin_inset space ~
38612 Please note that if you use password protected access to repository via ssh,
38613 you will be asked in terminal window.
38615 was tested against SVN 1.5,
38621 \begin_layout Plain Layout
38622 Most of the commands will work with 1.4 too,
38624 \begin_inset CommandInset ref
38626 reference "subsec:SVN-Repo-Update"
38632 There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
38640 \begin_layout Subsubsection
38646 \begin_layout Standard
38647 If your document is not under revision control,
38648 this is the only item shown in the menu.
38649 And if it is under revision control,
38654 item is not visible.
38657 \begin_layout Standard
38658 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
38663 This means you have to checkout the archive by yourself.
38666 \begin_layout Standard
38667 Then you are asked interactively to supply an initial description of the document.
38668 Don't forget that registered file is not yet commited.
38671 \begin_layout Standard
38672 SVN command that is run:
38676 \begin_inset Quotes qld
38680 \begin_inset Quotes qld
38686 \begin_layout Standard
38691 to understand the switches.
38694 \begin_layout Subsubsection
38700 \begin_layout Standard
38701 When you are finished editing a file,
38702 you commit your changes.
38704 you are asked for a description of the changes.
38705 After that changes are commited.
38708 \begin_layout Standard
38713 \begin_layout Plain Layout
38714 In case locking is not enabled.
38716 \begin_inset CommandInset ref
38718 reference "subsec:SVN-File-Locking"
38730 svn commit -q -m"<description>" <file-name>
38733 \begin_layout Subsubsection
38739 \begin_layout Standard
38740 Updates the changes of this file from the repository.
38741 Be sure you understand SVN merging and conflicts resolving before using this function,
38742 because all conflicts has to be resolved manually by you!
38745 \begin_layout Standard
38750 \begin_layout Plain Layout
38758 svn update --non-interactive
38759 \begin_inset Quotes qld
38763 \begin_inset Quotes qld
38769 \begin_layout Subsubsection
38772 Revert To Repository Version
38775 \begin_layout Standard
38776 This will discard all changes made to the document since the last check in.
38777 You get a warning before changes are discarded.
38780 \begin_layout Standard
38785 \begin_inset Quotes qld
38789 \begin_inset Quotes qld
38795 \begin_layout Subsubsection
38801 \begin_layout Standard
38802 This will create a copy of the current document including the version history.
38803 It requires a clean document without any changes since the last checkin.
38804 You are asked for a file name and a description of the copy operation.
38805 After that the copy is created,
38806 both locally and in the repository.
38807 If the parent directories of the copied and original document differ,
38808 all relative paths of included files of the copy are adjusted (like in
38810 File\SpecialChar menuseparator
38816 the copy is loaded instead of the original document.
38819 \begin_layout Labeling
38820 \labelwidthstring 00.00.0000
38822 \begin_inset space ~
38827 \begin_inset space ~
38831 \begin_inset Newline newline
38835 \begin_inset Flex Code
38838 \begin_layout Plain Layout
38842 \begin_inset Quotes qld
38846 \begin_inset Quotes qld
38850 \begin_inset Quotes qld
38854 \begin_inset Quotes qld
38863 \begin_inset Newline newline
38867 \begin_inset Flex Code
38870 \begin_layout Plain Layout
38879 \begin_layout Subsubsection
38885 \begin_layout Standard
38886 This will rename the current document including the version history.
38887 It requires a clean document without any changes since the last checkin.
38888 You are asked for a file name and a description of the rename operation.
38889 After that the document is renamed,
38890 both locally and in the repository.
38891 If the parent directories of the new and old file names differ,
38892 all relative paths of included files are adjusted (like in
38894 File\SpecialChar menuseparator
38900 the document is reloaded using the new name.
38903 \begin_layout Labeling
38904 \labelwidthstring 00.00.0000
38906 \begin_inset space ~
38911 \begin_inset space ~
38915 \begin_inset Newline newline
38919 \begin_inset Flex Code
38922 \begin_layout Plain Layout
38926 \begin_inset Quotes qld
38930 \begin_inset Quotes qld
38934 \begin_inset Quotes qld
38938 \begin_inset Quotes qld
38947 \begin_inset Newline newline
38951 \begin_inset Flex Code
38954 \begin_layout Plain Layout
38963 \begin_layout Subsubsection
38964 \begin_inset CommandInset label
38966 name "subsec:SVN-Repo-Update"
38970 Update of the local directory checkout from repository
38974 \begin_layout Plain Layout
38975 Note that this command will work only with subversion
38976 \begin_inset Formula $\geqq1.5$
38987 \begin_layout Standard
38988 All the commands above have one shortcoming – they deal with the current document only.
38989 Once your document contains pictures,
38991 \begin_inset Flex Code
38994 \begin_layout Plain Layout
39000 files and so on administration becomes more complicated.
39002 now supports updating the whole tree in which resides the document
39006 \begin_layout Plain Layout
39007 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
39014 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.
39018 \begin_layout Standard
39019 \begin_inset Flex Code
39022 \begin_layout Plain Layout
39023 Update local directory from repository
39028 command updates the whole directory and in case of merge conflicts local version of the files are left,
39029 so no unintended data loss occurs.
39030 If local changes are detected user is warned before update starts.
39033 \begin_layout Labeling
39034 \labelwidthstring 00.00.0000
39036 \begin_inset space ~
39041 \begin_inset space ~
39045 \begin_inset Newline newline
39049 \begin_inset Flex Code
39052 \begin_layout Plain Layout
39058 (Ask if changes are detected.)
39059 \begin_inset Newline newline
39063 \begin_inset Flex Code
39066 \begin_layout Plain Layout
39067 svn update --accept mine-full $path
39075 \begin_layout Standard
39077 \begin_inset Flex Code
39080 \begin_layout Plain Layout
39086 stands for the path to the document.
39089 \begin_layout Subsubsection
39095 \begin_layout Standard
39096 This shows the complete history of the SVN document.
39100 \begin_inset Quotes qld
39104 \begin_inset Quotes qld
39109 is shown in a browser.
39112 \begin_layout Subsubsection
39114 \begin_inset CommandInset label
39116 name "subsec:SVN-File-Locking"
39123 \begin_layout Standard
39124 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.
39125 When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
39126 which guarantees that only one user is allowed to edit file at the given time.
39129 \begin_layout Standard
39130 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
39132 \begin_inset CommandInset ref
39134 reference "subsec:Automatical-Locking-Property"
39140 \begin_inset Flex Code
39143 \begin_layout Plain Layout
39153 \begin_layout Plain Layout
39154 \begin_inset Flex URL
39157 \begin_layout Plain Layout
39159 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
39170 If this property is detected for a given document \SpecialChar LyX
39171 starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
39172 This in particular means there are two different modes of file use in \SpecialChar LyX
39176 \begin_layout Itemize
39178 The loaded file is in the read-only mode.
39179 For editing on needs to check-out.
39184 consists of updating from the repository and gaining write lock.
39185 If the lock is not possible to obtain,
39186 we remain in unlocked state.
39189 \begin_layout Itemize
39191 The loaded file is in the
39192 \begin_inset Quotes els
39196 \begin_inset Quotes ers
39200 No other user is allowed to edit the file.
39205 consists of commiting changes and releasing write-lock.
39206 If no changes have been made to the document,
39207 no commit will be produced
39211 \begin_layout Plain Layout
39212 Don't be puzzled by the fact that you will be asked for commit message anyway.
39217 and only the write-lock will be released.
39220 \begin_layout Standard
39224 \begin_layout Labeling
39225 \labelwidthstring 00.00.0000
39229 svn commit -q -m"<description>" "<file-name>"
39230 \begin_inset Newline newline
39233 svn unlock "<file-name>"
39236 \begin_layout Labeling
39237 \labelwidthstring 00.00.0000
39241 svn update "<file-name>"
39242 \begin_inset Newline newline
39245 svn lock "<file-name>"
39248 \begin_layout Subsubsection
39251 \begin_inset CommandInset label
39253 name "subsec:Automatical-Locking-Property"
39259 Automatic Locking Property
39262 \begin_layout Standard
39263 The above mentioned automatic setting of write permissions of the .lyx file can be set through
39265 File\SpecialChar menuseparator
39267 \begin_inset space ~
39270 Control\SpecialChar menuseparator
39271 Use Locking Property
39274 This command is active only when the file is not locked on the svn server (i.e.
39275 you need to check-out before proceeding).
39278 \begin_layout Labeling
39279 \labelwidthstring 00.00.0000
39281 \begin_inset space ~
39287 \begin_layout Labeling
39288 \labelwidthstring 00.00.0000
39292 svn propset svn:needs-lock ON "<file-name>"
39295 \begin_layout Labeling
39296 \labelwidthstring 00.00.0000
39300 svn propdel svn:needs-lock "<file-name>"
39303 \begin_layout Subsubsection
39304 \begin_inset CommandInset label
39306 name "subsec:VCS-Revision-Information"
39310 Revision Information in Documents
39313 \begin_layout Standard
39314 There are more possibilities how to activate revision information in our document.
39317 \begin_layout Itemize
39323 \begin_layout Itemize
39324 tree revision information (
39325 \begin_inset Flex Code
39328 \begin_layout Plain Layout
39335 The result is the output of the
39336 \begin_inset Flex Code
39339 \begin_layout Plain Layout
39346 the following table gives you an idea,
39347 how to read the results.
39350 \begin_layout Standard
39352 \begin_inset Tabular
39353 <lyxtabular version="3" rows="6" columns="2">
39354 <features tabularvalignment="middle">
39355 <column alignment="left" valignment="top">
39356 <column alignment="left" valignment="top">
39358 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
39361 \begin_layout Plain Layout
39369 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
39372 \begin_layout Plain Layout
39382 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39385 \begin_layout Plain Layout
39391 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39394 \begin_layout Plain Layout
39395 mixed revision working copy
39402 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39405 \begin_layout Plain Layout
39411 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39414 \begin_layout Plain Layout
39415 modified working copy
39422 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39425 \begin_layout Plain Layout
39431 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39434 \begin_layout Plain Layout
39435 switched working copy
39442 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
39445 \begin_layout Plain Layout
39451 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
39454 \begin_layout Plain Layout
39455 partial working copy,
39456 from a sparse checkout
39463 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
39466 \begin_layout Plain Layout
39472 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
39475 \begin_layout Plain Layout
39478 switched working copy
39491 \begin_layout Itemize
39492 file revision information.
39493 The result comes from parsing the output of
39494 \begin_inset Flex Code
39497 \begin_layout Plain Layout
39499 \begin_inset space ~
39503 \begin_inset space ~
39507 \begin_inset space ~
39516 Supported flags are:
39520 \begin_layout Itemize
39521 version number of the last commit (
39522 \begin_inset Flex Code
39525 \begin_layout Plain Layout
39534 \begin_layout Itemize
39535 author of the last commit (
39536 \begin_inset Flex Code
39539 \begin_layout Plain Layout
39548 \begin_layout Itemize
39549 date of the last commit (
39550 \begin_inset Flex Code
39553 \begin_layout Plain Layout
39562 \begin_layout Itemize
39563 time of the last commit (
39564 \begin_inset Flex Code
39567 \begin_layout Plain Layout
39577 \begin_layout Standard
39578 You can obtain this info via InsetInfo (
39579 \change_inserted 5863208 1564400022
39582 Insert\SpecialChar menuseparator
39583 Field\SpecialChar menuseparator
39584 Version Control Revision
39585 \change_deleted 5863208 1564399852
39590 \begin_inset Flex Code
39593 \begin_layout Plain Layout
39594 info-insert buffer vcs-date
39602 The information will be available only when you have the file stored under svn managment (i.e.
39604 \begin_inset Flex Code
39607 \begin_layout Plain Layout
39613 directory is available with your document).
39617 \begin_layout Itemize
39620 possibility is to use svn keywords
39624 \begin_layout Plain Layout
39625 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
39631 In short – you set file keywords property (e.g.
39634 svn propset svn:keywords 'Rev' file.lyx
39636 ) and then paste keyword \SpecialChar TeX
39641 \begin_layout Plain Layout
39642 This is an easy way how to ensure that \SpecialChar LyX
39643 won't break the line in the middle of keyword tag.
39648 tag in your document (e.g.
39650 \begin_inset Flex Code
39653 \begin_layout Plain Layout
39660 This way svn client will automatically substitute revision number (e.g.
39662 \begin_inset Flex Code
39665 \begin_layout Plain Layout
39672 ) after each update and commit.
39673 There are more problems with this approach.
39675 the '$' character is used in \SpecialChar TeX
39676 world for math equations,
39677 so any occurence of math formula
39678 \begin_inset Formula $Rev$
39682 \begin_inset Formula $Rev:59$
39685 in your \SpecialChar LyX
39687 Similarly for other keywords like Id,
39691 Secondly svn output is dependent on your locales,
39692 so its very easy that svn would produce some problematic strings once Date is used.
39693 Thirdly you get the whole 'Rev:
39694 59' string in your document instead of the plain number.
39695 Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
39696 to support it directly.
39699 \begin_layout Subsection
39700 SVN and Windows Environment
39703 \begin_layout Quote
39704 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
39705 they would be well advised to use TortoiseSVN.
39712 \begin_layout Subsubsection
39716 \begin_layout Standard
39717 In addition to installing \SpecialChar LyX
39719 and having access to a Subversion repository,
39720 the user will need to install the Subversion client program.
39721 A Windows installer for the client program is available from
39722 \begin_inset CommandInset href
39725 target "http://www.collab.net/nonav/downloads/subversion/"
39731 The user may also want to install
39732 \begin_inset CommandInset href
39735 target "http://tortoisesvn.tigris.org/"
39741 which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
39742 Operations done outside \SpecialChar LyX
39743 will typically be more convenient using the Explorer context menu.
39744 Note that TortoiseSVN is not a replacement for the client program,
39745 which is what \SpecialChar LyX
39749 \begin_layout Subsubsection
39750 Bringing a document under Subversion control
39753 \begin_layout Standard
39754 Before a \SpecialChar LyX
39755 document can be brought under version control in Subversion,
39756 its parent directory needs to be under version control.
39757 If the document is being added to a project already in the repository,
39758 this is accomplished by checking the project out to the directory where the new document will be placed.
39759 If the project itself is not yet under version control (for instance,
39760 if this document starts a new project),
39761 the directory must be imported into the repository.
39762 This is done outside \SpecialChar LyX
39764 Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
39765 or alternatively can be done using the command line client at a DOS prompt.
39766 The procedure for importing the project using TortoiseSVN is described below,
39767 assuming an existing repository and a new project being started in
39774 For information on using the Subversion client program,
39782 \begin_layout Enumerate
39789 in Windows Explorer,
39793 TortoiseSVN\SpecialChar menuseparator
39798 adjust the URL for the repository,
39802 \begin_layout Enumerate
39803 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
39807 Supply a name for the project folder and click OK.
39808 Add a message for the log file if desired,
39809 then click OK again.
39810 The new project folder should appear in the repository.
39812 click OK again to exit the repository browser.
39815 \begin_layout Enumerate
39816 Once again right click
39823 this time selecting SVN Checkout\SpecialChar ldots
39824 Select the URL of the project folder you just created in the repository,
39825 and set the checkout directory to
39833 You will be warned about a non-empty folder;
39834 click OK to proceed.
39835 You should now have a
39846 \begin_layout Enumerate
39847 Create or open your document in \SpecialChar LyX
39850 File\SpecialChar menuseparator
39852 \begin_inset space ~
39855 Control\SpecialChar menuseparator
39859 Add a log message and click OK to commit the document to version control.
39862 \begin_layout Standard
39863 From this point onward,
39864 you should have full functionality in the
39866 File\SpecialChar menuseparator
39868 \begin_inset space ~
39874 You also have the option of checking the document in and out,
39875 viewing its history,
39877 using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
39880 \begin_layout Subsubsection
39881 SSH tunnel used with SVN under Windows
39884 \begin_layout Standard
39885 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
39886 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,
39887 also be prepared for a great deal of frustration\SpecialChar ldots
39891 \begin_layout Enumerate
39892 Get an svn client for windows,
39893 as described in the previous sections.
39894 When it is a fresh install run some svn command (e.g.
39896 \begin_inset Flex Code
39899 \begin_layout Plain Layout
39905 ) to create config files,
39906 which you will need to change later on.
39909 \begin_layout Enumerate
39910 Choose an ssh client for Windows.
39911 There are several possibilities,
39912 we will use the one from Putty tools
39916 \begin_layout Plain Layout
39917 \begin_inset Flex URL
39920 \begin_layout Plain Layout
39922 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
39933 You will need to set the connection up so that the client doesn't ask for any password from you.
39934 To keep things easy we will use only keys without any additional password protection etc.
39938 \begin_layout Enumerate
39940 \begin_inset Flex Code
39943 \begin_layout Plain Layout
39950 Save your private .ppk key file and put the public one on the server side.
39951 If the SVN server runs on Linux,
39952 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
39953 \begin_inset Quotes eld
39958 Public key for pasting into OpenSSH authorized_keys file
39961 \begin_inset Quotes erd
39964 edit field into the server's
39965 \begin_inset Flex Code
39968 \begin_layout Plain Layout
39969 ~/.ssh/authorized_keys
39975 \begin_inset Flex Code
39978 \begin_layout Plain Layout
39987 \begin_layout Enumerate
39989 \begin_inset Flex Code
39992 \begin_layout Plain Layout
39999 In the SVN config file
40003 \begin_layout Plain Layout
40004 Exact path depends on Windows version,
40005 usually somewhere around
40006 \begin_inset Flex Code
40009 \begin_layout Plain Layout
40012 Documents and Settings
40026 \begin_inset Flex Code
40029 \begin_layout Plain Layout
40049 \begin_inset Flex Code
40052 \begin_layout Plain Layout
40053 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
40062 \begin_layout Plain Layout
40063 It will usually take a lot of time to get exact command right and it depends on many things.
40064 For example do not have some remote server saved as a default session in Putty etc.
40066 try to connect via plink without SVN first.
40075 \begin_layout Enumerate
40076 Checkout the SVN archive,
40078 \begin_inset space \thinspace{}
40082 \begin_inset Newline newline
40086 \begin_inset Flex Code
40089 \begin_layout Plain Layout
40090 svn co svn+ssh://user@server/repository_path
40098 \begin_layout Subsubsection
40099 End-of-Line Conversions
40102 \begin_layout Standard
40103 When the collaborators are mixing Linux and Windows environments,
40105 will use different line endings inside the .lyx files.
40106 This is not a problem as far as \SpecialChar LyX
40107 functionality is concerned,
40108 but the commit diffs will be huge and merge-conflicts prone.
40109 Fortunately SVN itself knows
40113 \begin_layout Plain Layout
40114 \begin_inset Flex URL
40117 \begin_layout Plain Layout
40119 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
40129 how to deal with CR/LF problems when switching .lyx files to the
40130 \begin_inset Flex Code
40133 \begin_layout Plain Layout
40143 \begin_layout Plain Layout
40146 \begin_inset Flex Code
40149 \begin_layout Plain Layout
40150 svn propset svn:eol-style native FILE_NAME
40163 \begin_layout Subsection
40164 GIT commands in \SpecialChar LyX
40168 \begin_layout Standard
40169 A minimal subset of GIT commands is now supported by \SpecialChar LyX
40171 You can find the commands in the
40173 File\SpecialChar menuseparator
40175 \begin_inset space ~
40181 Please note that if you use password protected access to repository via ssh,
40182 you will be asked in terminal window.
40184 was tested against GIT 1.7.
40188 \begin_layout Plain Layout
40189 Windows users please note that you need to ensure that git is on the path.
40190 This can be set from within \SpecialChar LyX
40193 Tools\SpecialChar menuseparator
40194 Preferences\SpecialChar menuseparator
40195 Paths\SpecialChar menuseparator
40206 \begin_layout Standard
40207 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
40208 With traditional version control systems there is one central server which hosts the repository.
40209 Users commit their changes to the server,
40210 and get updates made by other users from it.
40212 users commit to a local repository.
40213 The local repository can be synchronized with one or more remote repositories using the
40214 \begin_inset Flex Code
40217 \begin_layout Plain Layout
40224 \begin_inset Flex Code
40227 \begin_layout Plain Layout
40235 does not interact in any way with remote GIT repositories.
40236 It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
40237 If you use remote GIT repositories you need to do the
40238 \begin_inset Flex Code
40241 \begin_layout Plain Layout
40248 \begin_inset Flex Code
40251 \begin_layout Plain Layout
40257 operations with your favourite GIT client.
40260 \begin_layout Subsubsection
40266 \begin_layout Standard
40267 If your document is not under revision control,
40268 this is the only item shown in the menu.
40269 And if it is under revision control,
40274 item is not visible.
40277 \begin_layout Standard
40278 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
40283 This means you have to checkout the archive by yourself.
40286 \begin_layout Standard
40287 Then you are asked interactively to supply an initial description of the document.
40288 Don't forget that registered file is not yet committed.
40291 \begin_layout Standard
40292 GIT command that is run:
40296 \begin_inset Quotes qld
40300 \begin_inset Quotes qld
40306 \begin_layout Standard
40311 to understand the switches.
40314 \begin_layout Subsubsection
40320 \begin_layout Standard
40321 When you are finished editing a file,
40322 you commit your changes.
40324 you are asked for a description of the changes.
40325 After that changes are committed.
40328 \begin_layout Standard
40332 git commit -q -m"<description>" <file-name>
40335 \begin_layout Subsubsection
40338 Revert To Repository Version
40341 \begin_layout Standard
40342 This will discard all changes made to the document since the last check in.
40343 You get a warning before changes are discarded.
40346 \begin_layout Standard
40351 \begin_inset Quotes qld
40355 \begin_inset Quotes qld
40361 \begin_layout Subsubsection
40367 \begin_layout Standard
40368 This will rename the current document including the version history.
40369 It requires a clean document without any changes since the last checkin.
40370 You are asked for a file name and a description of the rename operation.
40371 After that the document is renamed,
40372 both locally and in the repository.
40373 If the parent directories of the new and old file names differ,
40374 all relative paths of included files are adjusted (like in
40376 File\SpecialChar menuseparator
40382 the document is reloaded using the new name.
40385 \begin_layout Labeling
40386 \labelwidthstring 00.00.0000
40388 \begin_inset space ~
40393 \begin_inset space ~
40397 \begin_inset Newline newline
40401 \begin_inset Flex Code
40404 \begin_layout Plain Layout
40408 \begin_inset Quotes qld
40412 \begin_inset Quotes qld
40416 \begin_inset Quotes qld
40420 \begin_inset Quotes qld
40429 \begin_inset Newline newline
40433 \begin_inset Flex Code
40436 \begin_layout Plain Layout
40445 \begin_layout Subsubsection
40451 \begin_layout Standard
40452 This shows the complete history of the GIT document.
40456 \begin_inset Quotes qld
40460 \begin_inset Quotes qld
40465 is shown in a browser.
40468 \begin_layout Subsubsection
40472 \begin_layout Standard
40474 supports GIT hash number of the last commit to the file,
40476 \change_inserted 1119979965 1564297456
40477 its abbreviated form,
40481 date and time of last commit.
40482 All those are extracted from
40484 git log -n 1 --pretty=format:%H%n
40485 \change_inserted 1119979965 1564297427
40491 Tree version information is obtained via
40493 git describe --abbrev --dirty --long
40497 \begin_inset CommandInset ref
40499 reference "subsec:VCS-Revision-Information"
40507 \begin_layout Subsection
40511 \begin_layout Standard
40512 With the recent addition of the
40513 \begin_inset Flex Code
40516 \begin_layout Plain Layout
40522 function \SpecialChar LyX
40523 power users are allowed to create their own commands for revision control.
40526 \begin_layout Standard
40527 As an example you can see how two TortoiseSVN commands could be integrated directly:
40530 \begin_layout Description
40533 \begin_inset Flex Code
40536 \begin_layout Plain Layout
40537 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
40545 \begin_layout Description
40548 \begin_inset Flex Code
40551 \begin_layout Plain Layout
40552 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
40560 \begin_layout Subsection
40561 Version control and Document comparison
40564 \begin_layout Standard
40565 One of the typical uses of version control is to inspect the changes between revisions,
40566 usually by creating
40567 \begin_inset Flex Code
40570 \begin_layout Plain Layout
40577 While this is useful for plain text files,
40578 it is much less useful in the case of \SpecialChar LyX
40580 which have more a complicated structure.
40581 Hence we provide binding to the Document comparison feature.
40582 There are two ways of calling this feature – either by direct call of
40583 \begin_inset Flex Code
40586 \begin_layout Plain Layout
40593 function (for details see \SpecialChar LyX
40594 functions manual) or by the toolbar icon
40608 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 '
40609 \begin_inset Flex Noun
40612 \begin_layout Plain Layout
40618 ' revisions back means comparison of the edited file with last commited revision).
40622 \begin_layout Standard
40623 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,
40624 numbers always point to the last number in RCS revision number,
40627 We don't currently support GIT addressing of revisions,
40628 one can just compare edited document with its revision X steps backs,
40629 where X is addressed as
40630 \begin_inset Flex Code
40633 \begin_layout Plain Layout
40642 \begin_layout Section
40644 \change_inserted 564990737 1672161575
40645 \begin_inset CommandInset label
40647 name "sec:Literate-Programming"
40653 Literate Programming
40656 \begin_layout Standard
40661 (kayvan@sylvan.com)
40666 original documentation written by
40668 Edmar Wienskoski Jr.
40671 (edmar-w-jr@technologist.com)
40674 \begin_layout Subsection
40678 \begin_layout Standard
40679 The main purpose of this documentation is to show you how to use \SpecialChar LyX
40680 for literate programming,
40681 where it is assumed that you are familiar with this programming technique,
40683 \begin_inset Quotes eld
40687 \begin_inset Quotes erd
40691 \begin_inset Quotes eld
40695 \begin_inset Quotes erd
40699 If that is not the case,
40700 please follow the web links provided in the following sections.
40701 There is a lot of good documentation out there covering old development history to the latest tools tips.
40704 \begin_layout Standard
40705 It is also assumed that you are familiar with \SpecialChar LyX
40706 itself to a point that you are comfortable changing your \SpecialChar LyX
40708 and X resources file.
40709 If that is not the case please refer to other \SpecialChar LyX
40710 documentation to cover your specific needs.
40713 \begin_layout Subsection
40714 Literate Programming
40717 \begin_layout Standard
40718 From the Literate Programming FAQ:
40722 \begin_layout Quotation
40723 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
40725 literate programs should be enjoyable reading,
40728 I couldn't resist!) In general,
40729 literate programs combine source and documentation in a single file.
40730 Literate programming tools then parse the file to produce either readable documentation or compilable source.
40731 The WEB style of literate programming was created by D.
40732 \begin_inset space \thinspace{}
40736 Knuth during the development of his \SpecialChar TeX
40737 typesetting software.
40741 \begin_layout Standard
40742 Another excerpt says:
40745 \begin_layout Quotation
40748 How is literate programming different from verbose commenting?
40751 \begin_layout Quotation
40752 There are three distinguishing characteristics.
40753 In order of importance,
40759 \begin_layout Itemize
40760 flexible order of elaboration
40763 \begin_layout Itemize
40764 automatic support for browsing
40767 \begin_layout Itemize
40768 typeset documentation,
40769 especially diagrams and mathematics
40773 \begin_layout Standard
40774 Now that I sparked your curiosity,
40775 take a look in the references.
40778 \begin_layout Subsubsection
40782 \begin_layout Standard
40783 The complete Literate Programming FAQ can be found at:
40786 \begin_layout Quote
40787 Literate Programming FAQ
40788 \begin_inset Flex URL
40791 \begin_layout Plain Layout
40793 http://www.literateprogramming.com/lpfaq.pdf
40801 \begin_layout Standard
40802 The FAQ lists 23 (twenty three!) different literate programming tools.
40803 Where some are specialized or
40804 \begin_inset Quotes eld
40808 \begin_inset Quotes erd
40811 for particular programming languages,
40812 while other have general scope.
40817 for my own use for several reasons:
40820 \begin_layout Itemize
40821 It can generate the documentation either in \SpecialChar LaTeX
40825 \begin_layout Itemize
40826 It has a open architecture,
40828 \begin_inset space \thinspace{}
40832 \begin_inset space \space{}
40835 it is easy to plug in new filters
40839 \begin_layout Plain Layout
40844 are programs that read a given data stream and output a manipulated data stream.
40846 a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
40852 and to perform special processing that you may need.
40856 \begin_layout Itemize
40857 There is a good selection of filters available already (the HTML is one of them).
40860 \begin_layout Itemize
40864 \begin_layout Standard
40865 The Noweb web page can be found at:
40869 \begin_layout Quote
40871 \begin_inset Flex URL
40874 \begin_layout Plain Layout
40876 https://www.cs.tufts.edu/~nr/noweb/
40884 \begin_layout Standard
40885 Starting from there you can reach many other interesting links and even some literate program examples.
40888 \begin_layout Subsection
40890 and Literate Programming with Noweb
40893 \begin_layout Standard
40894 The \SpecialChar LyX
40895 support for Literate Programming is provided by using the generic \SpecialChar LyX
40896 converters mechanism.
40897 This support is provided in a
40898 \begin_inset Quotes eld
40902 \begin_inset Quotes erd
40907 \begin_inset space \thinspace{}
40911 \begin_inset space \space{}
40914 you will be able to use this new \SpecialChar LyX
40915 feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
40919 \begin_layout Subsubsection
40920 Generating documents and code (weaving and tangling)
40923 \begin_layout Paragraph
40924 Using the noweb module
40927 \begin_layout Standard
40928 If you have installed Noweb and \SpecialChar LyX
40930 whenever you open a new document,
40931 after you have chosen its document class,
40934 Document\SpecialChar menuseparator
40938 \begin_inset Quotes eld
40942 \begin_inset Quotes erd
40946 If Noweb is correctly installed,
40947 when you click on the
40948 \begin_inset Quotes eld
40952 \begin_inset Quotes erd
40957 \begin_inset Quotes eld
40961 \begin_inset Quotes erd
40964 module in the available list and you can add it to your document.
40967 \begin_layout Paragraph
40971 \begin_layout Standard
40973 enables you to write code with a custom inset named
40974 \begin_inset Flex Noun
40977 \begin_layout Plain Layout
40984 Noweb delimits chunks like this:
40987 \begin_layout LyX-Code
40991 \begin_layout LyX-Code
40995 \begin_layout LyX-Code
40999 \begin_layout LyX-Code
41003 \begin_layout LyX-Code
41007 \begin_layout Standard
41008 The problem is that whatever is written in between the << and the
41012 must be taken literally,
41014 \begin_inset space \thinspace{}
41018 \begin_inset space \space{}
41022 should be prevented from making any special interpretation of what has been written.
41023 This is also handled by
41024 \begin_inset Flex Noun
41027 \begin_layout Plain Layout
41034 that works like a normal text inset but has a free spacing capability.
41037 \begin_layout Standard
41039 you can also use the
41040 \begin_inset Quotes eld
41044 \begin_inset Quotes erd
41047 construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
41050 \begin_layout LyX-Code
41054 \begin_layout LyX-Code
41055 def some_function(args):
41058 \begin_layout LyX-Code
41059 "This is the doc string for this function."
41062 \begin_layout LyX-Code
41068 \begin_layout LyX-Code
41069 @ %def some_function
41072 \begin_layout Standard
41073 For an example of this usage and the resulting cross-reference output,
41074 look at the Literate python program in
41076 LIBDIR/examples/listerrors.lyx
41078 which should make this all clear.
41081 \begin_layout Paragraph
41082 Generating the documentation
41085 \begin_layout Standard
41086 At this point you already have a new document file with a proper document class,
41087 and with some code and text on it.
41089 The answer is simple,
41092 View\SpecialChar menuseparator
41097 Just like you would do for a plain document.
41098 No special procedure is required.
41101 \begin_layout Standard
41102 To help orientate you,
41103 I will now explain what happens inside \SpecialChar LyX
41107 \begin_layout Enumerate
41110 Update\SpecialChar menuseparator
41113 menu option is chosen,
41114 a \SpecialChar LaTeX
41120 \begin_layout Standard
41121 If the document is of any literate class the generated file will be named with an extension name defined by the
41122 \begin_inset Quotes eld
41126 \begin_inset Quotes erd
41129 format (defined in the Preferences panel),
41130 otherwise the file will have the usual
41138 \begin_layout Enumerate
41139 Note that the only difference so far is in the name of the file,
41140 no special processing is required by \SpecialChar LyX
41142 Given that you formatted the code using the
41143 \begin_inset Flex Noun
41146 \begin_layout Plain Layout
41154 takes care of the business.
41157 \begin_layout Enumerate
41158 If the document is of any literate class \SpecialChar LyX
41159 will then use the internal \SpecialChar LyX
41160 to Noweb converter,
41161 followed by the Noweb to \SpecialChar LaTeX
41166 \begin_layout Plain Layout
41167 The converters are defined in the
41169 Tools\SpecialChar menuseparator
41174 \begin_inset Quotes eld
41178 \begin_inset Quotes erd
41190 manual for general information about converters.
41195 to generate the \SpecialChar LaTeX
41200 \begin_layout Standard
41201 Otherwise it will just skip this step.
41205 \begin_layout Enumerate
41208 is invoked and the regular post processing continues as in a plain document.
41211 \begin_layout Standard
41212 Independence from a particular
41213 \begin_inset Quotes eld
41217 \begin_inset Quotes erd
41220 is easily achieved by changing the commands that are run by the various converters.
41223 \begin_layout Paragraph
41224 Generating the code
41227 \begin_layout Standard
41228 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
41229 a \SpecialChar LaTeX
41230 file is generated just like step 1 above.
41238 This converter needs to be defined by the user and is not installed by default,
41239 though the Program format is.
41240 This converter (like any other converter) will have two parts:
41243 \begin_layout Enumerate
41244 The converter program itself.
41245 This program performs the conversion from the one format to the other (in this case,
41246 from the Noweb format to the Program pseudo-format).
41249 \begin_layout Enumerate
41250 The error log parser.
41251 This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
41253 This makes it possible for \SpecialChar LyX
41254 to place error boxes in the right places in the file buffer.
41257 \begin_layout Standard
41260 \begin_inset Quotes eld
41264 \begin_inset Quotes erd
41271 \begin_layout LyX-Code
41279 \begin_layout Standard
41280 This basically means that \SpecialChar LyX
41282 \begin_inset Quotes eld
41286 \begin_inset Quotes erd
41289 (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
41290 temp directory) and the directory path of the original \SpecialChar LyX
41295 \begin_layout Standard
41296 This is an implementation of
41297 \begin_inset Quotes eld
41301 \begin_inset Quotes erd
41304 that you can place in a directory on your path:
41307 \begin_layout LyX-Code
41313 \begin_layout LyX-Code
41319 \begin_layout LyX-Code
41322 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
41325 \begin_layout Standard
41326 The next part of the converter setting is the
41327 \begin_inset Quotes eld
41331 \begin_inset Quotes erd
41334 which is to be set to
41337 \begin_layout LyX-Code
41340 parselog=$$s/scripts/listerrors
41343 \begin_layout Standard
41344 This will run any errors that are generated by the
41345 \begin_inset Quotes eld
41349 \begin_inset Quotes erd
41352 process through the
41353 \begin_inset Quotes eld
41357 \begin_inset Quotes erd
41363 \begin_layout Standard
41364 The build will normally take place in \SpecialChar LyX
41365 's temporary directory,
41366 so the files produced by the conversion will be in that directory.
41368 will copy out what it regards as the `main' file,
41373 conversion may produce several files,
41374 and so most of these would then be deleted when \SpecialChar LyX
41376 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.
41379 \begin_layout Paragraph
41380 Build instructions in the document
41383 \begin_layout Standard
41384 The last piece of the integration between \SpecialChar LyX
41386 \begin_inset Quotes eld
41390 \begin_inset Quotes erd
41395 the instructions for building your program should be embedded in a chunk of its own.
41397 \begin_inset Quotes eld
41401 \begin_inset Quotes erd
41404 above uses the notangle command to look for this chunk (called
41405 \begin_inset Quotes eld
41409 \begin_inset Quotes erd
41412 ) and runs its contents through
41413 \begin_inset Quotes eld
41417 \begin_inset Quotes erd
41423 \begin_layout Standard
41425 such a chunk would look something like this:
41428 \begin_layout LyX-Code
41432 \begin_layout LyX-Code
41434 \begin_inset Newline newline
41437 if [ -z "${NOWEB_SOURCE}" ]
41438 \begin_inset Newline newline
41444 \begin_layout LyX-Code
41445 NOWEB_SOURCE=myfile.nw
41446 \begin_inset Newline newline
41450 \begin_inset Newline newline
41454 code to extract files ...
41455 use NOWEB_OUTPUT_DIR here ...]
41456 \begin_inset Newline newline
41460 code to compile files ...]
41461 \begin_inset Newline newline
41467 \begin_layout Standard
41469 \change_deleted 564990737 1672161716
41472 LIBDIR/examples/listerrors.lyx
41476 LIBDIR/examples/Literate.lyx
41477 \change_inserted 564990737 1672161716
41481 File\SpecialChar menuseparator
41482 Open Example\SpecialChar menuseparator
41483 Modules\SpecialChar menuseparator
41489 \change_inserted -712698321 1674917096
41492 File\SpecialChar menuseparator
41493 Open Example\SpecialChar menuseparator
41494 Modules\SpecialChar menuseparator
41500 \change_deleted 564990737 1672161729
41504 \begin_inset Quotes eld
41508 \begin_inset Quotes erd
41511 program for some illustrations of how all of these pieces go together
41512 \change_deleted -712698321 1674917093
41514 \change_deleted 564990737 1672161756
41517 LIBDIR/examples/noweb2lyx.lyx
41518 \change_deleted -712698321 1674917093
41522 File\SpecialChar menuseparator
41523 Open Example\SpecialChar menuseparator
41524 Modules\SpecialChar menuseparator
41525 Noweb2\SpecialChar LyX
41536 \change_deleted 564990737 1672161767
41539 files show off the language-indepence of the \SpecialChar LyX
41540 literate programming support since they are written in Python
41541 \change_deleted 564990737 1672161782
41545 and Perl respectively.
41548 \begin_layout Subsubsection
41549 Configuring \SpecialChar LyX
41553 \begin_layout Standard
41554 All the Literate Programming support is configured by the
41556 Tools\SpecialChar menuseparator
41560 \begin_inset Quotes eld
41564 \begin_inset Quotes erd
41568 The important parts are:
41571 \begin_layout Description
41573 \begin_inset space ~
41577 \begin_inset Quotes eld
41581 \begin_inset Quotes erd
41585 \begin_inset space ~
41588 format Set up via the File Formats tab,
41589 this is where the Noweb-specific pieces are set up.
41599 the file extension is set to
41604 This tells \SpecialChar LyX
41605 to create a file with a
41609 extension in the first step of the conversion process.
41612 \begin_layout Description
41614 \begin_inset space ~
41622 \begin_inset space ~
41625 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).
41628 \begin_layout Description
41638 This converter performs the
41639 \begin_inset Quotes eld
41643 \begin_inset Quotes erd
41646 of the literate document.
41649 \begin_inset Quotes eld
41654 noweave -delay -index $$i > $$o
41657 \begin_inset Quotes erd
41663 \begin_layout Description
41673 \begin_inset Quotes eld
41677 \begin_inset Quotes erd
41682 the Converter is set to
41683 \begin_inset Quotes eld
41691 \begin_inset Quotes erd
41696 \begin_inset Newline newline
41700 \begin_inset Quotes eld
41705 parselog=$$s/scripts/listerrors
41708 \begin_inset Quotes erd
41714 \begin_layout Subsubsection
41718 \begin_layout Standard
41719 There is also a new function implemented in the \SpecialChar LyX
41722 \begin_inset Quotes eld
41725 server-goto-file-row" function,
41726 to be used with ddd/gdb or other debugger.
41730 \begin_layout Standard
41731 When debugging code with ddd/gdb,
41732 it is possible to invoke a text editor at the current execution position with a single key stroke.
41733 The default ddd configuration for that is shift-ctrl-V.
41734 It happens that you can define the editor command line invocation in ddd by accessing the
41736 Edit\SpecialChar menuseparator
41737 Preferences\SpecialChar menuseparator
41740 dialog and changing the "Edit Sources" entry.
41743 \begin_layout Standard
41744 I take advantage of the newly created \SpecialChar LyX
41745 server function and this ddd feature,
41747 \begin_inset Quotes eld
41751 \begin_inset Quotes erd
41757 \begin_layout LyX-Code
41758 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
41761 \begin_layout Standard
41763 whenever you are using ddd and find a point in the program that you want to edit,
41764 you just press shift-ctrl-V (in the ddd window),
41765 and ddd will forward this information to \SpecialChar LyX
41766 through the \SpecialChar LyX
41767 server and then the \SpecialChar LyX
41768 window will show the same file with the cursor at the same position ddd was pointing to.
41769 No more guessing or long scrolling to locate a point in the program back from debugging !
41772 \begin_layout Standard
41773 Note however that you must enable the \SpecialChar LyX
41774 server to get this feature working (it is disabled by default).
41776 \begin_inset space ~
41780 \begin_inset CommandInset ref
41782 reference "sec:Starting-the-Server"
41787 explains how to do that.
41790 \begin_layout Subsubsection
41794 \begin_layout Standard
41795 There are six new buttons that can be added to your \SpecialChar LyX
41797 Four of these buttons are short cuts to layout styles:
41820 one for the custom inset
41825 The last one is a short cut to the
41826 \begin_inset Quotes eld
41830 \begin_inset Quotes erd
41837 \begin_layout Standard
41839 has a range of buttons that are available for tool bar customization.
41840 In my toolbar I like to combine the six short cuts above with two more:
41845 \SpecialChar menuseparator
41850 \SpecialChar menuseparator
41857 Document\SpecialChar menuseparator
41858 View\SpecialChar menuseparator
41862 Here is how it looks like:
41865 \begin_layout LyX-Code
41869 \begin_layout LyX-Code
41873 \begin_layout LyX-Code
41874 Icon "layout Standard"
41877 \begin_layout LyX-Code
41878 Icon "layout Section"
41881 \begin_layout LyX-Code
41882 Icon "layout \SpecialChar LaTeX
41886 \begin_layout LyX-Code
41887 Icon "layout \SpecialChar LyX
41891 \begin_layout LyX-Code
41892 Icon "flex.insert Chunk"
41895 \begin_layout LyX-Code
41899 \begin_layout LyX-Code
41903 \begin_layout LyX-Code
41904 Icon "buffer-typeset"
41907 \begin_layout LyX-Code
41908 Icon "build-program"
41911 \begin_layout LyX-Code
41915 \begin_layout LyX-Code
41919 \begin_layout LyX-Code
41923 \begin_layout LyX-Code
41927 \begin_layout LyX-Code
41931 \begin_layout Subsubsection
41932 Colors customization
41935 \begin_layout Standard
41936 There are a number of colors in \SpecialChar LyX
41937 that can be customized in
41942 One of the things that bothers people is the \SpecialChar LaTeX
41944 The default color is red,
41945 since the chunks uses \SpecialChar LaTeX
41947 and there is a lot of chunks in literate documents,
41948 you may get tired of seeing everything in red.
41949 You can change it by going to the tabs
41959 \begin_layout Standard
41960 The next thing is the visible presence of the newline character in the screen.
41961 You can choose the color of this particular character and make it blend in the background.
41962 I recommend you choosing a color that is close to the background but not equal,
41963 that way you still can see it is there,
41964 but it is not bothering you anymore.
41967 \begin_layout Subsection
41972 \begin_layout Standard
41982 \change_inserted 564990737 1672161863
41985 Help\SpecialChar menuseparator
41986 Specific Manuals\SpecialChar menuseparator
41992 \change_deleted 564990737 1671643409
41998 \change_inserted 564990737 1672161856
42001 File\SpecialChar menuseparator
42002 Open Example\SpecialChar menuseparator
42003 Modules\SpecialChar menuseparator
42009 \change_deleted 564990737 1671643461
42010 the Sweave manual (menu
42012 Help\SpecialChar menuseparator
42016 \change_inserted 564990737 1672161856
42019 Help\SpecialChar menuseparator
42020 Specific Manuals\SpecialChar menuseparator
42022 \change_deleted 564990737 1672161921
42027 \change_inserted 564990737 1672161917
42030 File\SpecialChar menuseparator
42031 Open Example\SpecialChar menuseparator
42032 Modules\SpecialChar menuseparator
42036 \change_deleted 564990737 1672742969
42040 \begin_layout Standard
42042 \change_deleted 564990737 1671355343
42046 \begin_layout Standard
42048 \change_deleted 564990737 1671355343
42049 You can do everything with \SpecialChar LyX
42050 that you can do with \SpecialChar LaTeX
42054 cannot support every \SpecialChar LaTeX
42056 But you can always use \SpecialChar TeX
42058 This chapter shows you some more special things you might want to use.
42059 For other special things you can do with figures,
42066 \begin_inset space ~
42072 \change_inserted -712698321 1674917293
42076 \begin_layout Standard
42078 \change_inserted -712698321 1674917303
42079 \begin_inset CommandInset index_print
42080 LatexCommand printindex