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 \begin_inset Flex Noun
752 \begin_layout Plain Layout
753 Export\SpecialChar menuseparator
760 \begin_inset Flex Noun
763 \begin_layout Plain Layout
770 \begin_inset Flex Noun
773 \begin_layout Plain Layout
774 View\SpecialChar menuseparator
785 then look at the preamble of the resulting
786 \begin_inset Flex Code
789 \begin_layout Plain Layout
796 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
798 These macros are defined automatically,
799 according to the features you use in the document.
802 \begin_layout Standard
803 There are several commands that automatically invoke \SpecialChar LaTeX
808 \begin_layout Itemize
809 \begin_inset Flex Noun
812 \begin_layout Plain Layout
813 Document\SpecialChar menuseparator
822 \begin_layout Itemize
823 \begin_inset Flex Noun
826 \begin_layout Plain Layout
827 Document\SpecialChar menuseparator
836 \begin_layout Standard
837 They will only invoke \SpecialChar LaTeX
838 if the file has changed since the last time \SpecialChar LaTeX
843 \begin_layout Standard
844 When \SpecialChar LyX
845 runs \SpecialChar LaTeX
846 on the file you're editing,
847 it performs these steps:
850 \begin_layout Enumerate
851 Convert the document to \SpecialChar LaTeX
852 and save to a file with the extension
853 \begin_inset Flex Code
856 \begin_layout Plain Layout
863 \begin_inset Flex Code
866 \begin_layout Plain Layout
875 \begin_layout Enumerate
876 Run \SpecialChar LaTeX
878 \begin_inset Flex Code
881 \begin_layout Plain Layout
887 file (maybe several times),
888 and run any other commands (such as
889 \begin_inset Flex Code
892 \begin_layout Plain Layout
899 \begin_inset Flex Code
902 \begin_layout Plain Layout
908 ) needed to compile the \SpecialChar LaTeX
912 \begin_layout Enumerate
913 If there are any errors,
917 \begin_layout Standard
918 If you have run \SpecialChar LaTeX
920 \begin_inset Flex Noun
923 \begin_layout Plain Layout
924 View\SpecialChar menuseparator
932 then runs a DVI viewer to display the DVI-file.
934 \begin_inset Flex Noun
937 \begin_layout Plain Layout
938 View\SpecialChar menuseparator
946 performs further steps:
949 \begin_layout Enumerate
951 \begin_inset Flex Code
954 \begin_layout Plain Layout
960 to convert the DVI file to PostScript.
963 \begin_layout Enumerate
964 Run a PostScript viewer,
966 \begin_inset Flex Code
969 \begin_layout Plain Layout
976 to display the PostScript file.
979 \begin_layout Standard
981 does similar things when viewing,
986 \begin_layout Section
987 Translating \SpecialChar LaTeX
988 files into \SpecialChar LyX
992 \begin_layout Standard
993 You can import a \SpecialChar LaTeX
994 file into \SpecialChar LyX
996 \begin_inset Flex Noun
999 \begin_layout Plain Layout
1000 File\SpecialChar menuseparator
1001 Import\SpecialChar menuseparator
1007 command in \SpecialChar LyX
1009 This will call a program named
1010 \begin_inset Flex Code
1013 \begin_layout Plain Layout
1019 which will create a file
1020 \begin_inset Flex Code
1023 \begin_layout Plain Layout
1030 \begin_inset Flex Code
1033 \begin_layout Plain Layout
1041 will then open that file.
1045 \begin_layout Plain Layout
1046 \begin_inset Flex Code
1049 \begin_layout Plain Layout
1055 can also be run from the command line,
1064 \begin_layout Standard
1065 \begin_inset Flex Code
1068 \begin_layout Plain Layout
1074 will translate most legal \SpecialChar LaTeX
1077 It will put things it doesn't understand into \SpecialChar TeX
1079 so after translating a file with
1080 \begin_inset Flex Code
1083 \begin_layout Plain Layout
1090 you can look for \SpecialChar TeX
1091 code and hand-edit it until it looks right.
1094 \begin_layout Standard
1095 If you don't know what \SpecialChar TeX
1097 read the next section.
1100 \begin_layout Section
1101 \begin_inset CommandInset label
1103 name "sec:Inserting-TeX-Code"
1107 Inserting \SpecialChar TeX
1108 Code into \SpecialChar LyX
1112 \begin_layout Standard
1113 Anything you can do in \SpecialChar LaTeX
1114 you can do in \SpecialChar LyX
1116 for a very simple reason:
1117 You can always insert \SpecialChar TeX
1118 code into any \SpecialChar LyX
1122 and will never be able to,
1123 display every possible \SpecialChar LaTeX
1125 If ever you need to insert \SpecialChar LaTeX
1126 commands into your \SpecialChar LyX
1129 \begin_inset Flex Code
1132 \begin_layout Plain Layout
1140 which you can insert into your document with
1141 \begin_inset Flex Noun
1144 \begin_layout Plain Layout
1145 Insert\SpecialChar menuseparator
1155 or the keyboard shortcut
1164 \begin_layout Standard
1165 Here's an example of inserting \SpecialChar LaTeX
1166 commands in a \SpecialChar LyX
1168 The code looks like this:
1171 \begin_layout LyX-Code
1175 \begin_inset Newline newline
1180 begin{minipage}{5cm}
1181 \begin_inset Newline newline
1184 This is an example of a minipage environment.
1186 \begin_inset Newline newline
1189 can put nearly everything in it,
1191 \begin_inset Newline newline
1196 \begin_inset Newline newline
1202 \begin_inset Newline newline
1206 \begin_inset Newline newline
1211 begin{minipage}{5cm}
1212 \begin_inset Newline newline
1218 \begin_inset Newline newline
1223 begin{minipage}{5cm}
1224 \begin_inset Newline newline
1229 \begin_inset Newline newline
1235 \begin_inset Newline newline
1241 \begin_inset Newline newline
1247 \begin_inset Newline newline
1255 \begin_layout LyX-Code
1259 \begin_layout Standard
1261 \begin_inset Flex Code
1264 \begin_layout Plain Layout
1271 box containing this text is directly after this paragraph.
1272 Those of you reading the manual in \SpecialChar LyX
1273 will only see the \SpecialChar TeX
1275 Those reading a printed version of the manuals will see the actual results:
1276 \begin_inset VSpace bigskip
1282 \begin_layout Standard
1286 \begin_layout Plain Layout
1293 \begin_layout Plain Layout
1297 begin{minipage}{5cm}
1300 \begin_layout Plain Layout
1302 This is an example of a minipage environment.
1303 You can put nearly everything in it,
1304 even (non-floating) figures and tables.
1308 \begin_layout Plain Layout
1315 \begin_layout Plain Layout
1320 \begin_layout Plain Layout
1324 begin{minipage}{5cm}
1327 \begin_layout Plain Layout
1334 \begin_layout Plain Layout
1338 begin{minipage}{5cm}
1341 \begin_layout Plain Layout
1347 \begin_layout Plain Layout
1354 \begin_layout Plain Layout
1361 \begin_layout Plain Layout
1368 \begin_layout Plain Layout
1378 \begin_inset VSpace bigskip
1384 \begin_layout Standard
1385 In addition to using \SpecialChar TeX
1387 you can also create a separate file containing some complex \SpecialChar LaTeX
1388 structure and then use
1389 \begin_inset Flex Noun
1392 \begin_layout Plain Layout
1393 Insert\SpecialChar menuseparator
1395 \begin_inset space ~
1403 to include your file (you should select the type
1404 \begin_inset Flex Code
1407 \begin_layout Plain Layout
1414 We recommend that you only do this if you have a
1415 \begin_inset Flex Code
1418 \begin_layout Plain Layout
1430 you'll have a big job tracking down \SpecialChar LaTeX
1434 \begin_layout Standard
1435 There are a few last points to emphasize:
1438 \begin_layout Itemize
1444 check if your \SpecialChar LaTeX
1448 \begin_layout Itemize
1449 Beware of reinventing the wheel.
1452 \begin_layout Standard
1455 does have quite a few features tucked into it,
1456 and more are coming.
1457 Be sure to check the manuals to make sure that \SpecialChar LyX
1458 doesn't have such-and-such feature before you decide you have to do it by hand.
1460 there are numerous \SpecialChar LaTeX
1461 packages out there to do all sorts of things,
1462 from labels to envelopes to fancy multipage tables.
1464 \change_inserted 244031559 1603815732
1466 \begin_inset CommandInset href
1469 target "https://www.ctan.org/"
1475 \change_deleted 244031559 1603815732
1477 \begin_inset CommandInset href
1480 target "http://www.ctan.org/"
1490 \begin_layout Standard
1491 If you do need to do some wild and fancy things within your document,
1492 be sure to check out a good \SpecialChar LaTeX
1493 book for assistance.
1494 There are a number of them listed in the bibliography of the
1501 \begin_layout Section
1503 and the \SpecialChar LaTeX
1507 \begin_layout Subsection
1508 About the \SpecialChar LaTeX
1512 \begin_layout Standard
1513 If you already know \SpecialChar LaTeX
1515 there is no need to explain here what the preamble is good for.
1517 the following will give you some ideas—
1518 we recommend again that you consult a \SpecialChar LaTeX
1519 book for further information.
1521 you should read the points below,
1522 because they explain what you can do and what you don't need to do in the \SpecialChar LaTeX
1523 preamble of a \SpecialChar LyX
1527 \begin_layout Standard
1528 The \SpecialChar LaTeX
1529 preamble comes at the very beginning of a document,
1538 \begin_layout Itemize
1539 Declare the document class.
1541 \begin_inset Newline newline
1545 already does this for you.
1546 If you're a seasoned \SpecialChar LaTeX
1548 and you have a custom document class you want to use,
1551 Customization Manual
1553 for information on how to make \SpecialChar LyX
1557 \begin_layout Itemize
1558 Declare the usage of packages.
1560 \begin_inset Newline newline
1564 packages provide special commands,
1565 which are only available within a document when the package has been declared in the preamble.
1566 In addition to providing special commands,
1567 the inclusion of a package can change the document.
1570 \begin_inset Flex Code
1573 \begin_layout Plain Layout
1579 forces all paragraphs to be indented.
1580 There are other packages for labels,
1587 \begin_layout Itemize
1592 \begin_inset Newline newline
1595 There are several \SpecialChar LaTeX
1596 counters and variables that
1600 be set globally from within the preamble in order to have the desired effect.
1601 (There are variables that you can set and reset inside the document,
1602 too.) Margins are a good example of something that must be set in the preamble.
1603 Another example is the label format for lists.
1604 You can actually set these just about anywhere,
1605 but it's best to do it just once,
1606 inside the preamble.
1609 \begin_layout Itemize
1610 Declare user defined commands (with
1611 \begin_inset Flex Code
1614 \begin_layout Plain Layout
1623 \begin_inset Flex Code
1626 \begin_layout Plain Layout
1635 \begin_inset Newline newline
1638 These are abbreviations for \SpecialChar LaTeX
1639 commands which appear very often inside a document.
1640 Although the preamble is a good place to declare such commands,
1645 be declared anywhere (before they are used for the first time,
1647 This can be useful if there is a lot of raw \SpecialChar LaTeX
1648 code in your document,
1649 which normally should not be the case.
1652 \begin_layout Standard
1654 adds its own set of definitions to the preamble of the
1655 \begin_inset Flex Code
1658 \begin_layout Plain Layout
1665 This makes \SpecialChar LaTeX
1666 files generated by \SpecialChar LyX
1670 \begin_layout Subsection
1671 Changing the Preamble
1674 \begin_layout Standard
1675 The commands which \SpecialChar LyX
1676 adds to the preamble of a \SpecialChar LaTeX
1678 you can't change them without patching \SpecialChar LyX
1682 add your own stuff to the preamble by selecting
1683 \begin_inset Flex Noun
1686 \begin_layout Plain Layout
1689 \begin_inset space ~
1698 \begin_inset Flex Noun
1701 \begin_layout Plain Layout
1702 Document\SpecialChar menuseparator
1710 adds anything in the
1711 \begin_inset Flex Noun
1714 \begin_layout Plain Layout
1720 dialog to its own built-in preamble.
1721 Before adding your own declarations in the preamble,
1722 you should make sure that \SpecialChar LyX
1723 doesn't already support what you want to do.
1724 (Remember what we said about reinventing the wheel?) Also,
1727 make sure your preamble code is correct
1731 doesn't check it for you.
1732 If there is an error,
1733 you're likely to get an error like
1734 \begin_inset Quotes eld
1738 \begin_inset Flex Code
1741 \begin_layout Plain Layout
1750 \begin_inset Quotes erd
1754 If you see this error,
1755 check your preamble.
1758 \begin_layout Subsection
1762 \begin_layout Standard
1763 Here are some examples of what you can add to a preamble,
1767 \begin_layout Subsubsection
1772 \begin_layout Standard
1773 There are two variables under \SpecialChar LaTeX
1774 that control page position:
1776 \begin_inset Flex Code
1779 \begin_layout Plain Layout
1788 \begin_inset Flex Code
1791 \begin_layout Plain Layout
1800 Their names should be self-explanatory.
1801 These variables are useful if you think for a moment about computer labels.
1803 the size of a print medium and the area of the medium that you can actually print on aren't the same.
1805 \begin_inset Flex Code
1808 \begin_layout Plain Layout
1817 \begin_inset Flex Code
1820 \begin_layout Plain Layout
1831 \begin_layout Standard
1832 The default values for
1833 \begin_inset Flex Code
1836 \begin_layout Plain Layout
1845 \begin_inset Flex Code
1848 \begin_layout Plain Layout
1857 \begin_inset space \thinspace{}
1862 \begin_inset space \thinspace{}
1866 \begin_inset space \space{}
1869 the page isn't shifted.
1871 some DVI drivers always seem to shift the page.
1872 We have no idea why,
1873 or why the sysadmin hasn't fixed such behavior.
1874 If you're using \SpecialChar LyX
1875 on a system that you don't personally maintain,
1876 and your sysadmin is a doofus,
1878 \begin_inset Flex Code
1881 \begin_layout Plain Layout
1890 \begin_inset Flex Code
1893 \begin_layout Plain Layout
1902 Suppose your left and top margins are always 0.5
1903 \begin_inset space \thinspace{}
1907 You can add this to the preamble:
1910 \begin_layout LyX-Code
1918 \begin_layout LyX-Code
1926 \begin_layout Standard
1927 and your margins should now be correct.
1930 \begin_layout Subsubsection
1935 \begin_layout Standard
1937 suppose you wanted to print out a bunch of address labels.
1938 There's a rather nice package,
1939 available at your nearest CTAN archive,
1940 for printing sheets of labels:
1942 \begin_inset Flex Code
1945 \begin_layout Plain Layout
1953 your system may not have this package installed by default.
1954 We leave that up to you to check.
1955 You'll also want to read the documentation for it;
1956 we're not going to do that for you.
1957 Since this is an example,
1959 we'll give you an example of how you use this package.
1962 \begin_layout Standard
1964 make sure you're using the
1965 \begin_inset Flex Code
1968 \begin_layout Plain Layout
1976 you need to put the following in your preamble:
1979 \begin_layout LyX-Code
1985 \begin_layout LyX-Code
1991 \begin_layout LyX-Code
1997 \begin_layout LyX-Code
2003 \begin_layout LyX-Code
2009 \begin_layout LyX-Code
2015 \begin_layout LyX-Code
2021 \begin_layout Standard
2022 This sets things up for Avery label sheets,
2024 You're now ready to print labels,
2025 but you'll need to insert \SpecialChar LaTeX
2027 placing the commands
2028 \begin_inset Flex Code
2031 \begin_layout Plain Layout
2040 \begin_inset Flex Code
2043 \begin_layout Plain Layout
2051 around each label text.
2052 This and other special features of
2053 \begin_inset Flex Code
2056 \begin_layout Plain Layout
2062 are explained in its documentation.
2065 \begin_layout Standard
2067 someone may write a \SpecialChar LyX
2068 layout file to support this package directly.
2069 Maybe that someone is you.
2072 \begin_layout Subsubsection
2074 Paragraph Indentation
2077 \begin_layout Standard
2078 Americans are trained to indent the first line of
2083 As with all of their other weird quirks,
2084 most Americans will whine and moan until they can have their way and indent the first line of all paragraphs.
2095 \begin_layout Standard
2097 this behavior isn't standard typography.
2099 you typically only indent the first line of a paragraph
2103 it follows another one.
2104 The idea behind indenting the first line of a paragraph is to distinguish neighboring paragraphs from one another.
2105 If there is no previous paragraph—
2107 if it follows a figure or is the first paragraph in a section—
2108 then there is no need for indentation.
2112 \begin_layout Standard
2113 If you're a typical American (we're still joking!),
2115 you don't care about such esoteric things;
2116 you want your indentation!
2117 Add this to the preamble:
2120 \begin_layout LyX-Code
2123 usepackage{indentfirst}
2126 \begin_layout Standard
2127 If your \SpecialChar TeX
2128 distribution isn't braindead,
2129 you'll have this package,
2130 and all of your paragraphs will get the indentation the Founding Fathers intended they should have.
2133 \begin_layout Subsubsection
2138 \begin_layout Standard
2139 You can also check out the preamble of this document to get an idea of some of the advanced things you can do.
2142 \begin_layout Section
2144 and \SpecialChar LaTeX
2148 \begin_layout Standard
2149 When \SpecialChar LyX
2150 calls \SpecialChar LaTeX
2152 it tells \SpecialChar LaTeX
2153 to blithely ignore any errors and keep going.
2154 It then uses the logfile from the \SpecialChar LaTeX
2155 run to do a post-mortem.
2156 After analyzing the logfile,
2158 displays a dialog listing the errors.
2159 Clicking on any one of them will take you to the position in your \SpecialChar LyX
2160 file where the error occurred.
2164 \begin_layout Plain Layout
2167 Analyzing the logfile is a tough job,
2168 and \SpecialChar LyX
2169 doesn't always go to the right line.
2170 There are also cases where \SpecialChar LaTeX
2171 reports the error on one line,
2172 but the actual error is earlier.
2173 This is not unlike forgetting a closing brace in a program:
2174 You'll get an error,
2183 \begin_layout Standard
2184 Some folks also like to look at the log file directly:
2185 It is available from
2186 \begin_inset Flex Noun
2189 \begin_layout Plain Layout
2190 Document\SpecialChar menuseparator
2192 \begin_inset space ~
2201 There are some fairly common error messages and warnings.
2202 We'll cover those here.
2203 You should look at a good \SpecialChar LaTeX
2204 book for a complete listing.
2207 \begin_layout Itemize
2208 \begin_inset Flex Code
2211 \begin_layout Plain Layout
2218 \begin_inset Newline newline
2221 Anything beginning with these words is a warning message for the purpose of
2222 \begin_inset Quotes eld
2226 \begin_inset Quotes erd
2229 the \SpecialChar LaTeX
2231 You'll get messages like this if you added or changed cross-references or bibliography entries,
2234 is trying to tell you that you need to make another run.
2235 You can by-and-large ignore these.
2238 \begin_layout Itemize
2239 \begin_inset Flex Code
2242 \begin_layout Plain Layout
2249 \begin_inset Newline newline
2252 Another warning message,
2253 this time about fonts which \SpecialChar LaTeX
2255 The rest of the message will often say something about a replacement font that \SpecialChar LaTeX
2257 You can safely ignore these,
2261 \begin_layout Itemize
2262 \begin_inset Flex Code
2265 \begin_layout Plain Layout
2274 \begin_inset Newline newline
2283 It seems to generate at least one of these messages for just about any document you write.
2284 They are warnings about lines that were too long and run past the right margin.
2285 This happens if \SpecialChar LaTeX
2286 does not find a reasonable way to break the lines (notoriously often with typewriter font,
2287 since this does not allow for automatic break points).
2289 this is unnoticeable in the final output.
2290 (It can be just a point or two.) Sometimes,
2292 the lines run rather visibly into the margin;
2293 something you will not want to have in your final print.
2295 \begin_inset Newline newline
2298 There are several global ways to try to minimize the overfull lines.
2301 Enable micro-typographic extensions
2305 Document\SpecialChar menuseparator
2306 Settings\SpecialChar menuseparator
2309 might already improve things a lot.
2312 code such as the following in
2314 Document\SpecialChar menuseparator
2315 Settings\SpecialChar menuseparator
2318 usually reduces the overfull lines drastically (we use this in the preamble of this document):
2322 \begin_layout LyX-Code
2326 \begin_inset Newline newline
2332 \begin_inset Newline newline
2337 emergencystretch 1.5em
2338 \begin_inset Newline newline
2346 \begin_layout Standard
2349 you eventually have to rewrite the text to get the line breaking right.
2353 \begin_layout Plain Layout
2354 For more information,
2356 \begin_inset Flex URL
2359 \begin_layout Plain Layout
2361 http://www.tex.ac.uk/FAQ-overfull.html
2374 \begin_layout Standard
2376 you should check the respective lines,
2377 at least for the final version of your document.
2378 Your eyes will tell you if there's a problem with something that's too wide.
2382 \begin_layout Plain Layout
2383 You can also enable the `draft' option in
2384 \begin_inset Flex Noun
2387 \begin_layout Plain Layout
2388 Document\SpecialChar menuseparator
2395 and then \SpecialChar LaTeX
2396 will draw a black box in the margin of lines that are overfull.
2405 \begin_layout Itemize
2406 \begin_inset Flex Code
2409 \begin_layout Plain Layout
2418 \begin_inset Newline newline
2421 Not quite as common as its cousin.
2422 This happens again if \SpecialChar LaTeX
2423 does not find a reasonable break point and consequently generates too loose lines.
2424 As with the overfull lines,
2425 you should check if this is a visible problem.
2428 \begin_layout Itemize
2429 \begin_inset Flex Code
2432 \begin_layout Plain Layout
2441 \begin_inset Flex Code
2444 \begin_layout Plain Layout
2453 \begin_inset Newline newline
2456 Warnings about troubles breaking the page.
2458 just look at the output.
2459 Your eyes will tell you where something has gone wrong.
2462 \begin_layout Itemize
2463 \begin_inset Flex Code
2466 \begin_layout Plain Layout
2469 \begin_inset Quotes els
2473 \begin_inset Quotes ers
2482 \begin_inset Newline newline
2486 \begin_inset Quotes eld
2490 \begin_inset Quotes erd
2493 isn't installed on this system.
2494 This usually appears because some package your document needs isn't installed.
2495 If you didn't touch the preamble or didn't use the
2496 \begin_inset Flex Code
2499 \begin_layout Plain Layout
2508 then one of the packages \SpecialChar LyX
2509 tried to load is missing.
2511 \begin_inset Flex Noun
2514 \begin_layout Plain Layout
2515 Help\SpecialChar menuseparator
2522 to get a list of packages that \SpecialChar LyX
2524 This file is updated whenever you reconfigure \SpecialChar LyX
2526 \begin_inset Flex Noun
2529 \begin_layout Plain Layout
2530 Tools\SpecialChar menuseparator
2536 ) and tells you which packages have been detected and what they do.
2537 \begin_inset Newline newline
2541 \begin_inset Flex Code
2544 \begin_layout Plain Layout
2552 command and the package in question isn't installed,
2553 then you'll need to install it yourself.
2556 \begin_layout Itemize
2557 \begin_inset Flex Code
2560 \begin_layout Plain Layout
2568 \begin_inset Newline newline
2571 Error messages beginning with this are trying to tell you that you specified a bad or undefined option to a package.
2572 Check the package's documentation.
2575 \begin_layout Itemize
2576 \begin_inset Flex Code
2579 \begin_layout Plain Layout
2580 Undefined control sequence
2586 \begin_inset Newline newline
2589 If you've inserted \SpecialChar LaTeX
2590 code into your document,
2592 you'll get one of these.
2593 You may have forgotten to load a package.
2595 this error message usually means that you used an undefined command.
2599 \begin_layout Standard
2600 There are other error and warning messages.
2601 Some are self-explanatory.
2602 These are usually \SpecialChar LaTeX
2604 Others are downright cryptic.
2605 These are usually \SpecialChar TeX
2611 what they mean or how to decipher them.
2615 \begin_layout Standard
2616 There's a general sequence you should follow if you get error messages:
2619 \begin_layout Enumerate
2620 Look at the \SpecialChar LaTeX
2621 code you inserted for typos.
2624 \begin_layout Enumerate
2625 If there are no typos,
2626 check that you used the command(s) correctly.
2629 \begin_layout Enumerate
2630 If you get a bunch of error boxes piled up at the very top of the document—
2631 and especially if you see a
2632 \begin_inset Quotes eld
2636 \begin_inset Flex Code
2639 \begin_layout Plain Layout
2648 \begin_inset Quotes erd
2652 it means that there are errors in the preamble.
2653 Start debugging your preamble.
2656 \begin_layout Enumerate
2657 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2658 code to the document,
2659 the first suspect is your \SpecialChar LaTeX
2660 distribution itself.
2661 Check for missing packages and install them.
2664 \begin_layout Enumerate
2666 so there are no missing packages.
2667 Did you use any of the fine-tuning options in \SpecialChar LyX
2675 like trying to manually insert lots of
2676 \begin_inset Flex Code
2679 \begin_layout Plain Layout
2681 \change_deleted 177693 1654669036
2683 \change_inserted 177693 1654669038
2687 \begin_inset space ~
2691 \change_deleted 177693 1654669040
2693 \change_inserted 177693 1654669041
2703 \begin_inset Flex Code
2706 \begin_layout Plain Layout
2714 \begin_inset Flex Code
2717 \begin_layout Plain Layout
2724 Did you try to kludge something together with these instead of using the appropriate paragraph environment?
2727 \begin_layout Enumerate
2729 you didn't use any of the fine-tuning options,
2730 you played by the rules.
2731 Did you try to pull a fancy maneuver?
2732 Did you do something funky inside a table or an equation,
2733 like inserting a graphic into a table cell?
2736 \begin_layout Enumerate
2737 Do you have long sections of text where \SpecialChar LaTeX
2738 cannot find a place to break a line?
2741 is rather strict about how much extra inter-word spacing it will add in order to break a line.
2743 you should rework the paragraph to avoid the problem.
2746 \begin_layout Enumerate
2747 Did you go overboard with the nesting?
2749 (currently) doesn't check to make sure you're in the limits for nesting environments.
2750 If you nested a bunch of environments to the
2751 \begin_inset Formula $17^{\mathrm{th}}$
2756 (The limit in \SpecialChar LaTeX
2760 \begin_layout Enumerate
2762 you didn't get any error messages,
2763 but your output looks awful.
2764 If you have a table or figure that's too wide or long for the page,
2769 \begin_layout Enumerate
2770 rescale the figure so it fits.
2773 \begin_layout Enumerate
2774 trim down the table so it fits.
2778 \begin_layout Enumerate
2779 If something else is wrong with the output,
2780 and you didn't try to pull anything fancy or kludge the fine-tuning options,
2781 we're not sure what's wrong.
2784 \begin_layout Standard
2785 If all this doesn't help—
2791 you might have found a bug in \SpecialChar LyX
2796 \begin_layout Chapter
2798 \change_inserted 564990737 1672345271
2802 \begin_layout Standard
2804 \change_inserted 564990737 1672345272
2811 originally offered four standard document classes,
2815 but individuals and organizations,
2816 most notably the American Mathematical Society in the early days,
2817 have made many contributions to extending the range of document classes.
2818 In this chapter we summarize the main externally maintained classes,
2819 some of which are marked “Unavailable:” in the pull-down
2822 \begin_inset space ~
2836 ocument\SpecialChar menuseparator
2841 ettings\SpecialChar menuseparator
2843 \begin_inset space ~
2848 dialog and which you will need to install as described in the
2850 Installing New Document Classes
2856 manual if you want to use them.
2860 \begin_layout Section
2862 \change_inserted 564990737 1670439533
2863 \begin_inset CommandInset label
2865 name "sec:Collections"
2872 \begin_layout Subsection
2874 \change_inserted 564990737 1672345298
2875 \begin_inset CommandInset label
2877 name "subsec:AMS-LaTeX-(American-Mathematical"
2881 AMS-\SpecialChar LaTeX
2882 (American Mathematical Society)
2885 \begin_layout Standard
2887 \change_inserted 564990737 1672345298
2888 The \SpecialChar LyX
2889 supported document classes
2897 are maintained by the Society;
2898 use of their features is described in the Math manual and on their website
2899 \begin_inset Flex URL
2902 \begin_layout Plain Layout
2904 \change_inserted 564990737 1672345298
2906 http://www.ams.org/publications/authors/tex/amslatex
2914 The following summary was originally provided by
2921 \change_inserted -712698321 1673082716
2923 \change_inserted 564990737 1672345298
2926 and the \SpecialChar LyX
2930 \change_deleted 564990737 1672345297
2933 AMS \SpecialChar LaTeX
2937 \begin_layout Standard
2939 \change_deleted 564990737 1672345297
2947 Richard Kimberly Heck
2952 \begin_layout Standard
2953 \begin_inset VSpace bigskip
2959 \begin_layout Standard
2961 The AMS \SpecialChar LaTeX
2962 layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
2963 The layouts are not tailored to a specific journal,
2965 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
2967 That documentation is available on the Web at
2968 \begin_inset Flex URL
2971 \begin_layout Plain Layout
2979 \begin_inset Flex URL
2982 \begin_layout Plain Layout
2984 ftp://ftp.ams.org/pub/tex/amslatex/
2990 These layouts are appropriate,
2992 for any mathematical writing.
2996 \begin_layout Standard
2998 \change_deleted -712698321 1673083001
3000 \change_inserted -712698321 1673083002
3003 basic AMS \SpecialChar LaTeX
3008 \begin_layout Itemize
3010 The standard AMS article format
3011 \change_inserted 564990737 1672345333
3015 File\SpecialChar menuseparator
3016 Open Example\SpecialChar menuseparator
3017 Articles\SpecialChar menuseparator
3018 American Mathematical Society (AMS)
3025 \begin_layout Itemize
3027 the standard AMS book (really,
3029 \change_inserted 564990737 1672345366
3033 File\SpecialChar menuseparator
3034 Open Example\SpecialChar menuseparator
3035 Books\SpecialChar menuseparator
3036 American Mathematical Society (AMS)
3041 \change_inserted 564990737 1672345369
3045 \begin_layout Itemize
3047 \change_inserted 564990737 1672345383
3049 the standard AMS proceedings format.
3052 \begin_layout Standard
3054 \change_inserted 564990737 1672345383
3056 only supports the first two natively;
3059 Installing New Document Classes
3065 manual if you want to use
3072 \begin_layout Standard
3073 The layouts themselves contain only the minimum necessary to use the AMS classes.
3076 contain any of the `theorem' environments used for setting theorems,
3079 These are contained,
3082 \change_deleted 564990737 1672345416
3084 \begin_inset Flex Code
3087 \begin_layout Plain Layout
3094 \change_inserted 564990737 1672345416
3102 which is loaded by default when you select one of the AMS classes.
3103 (It can also be used with other classes and can be removed,
3104 if you would rather use something else.) Less commonly used environments are in the
3105 \change_deleted 564990737 1672345436
3107 \begin_inset Flex Code
3110 \begin_layout Plain Layout
3111 Theorems (AMS-Extended)
3117 \change_inserted 564990737 1672345436
3120 AMS Theorems (Extended)
3125 which must be loaded manually.
3128 \begin_layout Standard
3130 theorems and the like are numbered consecutively throughout the document,
3131 but this may be modified by loading the module
3132 \change_deleted 564990737 1672345461
3134 \begin_inset Flex Code
3137 \begin_layout Plain Layout
3138 Theorems (Order by Section)
3144 \change_inserted 564990737 1672345461
3147 Standard Theorems (Numbered by Section)
3153 \begin_inset Flex Code
3156 \begin_layout Plain Layout
3164 \change_deleted 564990737 1672345479
3166 \begin_inset Flex Code
3169 \begin_layout Plain Layout
3170 Theorems (Order by Chapter)
3176 \change_inserted 564990737 1672345480
3179 Standard Theorems (Numbered by Chapter)
3184 These will number the results as
3185 \begin_inset Formula $n.m$
3189 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).
3190 Many environments are also available unnumbered.
3191 These are indicated by an asterisk at the end.
3192 If you happen to want
3198 \change_deleted 564990737 1672345498
3200 \begin_inset Flex Code
3203 \begin_layout Plain Layout
3210 \change_inserted 564990737 1672345498
3213 Standard Theorems (Unnumbered)
3217 provides that option.
3220 \begin_layout Standard
3221 Note that these modules do not
3225 to be used with the AMS classes.
3226 It is perfectly possible to use the
3227 \change_deleted 564990737 1672345520
3229 \begin_inset Flex Code
3232 \begin_layout Plain Layout
3239 \change_inserted 564990737 1672345520
3247 and the others mentioned,
3250 \begin_inset Flex Code
3253 \begin_layout Plain Layout
3255 \change_deleted -712698321 1673083855
3257 \change_inserted -712698321 1673083855
3258 Article (Standard Class)
3267 \begin_inset Flex Code
3270 \begin_layout Plain Layout
3272 \change_deleted -712698321 1673083858
3274 \change_inserted -712698321 1673083862
3275 Report (Standard Class)
3284 \begin_inset Flex Code
3287 \begin_layout Plain Layout
3289 \change_deleted -712698321 1673083819
3291 \change_inserted -712698321 1673083822
3303 \begin_layout Subsubsection
3304 What these layouts provide
3307 \begin_layout Standard
3308 There is a long list of included environments provided by these layouts.
3309 In AMS-\SpecialChar LaTeX
3313 an opportunity to define an unlimited variety of `theorem' environments.
3315 the AMS recommends the environments that are available in \SpecialChar LyX
3320 \begin_layout Standard
3321 The following environments—
3322 as well as the standard environments,
3324 \begin_inset Flex Noun
3327 \begin_layout Plain Layout
3335 \begin_inset Flex Noun
3338 \begin_layout Plain Layout
3346 \begin_inset Flex Noun
3349 \begin_layout Plain Layout
3357 \begin_inset Flex Noun
3360 \begin_layout Plain Layout
3368 \begin_inset Flex Noun
3371 \begin_layout Plain Layout
3379 \begin_inset Flex Code
3382 \begin_layout Plain Layout
3389 \begin_inset Flex Code
3392 \begin_layout Plain Layout
3401 \begin_layout Description
3402 Address This should be the author's permanent address.
3405 \begin_layout Description
3407 \begin_inset space ~
3410 Address This should be the author's temporary address at the time of submission,
3411 if different from the Address.
3414 \begin_layout Description
3415 Email Author's e-mail address
3418 \begin_layout Description
3419 URL Author's Web address,
3423 \begin_layout Description
3424 Keywords Key words or phrases used to identify specific topics discussed in the paper.
3427 \begin_layout Description
3428 Subjectclass These refer to the AMS Subject Classifications,
3429 published and described in
3431 Mathematical Reviews
3434 These are also available online at the AMS cites listed above.
3437 \begin_layout Description
3441 \begin_layout Description
3445 \begin_layout Description
3449 \begin_layout Standard
3450 The following environments are provided by both the
3451 \change_deleted 564990737 1672345566
3453 \begin_inset Flex Code
3456 \begin_layout Plain Layout
3463 \change_inserted 564990737 1672345566
3471 \change_deleted 564990737 1672345580
3473 \begin_inset Flex Code
3476 \begin_layout Plain Layout
3483 \change_inserted 564990737 1672345580
3491 in the latter case in both
3492 \change_deleted -712698321 1673084072
3496 \change_deleted -712698321 1673084073
3500 \change_deleted -712698321 1673084075
3504 \change_deleted -712698321 1673084077
3508 These same environments are provided only in the starred versions by the
3509 \change_deleted 564990737 1672345596
3511 \begin_inset Flex Code
3514 \begin_layout Plain Layout
3521 \change_inserted 564990737 1672345596
3525 \change_inserted -712698321 1673084060
3533 \begin_layout Theorem
3534 This is typically used for the statements of major results.
3538 \begin_layout Corollary*
3539 This is used for statements which follow fairly directly from previous statements.
3541 these can be major results.
3546 These are smaller results needed to prove other statements.
3549 \begin_layout Proposition
3550 These are less major results which (hopefully) add to the general theory being discussed.
3553 \begin_layout Conjecture
3554 These are statements provided without justification,
3555 which the author does not know how to prove,
3556 but which seem to be true (to the author,
3560 \begin_layout Definition*
3561 Guess what this is for.
3562 The font is different for this environment than for the previous ones.
3566 \begin_layout Example*
3567 Used for examples illustrating proven results.
3570 \begin_layout Problem
3571 It's not really known what this is for.
3572 You should figure it out.
3575 \begin_layout Exercise*
3576 Write a description for this one.
3579 \begin_layout Remark
3580 This environment is also a type of theorem,
3581 usually a lesser sort of observation.
3584 \begin_layout Claim*
3585 Often used in the course of giving a proof of a larger result.
3590 these are used to break up long arguments,
3591 using specific instances of some condition.
3596 The numbering scheme for cases is on its own,
3597 not together with other numbered statements.
3602 At the end of this environment,
3603 a QED symbol (usually a square,
3604 but it can vary with different styles) is placed.
3605 If you want to have other environments within this one—
3608 and have the QED symbol appear only after them,
3609 then the other environments need to be nested within the proof environment.
3612 Nesting Environments
3618 for information on nesting.
3623 \change_inserted 564990737 1672345651
3624 Used in a way similar to Proposition,
3625 though perhaps lower on the scale.
3628 \begin_layout Standard
3629 And these environments are provided by
3630 \change_deleted 564990737 1672345684
3632 \begin_inset Flex Code
3635 \begin_layout Plain Layout
3636 Theorems (AMS-Extended)
3642 \change_inserted 564990737 1672345689
3645 AMS Theorems (Extended
3652 \begin_layout Criterion*
3653 A required condition.
3656 \begin_layout Algorithm*
3657 A general procedure to be used.
3660 \begin_layout Axiom*
3661 This is a property or statement taken as true within the system being discussed.
3664 \begin_layout Condition*
3665 Sometimes used to state a condition assumed within the present context of discussion.
3669 Similar to a Remark.
3672 \begin_layout Notation*
3673 Used for the explanation of,
3678 \begin_layout Summary
3679 Do we really need to tell you?
3683 \begin_layout Acknowledgement*
3687 \begin_layout Conclusion*
3688 Sometimes used at the end of a long train of argument.
3689 \change_deleted 564990737 1672345729
3695 \change_deleted 564990737 1672345638
3696 Used in a way similar to Proposition,
3697 though perhaps lower on the scale.
3698 \change_inserted 564990737 1672345720
3702 \begin_layout Assumption*
3704 \change_inserted 564990737 1672345721
3708 \begin_layout Question*
3710 \change_inserted 564990737 1672345721
3714 \begin_layout Standard
3716 \change_inserted 564990737 1672345721
3717 There are ten more Maths modules available including several offering options ordered on
3719 (Numbered by Type \SpecialChar ldots
3727 \begin_layout Standard
3729 the AMS classes automatically provide the AMS \SpecialChar LaTeX
3730 and AMS fonts packages.
3731 They need to be available on your system in order to use these environments.
3734 \begin_layout Subsection
3736 \change_inserted 564990737 1671383236
3737 \begin_inset CommandInset label
3739 name "subsec:Extra-font-sizes"
3746 \begin_layout Standard
3748 \change_inserted 564990737 1671383236
3749 The “Extra font sizes” collection provides the document classes
3752 \begin_inset space \thinspace{}
3755 (with extra font sizes)
3761 \begin_inset space \thinspace{}
3764 (with extra font sizes)
3770 \begin_inset space \thinspace{}
3773 (with extra font sizes)
3778 \begin_inset space \thinspace{}
3781 (with extra font sizes)
3801 document classes respectively but offer the additional
3807 \begin_inset space ~
3820 ocument\SpecialChar menuseparator
3825 ettings\SpecialChar menuseparator
3831 \begin_layout Subsection
3833 \change_inserted 564990737 1671383236
3837 \begin_layout Standard
3839 \change_inserted 564990737 1671383236
3840 The document classes
3843 \begin_inset space \thinspace{}
3851 \begin_inset space \thinspace{}
3866 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3870 \begin_layout Subsection
3872 \change_inserted 564990737 1671383236
3873 \begin_inset CommandInset label
3875 name "subsec:Japanese"
3882 \begin_layout Standard
3884 \change_inserted 564990737 1671383236
3885 The document classes
3886 \change_inserted -712698321 1673089024
3890 \change_deleted -712698321 1673089025
3892 \change_inserted -712698321 1673089025
3894 \change_inserted 564990737 1671383236
3896 \begin_inset space \thinspace{}
3900 \change_deleted -712698321 1673089027
3902 \change_inserted 564990737 1671383236
3909 \change_deleted -712698321 1673089041
3911 \change_inserted -712698321 1673089041
3913 \change_inserted 564990737 1671383236
3915 \begin_inset space \thinspace{}
3919 \change_deleted -712698321 1673089044
3921 \change_inserted 564990737 1671383236
3922 Standard Class Vertical Writing)
3926 \change_deleted -712698321 1673089041
3930 \begin_inset space \thinspace{}
3933 (Japanese Standard Class)
3934 \change_inserted -712698321 1673088992
3935 Japanese Article (Standard Class)
3936 \change_inserted 564990737 1671383236
3941 \change_inserted -712698321 1673089053
3945 \change_deleted -712698321 1673089053
3947 \change_inserted -712698321 1673089064
3949 \change_inserted 564990737 1671383236
3951 \begin_inset space \thinspace{}
3955 \change_deleted -712698321 1673089067
3957 \change_inserted 564990737 1671383236
3964 \change_inserted -712698321 1673089073
3966 \change_deleted -712698321 1673089270
3968 \change_inserted 564990737 1671383236
3970 \begin_inset space \thinspace{}
3974 \change_deleted -712698321 1673089077
3976 \change_inserted 564990737 1671383236
3977 Standard Class Vertical Writing)
3981 \change_deleted -712698321 1673089083
3985 \change_inserted -712698321 1673089083
3987 \change_inserted 564990737 1671383236
3989 \begin_inset space \thinspace{}
3993 \change_deleted -712698321 1673089087
3995 \change_inserted 564990737 1671383236
4000 \change_inserted -712698321 1673089094
4004 \change_deleted -712698321 1673089094
4006 \change_inserted -712698321 1673089094
4008 \change_inserted 564990737 1671383236
4010 \begin_inset space \thinspace{}
4014 \change_deleted -712698321 1673089097
4016 \change_inserted 564990737 1671383236
4020 \change_deleted -712698321 1673089104
4024 \change_inserted -712698321 1673089104
4026 \change_inserted 564990737 1671383236
4028 \begin_inset space \thinspace{}
4032 \change_deleted -712698321 1673089107
4034 \change_inserted 564990737 1671383236
4037 provide document classes for the Japanese language.
4040 \begin_layout Subsection
4042 \change_inserted 564990737 1672429136
4043 \begin_inset CommandInset label
4045 name "subsec:KOMA-Script"
4052 \begin_layout Standard
4054 \change_inserted 564990737 1672429136
4064 and the \SpecialChar LyX
4066 \change_deleted 564990737 1672429136
4070 \begin_layout Standard
4072 \change_deleted 564990737 1672429136
4080 \begin_layout Subsubsection
4082 \change_inserted 564990737 1672429161
4086 \begin_layout Standard
4088 \change_inserted 564990737 1672429162
4089 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
4090 it was formally launched with the addition of a letter class in 1994.
4092 a second letter class has been added.
4093 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.
4099 \begin_layout Standard
4100 The \SpecialChar LyX
4102 \change_deleted -712698321 1673089779
4105 article (koma-script)
4106 \change_inserted -712698321 1673089784
4113 \change_deleted -712698321 1673089790
4116 report (koma-script)
4117 \change_inserted -712698321 1673089794
4124 \change_deleted -712698321 1673089790
4132 \change_inserted -712698321 1673089771
4139 \change_inserted -712698321 1673089799
4143 \change_deleted -712698321 1673089802
4145 \change_inserted -712698321 1673089802
4149 \change_deleted -712698321 1673089811
4158 correspond to the \SpecialChar LaTeX
4180 \begin_inset space ~
4183 of the Koma-Script family.
4184 They are replacements for the standard document classes
4204 and fit better to European typography conventions in a number of points.
4207 \begin_layout Itemize
4209 \change_deleted 564990737 1672429262
4210 Standard character size is
4211 \change_inserted 564990737 1672429263
4212 The base character sizes when you select a KOMA-Script class are
4215 \change_deleted -712698321 1673089877
4218 article (koma-script)
4219 \change_inserted -712698321 1673089877
4226 \change_deleted -712698321 1673089886
4229 report (koma-script)
4230 \change_inserted -712698321 1673089886
4237 \change_deleted -712698321 1673089893
4241 \change_inserted -712698321 1673089893
4243 \change_deleted 564990737 1672429267
4250 \change_deleted -712698321 1673089903
4253 letter (koma-script)
4254 \change_inserted -712698321 1673089903
4262 \begin_layout Itemize
4264 labels of the description environment,
4265 and a number of elements of the
4266 \change_deleted -712698321 1673089925
4269 letter (koma-script)
4270 \change_inserted -712698321 1673089925
4275 document class are set in a bold sans serif font.
4279 \begin_layout Plain Layout
4280 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
4281 especially in the appearance of headings.
4283 the ec bold sans serif fonts look a bit thin.
4284 Here the \SpecialChar LaTeX
4293 helps to produce the
4294 \begin_inset Quotes eld
4298 \begin_inset Quotes erd
4301 appearance when using the ec fonts.
4306 The numbering of chapter headings is made in the same way as the numbering of section headings,
4307 that is without the extra line
4308 \begin_inset Quotes eld
4311 Chapter\SpecialChar ldots
4313 \begin_inset Quotes erd
4318 the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
4319 to be entered in the field
4322 \begin_inset space ~
4329 Layout\SpecialChar menuseparator
4336 \begin_layout Itemize
4338 \change_deleted 564990737 1672429310
4339 The main means in the Koma-Script document classes to design the type area are the options
4347 (in \SpecialChar LyX
4348 to be entered in the extra class options field in the dialog
4350 Document\SpecialChar menuseparator
4354 They make a clearer modification of page margins possible as do the options of the dialog
4356 Document\SpecialChar menuseparator
4361 \change_inserted 564990737 1672429310
4362 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.
4363 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.
4364 You can change the sizes of the margins by changing the factor by which the page is divided into strips;
4365 the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
4370 \begin_layout Standard
4372 \change_inserted 564990737 1672429310
4373 Whatever the factor,
4374 two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
4375 leaving a text area occupying around half the page.
4376 Since most two-sided documents have a binding,
4377 this can make the inner margins appear too narrow;
4378 so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
4382 \begin_layout Standard
4384 \change_inserted 564990737 1672429310
4385 The main means in the Koma-Script document classes to design the type area are the options
4395 Document\SpecialChar menuseparator
4396 Settings\SpecialChar menuseparator
4397 Document Class\SpecialChar menuseparator
4398 Class Options\SpecialChar menuseparator
4405 \begin_layout Standard
4407 \change_inserted 564990737 1672429310
4409 the binding correction is 7.5mm which is added in the form
4416 \begin_inset space ~
4419 options\SpecialChar menuseparator
4427 To change the factor to 11,
4433 to the comma separated list of entries in the
4444 \begin_inset space ~
4450 If you want the default value of this factor for a page size other than A4,
4458 \begin_layout Standard
4460 \change_inserted 564990737 1672429310
4461 To use the circle method of calculating the page layout,
4472 \begin_layout Itemize
4473 The \SpecialChar LaTeX
4474 document classes of the Koma-Script family define a number of additional commands.
4475 Those part of it which makes sense in \SpecialChar LyX
4476 is implemented in corresponding paragraph types.
4479 \begin_layout Standard
4480 Detailed descriptions of the \SpecialChar LaTeX
4481 document classes of the Koma-Script family can be found in the Koma-Script documentation
4492 \begin_layout Subsubsection
4494 \change_inserted 564990737 1672429358
4497 \begin_inset CommandInset label
4499 name "subsec:article-(KOMA-Script),-report"
4504 \change_deleted -712698321 1673090826
4507 article (KOMA-Script)
4508 \change_inserted -712698321 1673090826
4512 \change_inserted 564990737 1672429358
4517 \change_deleted -712698321 1673090830
4518 report (KOMA-Script)
4519 \change_inserted -712698321 1673090840
4523 \change_inserted 564990737 1672429358
4528 \change_deleted -712698321 1673090835
4530 \change_inserted -712698321 1673090844
4534 \change_deleted 564990737 1672429367
4537 article (koma-script),
4538 report (koma-script),
4539 and book (koma-script)
4544 \begin_layout Standard
4545 The document classes
4546 \change_deleted -712698321 1673090858
4549 article (koma-script)
4550 \change_inserted -712698321 1673090858
4557 \change_deleted -712698321 1673090862
4560 report (koma-script)
4561 \change_inserted -712698321 1673090869
4568 \change_deleted -712698321 1673090866
4576 \change_inserted -712698321 1673090874
4581 are implemented in the layout files
4597 They contain all the paragraph types of the corresponding standard document classes
4614 with the exception of the \SpecialChar LyX
4620 which is replaced by the new
4624 -type having the same functionality.
4629 -Type there is a number of new paragraph types added.
4636 letter (koma-script)
4641 \begin_layout Itemize
4664 additionally inserting an entry in the table of contents.
4673 are not contained in
4675 article (koma-script)
4680 \begin_layout Itemize
4701 additionally clearing running heads.
4708 article (koma-script)
4714 \begin_layout Plain Layout
4727 report (koma-script)
4730 but since this is identical to
4735 is has not been implemented in \SpecialChar LyX
4744 \begin_layout Itemize
4750 generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
4753 \begin_layout Itemize
4762 are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
4763 you might want to place table captions always above the table).
4764 You can also use the class option
4782 You need at least Koma-Script version 2.8q to use this.
4785 \begin_layout Itemize
4791 can be used to set a bonmot,
4793 \begin_inset space \thinspace{}
4797 \begin_inset space \space{}
4800 at the beginning of a chapter.
4801 If you use the optional argument (
4803 Insert\SpecialChar menuseparator
4805 \begin_inset space ~
4811 you can insert the dictum's author there.
4812 Dictum and author are separated by a line.
4813 You need at least Koma-Script version 2.8q to use this.
4820 article (koma-script)
4825 \begin_layout Standard
4826 The following types,
4827 together with the standard types
4842 form the title area of the document.
4843 They must be entered ahead of the first
4844 \begin_inset Quotes eld
4848 \begin_inset Quotes erd
4855 \begin_layout Plain Layout
4856 The corresponding \SpecialChar LaTeX
4857 commands must appear before the
4868 When such a type is used more than once,
4869 the latter usage overwrites the former one,
4871 for every type only the latest usage is valid.
4872 The order of the different types however has,
4888 no effect on the appearance of the produced document.
4891 \begin_layout Itemize
4897 produces a centered paragraph above the ordinary title (
4911 ) for the subject of the document.
4914 \begin_layout Itemize
4920 produces a centered paragraph below the ordinary title (
4934 ) for the publishers' name.
4937 \begin_layout Itemize
4945 report (koma-script)
4951 produces a centered paragraph on its own page behind the title page,
4954 article (koma-script)
4956 produces a centered paragraph below the ordinary title (
4978 \begin_layout Itemize
4984 produces a left aligned paragraph above the ordinary title (
5003 ) for a document`s head.
5006 \begin_layout Itemize
5012 produces in a double-sided print in
5014 report (koma-script)
5020 a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
5022 article (koma-script)
5027 \begin_layout Itemize
5033 produces in a double-sided print in
5035 report (koma-script)
5041 a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
5043 article (koma-script)
5048 \begin_layout Itemize
5055 \begin_inset Quotes eld
5059 \begin_inset Quotes erd
5062 page ahead of the actual document containing a paragraph without special formatting.
5065 \begin_layout Standard
5067 \change_inserted 564990737 1672429680
5068 KOMA-Script offers a wide range of
5075 \begin_inset space ~
5085 ocument\SpecialChar menuseparator
5090 ettings\SpecialChar menuseparator
5092 \begin_inset space ~
5097 dialog which you can apply to the whole document,
5101 \begin_layout Description
5103 \change_inserted 564990737 1672429680
5110 which produces a PDF with a small black box at the end any line in which a formatting error occurs;
5111 the default setting is
5116 \begin_layout Description
5118 \change_inserted 564990737 1672429680
5125 which may take the values
5139 the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
5142 \begin_layout Description
5144 \change_inserted 564990737 1672429680
5151 which may take the values
5165 the first leaves it up to KOMA-Script to add periods after chapter,
5168 the second forces the addition of periods and third suppresses them
5171 \begin_layout Standard
5173 \change_inserted 564990737 1672429680
5174 and the math options:
5177 \begin_layout Description
5179 \change_inserted 564990737 1672429680
5186 which causes equations to be numbered on the left rather than on the right,
5190 \begin_layout Description
5192 \change_inserted 564990737 1672429680
5199 which causes equations to be left justified rather than centered.
5202 \begin_layout Standard
5204 \change_inserted 564990737 1672429680
5205 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
5206 commands and packages;
5208 if you want your captions in bold add
5211 \begin_layout Standard
5213 \change_inserted 564990737 1672429680
5218 setkomafont{captionlabel}{
5223 \begin_layout Standard
5225 \change_inserted 564990737 1672429680
5231 ocument\SpecialChar menuseparator
5238 \SpecialChar menuseparator
5243 \begin_inset space ~
5248 ) and the problem is solved.
5251 \begin_layout Standard
5253 \change_inserted 564990737 1672429680
5254 If you are writing a book,
5255 it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
5256 If you use the Chapter* environment,
5257 your Foreword and Preface will not appear in the Table of Contents;
5258 to make them to appear in the Table of contents,
5259 you need to use Chapter environments and add the \SpecialChar TeX
5263 \begin_layout Standard
5265 \change_inserted 564990737 1672429680
5273 \begin_layout Standard
5275 \change_inserted 564990737 1672429680
5276 at the very start of the book (not in the \SpecialChar LaTeX
5280 \begin_layout Standard
5282 \change_inserted 564990737 1672429680
5290 \begin_layout Standard
5292 \change_inserted 564990737 1672429680
5293 before the first chapter of the body of the text.
5295 \change_inserted -712698321 1673092640
5304 \begin_layout Standard
5306 \change_inserted 564990737 1672429680
5307 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
5312 \begin_layout Plain Layout
5314 \change_inserted 564990737 1672429680
5315 Appendices are normally “numbered” with letters.
5320 If you use the Chapter* environment,
5321 they will not appear in the Table of Contents;
5322 so add the \SpecialChar TeX
5326 \begin_layout Standard
5328 \change_inserted 564990737 1672429680
5336 \begin_layout Standard
5338 \change_inserted 564990737 1672429682
5339 before the first of these headings and use the Chapter environment.
5340 These commands will have no effect on the numbering in \SpecialChar LyX
5342 only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
5345 \begin_layout Standard
5346 The layout files for the document classes
5348 article (koma-script)
5353 report (koma-script)
5365 This is thought of as a place to define your own types.
5370 in your personal layout directory and edit the file!
5371 \change_deleted 564990737 1672430255
5375 \begin_layout Standard
5377 \change_deleted 564990737 1672430255
5378 letter (koma-script)
5381 \begin_layout Description
5383 \change_deleted 564990737 1672429749
5385 This section discusses the obsolete
5387 KOMA-Script-Letter (v.
5388 \begin_inset space ~
5394 which is not even included anymore in recent KOMA releases.
5395 Please refer to the next section for the current KOMA-Script-Letter class (v.
5396 \begin_inset space ~
5402 \begin_layout Standard
5405 \change_deleted 564990737 1672429749
5408 letter (koma-script)
5410 is implemented in the layout file
5415 It contains all the paragraph types of the corresponding standard document class
5421 with the exception of the \SpecialChar LyX
5436 which is replaced by the new
5443 in contrast to the standard document class,
5466 there are a number of new letter specific types.
5469 \begin_layout Standard
5471 \change_deleted 564990737 1672429749
5472 The appearance of the letter produced by this document class can be controlled by a number of \SpecialChar LaTeX
5474 which you can put in the \SpecialChar LaTeX
5479 \begin_layout Plain Layout
5481 the standard appearance of the letter`s heading,
5482 consisting of name and address,
5483 is quite self-willed.
5485 \begin_inset Quotes eld
5489 \begin_inset Quotes erd
5492 heading is produced by the following \SpecialChar LaTeX
5493 commands in the preamble:
5496 \begin_layout LyX-Code
5506 \begin_layout LyX-Code
5522 \begin_layout LyX-Code
5532 \begin_layout LyX-Code
5552 A detailed German description of such \SpecialChar LaTeX
5553 commands can be found in the Koma-Script documentation
5559 the letter's author can produce his personal letter layout.
5562 \begin_layout Standard
5564 \change_deleted 564990737 1672429749
5573 define the beginning of the letter and must be used in every letter.
5574 To emphasize them in the \SpecialChar LyX
5576 they are marked with the letter
5586 \begin_inset space ~
5590 It is possible to write any number of letters in one file.
5595 type produces a new letter using the same addressee and a
5599 type produces a new addressee.
5619 are ordinary paragraph types and can also be used several times in one and the same letter.
5622 \begin_layout Itemize
5624 \change_deleted 564990737 1672429749
5630 produces a paragraph for the addressee and implicitly defines the beginning of the letter.
5633 \begin_layout Itemize
5635 \change_deleted 564990737 1672429749
5641 produces a paragraph for the form of address and implicitly produces a new letter.
5644 \begin_layout Itemize
5646 \change_deleted 564990737 1672429749
5652 produces a paragraph for a close.
5655 \begin_layout Itemize
5657 \change_deleted 564990737 1672429749
5663 produces a paragraph for a postscript.
5666 \begin_layout Itemize
5668 \change_deleted 564990737 1672429749
5674 produces a paragraph for a distribution list.
5677 \begin_layout Itemize
5679 \change_deleted 564990737 1672429749
5685 produces a paragraph for enclosures.
5688 \begin_layout Standard
5690 \change_deleted 564990737 1672429749
5740 are input types provided with a label to enter information,
5741 which will be processed by the document class.
5745 \begin_layout Plain Layout
5746 It could be seen as a matter of inconsequence,
5755 described above are not such input types as well.
5756 Because of the special meaning of those types,
5758 I have implemented them as ordinary paragraph types with a one letter mark in the left margin.
5760 it would affect my feeling of symmetry,
5769 type had such a serious different appearance.
5774 The types must be used ahead of the corresponding
5781 \begin_layout Standard
5783 \change_deleted 564990737 1672429749
5784 An implementation of these types in a WYSIWYG fashion does not seem to make sense,
5785 because the real appearance of the produced letter does not only depend on the usage of the particular type,
5786 but also on other factors.
5788 a signature entered in the
5792 type will in the standard behavior appear in the produced letter only,
5793 when in the same letter also a
5798 The entered value of the
5802 type will in the standard behavior not appear in the produced letter at all.
5803 The possibility to design the letter`s heading freely is already indicated in a footnote above.
5806 \begin_layout Standard
5808 \change_deleted 564990737 1672429749
5809 The input types can also be used as empty paragraphs.
5811 \begin_inset space \thinspace{}
5815 \begin_inset space \space{}
5827 type is not used at all,
5828 in the standard behavior the value of the
5832 type is used as signature,
5838 no signature value is defined.
5841 \begin_layout Standard
5843 \change_deleted 564990737 1672429749
5844 By using the input types it is possible to write a letter template,
5845 containing filled input types with your personal dates (name,
5847 etc.) and empty input types for other dates you want to enter.
5850 \begin_layout Itemize
5852 \change_deleted 564990737 1672429749
5859 in the standard behavior appears as a centered paragraph in small caps in the letter`s heading.
5862 \begin_layout Itemize
5864 \change_deleted 564990737 1672429749
5871 in the standard behavior appears below the
5885 type appears instead.
5888 \begin_layout Itemize
5890 \change_deleted 564990737 1672429749
5897 in the standard behavior appears in a centered paragraph in the letter`s heading below the sender's name.
5900 \begin_layout Itemize
5902 \change_deleted 564990737 1672429749
5908 sender's telephone number,
5909 in the standard behavior only sets the \SpecialChar LaTeX
5919 \begin_layout Itemize
5921 \change_deleted 564990737 1672429749
5927 place of the letter`s making.
5930 \begin_layout Itemize
5932 \change_deleted 564990737 1672429749
5938 date of the letter`s making.
5948 in the standard behavior,
5949 produce the place and the date in a right-aligned line below the addressee's field.
5955 neither place nor date appear,
5956 independent of the value of the
5966 the date of the letter `s production is used.
5969 \begin_layout Itemize
5971 \change_deleted 564990737 1672429749
5977 sender`s back address,
5978 in the standard behavior appears above the addressee's field in a small sans serif font.
5981 \begin_layout Itemize
5983 \change_deleted 564990737 1672429749
5989 special mail information,
5990 in the standard behavior appears underlined above the addressee's field below the back address.
5993 \begin_layout Itemize
5995 \change_deleted 564990737 1672429749
6001 additional information,
6002 in the standard behavior appears on right side below the addressee`s field.
6005 \begin_layout Itemize
6007 \change_deleted 564990737 1672429749
6014 in the standard behavior appears in a big,
6016 sans serif font above the subject.
6019 \begin_layout Itemize
6021 \change_deleted 564990737 1672429749
6027 the letter's subject,
6028 in the standard behavior appears in a bold font above the
6035 \begin_layout Standard
6037 \change_deleted 564990737 1672429749
6062 produce a business letter like line above the
6066 line containing the fields
6067 \begin_inset Quotes eld
6071 \begin_inset Quotes erd
6076 \begin_inset Quotes eld
6080 \begin_inset Quotes erd
6085 \begin_inset Quotes eld
6089 \begin_inset Quotes erd
6094 \begin_inset Quotes eld
6098 \begin_inset Quotes erd
6103 \begin_inset Quotes eld
6107 \begin_inset Quotes erd
6112 \begin_inset Quotes eld
6116 \begin_inset Quotes erd
6127 \begin_inset Quotes eld
6130 business letter types
6131 \begin_inset Quotes erd
6139 type however does not appear,
6140 but only the \SpecialChar LaTeX
6148 The ordinary output of place and date in a right-aligned line below the addressee`s field is suppressed.
6149 The types are implemented as input types provided with a label and must be used ahead of the corresponding
6156 \begin_layout Itemize
6158 \change_deleted 564990737 1672429749
6167 \begin_layout Itemize
6169 \change_deleted 564990737 1672429749
6178 \begin_layout Itemize
6180 \change_deleted 564990737 1672429749
6189 \begin_layout Itemize
6191 \change_deleted 564990737 1672429749
6200 \begin_layout Itemize
6202 \change_deleted 564990737 1672429749
6213 \begin_layout Subsubsection
6215 \change_deleted 564990737 1672429773
6216 The new letter class:
6217 letter (koma-script v.2)
6218 \change_inserted 564990737 1672429774
6220 \begin_inset CommandInset label
6222 name "subsec:The-new-letter"
6226 The new letter class:
6228 \change_inserted -712698321 1673092709
6230 \change_deleted -712698321 1673092710
6232 \change_inserted -712698321 1673092710
6234 \change_inserted 564990737 1672429774
6236 \change_deleted -712698321 1673092713
6238 \change_inserted -712698321 1673092714
6240 \change_inserted 564990737 1672429774
6243 \change_inserted -712698321 1673092715
6245 \change_inserted 564990737 1672429774
6251 \begin_layout Standard
6257 \begin_layout Standard
6258 \begin_inset VSpace medskip
6264 \begin_layout Standard
6266 Koma-Script version 2.8 has introduced a new letter class
6270 which supersedes the now unsupported
6276 on the \SpecialChar LaTeX
6278 a completely new interface and is not compatible with the old class.
6282 though it is recommended you use the new class.
6285 \begin_layout Standard
6286 This class covers the same functionality as
6288 letter (koma-script),
6296 (receiver's address,
6316 will start a new letter (i.
6317 \begin_inset space \thinspace{}
6321 \begin_inset space \space{}
6324 you can write several letters per document).
6325 New elements are sender's
6344 and the possibility to use a
6350 Insert\SpecialChar menuseparator
6356 \begin_layout Standard
6357 The biggest improvement is,
6359 that the letter's layout is configurable to meet almost any needs.
6360 This can be done via the preamble or with a special style file (Letter Class Option,
6366 that will be read in as a class option.
6370 \begin_layout Plain Layout
6371 The KOMA package comes with some default
6382 file that follows german typesetting rules,
6387 that provides the default layout of the old
6392 The latter can be loaded with the class option
6399 Layout\SpecialChar menuseparator
6400 Document\SpecialChar menuseparator
6409 \change_deleted 564990737 1671617922
6417 \change_deleted 564990737 1671617938
6418 that is included in \SpecialChar LyX
6420 \change_inserted 564990737 1671617997
6426 ile\SpecialChar menuseparator
6428 \begin_inset space ~
6436 \begin_inset space ~
6439 Template\SpecialChar menuseparator
6440 Letters\SpecialChar menuseparator
6441 KOMA-Script Letter (V.2)
6446 A detailed description is to be found in the Koma-Script documentation (
6453 \begin_layout Subsubsection
6457 \begin_layout Standard
6458 Visualizing the Koma-Script document classes in \SpecialChar LyX
6460 the \SpecialChar LyX
6461 internals cause some problems.
6464 \begin_layout Itemize
6465 The chapter number of a
6469 type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
6470 The cause for that is the \SpecialChar LyX
6471 internal behavior for the labeltype
6478 \begin_layout Itemize
6479 The headings of the types
6488 \begin_inset Quotes eld
6492 \begin_inset Quotes erd
6497 but not in the \SpecialChar LyX
6500 Document\SpecialChar menuseparator
6502 \begin_inset space ~
6506 \begin_inset space ~
6514 \begin_layout Itemize
6519 document class appear in a skip separation mode,
6521 This is the standard behavior,
6522 no special \SpecialChar LaTeX
6523 commands are needed for that.
6526 Document\SpecialChar menuseparator
6529 dialog the corresponding radio button indicates
6538 value always has the effect that extra \SpecialChar LaTeX
6539 commands are inserted in the document to produce the gap,
6540 which is not what is wanted in this case.
6543 \begin_layout Subsection
6545 \change_inserted 564990737 1672743555
6546 \begin_inset CommandInset label
6548 name "subsec:Polish-M.W.collection"
6553 \begin_inset space \thinspace{}
6557 \begin_inset space \space{}
6561 \change_deleted 564990737 1670924933
6563 book (mwbk) and report (mwrep)
6564 \begin_inset Argument status
6567 \begin_layout Plain Layout
6582 \begin_layout Standard
6588 \begin_layout Standard
6589 The \SpecialChar LyX
6591 \change_deleted -712698321 1673094342
6595 \change_inserted -712698321 1673094343
6596 Polish Article (MW Bundle)
6602 \change_deleted -712698321 1673094349
6606 \change_inserted -712698321 1673094356
6607 Polish Report (MW Bundle)
6612 \change_deleted -712698321 1673094352
6620 \change_inserted -712698321 1673094359
6621 Polish Book (MW Bundle)
6625 correspond to the \SpecialChar LaTeX
6641 They are replacements for the standard document classes
6656 and fit better to Polish typography conventions in a number of points.
6660 \begin_layout Standard
6664 \begin_layout Itemize
6665 Unnumbered titles (with star,
6667 \begin_inset space \thinspace{}
6671 \begin_inset space \space{}
6678 ) are added into table of contents,
6681 \begin_layout Itemize
6682 Additional page styles:
6686 \begin_layout Description
6687 uheadings header with separated lines,
6690 \begin_layout Description
6691 myheadings custom header,
6692 contents headers via commands:
6708 \begin_layout Description
6709 myuheadings custom header with separated lines,
6712 \begin_layout Description
6713 outer page number is placed on outer side of page
6717 \begin_layout Itemize
6722 \begin_layout Description
6723 rmheadings serif titles —
6727 \begin_layout Description
6728 sfheadings sansserif titles,
6731 \begin_layout Description
6732 authortitle on title page first placed is author next title —
6736 \begin_layout Description
6737 titleauthor on title page first placed is title next author,
6740 \begin_layout Description
6741 withmarginpar reserve place on page for margins.
6745 \begin_layout Subsection
6747 \change_inserted 564990737 1672652245
6751 \begin_layout Standard
6753 \change_inserted 564990737 1672652245
6754 The document classes
6755 \change_deleted -712698321 1673094404
6759 \begin_inset space \thinspace{}
6763 \change_inserted -712698321 1673094404
6765 \change_inserted 564990737 1672652245
6769 \change_deleted -712698321 1673094408
6773 \begin_inset space \thinspace{}
6777 \change_inserted -712698321 1673094411
6779 \change_inserted 564990737 1672652245
6791 Detailed information about these document classes can be found in
6793 File\SpecialChar menuseparator
6794 Open Example\SpecialChar menuseparator
6795 Books\SpecialChar menuseparator
6800 File\SpecialChar menuseparator
6801 Open Example\SpecialChar menuseparator
6802 Handouts\SpecialChar menuseparator
6808 \begin_layout Section
6810 \change_inserted 564990737 1670439534
6814 \begin_layout Standard
6816 \change_inserted 564990737 1670794710
6817 See also the document classes in the Collections (section
6818 \begin_inset space ~
6822 \begin_inset CommandInset ref
6824 reference "sec:Collections"
6832 \begin_layout Subsection
6834 \change_deleted -712698321 1673095198
6836 \change_inserted -712698321 1673095198
6837 Astronomy & Astrophysics
6838 \change_inserted 564990737 1670794716
6842 \begin_layout Standard
6844 \change_inserted 564990737 1670794716
6850 updated by the \SpecialChar LyX
6854 \begin_layout Subsubsection
6856 \change_inserted 564990737 1670794716
6860 \begin_layout Standard
6862 \change_inserted 564990737 1670794716
6863 This section describes how \SpecialChar LyX
6864 can be used to write articles for submission to the scientific journal
6867 \change_deleted -712698321 1673095254
6869 \change_inserted -712698321 1673095254
6871 \change_inserted 564990737 1670794716
6875 \begin_inset CommandInset href
6878 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6883 ) using Version 9.1 of the document class
6888 information about it is available at
6889 \begin_inset Flex URL
6892 \begin_layout Plain Layout
6894 \change_inserted 564990737 1670794716
6896 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
6906 \begin_layout Standard
6908 \change_inserted 564990737 1670794716
6909 A manual comes together with the package and should be consulted before installing this document class as described in the
6911 Installing New Document Classe
6921 \begin_layout Standard
6923 \change_inserted 564990737 1670794716
6924 \begin_inset Note Greyedout
6927 \begin_layout Plain Layout
6929 \change_inserted 564990737 1670794716
6930 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
6932 That change also involved some slight changes to the style files,
6933 namely the removal of the thesaurus command.
6934 If you have an older version installed,
6936 For information about compatibility with the old (version 4) layout,
6937 please refer to the comments in
6940 Dir/layouts/aapaper.layout
6950 \begin_layout Subsubsection
6952 \change_inserted 564990737 1670794716
6956 \begin_layout Standard
6958 \change_inserted 564990737 1671617129
6959 It is recommended you start from the template in the menu
6964 ile\SpecialChar menuseparator
6966 \begin_inset space ~
6974 \begin_inset space ~
6977 Template\SpecialChar menuseparator
6978 Articles\SpecialChar menuseparator
6979 Astronomy & Astrophysics
6982 If you are not using the template,
6983 note the following settings:
6986 \begin_layout Itemize
6988 \change_inserted 564990737 1670794716
6990 \change_deleted -712698321 1673095619
6994 \change_inserted -712698321 1673095619
6995 Astronomy & Astrophysics
6996 \change_inserted 564990737 1670794716
7004 ocument\SpecialChar menuseparator
7009 ettings\SpecialChar menuseparator
7011 \begin_inset space ~
7017 that one was obvious).
7020 \begin_layout Itemize
7022 \change_inserted 564990737 1670794716
7026 \begin_inset space ~
7038 \begin_inset space ~
7049 The whole layout is done by the macros,
7050 you shouldn't change anything.
7053 \begin_layout Subsubsection
7055 \change_inserted 564990737 1670794716
7059 \begin_layout Standard
7061 \change_inserted 564990737 1670794716
7062 First thing to enter is the header information.
7064 \change_deleted -712698321 1673167006
7066 \change_inserted -712698321 1673167007
7068 \change_inserted 564990737 1670794716
7070 of which one is optional.
7074 \begin_layout Itemize
7076 \change_inserted 564990737 1670794716
7085 \begin_layout Itemize
7087 \change_inserted 564990737 1670794716
7096 \begin_layout Itemize
7098 \change_inserted 564990737 1670794716
7107 \begin_layout Itemize
7109 \change_deleted -712698321 1673167065
7113 \change_inserted -712698321 1673167065
7115 \change_inserted 564990737 1670794716
7120 \change_inserted -712698321 1673167087
7124 \begin_layout Itemize
7126 \change_inserted -712698321 1673168577
7132 Determines to whom correspondence and reprints are to be sent.
7135 \begin_layout Itemize
7137 \change_inserted -712698321 1673168590
7142 [optional] Snail mail address for contacts.
7143 \change_inserted 564990737 1670794716
7147 \begin_layout Itemize
7149 \change_inserted 564990737 1670794716
7163 \begin_layout Standard
7165 \change_inserted -712698321 1673168612
7166 There is no need to issue the
7173 this is done automatically by \SpecialChar LyX
7174 when the header is finished.
7176 \change_inserted 564990737 1670794716
7177 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
7178 just to get the best optics and meets the layout of the real document.
7181 \begin_layout Standard
7183 \change_inserted 564990737 1670794716
7184 If you want to place footnotes in the header block,
7186 \begin_inset space \thinspace{}
7190 \begin_inset space \space{}
7193 to state your present address,
7194 just use the standard footnote via the menu
7199 nsert\SpecialChar menuseparator
7208 will automagically use the term
7215 \change_inserted -712698321 1673168649
7219 \begin_layout Standard
7221 \change_inserted -712698321 1673168649
7224 Edit\SpecialChar menuseparator
7228 you'll find two insets which are relevant for the titling:
7231 \begin_layout Itemize
7233 \change_inserted -712698321 1673168649
7240 to mark corresponding author\SpecialChar breakableslash
7242 The institutes are numbered sequentially as they appear in the
7247 so you have to put a marker to each author.
7250 \begin_layout Itemize
7252 \change_inserted -712698321 1673168649
7257 to supply an email address for fast contact.
7258 \change_inserted 564990737 1670794716
7262 \begin_layout Standard
7264 \change_inserted 564990737 1670794716
7265 In addition to these topics,
7266 the macros use three additional \SpecialChar LaTeX
7267 commands that have no counterpart in \SpecialChar LyX
7271 \begin_layout Itemize
7273 \change_inserted 564990737 1670794716
7280 to separate different names for more than one author and institute,
7284 \begin_layout Itemize
7286 \change_deleted -712698321 1673168671
7293 to mark corresponding author/institute pairs.
7294 The institutes are numbered sequentially as they appear in the
7299 so you have to put a marker to each author.
7302 \begin_layout Itemize
7304 \change_deleted -712698321 1673168671
7311 to supply an email address for fast contact.
7312 \change_inserted 564990737 1670794716
7316 \begin_layout Standard
7318 \change_deleted -712698321 1673168684
7321 \change_inserted -712698321 1673168684
7323 \change_inserted 564990737 1671642374
7324 he appropriate command has to be entered as \SpecialChar TeX
7325 code in \SpecialChar LyX
7327 See the examples in the template and in
7329 File\SpecialChar menuseparator
7330 Open Example\SpecialChar menuseparator
7331 Articles\SpecialChar menuseparator
7332 Astronomy & Astrophysics
7339 \begin_layout Subsubsection
7341 \change_inserted 564990737 1670794716
7345 \begin_layout Standard
7347 \change_inserted -712698321 1673168754
7348 The abstract should immediately follow the header block.
7349 With version 5 the abstract environment was changed to a command,
7350 and there is now a restriction to only one paragraph.
7352 it should contain an entry with the keywords.
7353 This is done via the paragraph style
7358 Refer to the example paper.
7359 \change_deleted -712698321 1673168754
7360 The abstract should immediately follow the header block and must contain five tokens:
7370 \begin_layout Enumerate
7372 \change_deleted -712698321 1673168754
7377 (optional) {} leave it empty if necessary
7380 \begin_layout Enumerate
7382 \change_deleted -712698321 1673168754
7390 \begin_layout Enumerate
7392 \change_deleted -712698321 1673168754
7400 \begin_layout Enumerate
7402 \change_deleted -712698321 1673168754
7410 \begin_layout Enumerate
7412 \change_deleted -712698321 1673168754
7417 (optional) {} leave it empty if necessary
7420 \begin_layout Standard
7422 \change_deleted -712698321 1673168754
7424 This structure not shown in
7429 \change_inserted 564990737 1670794716
7433 \begin_layout Subsubsection
7435 \change_inserted 564990737 1670794716
7436 Supported environments
7439 \begin_layout Standard
7441 \change_inserted 564990737 1670794716
7442 The A&A paper layout supports the following environments for structuring your text:
7445 \begin_layout Standard
7447 \change_inserted -712698321 1673169058
7450 \begin_inset Flex Multiple Columns
7453 \begin_layout Itemize
7455 \change_inserted -712698321 1673169058
7461 \begin_layout Itemize
7463 \change_inserted -712698321 1673169058
7469 \begin_layout Itemize
7471 \change_inserted -712698321 1673169058
7477 \begin_layout Itemize
7479 \change_inserted -712698321 1673169058
7485 \begin_layout Itemize
7487 \change_inserted -712698321 1673169058
7493 \begin_layout Itemize
7495 \change_inserted -712698321 1673169058
7501 \begin_layout Itemize
7503 \change_inserted -712698321 1673169058
7509 \begin_layout Itemize
7511 \change_inserted -712698321 1673169058
7517 \begin_layout Itemize
7519 \change_inserted -712698321 1673169058
7525 \begin_layout Itemize
7527 \change_inserted -712698321 1673169058
7533 \begin_layout Itemize
7535 \change_inserted -712698321 1673169058
7541 \begin_layout Itemize
7543 \change_inserted -712698321 1673169078
7552 \change_deleted -712698321 1673169058
7556 \begin_layout Itemize
7558 \change_deleted -712698321 1673169058
7564 \begin_layout Itemize
7566 \change_deleted -712698321 1673169058
7572 \begin_layout Itemize
7574 \change_deleted -712698321 1673169058
7580 \begin_layout Itemize
7582 \change_deleted -712698321 1673169058
7588 \begin_layout Itemize
7590 \change_deleted -712698321 1673169058
7596 \begin_layout Itemize
7598 \change_deleted -712698321 1673169058
7604 \begin_layout Itemize
7606 \change_deleted -712698321 1673169058
7612 \begin_layout Itemize
7614 \change_deleted -712698321 1673169058
7620 \begin_layout Itemize
7622 \change_deleted -712698321 1673169058
7628 \begin_layout Itemize
7630 \change_deleted -712698321 1673169058
7636 \begin_layout Itemize
7638 \change_deleted -712698321 1673169058
7643 \change_inserted 564990737 1670794716
7647 \begin_layout Subsubsection
7649 \change_inserted 564990737 1670794716
7650 Commands not supported by \SpecialChar LyX
7654 \begin_layout Standard
7656 \change_inserted 564990737 1670794716
7657 Some commands are not yet supported by the
7658 \change_deleted -712698321 1673169117
7662 \change_inserted -712698321 1673169117
7663 Astronomy & Astrophysics
7664 \change_inserted 564990737 1670794716
7667 layout for \SpecialChar LyX
7669 Some have already been mentioned.
7670 For the sake of completeness,
7671 they are listed all together here:
7674 \begin_layout Itemize
7676 \change_inserted 564990737 1670794716
7684 \begin_layout Itemize
7686 \change_inserted -712698321 1673168793
7694 \begin_layout Itemize
7696 \change_inserted -712698321 1673168793
7704 \begin_layout Itemize
7706 \change_inserted -712698321 1673168793
7712 \change_deleted -712698321 1673168793
7718 \begin_layout Itemize
7720 \change_deleted -712698321 1673168793
7728 \begin_layout Itemize
7730 \change_deleted -712698321 1673168793
7738 \begin_layout Itemize
7740 \change_deleted -712698321 1673168793
7746 \change_inserted 564990737 1670794716
7750 \begin_layout Standard
7752 \change_inserted 564990737 1670794716
7753 If you want to use any of these commands,
7754 you have to enter them yourself.
7755 Do not forget to use
7761 nsert\SpecialChar menuseparator
7764 \begin_inset space ~
7772 \begin_layout Subsubsection
7774 \change_inserted 564990737 1670794716
7775 Figure and Table Floats
7778 \begin_layout Standard
7780 \change_inserted 564990737 1670794716
7782 provides support for the necessary float environments
7793 therefore we won't tell much about it here.
7797 \begin_inset space ~
7803 Just remember that tables should be left-aligned.
7805 select the table and change the alignment in
7810 dit\SpecialChar menuseparator
7816 \begin_inset space ~
7820 \change_inserted -712698321 1673169201
7826 arg "layout-paragraph"
7830 \change_inserted 564990737 1670794716
7836 \begin_layout Standard
7838 \change_inserted 564990737 1670794716
7839 There is only one special thing:
7840 the figures with a caption beside the figure.
7841 To create such a figure,
7842 you have to do the following:
7845 \begin_layout Enumerate
7847 \change_inserted 564990737 1670794716
7848 Create a wide figure float:
7854 nsert\SpecialChar menuseparator
7859 t\SpecialChar menuseparator
7864 from within the float,
7870 dit\SpecialChar menuseparator
7876 \begin_inset space ~
7887 \begin_inset space ~
7899 \begin_layout Enumerate
7901 \change_inserted 564990737 1670794716
7902 Enter your caption text.
7905 \begin_layout Enumerate
7907 \change_inserted 564990737 1670794716
7912 to move the cursor above the caption.
7915 \begin_layout Enumerate
7917 \change_inserted 564990737 1670794716
7921 \begin_layout Enumerate
7923 \change_inserted 564990737 1670794716
7924 Position the cursor after the figure and insert a horizontal fill by using the menu:
7930 nsert\SpecialChar menuseparator
7935 rmatting\SpecialChar menuseparator
7941 \begin_inset space ~
7950 dialog and select the
7962 \change_deleted -712698321 1673169720
7964 \change_inserted -712698321 1673169724
7966 \change_inserted 564990737 1670794716
7970 \begin_layout Enumerate
7972 \change_inserted 564990737 1670794716
7973 Switch to \SpecialChar LaTeX
7978 \begin_inset space ~
7986 \begin_layout Enumerate
7988 \change_inserted 564990737 1670794716
7997 Do not close the brace!
8000 \begin_layout Enumerate
8002 \change_inserted 564990737 1670794716
8003 Position the cursor behind the caption text,
8004 switch to \SpecialChar LaTeX
8005 mode and insert the closing brace:
8009 \begin_inset space ~
8021 \begin_layout Standard
8023 \change_inserted 564990737 1671642458
8025 refer to the figures in the file in
8027 File\SpecialChar menuseparator
8028 Open Example\SpecialChar menuseparator
8029 Articles\SpecialChar menuseparator
8030 Astronomy & Astrophysics
8035 \begin_layout Subsubsection
8037 \change_inserted 564990737 1670794716
8041 \begin_layout Standard
8043 \change_inserted 564990737 1670794716
8045 the paper has to be formatted in a special double-spacing layout.
8047 you have to add the option
8058 \begin_inset space ~
8068 ocument\SpecialChar menuseparator
8073 ettings\SpecialChar menuseparator
8075 \begin_inset space ~
8084 \begin_layout Subsubsection
8086 \change_inserted 564990737 1670794716
8090 \begin_layout Standard
8092 \change_inserted 564990737 1671642520
8095 File\SpecialChar menuseparator
8096 Open Example\SpecialChar menuseparator
8097 Articles\SpecialChar menuseparator
8098 Astronomy & Astrophysics
8100 was written with \SpecialChar LyX
8102 It is the example paper from the original macro package,
8108 \begin_inset CommandInset href
8111 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
8117 but translated to \SpecialChar LyX
8118 using the older unstructured abstract type.
8119 Use it for inspiration,
8120 and compare the \SpecialChar LaTeX
8125 with the \SpecialChar LyX
8129 \begin_layout Subsection
8134 \begin_layout Standard
8140 \begin_layout Subsubsection
8144 \begin_layout Standard
8146 is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
8147 the Astrophysical Journal (including the Letters and Supplement),
8148 the Astronomical Journal,
8149 and the Publications of the Astronomical Society of the Pacific.
8151 has proven to be an excellent tool for generating these documents,
8152 especially given its equation,
8154 and figure handling capabilities.
8156 requires version 5.0 (or higher) of these macros;
8158 which is the version described here,
8160 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8161 2.09 and are fundamentally incompatible with \SpecialChar LyX
8163 The AAS\SpecialChar TeX
8164 package may be downloaded from the AAS\SpecialChar TeX
8168 \begin_layout Standard
8169 \begin_inset VSpace medskip
8175 \begin_layout Standard
8177 \begin_inset Flex URL
8180 \begin_layout Plain Layout
8182 https://aas.org/aastex/aastex-downloads
8190 \begin_layout Standard
8191 \begin_inset VSpace medskip
8197 \begin_layout Standard
8198 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
8201 will not reduce the need to figure out all the AAS\SpecialChar TeX
8203 it will only reduce the drudgery of typing everything in.
8204 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8205 document conforms completely to the requirements of the journal to which you are submitting your paper.
8208 \begin_layout Subsubsection
8209 Starting a New Paper
8212 \begin_layout Standard
8213 I strongly suggest that you start with the AAS\SpecialChar TeX
8217 File\SpecialChar menuseparator
8223 \change_inserted 564990737 1671617265
8224 \SpecialChar menuseparator
8225 Articles\SpecialChar menuseparator
8226 American Astronomical Society
8227 \change_deleted 564990737 1671617310
8231 enter the new file name,
8239 This will show the most common fields found in a manuscript.
8240 Simply overwrite the existing text (including the brackets,
8245 ) with the correct information.
8246 Many of the AAS\SpecialChar TeX
8247 commands and environments can be implemented directly in \SpecialChar LyX
8250 For commands such as these,
8251 the \SpecialChar LaTeX
8252 code must be entered directly and marked as such.
8253 Such commands are referred to as \SpecialChar TeX
8256 I tried to minimize the amount of \SpecialChar TeX
8257 code needed in an AAS\SpecialChar TeX
8261 \begin_layout Subsubsection
8262 Finishing Your Paper
8265 \begin_layout Standard
8266 When the paper is finished to your satisfaction and previews/prints correctly,
8268 \begin_inset Quotes eld
8272 \begin_inset Quotes erd
8275 actions which need to be done before you submit it to the journals.
8279 \begin_layout Enumerate
8280 Export your paper as a \SpecialChar LaTeX
8283 File\SpecialChar menuseparator
8284 Export\SpecialChar menuseparator
8292 \begin_layout Enumerate
8297 file with your favorite text editor
8301 \begin_layout Enumerate
8302 remove the comment lines before the
8311 \begin_layout Enumerate
8316 usepackage...{fontenc}
8318 line if it appears (usually just after
8334 \begin_layout Enumerate
8335 remove everything between (and including) the
8348 except for any commands you specifically put into the \SpecialChar LaTeX
8349 preamble (which should appear immediately after the
8350 \begin_inset Quotes eld
8353 User specified \SpecialChar LaTeX
8355 \begin_inset Quotes erd
8366 \begin_layout Enumerate
8367 Run the resulting file through \SpecialChar LaTeX
8368 to make sure it still processes correctly.
8371 \begin_layout Enumerate
8372 Reread the journal requirements to make sure your filenames and formats are correct.
8375 \begin_layout Enumerate
8379 \begin_layout Subsubsection
8380 Comments On Specific Commands
8383 \begin_layout Standard
8384 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8386 the AAS\SpecialChar TeX
8391 ) gives a good description of each.
8392 Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
8393 So let's begin \SpecialChar ldots
8397 \begin_layout Paragraph
8398 Things that work as expected
8401 \begin_layout Standard
8402 Because they work as you might expect,
8403 I simply list them and the section they are found in:
8520 begin{thebibliography}
8530 all the cite commands and their variations (2.13.2),
8531 the generic graphicx figure commands (2.14.1),
8560 amongst other places),
8591 \begin_layout Standard
8592 The following style options also work correctly:
8618 Simply put them in the
8624 Layout\SpecialChar menuseparator
8630 \begin_layout Paragraph
8632 but require more comment
8635 \begin_layout Standard
8636 The following items work,
8637 but require a little more discussion:
8640 \begin_layout Itemize
8641 These items are reserved for use by the journal editors,
8642 but you can put them into the \SpecialChar LaTeX
8643 preamble if you feel compelled to do so:
8681 \begin_layout Itemize
8682 These items may be placed in the \SpecialChar LaTeX
8684 and are included as blanks in the template file:
8708 \begin_layout Itemize
8715 (2.3) – can only be used
8716 \begin_inset Quotes eld
8720 \begin_inset Quotes erd
8724 not in the middle of a paragraph.
8725 Use \SpecialChar TeX
8726 code if you need to embed it.
8729 \begin_layout Itemize
8736 (2.3) – will have extra {} after it.
8737 This should not cause an error.
8740 \begin_layout Itemize
8747 (2.6) – can only be used
8748 \begin_inset Quotes eld
8752 \begin_inset Quotes erd
8756 not in the middle of a paragraph.
8757 Use \SpecialChar TeX
8758 code if you need to embed it.
8761 \begin_layout Itemize
8768 (2.8) – can't insert a cross-reference tag,
8769 you must type the tag name by hand
8772 \begin_layout Itemize
8786 \begin_layout Itemize
8793 (2.9) – will have extra {} after it.
8794 This should not cause an error.
8797 \begin_layout Itemize
8804 (2.11) – will have extra {} after it.
8805 This should not cause an error.
8808 \begin_layout Itemize
8815 (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
8817 Insert\SpecialChar menuseparator
8822 \begin_inset Quotes eld
8826 \begin_inset Quotes erd
8829 inserts an optional argument of the type needed by
8836 Hopefully it will be renamed someday.
8839 \begin_layout Itemize
8852 for the catalog ID optional parameter
8855 \begin_layout Itemize
8868 for the catalog ID optional parameter
8871 \begin_layout Paragraph
8872 Things not implemented,
8873 use \SpecialChar TeX
8877 \begin_layout Standard
8889 setcounter{equation}
8892 Journal name abbreviations (2.13.4),
8935 insert it as the first element in the lefthand cell after where you want it.
8936 Don't use any of \SpecialChar LyX
8937 's rules in the table),
9012 \begin_layout Paragraph
9013 Things that cannot be implemented
9016 \begin_layout Standard
9018 at least in any meaningful sort of way,
9019 so I suggest ignoring them.
9020 They are the references environment (2.13.3),
9021 and the deluxetable environment (2.15).
9023 really need to use deluxetable,
9024 I suggest editing it in a separate file with a text editor,
9027 Insert\SpecialChar menuseparator
9029 \begin_inset space ~
9034 to include it in your \SpecialChar LyX
9037 \change_deleted 564990737 1671642564
9043 \change_inserted 564990737 1671642618
9046 File\SpecialChar menuseparator
9047 Open Example\SpecialChar menuseparator
9048 Articles\SpecialChar menuseparator
9049 American Astronomical Society
9054 \change_inserted 564990737 1671642621
9060 \begin_layout Subsubsection
9064 and Other Ruminations
9067 \begin_layout Paragraph
9068 Getting \SpecialChar LyX
9069 and AAS\SpecialChar TeX
9073 \begin_layout Standard
9074 It can be a bit tricky to get \SpecialChar LyX
9075 to recognize a new layout and document class.
9076 When all else fails,
9080 \begin_layout Enumerate
9081 Make certain that \SpecialChar LaTeX
9082 can find AAS\SpecialChar TeX
9084 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9085 distribution into a directory completely unrelated to \SpecialChar LaTeX
9086 or AAS\SpecialChar TeX
9087 and run \SpecialChar LaTeX
9095 \begin_layout Enumerate
9100 appears in \SpecialChar LyX
9108 \begin_layout Enumerate
9111 Tools\SpecialChar menuseparator
9116 then restart \SpecialChar LyX
9120 \begin_layout Enumerate
9121 Open a regular new file,
9122 not from a template.
9124 \change_deleted -712698321 1673170671
9127 \change_inserted -712698321 1673170671
9130 American Astronomical Society (AASTeX V.
9131 \begin_inset space \thinspace{}
9138 appear in the class list in
9140 Document\SpecialChar menuseparator
9146 \begin_layout Standard
9147 If you get a warning from an existing AAS\SpecialChar TeX
9148 document about not being able to find the AAS\SpecialChar TeX
9149 layout or a message about
9150 \begin_inset Quotes eld
9153 You should not mix title layouts with normal ones
9154 \begin_inset Quotes erd
9158 things haven't been installed correctly.
9161 \begin_layout Paragraph
9163 error processing a table
9166 \begin_layout Standard
9170 attempts to center the table caption/title.
9171 This seems to produce a bad interaction in AAS\SpecialChar TeX
9172 so you should click somewhere in the caption/title,
9175 Edit\SpecialChar menuseparator
9177 \begin_inset space ~
9192 This took care of it for me.
9195 \begin_layout Paragraph
9199 \begin_layout Standard
9202 \change_inserted -712698321 1673170733
9206 \begin_layout Enumerate
9208 \change_deleted -712698321 1673170736
9211 I have noticed some funny spacing in the reference entries in the text.
9212 When you enter the bibliography item data,
9217 space between the last author and the parenthesis setting off the year;
9221 \begin_inset space \thinspace{}
9225 \begin_inset space \space{}
9241 \change_deleted -712698321 1673170741
9243 \change_inserted -712698321 1673170741
9247 \begin_layout Enumerate
9248 Entering the references at all is not obvious.
9249 The easiest thing is to start typing your first reference at the end of the document,
9250 then mark it as type
9255 That will put a small gray box in front of what you just typed.
9256 Click on the box to fill in the rest of the information.
9258 go to the end of an existing reference and press return.
9259 That will create a new line with its own box,
9263 \begin_layout Paragraph
9267 \begin_layout Standard
9268 Even though AAS\SpecialChar TeX
9269 provides its own figure commands (
9277 I much prefer \SpecialChar LaTeX
9278 's standard figure commands (with the default graphicx).
9287 \begin_inset space ~
9290 commands as \SpecialChar TeX
9291 code into a Figure Float box if you desire,
9292 but I never have much luck getting the layout right.
9293 With the standard graphics,
9299 usepackage{graphicx}
9301 command into the \SpecialChar LaTeX
9302 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9304 interspersing the figures in the text.
9305 I believe ApJ accepts figures exactly this way now;
9306 AJ might still use the
9307 \begin_inset Quotes eld
9310 stack everything at the end
9311 \begin_inset Quotes erd
9317 \begin_layout Paragraph
9318 Things I could have done,
9322 \begin_layout Standard
9324 \begin_inset Quotes eld
9328 \begin_inset Quotes erd
9331 things I could have implemented,
9334 I saw no point in double-spacing the text in the \SpecialChar LyX
9336 even though it is double-spaced in the paper manuscript.
9338 I chose not to make separate layouts for the preprint and preprint2 styles.
9339 Since I assume you will spend most of your time in the plain manuscript mode anyway,
9340 I decided not to chew up more disk space with this.
9344 \begin_layout Subsubsection
9348 \begin_layout Standard
9349 Your mileage may vary.
9350 I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
9352 the last 2% was the \SpecialChar LaTeX
9353 post-processing and a few cleanups.
9354 I have had no trouble with the submission process,
9355 and I'm sure the journals were never aware that there might be a difference.
9357 go forth and publish!
9360 \begin_layout Subsection
9362 \change_inserted 564990737 1671442131
9366 \begin_layout Standard
9368 \change_inserted 564990737 1671642768
9370 \change_deleted -712698321 1673171415
9374 \begin_inset space \thinspace{}
9378 \change_inserted 564990737 1671642768
9380 \change_deleted -712698321 1673171417
9382 \change_inserted 564990737 1671642768
9386 \change_deleted -712698321 1673171421
9392 \change_inserted -712698321 1673171424
9394 \change_inserted 564990737 1671642768
9395 document class together with the
9396 \change_deleted -712698321 1673171428
9398 \change_inserted -712698321 1673171429
9400 \change_inserted 564990737 1671642768
9404 \change_deleted -712698321 1673171431
9406 \change_inserted 564990737 1671642768
9409 to facilitate the description of chess games.
9412 File\SpecialChar menuseparator
9413 Open Example\SpecialChar menuseparator
9414 Articles\SpecialChar menuseparator
9428 \begin_layout Subsection
9430 \change_inserted 564990737 1671042028
9434 \begin_layout Standard
9436 \change_inserted 564990737 1671617396
9438 \change_deleted -712698321 1673171640
9442 \begin_inset space \thinspace{}
9446 \change_inserted 564990737 1671617396
9448 \change_deleted -712698321 1673171643
9450 \change_inserted 564990737 1671617396
9454 \change_inserted -712698321 1673171717
9456 \change_inserted 564990737 1671617396
9460 \change_deleted -712698321 1673171720
9462 \change_inserted 564990737 1671617396
9466 \change_deleted -712698321 1673171728
9468 \change_inserted -712698321 1673171728
9471 \change_inserted 564990737 1671617396
9473 \change_inserted -712698321 1673171744
9474 for journals in the Elsevier publishing house
9475 \change_inserted 564990737 1671617396
9477 This provides the following additional environments:
9481 \begin_inset space ~
9490 \begin_inset space ~
9499 \begin_inset space ~
9520 \change_inserted -712698321 1673172045
9524 \begin_layout Standard
9526 \change_inserted 564990737 1671617396
9527 A template is available in the menu
9532 ile\SpecialChar menuseparator
9534 \begin_inset space ~
9542 \begin_inset space ~
9545 Template\SpecialChar menuseparator
9546 Articles\SpecialChar menuseparator
9550 It has been customized with further environments and contains all the information you may need.
9552 the documentation is also available from
9553 \begin_inset CommandInset href
9556 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
9564 \begin_layout Subsection
9566 \change_inserted 564990737 1671042046
9570 \begin_layout Standard
9572 \change_inserted 564990737 1671042046
9574 \change_deleted -712698321 1673172423
9578 \begin_inset space \thinspace{}
9582 \change_inserted -712698321 1673172423
9583 Paper (Standard Class)
9584 \change_deleted -712698321 1673172423
9586 \change_inserted 564990737 1671042046
9589 provides an alternative to the
9590 \change_deleted -712698321 1673172092
9594 \change_inserted -712698321 1673172435
9597 Article (Standard Class)
9598 \change_inserted 564990737 1671042046
9602 It provides similar functionality,
9603 but you might prefer this layout with sans serif sections,
9608 \begin_layout Subsection
9613 \begin_layout Standard
9619 \begin_layout Standard
9620 \begin_inset VSpace bigskip
9626 \begin_layout Standard
9631 \change_deleted -712698321 1673172482
9633 \begin_inset space ~
9637 \change_inserted -712698321 1673172487
9639 \begin_inset space \thinspace{}
9646 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
9648 \begin_inset Formula $\beta$
9655 \begin_layout Standard
9660 \change_deleted -712698321 1673172511
9662 \change_inserted -712698321 1673172517
9668 which works with Rev\SpecialChar TeX
9671 v3.1 is basically obsolete,
9672 as it works with \SpecialChar LaTeX
9674 That means that it doesn't interact very well with \SpecialChar LyX
9676 which requires \SpecialChar LaTeX2e
9678 although it has been kludged to work.
9679 Since Rev\SpecialChar TeX
9680 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
9684 \change_deleted -712698321 1673172538
9689 \begin_inset space ~
9693 \change_inserted -712698321 1673172538
9695 \begin_inset space ~
9699 \begin_inset space \thinspace{}
9706 textclass should also be pretty easy to use.
9709 \begin_layout Standard
9710 These documents are supposed to be used in
9714 to the Rev\SpecialChar TeX
9716 so we don't describe any of the special Rev\SpecialChar TeX
9718 and assume you'll know what to put in the preamble if necessary.
9721 \begin_layout Subsubsection
9725 \begin_layout Standard
9726 All you need to do is install Rev\SpecialChar TeX
9728 as described in the package's README file.
9729 The package can be found at The Rev\SpecialChar TeX
9731 \begin_inset Flex URL
9734 \begin_layout Plain Layout
9736 http://publish.aps.org/revtex4/
9742 Install it somewhere that \SpecialChar LaTeX
9744 Test it by trying to \SpecialChar LaTeX
9745 a short Rev\SpecialChar TeX
9746 4 document in some random directory (i.
9747 \begin_inset space \thinspace{}
9751 \begin_inset space \space{}
9754 not the directory where you installed the class file.) Then,
9755 if you reconfigure \SpecialChar LyX
9757 it will find the class file and let you use the Rev\SpecialChar TeX
9761 \begin_layout Standard
9762 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
9771 \begin_inset space ~
9778 \change_deleted -712698321 1673172641
9779 the templates directory
9780 \change_inserted -712698321 1673172687
9783 File\SpecialChar menuseparator
9784 New From Templates\SpecialChar menuseparator
9792 \begin_layout Subsubsection
9796 \begin_layout Standard
9797 Optional arguments to
9805 \begin_inset Quotes eld
9809 \begin_inset Quotes erd
9813 \begin_inset Quotes eld
9817 \begin_inset Quotes erd
9824 \begin_inset space ~
9832 \begin_inset space ~
9839 Remember that in Rev\SpecialChar TeX
9841 at least one optional argument is required!
9845 \begin_layout Standard
9846 Other preamble matter,
9854 \begin_inset space ~
9861 \begin_inset space ~
9870 \begin_layout Subsubsection
9874 \begin_layout Standard
9875 The layouts basically correspond to the commands in Rev\SpecialChar TeX
9878 the Email layout corresponds to
9885 Note that (at least as of Rev\SpecialChar TeX
9895 layouts are exactly equivalent,
9896 so you shouldn't need to use both.
9900 \begin_layout Plain Layout
9901 In case you're curious,
9902 both were included so that
9906 would be able to translate both
9926 \begin_layout Subsubsection
9930 \begin_layout Standard
9931 There are a couple of important unique aspects of Rev\SpecialChar TeX
9932 4 which might cause bugs that will be even more confusing in \SpecialChar LyX
9936 \begin_layout Standard
9937 In Rev\SpecialChar TeX
9956 The \SpecialChar LyX
9957 equivalent is that there is a separate Thanks layout.
9962 write footnotes in the
9967 or weird things may happen.
9968 See the Rev\SpecialChar TeX
9969 4 documentation for more details.
9972 \begin_layout Standard
9977 \begin_inset space ~
9986 \begin_inset space ~
9996 layouts must be placed
10004 layout and the corresponding
10022 the \SpecialChar LaTeX
10026 \begin_layout Subsection
10028 \change_inserted 564990737 1671042072
10032 \begin_layout Standard
10034 \change_inserted 564990737 1671042072
10039 classes were replaced
10040 \change_deleted -712698321 1673176131
10042 \change_inserted 564990737 1671042072
10043 with a completely new
10044 \change_deleted -712698321 1673175919
10050 This package provides a \SpecialChar LaTeX
10051 class and templates for books to be published at Springer Gabler Research,
10052 Springer Vieweg Research,
10053 Springer Spektrum Research,
10054 Springer VS Research,
10055 or Springer VS Forschung.
10056 The documentation is available in German from
10057 \begin_inset CommandInset href
10060 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
10067 \change_inserted -712698321 1673176125
10074 Please find information at
10075 \begin_inset Flex URL
10078 \begin_layout Plain Layout
10080 \change_inserted -712698321 1673176047
10082 https://www.springernature.com/gp/authors/campaigns/latex-author-support
10090 Native \SpecialChar LyX
10091 support is not available yet.
10092 \change_inserted 564990737 1671042072
10096 \begin_layout Section
10098 \change_inserted 564990737 1670439560
10102 \begin_layout Standard
10104 \change_inserted 564990737 1670439581
10105 See also the document classes in the Collections (section
10106 \begin_inset space ~
10110 \begin_inset CommandInset ref
10112 reference "sec:Collections"
10120 \begin_layout Subsection
10124 \begin_layout Standard
10130 \begin_layout Subsubsection
10134 \begin_layout Standard
10135 Memoir is a very powerful and constantly evolving class.
10136 It has been designed with regard to fictional and non-fictional literature.
10137 Its aim is to let the user have maximum control over the typesetting of his document.
10138 Memoir is based on the standard book class,
10139 but it can also emulate the article class (see below).
10142 \begin_layout Standard
10144 the developer of Memoir,
10145 is known as the author of lots of useful packages in the \SpecialChar LaTeX
10147 Most of them have been merged with Memoir.
10149 it is much easier to layout the table of contents,
10151 chapter designs and such.
10155 does not support all of these goodies natively.
10156 Some of them might be added to forthcoming releases
10160 \begin_layout Plain Layout
10161 You are invited to send suggestions to
10162 \begin_inset Flex URL
10165 \begin_layout Plain Layout
10167 lyx-devel@lists.lyx.org
10178 lots will probably never be supported,
10179 due to the limitations of \SpecialChar LyX
10181 Of course you can still use all features with the help of some native \SpecialChar LaTeX
10182 commands (\SpecialChar TeX
10187 \begin_layout Plain Layout
10192 \begin_layout Plain Layout
10202 \begin_inset space ~
10206 \begin_inset CommandInset ref
10208 reference "sec:Inserting-TeX-Code"
10220 we can only list those features that are natively supported by \SpecialChar LyX
10222 For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
10226 \begin_layout Plain Layout
10231 \begin_layout Plain Layout
10241 \begin_inset Flex URL
10244 \begin_layout Plain Layout
10246 CTAN:/macros/latex/memoir/memman.pdf
10257 which is not only a user guide for the class,
10258 but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
10261 \begin_layout Subsubsection
10262 Basic features and restrictions
10265 \begin_layout Standard
10266 Memoir supports basically all features of the standard book classes.
10273 \begin_layout Description
10275 \begin_inset space ~
10279 Memoir has a broader range of font sizes:
10288 \begin_layout Description
10290 \begin_inset space ~
10294 The fancy page style is not supported,
10295 due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
10296 which confuses \SpecialChar LaTeX
10299 Memoir comes with a number of its own page styles (see
10301 Document\SpecialChar menuseparator
10302 Settings\SpecialChar menuseparator
10304 \begin_inset space ~
10310 If you want to use these for the chapter pages,
10311 you have to use the command
10317 in the main text or in preamble (e.
10318 \begin_inset space \thinspace{}
10322 \begin_inset space \space{}
10329 chapterstyle{companion}
10334 \begin_layout Description
10336 Sectionings (chapter,
10338 subsection etc.) come with an optional argument in the standard classes.
10340 you can specify an alternative version of the title for the table of contents and the headers (for instance,
10341 if the title is too long).
10342 In \SpecialChar LyX
10344 you can do this via
10346 Insert\SpecialChar menuseparator
10348 \begin_inset space ~
10353 at the beginning of a chapter/section.
10354 Memoir features a second optional argument and thus separates the table of contents from the header.
10355 You can define three variants of a title with this:
10356 one for the main text,
10357 one for the table of contents,
10358 and one for the headers.
10360 makes these available in form of specific
10371 \begin_layout Description
10373 In the standard classes (and in many other classes),
10374 the table of contents,
10375 the list of figures and the list of table start a new page automatically.
10376 Memoir does not follow this route.
10377 You have to insert a page break yourself,
10378 if you want to have one.
10381 \begin_layout Description
10383 For some unknown reason,
10384 Memoir uses pagination on the title page (in the standard classes,
10386 \begin_inset Quotes eld
10390 \begin_inset Quotes erd
10394 If you want an empty title page,
10399 aliaspagestyle{title}{empty}
10404 \begin_layout Description
10406 With the class option
10412 Document\SpecialChar menuseparator
10413 Settings\SpecialChar menuseparator
10414 Class Settings\SpecialChar menuseparator
10416 \begin_inset space ~
10422 you can emulate article style.
10424 counters (footnotes,
10426 tables etc.) will not be reset on new chapters,
10427 chapters don't start a new page (but are—
10429 \begin_inset Quotes eld
10433 \begin_inset Quotes erd
10440 use their own page,
10444 \begin_layout Description
10447 Memoir does not allow the use of the deprecated font commands,
10448 which have been used in the old \SpecialChar LaTeX
10450 \begin_inset space \thinspace{}
10454 \begin_inset space \space{}
10471 It produces an error and stops \SpecialChar LaTeX
10472 whenever such a command appears.
10477 reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
10479 Since a lot of packages and particularly Bib\SpecialChar TeX
10480 style files are still using those commands,
10481 we have decided to use this option by default.
10484 \begin_layout Subsubsection
10488 \begin_layout Standard
10489 We will only describe the features supported by \SpecialChar LyX
10490 (which is not much currently).
10491 Please consult the Memoir manual
10495 \begin_layout Plain Layout
10500 \begin_layout Plain Layout
10510 \begin_inset Flex URL
10513 \begin_layout Plain Layout
10515 CTAN:/macros/latex/memoir/memman.pdf
10528 \begin_layout Description
10530 You may wonder why an abstract is an extra feature.
10532 it is in book class.
10533 Usually books don't have abstracts.
10537 You can use it wherever and how often you like.
10540 \begin_layout Description
10542 You may know this older typesetting style:
10543 The contents of a chapter are summarized below the title and also in the table of contents (e.
10544 \begin_inset space \thinspace{}
10548 \begin_inset space \space{}
10553 Our hero arrives in Troia;
10554 he loses some friends;
10558 Chapterprecis does exactly this.
10559 It is therefore only sensible below a chapter.
10562 \begin_layout Description
10564 An epigraph is a smart slogan or motto at the beginning of a chapter.
10565 The epigraph environment provides an elegant way of typesetting such a motto.
10566 The motto itself (text) and its (optional) author (source) are divided by a short line.
10567 The author (source) can be inserted via
10569 Insert\SpecialChar menuseparator
10576 \begin_layout Description
10578 Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
10580 can only support a few of them.
10582 which is a centered title for poems,
10583 which will also be added to the table of contents (verse is the standard environment for poems.
10584 Memoir has some enhanced versions of verse,
10585 but you need to use \SpecialChar TeX
10587 because they have to be nested inside regular verse environments,
10588 which is not possible with \SpecialChar LyX
10592 \begin_layout Description
10595 but it adds no entry to the table of contents.
10598 \begin_layout Subsection
10600 \change_inserted 564990737 1671442175
10604 \begin_layout Standard
10606 \change_inserted 564990737 1671442175
10610 \change_inserted -712698321 1673182264
10612 \change_inserted 564990737 1671442175
10614 \change_deleted -712698321 1673182266
10618 \change_inserted 564990737 1671442175
10622 \change_deleted -712698321 1673182282
10626 \begin_inset space \thinspace{}
10630 \change_inserted 564990737 1671442175
10632 \change_inserted -712698321 1673182287
10634 \change_deleted -712698321 1673182290
10636 \change_inserted 564990737 1671442175
10639 document class but adds two environments:
10642 \begin_layout Description
10644 \change_inserted 564990737 1671442175
10645 Recipe a numbered section environment at the
10649 level which generates a bold centered heading above a double horizontal rule
10652 \begin_layout Description
10654 \change_inserted 564990737 1671442175
10665 are what are being described and the environment ends with a horizontal rule.
10668 \begin_layout Standard
10670 \change_inserted 564990737 1671642866
10673 File\SpecialChar menuseparator
10674 Open Example\SpecialChar menuseparator
10675 Books\SpecialChar menuseparator
10678 illustrates its use.
10681 \begin_layout Standard
10683 \change_deleted -712698321 1673186391
10685 \change_inserted -712698321 1673186393
10687 \change_inserted 564990737 1671442175
10688 is designed for typesetting one or two recipes per page,
10689 with dimensions of 5.5
10690 \begin_inset Quotes qrd
10694 \change_deleted -712698321 1673185652
10696 \change_inserted -712698321 1673185654
10698 \begin_inset Formula $\times$
10702 \change_deleted -712698321 1673185660
10704 \change_inserted 564990737 1671442175
10706 \begin_inset Quotes qrd
10710 \change_inserted -712698321 1673186720
10711 (ideally on US letter paper,
10712 but A4 will work as well if the output is slightly downscaled)
10713 \change_inserted 564990737 1671442175
10715 The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient
10716 \change_inserted -712698321 1673186486
10718 \change_deleted -712698321 1673186487
10721 \change_inserted 564990737 1671442175
10723 \change_deleted -712698321 1673186488
10725 \change_inserted -712698321 1673186489
10727 \change_inserted 564990737 1671442175
10728 he pages can be joined together or printed 2 per page to
10729 \change_deleted -712698321 1673186516
10731 \change_inserted 564990737 1671442175
10733 \change_inserted -712698321 1673186529
10735 \change_inserted 564990737 1671442175
10737 \change_inserted -712698321 1673186520
10739 \change_inserted 564990737 1671442175
10741 The size was chosen to work in half-page 3-ring binder cover sheets,
10742 because un-laminated paper just doesn't last in the kitchen.
10745 \begin_layout Standard
10747 \change_inserted 564990737 1671442175
10748 The half-letter pages can be printed two per page using your printer driver,
10749 or bound together using
10750 \change_inserted -712698321 1673186305
10754 \begin_layout Quote
10756 \change_inserted 564990737 1671442175
10759 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
10766 \change_inserted -712698321 1673186310
10770 \begin_layout Standard
10772 \change_inserted 564990737 1671442175
10777 is the compiled version of your recipes.
10778 \change_inserted -712698321 1673175424
10782 \begin_layout Section
10784 \change_inserted 564990737 1671442207
10786 \change_deleted -712698321 1673186818
10788 \change_inserted -712698321 1673186818
10790 \change_inserted 564990737 1671442207
10794 \begin_layout Subsection
10796 \change_inserted 564990737 1671442208
10798 \change_inserted -712698321 1673187876
10800 \change_inserted 564990737 1671442208
10804 \begin_layout Standard
10806 \change_inserted 564990737 1671642942
10808 \change_deleted -712698321 1673187623
10812 \begin_inset space \space{}
10816 \begin_inset space \thinspace{}
10820 \change_inserted 564990737 1671642942
10822 \change_inserted -712698321 1673187655
10824 \change_deleted -712698321 1673187624
10826 \change_inserted 564990737 1671642942
10834 an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
10837 File\SpecialChar menuseparator
10838 Open Example\SpecialChar menuseparator
10839 Curricula Vitae\SpecialChar menuseparator
10841 \change_deleted -712698321 1673187728
10843 \change_inserted 564990737 1671642942
10846 offers guidance on its use.
10847 Its documentation is available from
10848 \begin_inset CommandInset href
10851 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
10859 \begin_layout Subsection
10861 \change_inserted 564990737 1671442208
10863 \change_deleted -712698321 1673187829
10865 \change_inserted -712698321 1673187829
10867 \change_inserted 564990737 1671442208
10871 \begin_layout Standard
10873 \change_inserted 564990737 1671642984
10875 \change_deleted -712698321 1673187820
10879 \begin_inset space \space{}
10883 \begin_inset space \thinspace{}
10887 \change_inserted 564990737 1671642984
10889 \change_inserted -712698321 1673187823
10891 \change_deleted -712698321 1673187824
10893 \change_inserted 564990737 1671642984
10901 an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
10904 File\SpecialChar menuseparator
10905 Open Example\SpecialChar menuseparator
10906 Curricula Vitae\SpecialChar menuseparator
10909 offers guidance on its use.
10910 Its documentation is available from
10911 \begin_inset CommandInset href
10914 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
10922 \begin_layout Subsection
10924 \change_inserted 564990737 1671442208
10926 \change_inserted -712698321 1673187869
10928 \change_inserted 564990737 1671442208
10932 \begin_layout Standard
10934 \change_inserted 564990737 1671643003
10936 \change_deleted -712698321 1673187880
10940 \begin_inset space \space{}
10944 \begin_inset space \thinspace{}
10948 \change_inserted -712698321 1673187880
10950 \change_inserted 564990737 1671643003
10952 \change_inserted -712698321 1673187884
10954 \change_deleted -712698321 1673187884
10956 \change_inserted 564990737 1671643003
10964 This allows the creation of customizable CVs.
10967 File\SpecialChar menuseparator
10968 Open Example\SpecialChar menuseparator
10969 Curricula Vitae\SpecialChar menuseparator
10972 offers guidance on its use.
10973 Its documentation is available from
10974 \begin_inset CommandInset href
10977 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
10985 \begin_layout Subsection
10987 \change_inserted 564990737 1671442208
10989 \change_inserted -712698321 1673187900
10991 \change_inserted 564990737 1671442208
10995 \begin_layout Standard
10997 \change_inserted 564990737 1671643024
10999 \change_deleted -712698321 1673187895
11003 \begin_inset space \space{}
11007 \begin_inset space \thinspace{}
11011 \change_inserted -712698321 1673187895
11013 \change_inserted 564990737 1671643024
11015 \change_inserted -712698321 1673187897
11017 \change_deleted -712698321 1673187898
11019 \change_inserted 564990737 1671643024
11027 originally developed for use with \SpecialChar LyX
11031 File\SpecialChar menuseparator
11032 Open Example\SpecialChar menuseparator
11033 Curricula Vitae\SpecialChar menuseparator
11036 offers guidance on its use.
11037 Its documentation is available from
11038 \begin_inset CommandInset href
11041 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
11049 \begin_layout Section
11051 \change_inserted 564990737 1672652454
11055 \begin_layout Standard
11057 \change_inserted 564990737 1672652455
11061 \begin_inset space \space{}
11067 \begin_inset space ~
11071 \begin_inset CommandInset ref
11073 reference "subsec:The-new-letter"
11081 \begin_inset space \space{}
11084 (with extra font sizes)
11087 \begin_inset space ~
11091 \begin_inset CommandInset ref
11093 reference "subsec:Extra-font-sizes"
11098 ) document classes .
11101 \begin_layout Subsection
11103 \change_inserted 564990737 1671041970
11107 \begin_layout Standard
11109 \change_inserted 564990737 1671617528
11118 document class for writing letters according to the
11120 Deutsches Institut für Normung
11123 The file in the menu
11128 ile\SpecialChar menuseparator
11130 \begin_inset space ~
11138 \begin_inset space ~
11141 Template\SpecialChar menuseparator
11142 Letters\SpecialChar menuseparator
11145 offers guidance on its use.
11146 The documentation is available from
11147 \begin_inset CommandInset href
11150 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
11158 \begin_layout Subsection
11160 \change_inserted 564990737 1672652499
11164 \begin_layout Standard
11166 \change_inserted 564990737 1672652499
11170 \begin_inset space \space{}
11179 document class for writing letters according to French conventions.
11180 The file in the menu
11185 ile\SpecialChar menuseparator
11187 \begin_inset space ~
11195 \begin_inset space ~
11198 Template\SpecialChar menuseparator
11199 Letters\SpecialChar menuseparator
11201 \begin_inset space \space{}
11206 offers guidance on its use.
11209 \begin_layout Subsection
11211 \change_inserted 564990737 1672652499
11215 \begin_layout Standard
11217 \change_inserted 564990737 1672652499
11221 \begin_inset space \thinspace{}
11230 document class for writing letters in German.
11231 The file in the menu
11236 ile\SpecialChar menuseparator
11238 \begin_inset space ~
11246 \begin_inset space ~
11249 Template\SpecialChar menuseparator
11250 Letters\SpecialChar menuseparator
11252 \begin_inset space \thinspace{}
11257 offers guidance on its use.
11258 The documentation is available from
11259 \begin_inset CommandInset href
11262 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
11270 \begin_layout Subsection
11272 \change_inserted 564990737 1671458835
11276 \begin_layout Standard
11278 \change_inserted 564990737 1671617591
11287 document class for English letters and to create mailing labels.
11288 The file in the menu
11293 ile\SpecialChar menuseparator
11295 \begin_inset space ~
11303 \begin_inset space ~
11306 Template\SpecialChar menuseparator
11307 Letters\SpecialChar menuseparator
11308 Letter (Standard Class)
11310 offers guidance on its use.
11313 \begin_layout Subsection
11315 \change_inserted 564990737 1672652527
11319 \begin_layout Standard
11321 \change_inserted 564990737 1672652527
11325 \begin_inset space \space{}
11334 document class for writing letters,
11335 faxes and envelopes in French.
11336 The file in the menu
11341 ile\SpecialChar menuseparator
11343 \begin_inset space ~
11351 \begin_inset space ~
11354 Template\SpecialChar menuseparator
11355 Letters\SpecialChar menuseparator
11357 \begin_inset space \space{}
11362 offers guidance on its use.
11363 The documentation is available from
11364 \begin_inset CommandInset href
11367 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
11375 \begin_layout Section
11377 \change_inserted 564990737 1670439660
11381 \begin_layout Subsection
11383 \change_inserted 564990737 1671458922
11387 \begin_layout Standard
11389 \change_inserted 564990737 1671617655
11393 \begin_inset space \thinspace{}
11402 document class for creating presentations.
11403 The file in the menu
11408 ile\SpecialChar menuseparator
11410 \begin_inset space ~
11418 \begin_inset space ~
11421 Template\SpecialChar menuseparator
11422 Presentations\SpecialChar menuseparator
11425 offers guidance on its use.
11426 The documentation is available from
11427 \begin_inset CommandInset href
11430 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
11438 \begin_layout Subsection
11441 Foil\SpecialChar TeX
11445 \begin_inset CommandInset label
11454 \begin_layout Standard
11456 \change_inserted 564990737 1672743383
11462 updated by the \SpecialChar LyX
11466 \begin_layout Subsubsection
11468 \change_inserted 564990737 1672743383
11472 \begin_layout Standard
11474 \change_inserted 564990737 1672743396
11478 \begin_inset space \thinspace{}
11481 (Foil\SpecialChar TeX
11488 document class to make slides for overhead projectors.
11489 There are two document classes that can do this:
11493 \begin_inset space \thinspace{}
11498 document class (section
11499 \begin_inset space ~
11503 \begin_inset CommandInset ref
11505 reference "sec:slitex"
11515 Foil\SpecialChar TeX
11519 As of 2023 the former has continued to be maintained whereas
11521 Foil\SpecialChar TeX
11524 has not been maintained since 2008.
11525 This section documents the latter.
11526 If your machine doesn’t have the
11529 \begin_inset space \thinspace{}
11532 (Foil\SpecialChar TeX
11535 document class installed,
11536 you’ll probably have to use the
11539 \begin_inset space \thinspace{}
11545 If you want to install the
11550 it is available from
11551 \begin_inset CommandInset href
11554 target "https://www.ctan.org/pkg/foiltex"
11560 You should also read the
11562 Installing New Document Classes
11569 \change_deleted 564990737 1672743436
11575 \begin_layout Standard
11577 \change_deleted 564990737 1672743383
11581 \begin_layout Standard
11583 \change_deleted 564990737 1672743383
11584 This section describes how to use \SpecialChar LyX
11585 to make slides for overhead projectors.
11586 There are two document classes that can do this:
11587 the default slides class and the
11589 Foil\SpecialChar TeX
11593 This section documents the latter.
11596 \begin_layout Standard
11598 \change_deleted 564990737 1672743383
11599 I'm going to say this again,
11601 so that there's no misunderstanding:
11604 \begin_layout Standard
11606 \change_deleted 564990737 1672743383
11607 \begin_inset VSpace bigskip
11613 \begin_layout Standard
11616 \change_deleted 564990737 1672743383
11619 This section documents the class
11620 \begin_inset Quotes eld
11628 \begin_inset Quotes erd
11636 \begin_layout Standard
11638 \change_deleted 564990737 1672743383
11639 \begin_inset VSpace bigskip
11645 \begin_layout Standard
11647 \change_deleted 564990737 1672743383
11648 If you're looking for the documentation for
11649 \begin_inset Quotes eld
11657 \begin_inset Quotes erd
11662 \begin_inset space ~
11666 \begin_inset CommandInset ref
11668 reference "sec:slitex"
11674 If your machine doesn't have the
11683 you'll probably have to use the default
11688 which isn't quite as good as
11693 \begin_layout Standard
11695 \change_deleted 564990737 1672743383
11700 class is designed for use with version
11701 \begin_inset space ~
11709 class file which is now an integral part of \SpecialChar LaTeX2e
11715 \begin_layout Subsubsection
11719 \begin_layout Standard
11721 to use this document class,
11733 \begin_inset space ~
11739 There are some settings in the
11742 \begin_inset space ~
11747 dialog that you should know about that are specific to this class:
11750 \begin_layout Itemize
11751 Don't change the options
11762 \begin_inset space ~
11768 They're ignored by the
11775 \begin_layout Itemize
11776 The default font size is 20
11777 \begin_inset space \thinspace{}
11780 pt with the other options being 17
11781 \begin_inset space \thinspace{}
11786 \begin_inset space \thinspace{}
11790 \begin_inset space \thinspace{}
11796 \begin_layout Itemize
11797 The default font is
11805 but all math equations are still typeset in the usual roman font.
11808 \begin_layout Itemize
11811 Foil\SpecialChar TeX
11814 supports A4 and Letter paper sizes as well as a special size for working with 35
11815 \begin_inset space \thinspace{}
11819 It doesn't support A5,
11821 legal or executive paper sizes.
11824 \begin_layout Itemize
11825 Don't bother changing the
11829 settings because they are ignored anyway.
11830 All floats appear where they are defined in the text.
11833 \begin_layout Itemize
11838 setting behaves a bit differently for this class.
11841 Foil\SpecialChar TeX
11844 provides extensive footer and header capabilities including a user-defined logo.
11846 \begin_inset space ~
11850 \begin_inset CommandInset ref
11852 reference "sec:foilfoot"
11858 The title page is treated differently to all other pages in the document and is
11866 has the logo centered at the bottom of the page (if one is defined).
11867 The possible page style choices and what they do are as follows:
11871 \begin_layout Labeling
11872 \labelwidthstring MMMMMMM
11879 The final output contains no page numbers,
11880 or other headers or footers (except footnotes of course).
11884 \begin_layout Labeling
11885 \labelwidthstring MMMMMMM
11892 The final output contains page numbers centered at the bottom of the page.
11893 No other headings or footers (other than footnotes).
11896 \begin_layout Labeling
11897 \labelwidthstring MMMMMMM
11902 Page numbers in lower right corner.
11903 Additional headers and footers are also shown.
11904 This is also the default.
11907 \begin_layout Labeling
11908 \labelwidthstring MMMMMMM
11913 Gives you access to the
11917 package although its use with
11919 Foil\SpecialChar TeX
11922 is discouraged by the writer of the
11924 Foil\SpecialChar TeX
11927 package because of some potential page layout clashes.
11931 \begin_layout Paragraph
11935 \begin_layout Standard
11936 The following options may be used in the extra class options in the
11938 Document\SpecialChar menuseparator
11944 \begin_layout Labeling
11945 \labelwidthstring MMMMMMx
11950 This sets up the page layout for 7.33
11951 \begin_inset space \thinspace{}
11955 \begin_inset space \thinspace{}
11959 which is about the same aspect ratio as a 35
11960 \begin_inset space \thinspace{}
11964 making it a bit easier to work with this medium.
11967 \begin_layout Labeling
11968 \labelwidthstring MMMMMMx
11973 Places a rule across the page below the header on every page except the title page.
11976 \begin_layout Labeling
11977 \labelwidthstring MMMMMMx
11982 Places a rule across the page above the footer on every page except the title page.
11985 \begin_layout Labeling
11986 \labelwidthstring MMMMMMx
11991 This is automatically set each time you create a new
11998 Foil\SpecialChar TeX
12001 to use the dvips driver to rotate those pages that are set as landscape foils.
12004 \begin_layout Labeling
12005 \labelwidthstring MMMMMMx
12010 Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
12011 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.
12012 Note that this option effectively reverses the roles of the
12020 environments (don't worry these are described in the next section).
12023 \begin_layout Labeling
12024 \labelwidthstring MMMMMMx
12029 Equation numbers on the left.
12032 \begin_layout Labeling
12033 \labelwidthstring MMMMMMx
12038 Flush-left equations.
12041 \begin_layout Subsubsection
12042 Supported Environments
12045 \begin_layout Standard
12046 Most of the environments commonly supported in other classes are also supported by the
12051 There are several additional environments provided by
12053 Foil\SpecialChar TeX
12056 as well as a couple added by \SpecialChar LyX
12058 The following environments are shared with other classes:
12061 \begin_layout Standard
12062 \begin_inset Flex Multiple Columns
12065 \begin_layout Itemize
12071 \begin_layout Itemize
12077 \begin_layout Itemize
12083 \begin_layout Itemize
12089 \begin_layout Itemize
12095 \begin_layout Itemize
12102 \begin_layout Itemize
12108 \begin_layout Itemize
12114 \begin_layout Itemize
12120 \begin_layout Itemize
12126 \begin_layout Itemize
12132 \begin_layout Itemize
12138 \begin_layout Itemize
12144 \begin_layout Itemize
12150 \begin_layout Itemize
12161 \begin_layout Standard
12163 all the major environments apart from the sectioning environments.
12164 Since foils are essentially self-contained sections,
12165 with a title and body,
12168 Foil\SpecialChar TeX
12171 provides specific commands for starting new foils and these are:
12174 \begin_layout Itemize
12180 \begin_layout Itemize
12186 \begin_layout Standard
12188 also provides slightly modified versions of these two environments called:
12191 \begin_layout Itemize
12197 \begin_layout Itemize
12200 ShortRotatefoilhead
12203 \begin_layout Standard
12204 and the differences will be explained in the next section.
12207 \begin_layout Standard
12208 Since foils are often used in presenting ideas or new theorems and such
12210 Foil\SpecialChar TeX
12213 also provides a comprehensive box of goodies for presenting them:
12216 \begin_layout Standard
12217 \begin_inset Flex Multiple Columns
12220 \begin_layout Itemize
12226 \begin_layout Itemize
12232 \begin_layout Itemize
12238 \begin_layout Itemize
12244 \begin_layout Itemize
12250 \begin_layout Itemize
12256 \begin_layout Itemize
12262 \begin_layout Itemize
12268 \begin_layout Itemize
12274 \begin_layout Itemize
12280 \begin_layout Itemize
12291 \begin_layout Standard
12292 The starred versions are unnumbered while the unstarred versions are numbered.
12293 There are also two list environments added by \SpecialChar LyX
12297 \begin_layout Itemize
12303 \begin_layout Itemize
12309 \begin_layout Standard
12312 Foil\SpecialChar TeX
12315 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.
12316 If you want to change these settings in your document the best place to do so is at the very top of a foil,
12318 \begin_inset space \thinspace{}
12324 \begin_inset space \space{}
12329 straight after the foilhead.
12332 \begin_layout Standard
12334 the following command styles are provided [
12341 \begin_layout Standard
12342 \begin_inset Flex Multiple Columns
12345 \begin_layout Itemize
12349 \begin_inset space ~
12355 \begin_layout Itemize
12361 \begin_layout Itemize
12365 \begin_inset space ~
12371 \begin_layout Itemize
12375 \begin_inset space ~
12381 \begin_layout Itemize
12385 \begin_inset space ~
12392 \begin_layout Plain Layout
12393 \begin_inset space ~
12405 \begin_layout Standard
12406 There are also a few commands provided by
12408 Foil\SpecialChar TeX
12411 that aren't directly supported by \SpecialChar LyX
12412 but I'll tell you what they do and how to use them in section
12413 \begin_inset space ~
12417 \begin_inset CommandInset ref
12419 reference "sec:unsuppfoils"
12427 \begin_layout Subsubsection
12428 Building a Set of Foils
12431 \begin_layout Standard
12432 This section will give a simple introduction to using the different environments to build a set of foils.
12433 If you want to see an example set of foils,
12435 \change_deleted 564990737 1671643085
12440 file you find in \SpecialChar LyX
12446 \change_inserted 564990737 1671643099
12449 File\SpecialChar menuseparator
12450 Open Example\SpecialChar menuseparator
12451 Presentations\SpecialChar menuseparator
12459 \begin_layout Paragraph
12460 Give It a Title Page
12463 \begin_layout Standard
12464 Unlike other classes that provide
12487 creates the title on a page of its own.
12488 If you leave out the
12492 environment \SpecialChar LaTeX
12493 will substitute the current date (every time you regenerate the output).
12496 \begin_layout Paragraph
12500 \begin_layout Standard
12501 As I mentioned earlier,
12502 there are four ways of starting a new foil.
12503 For portrait foils you should use
12512 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.
12515 \begin_layout Standard
12516 Landscape foils are generated using the
12522 ShortRotatefoilhead
12525 Again the only difference is the spacing between foilhead and body.
12526 Both of the short versions have 0.5
12527 \begin_inset space ~
12530 inches less separation between the foilhead and the body.
12534 \begin_layout Standard
12535 One problem with the support for landscape foils is the requirement that you have to use the
12539 driver to generate the PostScript output otherwise the foils won't be rotated.
12540 It is possible to get landscape foils even if you haven't got the
12544 driver provided you can feed your foils sideways through your printer ;-)
12547 \begin_layout Paragraph
12553 \begin_layout Standard
12554 You can't have two of the same type of these environments directly following each other.
12555 If you use a normal paragraph break,
12557 you will just be extending the previous environment as if you had merged the two environments together.
12559 you need to insert a so-called separator.
12560 Please refer to the section entitled
12571 \begin_layout Paragraph
12575 \begin_layout Standard
12576 You get all the commonly supported list styles found in other classes as well as two new ones.
12577 I'll only describe the new ones here.
12578 If you want to find out more about the other list environments check out the
12583 If you intend to use itemized lists you might also want to read about the
12586 \begin_inset space ~
12590 \begin_inset space ~
12595 dialog described above in section
12596 \begin_inset space ~
12600 \change_inserted 564990737 1671355684
12602 \begin_inset CommandInset ref
12604 reference "chap:bullets"
12610 \change_deleted 564990737 1671355684
12612 \begin_inset CommandInset ref
12614 reference "sec:bullet"
12624 \begin_layout Standard
12625 The two new list styles,
12635 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.
12636 These lists are in fact dedicated variants of the
12641 They do however require that you have the
12645 packages installed.
12648 \begin_layout Paragraph
12652 \begin_layout Standard
12655 Foil\SpecialChar TeX
12658 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.
12659 In fact if you change the float placement settings they are simply ignored.
12662 \begin_layout Paragraph
12663 Page Headers and Footers
12664 \begin_inset CommandInset label
12666 name "sec:foilfoot"
12673 \begin_layout Standard
12677 \begin_inset space ~
12686 are two commands used to control the left-footer text string.
12687 The first is meant to allow you to include a graphic logo on your foils and defaults to
12688 \begin_inset Quotes eld
12693 Foil\SpecialChar TeX
12697 \begin_inset Quotes erd
12701 While the second is meant to provide a classification for the audience,
12705 \begin_inset space \thinspace{}
12711 \begin_inset space \space{}
12715 It is empty by default.
12718 \begin_layout Standard
12719 The remaining page corners can be filled by
12722 \begin_inset space ~
12727 (which defaults to page numbers),
12731 \begin_inset space ~
12739 \begin_inset space ~
12747 \begin_layout Subsubsection
12750 Foil\SpecialChar TeX
12754 \begin_inset CommandInset label
12756 name "sec:unsuppfoils"
12763 \begin_layout Standard
12764 All the commands mentioned below need to be set in a
12774 within another environment.
12777 \begin_layout Paragraph
12781 \begin_layout Standard
12782 All lengths are adjusted using the
12805 should be replaced by the name given to the length you want to change and
12809 is the length value.
12810 All lengths should be specified in units of length such as inches (
12823 ) or relative to some document or font-based length such as
12833 \begin_layout Standard
12834 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
12847 \begin_inset space \space{}
12850 in closer to their bodies put the following in the preamble:
12857 foilheadskip}{-0.5in}
12860 \begin_layout Standard
12861 The spacings around floats can be adjusted by setting these lengths:
12864 \begin_layout Labeling
12865 \labelwidthstring MMMMMMMMMMM
12872 Separation between the text and the top of the float
12875 \begin_layout Labeling
12876 \labelwidthstring MMMMMMMMMMM
12883 Separation between the float and the caption
12886 \begin_layout Labeling
12887 \labelwidthstring MMMMMMMMMMM
12894 Separation between the caption and the following text
12897 \begin_layout Labeling
12898 \labelwidthstring MMMMMMMMMMM
12905 You can make the captions narrower than the surrounding text by adjusting this length.
12906 Best done relative to
12915 \begin_layout Standard
12916 There are also several title page related lengths that you may find useful if you have a long title or several authors:
12919 \begin_layout Labeling
12920 \labelwidthstring MMMMMMMMMMM
12927 Separation from headers to
12932 \begin_layout Labeling
12933 \labelwidthstring MMMMMMMMMMM
12951 \begin_layout Labeling
12952 \labelwidthstring MMMMMMMMMMM
12966 \begin_layout Labeling
12967 \labelwidthstring MMMMMMMMMMM
12983 \begin_layout Labeling
12984 \labelwidthstring MMMMMMMMMMM
13000 \begin_layout Standard
13001 The last length related command affects all the list environments.
13012 a list environment then all the vertical spacing between the list items is removed.
13013 Note that this is a command not a length so it doesn't require
13019 like the stuff mentioned above.
13022 \begin_layout Paragraph
13023 Headers and Footers
13026 \begin_layout Standard
13039 commands control whether the logo in the
13043 definition appear on a given page.
13050 in the preamble then none of the foils will have the logo on them.
13051 If you don't want the logo on a particular page place the
13057 directly after the foilhead of that page and the
13063 directly after the next foilhead.
13066 \begin_layout Standard
13067 If you decide to use the
13071 page style setting in the
13074 \begin_inset space ~
13079 dialog you should probably add
13089 to your preamble so headers and footers on landscape pages are correctly placed when rotated.
13090 This is due to some clashes between the page layouts provided by the
13101 \begin_layout Subsection
13103 \change_inserted 564990737 1671459032
13107 \begin_layout Standard
13109 \change_inserted 564990737 1671643165
13113 \begin_inset space \thinspace{}
13122 document class for creating presentations.
13125 File\SpecialChar menuseparator
13126 Open Example\SpecialChar menuseparator
13127 Presentations\SpecialChar menuseparator
13130 offers guidance on its use.
13131 The documentation is available from
13132 \begin_inset CommandInset href
13135 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
13143 \begin_layout Subsection
13145 \change_inserted 564990737 1671459032
13146 \begin_inset CommandInset label
13148 name "subsec:Seminar"
13157 \begin_layout Standard
13159 \change_inserted 564990737 1671643194
13163 \begin_inset space \thinspace{}
13172 document class for creating presentations.
13175 File\SpecialChar menuseparator
13176 Open Example\SpecialChar menuseparator
13177 Presentations\SpecialChar menuseparator
13180 offers guidance on its use.
13181 The documentation is available from
13182 \begin_inset CommandInset href
13185 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
13193 \begin_layout Subsection
13196 Sli\SpecialChar TeX
13200 \begin_inset CommandInset label
13209 \begin_layout Standard
13211 \change_inserted 564990737 1672743492
13217 updated by the \SpecialChar LyX
13221 \begin_layout Subsubsection
13223 \change_inserted 564990737 1672743492
13227 \begin_layout Standard
13229 \change_inserted 564990737 1672743492
13230 This section describes how to use \SpecialChar LyX
13231 to make slides for overhead projectors.
13232 There are two document classes that can do this:
13236 \begin_inset space \thinspace{}
13241 document class and the
13244 \begin_inset space \thinspace{}
13247 (Foil\SpecialChar TeX
13251 This section documents the former.
13252 If you’re looking for the documentation for
13255 \begin_inset space \thinspace{}
13258 (Foil\SpecialChar TeX
13263 \begin_inset space ~
13267 \begin_inset CommandInset ref
13269 reference "sec:Foiltex"
13275 As of 2023 the former has continued to be maintained whereas
13277 Foil\SpecialChar TeX
13280 has not been maintained since 2008.
13282 \change_deleted 564990737 1672743492
13290 \begin_layout Standard
13292 \change_deleted 564990737 1672743492
13296 \begin_layout Standard
13298 \change_deleted 564990737 1672743492
13299 This section describes how to use \SpecialChar LyX
13300 to make slides for overhead projectors.
13301 There are two document classes that can do this:
13302 the default slides class and the
13304 Foil\SpecialChar TeX
13308 This section documents the former.
13311 \begin_layout Standard
13313 \change_deleted 564990737 1672743492
13314 I'm going to say this again,
13316 so that there's no misunderstanding:
13319 \begin_layout Standard
13321 \change_deleted 564990737 1672743492
13322 \begin_inset VSpace bigskip
13328 \begin_layout Standard
13331 \change_deleted 564990737 1672743492
13334 This section documents the class
13335 \begin_inset Quotes eld
13343 \begin_inset Quotes erd
13351 \begin_layout Standard
13353 \change_deleted 564990737 1672743492
13354 \begin_inset VSpace bigskip
13360 \begin_layout Standard
13362 \change_deleted 564990737 1672743492
13363 If you're looking for the documentation for
13364 \begin_inset Quotes eld
13369 slides (Foil\SpecialChar TeX
13373 \begin_inset Quotes erd
13378 \begin_inset space ~
13382 \begin_inset CommandInset ref
13384 reference "sec:foiltex"
13395 \begin_inset Quotes eld
13400 slides (Foil\SpecialChar TeX
13404 \begin_inset Quotes erd
13407 ] is actually somewhat better than the default
13415 \begin_layout Plain Layout
13417 or so I've been told repeatedly by its advocates.
13418 Having never used it,
13419 I have no idea if this claim is true or not.
13424 which this section documents.
13427 \begin_layout Standard
13429 \change_deleted 564990737 1672743492
13430 This class is the \SpecialChar LaTeX2e
13431 improvement of the old
13433 Sli\SpecialChar TeX
13437 Every \SpecialChar LaTeX2e
13438 distribution includes this class [which I'll just refer to as
13439 \begin_inset Quotes eld
13447 \begin_inset Quotes erd
13451 so you're bound to have it.
13452 As I noted earlier,
13453 there are other classes,
13459 which also produce slides for overhead projectors and do a better job at it.
13461 there are some things which
13465 can do which the others can't,
13466 such as generate overlays.
13467 Read on to learn more!
13472 \begin_layout Subsubsection
13474 \begin_inset CommandInset label
13476 name "sec:slidesetup"
13483 \begin_layout Standard
13485 to use this document class,
13487 \begin_inset Quotes eld
13495 \begin_inset Quotes erd
13498 from the class list in the
13500 Document\SpecialChar menuseparator
13504 There are some other special things you should know about this class:
13507 \begin_layout Itemize
13508 Don't bother changing the options
13513 They're not supported by the
13521 \begin_layout Itemize
13525 \begin_inset space ~
13530 behaves a bit differently for this class.
13531 The possible choices and what they do are as follows:
13535 \begin_layout Description
13540 The final output contains page numbers in the lower right corner.
13543 \begin_layout Description
13553 but also prints out any time markers you've put in.
13554 This is the default.
13557 \begin_layout Description
13562 The final output contains no page numbers,
13564 or alignment markers.
13568 \begin_layout Itemize
13573 class has an extra option:
13581 \begin_inset Quotes eld
13589 \begin_inset Quotes erd
13592 in the extra class options.
13596 \begin_layout Standard
13597 Using this options allows you to add time markers to
13603 \begin_inset space ~
13607 \begin_inset CommandInset ref
13609 reference "sec:slideNote"
13618 \begin_layout Standard
13619 You can also use the template file
13620 \change_deleted 564990737 1671617694
13622 \begin_inset Quotes eld
13630 \begin_inset Quotes erd
13635 to automatically set up a document to use the
13640 \change_deleted 564990737 1671617699
13645 File\SpecialChar menuseparator
13647 \begin_inset space ~
13651 \begin_inset space ~
13655 \change_inserted 564990737 1671617723
13656 \SpecialChar menuseparator
13657 Presentations\SpecialChar menuseparator
13662 to open your new document
13663 \change_deleted 564990737 1671617728
13667 The template file also contains some examples of the special paragraph environments used by this class.
13668 I'll describe those next.
13671 \begin_layout Subsubsection
13672 Paragraph Environments
13675 \begin_layout Paragraph
13676 Supported Environments
13679 \begin_layout Standard
13680 The first thing you'll notice when you start up a new
13684 document is the font size and type:
13685 it's the equivalent of the size
13686 \begin_inset Quotes eld
13694 \begin_inset Quotes erd
13700 \begin_inset space ~
13706 This is also what's used in the output.
13708 \begin_inset Quotes eld
13712 \begin_inset Quotes erd
13715 to remind you that this is a slide.
13716 Your final slides will use a larger font;
13718 you'll have less space.
13720 the larger default screen font isn't WYSIWYG,
13724 \begin_layout Standard
13725 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
13726 Most of the paragraph environments you're used to seeing are missing.
13727 There are also five new ones.
13732 class itself only supports certain paragraph environments:
13735 \begin_layout Itemize
13741 \begin_layout Itemize
13747 \begin_layout Itemize
13753 \begin_layout Itemize
13759 \begin_layout Itemize
13765 \begin_layout Itemize
13771 \begin_layout Itemize
13777 \begin_layout Itemize
13783 \begin_layout Itemize
13789 \begin_layout Itemize
13796 \begin_layout Standard
13797 All of the other standard environments,
13798 including the section-heading environments,
13806 \begin_layout Standard
13808 you'll notice the following new environments:
13811 \begin_layout Itemize
13817 \begin_layout Itemize
13823 \begin_layout Itemize
13829 \begin_layout Itemize
13835 \begin_layout Itemize
13841 \begin_layout Standard
13842 These five are kind of quirky,
13844 \begin_inset Quotes eld
13848 \begin_inset Quotes erd
13851 in \SpecialChar LyX
13855 doesn't permit you to nest any other paragraph environment into an empty environment.
13857 that's fine and dandy,
13858 but it means that you wouldn't be able to start a slide with anything except plain text.
13860 I've performed a little
13861 \begin_inset Quotes eld
13866 \begin_inset Quotes erd
13872 \begin_layout Paragraph
13873 Quirks of the New Environments
13874 \begin_inset CommandInset label
13876 name "sec:slideQuirk"
13883 \begin_layout Standard
13884 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
13886 As I just mentioned,
13888 forbids environments that begin with another environment.
13889 To get around this,
13894 environment isn't a paragraph environment as described in the
13902 \begin_layout Standard
13903 You should consider
13918 \begin_inset Quotes eld
13921 pseudo-environments.
13922 \begin_inset Quotes erd
13925 They look like a section heading or a
13926 \begin_inset Quotes eld
13934 \begin_inset Quotes erd
13937 but really begin a [and,
13939 end the previous] paragraph environment.
13950 \begin_inset Quotes eld
13954 \begin_inset Quotes erd
13957 These two perform some action.
13960 \begin_layout Standard
13961 A common feature of all five environments,
13986 is a rather long-ish label.
13987 The text following this label —
13988 ordinarily the contents of the paragraph environment —
13989 is utterly irrelevant for
14014 completely ignores it.
14016 you can leave these five environments completely empty.
14020 \begin_layout Standard
14025 to put any text after the rather long-ish label,
14027 This could be a short description of the contents of the
14034 enter your descriptive comment and hit
14038 as you normally would.
14041 \begin_layout Standard
14044 you don't want to enter any descriptive text,
14045 you'll hit another \SpecialChar LyX
14051 and will not let you start a new paragraph environment until you put something in the old one.
14056 \begin_layout Itemize
14057 Start entering the text that will
14088 \begin_layout Itemize
14089 Now move to the beginning of that paragraph.
14093 \begin_layout Itemize
14103 \begin_layout Itemize
14106 empty paragraph to a
14133 \begin_layout Standard
14134 Some future version of \SpecialChar LyX
14137 resolve this quirkiness\SpecialChar ldots
14141 \begin_layout Subsubsection
14142 Making a Presentation with
14156 \begin_layout Paragraph
14164 \begin_layout Standard
14165 If you're expecting this section to teach you how to actually make a presentation,
14166 you'll be sorely disappointed.
14168 I'll describe all of the ways the
14172 class can assist you in preparing the materials for a presentation.
14173 Filling in the contents,
14181 the \SpecialChar LyX
14185 \begin_layout Standard
14190 environment [in the manner described in section
14191 \begin_inset space ~
14195 \begin_inset CommandInset ref
14197 reference "sec:slideQuirk"
14202 ] tells \SpecialChar LyX
14203 to begin a new slide [duh].
14204 The label for this environment/
14205 \begin_inset Quotes erd
14209 \begin_inset Quotes erd
14213 \begin_inset Quotes eld
14217 \begin_inset Quotes erd
14221 followed by the label,
14223 \begin_inset Quotes eld
14227 \begin_inset Quotes erd
14231 Any text or paragraph environments that follow this one go on the new slide.
14235 \begin_layout Standard
14236 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
14237 (this can be specified in the
14244 once you finish entering the contents of one slide.
14245 If you've entered more text than can physically fit on a slide,
14246 the extra overflows onto a new slide.
14247 I don't recommend doing this,
14249 since the overflow slide won't have any page number on it.
14251 it may interfere with any
14255 you've made to accompany the oversized
14262 \begin_layout Standard
14271 environments work the same way as the
14276 They both create an
14277 \begin_inset Quotes eld
14281 \begin_inset Quotes erd
14284 followed by a label [
14285 \begin_inset Quotes eld
14289 \begin_inset Quotes erd
14293 \begin_inset Quotes eld
14297 \begin_inset Quotes erd
14302 The color is a stunning magenta instead of blue,
14304 \begin_inset Quotes eld
14308 \begin_inset Quotes erd
14311 will look different,
14312 in style and in length.
14313 The label fonts of all three also differ from one another.
14316 \begin_layout Standard
14322 if the contents of a
14330 exceed the physical size of a slide or sheet of paper,
14331 the extra will overflow onto a new sheet.
14333 you should avoid this.
14334 It defeats the whole purpose of
14345 \begin_layout Paragraph
14355 \begin_layout Standard
14360 is a slide that sits atop another slide.
14361 Perhaps you wish to discuss a figure on the main
14365 before displaying the text associated with it.
14366 One way to accomplish this is tape a flap of dark paper over the part of the
14370 you want to display later.
14373 if you wish to overlap one graph with another,
14375 You would then have to fumble while speaking to align the two separate,
14380 s to align the two graphs.
14385 environment in both cases makes life much easier.
14388 \begin_layout Standard
14393 receives the page number of its
14394 \begin_inset Quotes eld
14398 \begin_inset Quotes erd
14407 \begin_inset Quotes eld
14415 \begin_inset Quotes erd
14422 \begin_layout Plain Layout
14429 \begin_inset Quotes eld
14437 \begin_inset Quotes erd
14442 \begin_inset Quotes eld
14450 \begin_inset Quotes erd
14455 \begin_inset Quotes eld
14463 \begin_inset Quotes erd
14468 \begin_inset space ~
14471 appended to the page number of the parent
14482 you want the contents of both the
14490 to each fit on a single physical slide!
14491 You should probably consider an
14496 \begin_inset Quotes eld
14500 \begin_inset Quotes erd
14509 the \SpecialChar LyX
14514 class provides a visual cue for this:
14515 the label at the start of an
14519 is shorter than that at the start of a
14525 when you generate printable output,
14526 you'll find alignment markers in all four corners of both the
14530 page and its parent
14535 These will assist you in lining up the two physical slides.
14538 \begin_layout Standard
14539 The major problem in overlaying two slides is aligning the contents of the two transparencies.
14540 How much space should you leave for that graph on the second slide?
14542 what if you want a graph and a sentence on second slide,
14543 but there is text on the main transparency that goes in between them?
14544 You could try and insert vertical space of the right size.
14545 The better way is to use
14556 \begin_layout Standard
14557 As their names imply,
14566 are two command-like paragraph environments that make all subsequent text invisible and visible,
14569 \begin_inset space ~
14573 \begin_inset CommandInset ref
14575 reference "sec:slideQuirk"
14580 that you don't place anything
14584 these two environments,
14591 it inserts a centered,
14592 sky-blue label into the page reading
14593 \begin_inset Quotes eld
14596 <Invisible Text Follows>
14597 \begin_inset Quotes erd
14601 For paragraphs following this label,
14611 it doesn't matter which] where they would be contain instead blank space.
14615 \begin_layout Standard
14621 the corresponding centered label is
14622 \begin_inset Quotes eld
14625 <Visible Text Follows>
14626 \begin_inset Quotes erd
14630 Paragraphs following this label behave normally.
14631 Note that the beginning of a new
14645 automatically shuts off an
14650 It's therefore not necessary to use
14661 \begin_layout Standard
14663 it should be obvious how to create overlay transparencies using the proper combination of
14682 \begin_layout Enumerate
14688 including everything that will appear on it,
14689 whether on the main slide or on the
14696 \begin_layout Enumerate
14697 Before each figure or paragraph that will appear only on the
14712 environment after the
14719 \begin_layout Enumerate
14724 immediately following the
14731 \begin_layout Enumerate
14732 Copy the contents of this
14743 \begin_layout Enumerate
14760 \begin_layout Standard
14762 You've just made an
14769 \begin_layout Standard
14770 There's one problem with the way I've designed the \SpecialChar LyX
14776 you can't make text in the middle of a paragraph invisible,
14777 nor make text in the middle of an invisible paragraph visible again.
14778 To accomplish this feat,
14779 you'll need to use some inlined \SpecialChar LaTeX
14784 \begin_layout Plain Layout
14785 The commands of interest are:
14789 \begin_layout Itemize
14794 invisible \SpecialChar ldots
14798 \begin_layout Itemize
14803 visible \SpecialChar ldots
14807 \begin_layout Plain Layout
14809 and need to be marked as \SpecialChar TeX
14812 \begin_inset Quotes eld
14816 \begin_inset Quotes erd
14819 you wish to change goes in between the brackets [and after the
14832 If you don't know how to mark text as \SpecialChar TeX
14834 see the appropriate section of the
14846 \begin_layout Paragraph
14856 \begin_inset CommandInset label
14858 name "sec:slideNote"
14865 \begin_layout Standard
14875 is associated with a
14876 \begin_inset Quotes eld
14880 \begin_inset Quotes erd
14890 the \SpecialChar LyX
14895 class provides visual cues.
14900 is shorter than that of a
14904 [yet longer than that of an
14909 like the label of an
14913 is shockingly magenta.
14919 has the page number of its
14920 \begin_inset Quotes eld
14924 \begin_inset Quotes erd
14933 \begin_inset Quotes eld
14941 \begin_inset Quotes erd
14946 \begin_inset Quotes eld
14954 \begin_inset Quotes erd
14959 \begin_inset Quotes eld
14967 \begin_inset Quotes erd
14972 You can have multiple
14976 s associated with a single
14991 you'll probably want to break up long
14995 s so that they fit on a single sheet of paper.
14998 \begin_layout Standard
15004 it contains anything additional you might want to say about a
15009 It could also be used as a sheet of reminders for a particular
15014 In the case of the latter,
15015 you might want to make use of time markers.
15017 the \SpecialChar LyX
15023 \begin_inset Quotes eld
15027 \begin_inset Quotes erd
15030 support for time markers,
15033 Sli\SpecialChar TeX
15038 you'll have to resort to using the \SpecialChar LaTeX
15042 \begin_layout Standard
15043 To use time markers,
15044 you'll need to specify the extra class option
15045 \begin_inset Quotes eld
15053 \begin_inset Quotes erd
15057 \begin_inset space ~
15061 \begin_inset CommandInset ref
15063 reference "sec:slidesetup"
15069 This option turns on timing marks,
15070 which will appear in the lower-left-hand corner of every
15075 To set what appears in the time marker,
15076 you use the \SpecialChar LaTeX
15078 \begin_inset Quotes eld
15088 \begin_inset Quotes erd
15092 \begin_inset Quotes eld
15102 \begin_inset Quotes erd
15106 The arguments of both commands are time measured in seconds.
15108 \begin_inset Quotes eld
15118 \begin_inset Quotes erd
15121 sets the time marker to a given time.
15123 \begin_inset Quotes eld
15133 \begin_inset Quotes erd
15136 increments the time marker by the specified amount.
15137 Using time markers and
15142 you can remind yourself how much time to spend on a particular
15149 \begin_layout Standard
15150 There's one last feature to describe.
15152 you'd like to print out all of your
15160 s on transparencies while printing all of your
15178 with which it is associated.
15179 What's a person to do?
15182 \begin_layout Standard
15184 there are two \SpecialChar LaTeX
15185 commands that allow you to select what to print out.
15186 Both must be placed into the preamble of your document.
15188 \begin_inset Quotes eld
15200 \begin_inset Quotes erd
15203 will cause the output to contain only the
15214 \begin_inset Quotes eld
15226 \begin_inset Quotes erd
15229 prevents the output of anything but
15234 I'd advise placing both commands in the preamble and initially comment both out.
15235 You can then preview your entire presentation as you write.
15236 When you're done writing,
15237 you can then uncomment one of the two to select what you want to print.
15238 I like to uncomment
15239 \begin_inset Quotes eld
15251 \begin_inset Quotes erd
15255 print to a file with
15256 \begin_inset Quotes eld
15264 \begin_inset Quotes erd
15268 comment it back out,
15270 \begin_inset Quotes eld
15282 \begin_inset Quotes erd
15286 \begin_inset Quotes eld
15294 \begin_inset Quotes erd
15298 I can then send either file to a printer,
15299 loading transparencies or plain paper as appropriate.
15302 \begin_layout Standard
15303 You can also provide other arguments to the
15304 \begin_inset Quotes eld
15314 \begin_inset Quotes erd
15318 \begin_inset Quotes eld
15328 \begin_inset Quotes erd
15332 See a good \SpecialChar LaTeX
15336 \begin_layout Subsubsection
15341 Class Template File
15344 \begin_layout Standard
15345 I have also provided a template file
15346 \change_deleted 564990737 1671617750
15349 \begin_inset Quotes eld
15357 \begin_inset Quotes erd
15369 begin your new presentation with
15371 File\SpecialChar menuseparator
15373 \begin_inset space ~
15377 \begin_inset space ~
15381 \change_inserted 564990737 1671616988
15382 \SpecialChar menuseparator
15383 Presentations\SpecialChar menuseparator
15389 Your new \SpecialChar LyX
15390 presentation file will contain an example
15411 additionally contain an example of the use of
15421 the preamble will contain:
15424 \begin_layout LyX-Code
15425 % Uncomment to print out only slides and overlays
15428 \begin_layout LyX-Code
15432 \begin_layout LyX-Code
15438 \begin_inset Newline newline
15444 \begin_layout LyX-Code
15445 % Uncomment to print out only notes
15448 \begin_layout LyX-Code
15452 \begin_layout LyX-Code
15460 \begin_layout Standard
15462 I created this class to support the \SpecialChar LaTeX2e
15464 \begin_inset Quotes eld
15469 Sli\SpecialChar TeX
15473 \begin_inset Quotes erd
15477 one of the built-in \SpecialChar LaTeX2e
15479 Neither I nor the rest of the \SpecialChar LyX
15480 Team endorse or oppose the use of this built-in slide class.
15481 It's here if you want it or need it.
15482 There exist other \SpecialChar LaTeX2e
15483 classes for creating presentations,
15489 \begin_inset space ~
15493 \begin_inset CommandInset ref
15495 reference "sec:foiltex"
15501 \begin_inset Quotes eld
15509 \begin_inset Quotes erd
15512 package [present on some \SpecialChar TeX
15514 The latter is not yet supported under \SpecialChar LyX
15519 \begin_layout Plain Layout
15520 Perhaps you can take on the task\SpecialChar ldots
15526 I know nothing about these other classes.
15527 Try them out to see what sort of alternative they provide.
15530 \begin_layout Section
15532 \change_inserted 564990737 1670439661
15536 \begin_layout Subsection
15538 \change_inserted 564990737 1670439661
15542 \begin_layout Standard
15544 \change_inserted 564990737 1670439661
15553 document class for preparing reports.
15559 this provides parts,
15560 chapters and sections but does not provide the paragraph styles needed for a book;
15566 it provides the abstract paragraph style.
15568 it does not start a new chapter on the right hand page.
15571 \begin_layout Standard
15573 \change_inserted 564990737 1672743528
15578 document classes are described in the Collections (section
15579 \begin_inset space ~
15583 \begin_inset CommandInset ref
15585 reference "sec:Collections"
15593 \begin_layout Standard
15595 \change_inserted 564990737 1672743530
15599 \begin_inset space \thinspace{}
15602 (Japanese in vertical writing)
15607 \begin_inset space \thinspace{}
15614 \begin_inset space ~
15618 \begin_inset CommandInset ref
15620 reference "subsec:Japanese"
15628 \begin_layout Standard
15630 \change_inserted 564990737 1672743530
15634 \begin_inset space \thinspace{}
15641 \begin_inset space ~
15645 \begin_inset CommandInset ref
15647 reference "subsec:KOMA-Script"
15655 \begin_layout Standard
15657 \change_inserted 564990737 1672743530
15661 \begin_inset space \thinspace{}
15664 (with extra font sizes)
15668 \begin_inset space ~
15672 \begin_inset CommandInset ref
15674 reference "subsec:Extra-font-sizes"
15682 \begin_layout Standard
15684 \change_inserted 564990737 1672743569
15688 \begin_inset space \thinspace{}
15691 (Polish version by M.
15692 \begin_inset space \thinspace{}
15699 \begin_inset space ~
15703 \begin_inset CommandInset ref
15705 reference "subsec:Polish-M.W.collection"
15716 \begin_layout Section
15718 \change_inserted 564990737 1670439674
15722 \begin_layout Subsection
15726 \begin_layout Standard
15732 \begin_layout Subsubsection
15736 \begin_layout Standard
15737 Broadway is for writing plays.
15738 The format is more decorative than Hollywood,
15739 and much less standardized.
15740 This format should be suitable for workshops.
15743 \begin_layout Subsubsection
15747 \begin_layout Standard
15748 The same as in Hollywood.
15751 \begin_layout Subsubsection
15755 \begin_layout Standard
15760 names as labels then cross-reference the label to insert the name.
15761 The cross-reference dialog will show the current cast of characters.
15764 \begin_layout Subsubsection
15765 Paper size and Margins
15768 \begin_layout Standard
15776 \begin_layout Subsubsection
15780 \begin_layout Standard
15781 The following environments are available.
15782 You can use broadway.bind to get the bind keys shown at the right.
15785 \begin_layout Itemize
15789 \begin_inset Newline newline
15794 You should not have to use this,
15795 but it is here for anything that does not fit otherwise.
15798 \begin_layout Itemize
15802 \begin_inset space \hfill{}
15806 \begin_inset Newline newline
15811 Used to describe stage setting and the action.
15812 First use of speaker names in all CAPs.
15815 \begin_layout Itemize
15819 \begin_inset space \hfill{}
15823 \begin_inset Newline newline
15828 Automatically numbered.
15829 On screen it will be arabic,
15830 but will print as Roman.
15833 \begin_layout Itemize
15837 \begin_inset space \hfill{}
15841 \begin_inset Newline newline
15851 It is just centered text.
15854 \begin_layout Itemize
15858 \begin_inset space \hfill{}
15862 \begin_inset Newline newline
15867 Not automatically numbered.
15868 You supply the number.
15869 This is because I couldn't figure out how.
15872 \begin_layout Itemize
15876 \begin_inset space \hfill{}
15880 \begin_inset Newline newline
15885 A special case of Narrative to describe the setting and action as the curtain rises.
15888 \begin_layout Itemize
15892 \begin_inset space \hfill{}
15896 \begin_inset Newline newline
15901 The speaker's (actor's) title,
15902 centered in all CAPS.
15905 \begin_layout Itemize
15909 \begin_inset space \hfill{}
15913 \begin_inset Newline newline
15918 Instructions to the speaker.
15919 The parentheses are automatically inserted.
15920 The ( will appear on screen,
15921 but both will be in the printed play.
15922 This environment is only used within
15929 \begin_layout Itemize
15933 \begin_inset space \hfill{}
15937 \begin_inset Newline newline
15942 What the Speaker says.
15945 \begin_layout Itemize
15949 \begin_inset space \hfill{}
15953 \begin_inset Newline newline
15958 The curtain comes down.
15961 \begin_layout Itemize
15965 \begin_inset space \hfill{}
15971 \begin_layout Itemize
15975 \begin_inset space \hfill{}
15981 \begin_layout Itemize
15985 \begin_inset space \hfill{}
15991 \begin_layout Standard
15995 \begin_layout Subsection
15996 Hollywood (Hollywood spec scripts)
15999 \begin_layout Standard
16005 \begin_layout Subsubsection
16009 \begin_layout Standard
16010 Getting the format of a Hollywood script right is a
16011 \begin_inset Quotes eld
16015 \begin_inset Quotes erd
16018 It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
16019 Each page of a script should be one minute of film.
16020 Nothing goes in a script that you cannot see or hear on screen.
16021 The courier 12 pt font should be used throughout.
16025 \begin_layout Subsubsection
16029 \begin_layout Standard
16030 Speakers' lines should NEVER break in mid-sentence.
16031 If a speaker's lines continue over a page break,
16036 title followed by (Cont'd).
16039 \begin_layout Subsubsection
16043 \begin_layout Standard
16048 names as labels then cross-reference the label to insert the name.
16049 The cross-reference dialog will show the current cast of characters.
16050 You can use this to insert the speaker name in narratives also.
16053 \begin_layout Subsubsection
16054 Paper size and Margins
16057 \begin_layout Standard
16065 \begin_layout Subsubsection
16069 \begin_layout Standard
16070 The following environments are available.
16071 You can use hollywood.bind to get the bind keys shown at the right.
16074 \begin_layout Itemize
16078 \begin_inset Newline newline
16083 Used where nothing else works.
16087 \begin_layout Itemize
16093 \begin_inset space \hfill{}
16101 \begin_inset Newline newline
16104 Usually followed by something like
16105 \begin_inset Quotes eld
16108 on Sally waking up.
16109 \begin_inset Quotes erd
16115 \begin_layout Itemize
16119 \begin_inset space \hfill{}
16123 \begin_inset Newline newline
16128 Introduces a new INTERIOR camera set-up.
16129 Always followed by DAY or NIGHT,
16130 or something similar to define the lighting required.
16131 Everthing on this line in CAPS.
16134 \begin_layout Itemize
16138 \begin_inset space \hfill{}
16142 \begin_inset Newline newline
16147 Introduces a new EXTERIOR camera set-up.
16148 Everthing on this line in CAPS.
16151 \begin_layout Itemize
16155 \begin_inset space \hfill{}
16159 \begin_inset Newline newline
16164 The character speaking.
16167 \begin_layout Itemize
16171 \begin_inset space \hfill{}
16175 \begin_inset Newline newline
16180 Instructions to the speaker.
16181 The () are automatically inserted.
16184 \begin_layout Itemize
16188 \begin_inset space \hfill{}
16192 \begin_inset Newline newline
16204 \begin_layout Itemize
16208 \begin_inset space \hfill{}
16212 \begin_inset Newline newline
16217 Camera movement instruction.
16219 \begin_inset space \thinspace{}
16223 \begin_inset space \space{}
16229 \begin_layout Itemize
16233 \begin_inset space \hfill{}
16239 \begin_layout Itemize
16243 \begin_inset space \hfill{}
16249 \begin_layout Itemize
16253 \begin_inset space \hfill{}
16259 \begin_layout Itemize
16263 \begin_inset space \hfill{}
16269 \begin_layout Subsubsection
16273 \begin_layout Itemize
16278 \begin_layout Itemize
16283 \begin_layout Itemize
16285 \begin_inset space \thinspace{}
16293 \begin_layout Itemize
16299 \begin_layout Itemize
16304 \begin_layout Itemize
16309 \begin_layout Chapter
16311 \change_inserted 564990737 1671185876
16315 \begin_layout Section
16317 \change_inserted 564990737 1671716212
16318 Academic Field Specifics
16321 \begin_layout Subsection
16323 \change_inserted 564990737 1671716212
16325 Hazard and Precautionary Statements
16328 \begin_layout Standard
16330 \change_inserted 564990737 1671716212
16331 This module provides two insets to typeset numbers and phrases of chemical hazard and precautionary statements.
16332 For a description see
16334 File\SpecialChar menuseparator
16335 Open Example\SpecialChar menuseparator
16336 Modules\SpecialChar menuseparator
16337 Hazard and Precautionary Statements
16341 Help\SpecialChar menuseparator
16342 Specific Manuals\SpecialChar menuseparator
16343 Hazard and Precautionary Statements
16348 \begin_layout Subsection
16350 \change_inserted 564990737 1671716212
16354 Risk and Safety Statements
16357 \begin_layout Standard
16359 \change_inserted 564990737 1671716212
16360 This module provides two insets,
16370 accessible via the menu
16375 nsert\SpecialChar menuseparator
16377 \begin_inset space ~
16382 and an environment to typeset numbers and phrases of chemical risk and safety statements.
16385 \begin_layout Subsection
16387 \change_inserted 564990737 1671716212
16391 \begin_layout Standard
16393 \change_inserted 564990737 1671716212
16394 This module uses the
16398 package to add environments useful for linguistics (numbered examples,
16402 You can obtain information about this module in
16407 elp\SpecialChar menuseparator
16413 \begin_inset space ~
16416 Manuals\SpecialChar menuseparator
16425 File\SpecialChar menuseparator
16426 Open Example\SpecialChar menuseparator
16427 Modules\SpecialChar menuseparator
16433 \begin_layout Section
16435 \change_inserted 564990737 1671788778
16439 \begin_layout Subsection
16441 \change_inserted 564990737 1671788778
16445 \begin_layout Standard
16447 \change_inserted 564990737 1671788778
16448 This module supports the Braille writing system.
16449 It requires the \SpecialChar LaTeX
16455 This and its documentation can be obtained from
16456 \begin_inset CommandInset href
16459 target "https://www.ctan.org/pkg/braille"
16465 You do not have to reconfigure your system after installing it.
16471 elp\SpecialChar menuseparator
16477 \begin_inset space ~
16480 Manuals\SpecialChar menuseparator
16489 File\SpecialChar menuseparator
16490 Open Example\SpecialChar menuseparator
16491 Modules\SpecialChar menuseparator
16497 \begin_layout Section
16499 \change_inserted 564990737 1671788778
16500 Annotation & Revision
16503 \begin_layout Subsection
16505 \change_inserted 564990737 1671788778
16509 \begin_layout Standard
16511 \change_inserted 564990737 1671788778
16512 This module provides “FiXme” (marginal) annotations for document revision purposes.
16513 A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
16514 The annotations are customizable via the LaTeX preamble.
16515 See the FiXme documentation which can be obtained from
16516 \begin_inset CommandInset href
16519 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
16528 \begin_layout Paragraph
16530 \change_inserted 564990737 1671788778
16534 \begin_layout Standard
16536 \change_inserted 564990737 1671788778
16538 the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
16540 Document\SpecialChar menuseparator
16541 Settings\SpecialChar menuseparator
16542 Document Class\SpecialChar menuseparator
16543 Class Options\SpecialChar menuseparator
16547 To display them always,
16556 Document\SpecialChar menuseparator
16557 Settings\SpecialChar menuseparator
16565 \begin_layout Subsection
16567 \change_inserted 564990737 1671788778
16571 \begin_layout Standard
16573 \change_inserted 564990737 1671788778
16574 This module provides various kinds of annotations for PDF output.
16577 Help\SpecialChar menuseparator
16578 Specific Manuals\SpecialChar menuseparator
16579 PDF comments and File\SpecialChar menuseparator
16580 Open Example\SpecialChar menuseparator
16581 Modules\SpecialChar menuseparator
16587 \begin_layout Subsection
16589 \change_inserted 564990737 1671788778
16595 \begin_layout Standard
16597 \change_inserted 564990737 1671788778
16598 This module provides fields and buttons for PDF forms.
16600 \begin_inset CommandInset href
16602 name "hyperref documentation"
16603 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
16611 Help\SpecialChar menuseparator
16612 Specific Manuals\SpecialChar menuseparator
16613 PDF forms and File\SpecialChar menuseparator
16614 Open Example\SpecialChar menuseparator
16615 Modules\SpecialChar menuseparator
16621 \begin_layout Subsection
16623 \change_inserted 564990737 1671788778
16629 \begin_layout Standard
16631 \change_inserted 564990737 1671788778
16632 This module defines an inset to typeset reading aids (ruby,
16633 furigana) to Chinese characters.
16634 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on the TeX engine) or a fallback definition.
16638 \begin_layout Subsection
16640 \change_inserted 564990737 1671788778
16646 \begin_layout Standard
16648 \change_inserted 564990737 1671788778
16649 This module provides custom insets to insert TODO items in your document.
16650 In order to generate a “List of TODOs,” the module provides a paragraph style.
16651 Inserting “final” in
16653 Document\SpecialChar menuseparator
16654 Settings\SpecialChar menuseparator
16655 Document Class\SpecialChar menuseparator
16656 Class Options\SpecialChar menuseparator
16659 ) suppresses the output of TODO notes.
16661 \begin_inset CommandInset href
16663 name "todonotes documentation"
16664 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
16672 \begin_layout Section
16674 \change_inserted 564990737 1671829045
16678 \begin_layout Subsection
16680 \change_inserted 564990737 1671829045
16681 APA Style with NatBib
16684 \begin_layout Standard
16686 \change_inserted 564990737 1671829045
16687 This module adds support for using natbib together with apacite (the bibliography style need not be apacite —
16688 it could be apacite,
16690 or any bibliography that works with both the natbib and apacite packages.)
16693 \begin_layout Section
16695 \change_inserted 564990737 1671829045
16699 \begin_layout Subsection
16701 \change_inserted 564990737 1671829045
16702 Fancy Colored Boxes
16705 \begin_layout Standard
16707 \change_inserted 564990737 1671829045
16708 This module adds ten custom insets that support colored boxes via the tcolorbox package.
16711 Help\SpecialChar menuseparator
16712 Specific Manuals\SpecialChar menuseparator
16718 File\SpecialChar menuseparator
16719 Open Example\SpecialChar menuseparator
16720 Modules\SpecialChar menuseparator
16724 \begin_inset CommandInset href
16726 name "tcolorbox documentation"
16727 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
16736 \begin_layout Subsection
16738 \change_inserted 564990737 1671829045
16742 \begin_layout Standard
16744 \change_inserted 564990737 1671829045
16745 This provides the custom insets
16763 to scale and rotate its content.
16766 \begin_layout Standard
16768 \change_inserted 564990737 1671829045
16773 is a simple way of reversing text without any other enhancement:
16776 \begin_layout Standard
16778 \change_inserted 564990737 1671829045
16779 \begin_inset Flex Reflectbox
16782 \begin_layout Plain Layout
16784 \change_inserted 564990737 1671829045
16785 Great Western Railway
16795 \begin_layout Standard
16797 \change_inserted 564990737 1671829045
16798 (You will need to use Ctrl-R to see any of these examples.)
16801 \begin_layout Standard
16803 \change_inserted 564990737 1671829045
16808 allows you to specify the dimensions of the text or image;
16809 permissible units are em,
16831 it scales by the width factor:
16834 \begin_layout Standard
16836 \change_inserted 564990737 1671829045
16837 \begin_inset Flex Resizebox
16840 \begin_layout Plain Layout
16842 \change_inserted 564990737 1671829045
16843 \begin_inset Argument 1
16846 \begin_layout Plain Layout
16848 \change_inserted 564990737 1671829045
16857 \begin_inset Argument 2
16860 \begin_layout Plain Layout
16862 \change_inserted 564990737 1671829045
16870 Great Western Railway
16880 \begin_layout Standard
16882 \change_inserted 564990737 1671829045
16887 allows you to rotate text around the reference point of the box.
16888 If you wish to rotate the box around a different origin,
16889 place the cursor inside the box and select Insert\SpecialChar menuseparator
16919 or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
16923 \begin_layout Standard
16925 \change_inserted 564990737 1671829045
16926 \begin_inset Flex Rotatebox
16929 \begin_layout Plain Layout
16931 \change_inserted 564990737 1671829045
16932 \begin_inset Argument 1
16935 \begin_layout Plain Layout
16937 \change_inserted 274215730 1672888693
16939 \change_inserted 564990737 1671829045
16948 \begin_inset Argument 2
16951 \begin_layout Plain Layout
16953 \change_inserted 564990737 1671829045
16961 Great Western Railway
16971 \begin_layout Standard
16973 \change_inserted 564990737 1671829045
16974 You can combine boxes as in:
16977 \begin_layout Standard
16979 \change_inserted 564990737 1671829045
16980 \begin_inset Flex Rotatebox
16983 \begin_layout Plain Layout
16985 \change_inserted 564990737 1671829045
16986 \begin_inset Argument 1
16989 \begin_layout Plain Layout
16991 \change_inserted 274215730 1672888702
16993 \change_inserted 564990737 1671829045
17002 \begin_inset Argument 2
17005 \begin_layout Plain Layout
17007 \change_inserted 564990737 1671829045
17016 \begin_inset Flex Resizebox
17019 \begin_layout Plain Layout
17021 \change_inserted 564990737 1671829045
17022 \begin_inset Argument 1
17025 \begin_layout Plain Layout
17027 \change_inserted 564990737 1671829045
17036 \begin_inset Argument 2
17039 \begin_layout Plain Layout
17041 \change_inserted 564990737 1671829045
17050 \begin_inset Flex Reflectbox
17053 \begin_layout Plain Layout
17055 \change_inserted 564990737 1671829045
17056 Great Western Railway
17080 \begin_layout Standard
17082 \change_inserted 564990737 1671829045
17088 select Insert\SpecialChar menuseparator
17089 V-Factor to add a vertical factor.
17090 If the vertical factor is omitted,
17091 the horizontal is used.
17092 Adding different horizontal and vertical values creates distortion as in
17095 \begin_layout Standard
17097 \change_inserted 564990737 1671829045
17100 \begin_inset Flex Scalebox
17103 \begin_layout Plain Layout
17105 \change_inserted 564990737 1671829045
17106 \begin_inset Argument 1
17109 \begin_layout Plain Layout
17111 \change_inserted 564990737 1671829045
17120 \begin_inset Argument 2
17123 \begin_layout Plain Layout
17125 \change_inserted 564990737 1671829045
17135 Great Western Railway
17145 \begin_layout Standard
17147 \change_inserted 564990737 1671829045
17148 A negative horizontal value reverses the text and a negative vertical value inverts it so that you get
17151 \begin_layout Standard
17153 \change_inserted 564990737 1671829045
17154 \begin_inset Flex Scalebox
17157 \begin_layout Plain Layout
17159 \change_inserted 564990737 1671829045
17160 \begin_inset Argument 1
17163 \begin_layout Plain Layout
17165 \change_inserted 564990737 1671829045
17174 \begin_inset Argument 2
17177 \begin_layout Plain Layout
17179 \change_inserted 564990737 1671829045
17187 Great Western Railway
17195 \begin_inset Flex Scalebox
17198 \begin_layout Plain Layout
17200 \change_inserted 564990737 1671829045
17201 \begin_inset Argument 1
17204 \begin_layout Plain Layout
17206 \change_inserted 564990737 1671829045
17215 \begin_inset Argument 2
17218 \begin_layout Plain Layout
17220 \change_inserted 564990737 1671829045
17228 Great Western Railway
17238 \begin_layout Subsection
17240 \change_inserted 564990737 1671884699
17244 \begin_layout Standard
17246 \change_inserted 564990737 1671884699
17247 This module defines Boxes with section header.
17248 It is mainly intended for the SciPoster Document class.
17252 \begin_layout Subsection
17254 \change_inserted 564990737 1671884699
17255 Variable-width Minipages
17258 \begin_layout Standard
17260 \change_inserted 564990737 1671884699
17264 \begin_inset space \thinspace{}
17271 Insert\SpecialChar menuseparator
17283 package provides a variable-width minipage,
17284 whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
17285 The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
17287 Insert\SpecialChar menuseparator
17289 \begin_inset space \thinspace{}
17300 Insert\SpecialChar menuseparator
17302 \begin_inset space \thinspace{}
17316 File\SpecialChar menuseparator
17317 Open Example\SpecialChar menuseparator
17318 Variable-width Minipages
17324 \begin_layout Section
17326 \change_inserted 564990737 1671884699
17330 \begin_layout Subsection
17332 \change_inserted 564990737 1671884699
17333 Fix Computer Modern Fonts
17336 \begin_layout Standard
17338 \change_inserted 564990737 1671884699
17339 This module uses the
17343 package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
17345 \begin_inset CommandInset href
17347 name "fix-cm documentation"
17348 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
17357 \begin_layout Subsection
17359 \change_inserted 564990737 1671884699
17361 Kernel Fixes (Obsolete)
17364 \begin_layout Standard
17366 \change_inserted 564990737 1671884699
17367 This module loads the \SpecialChar LaTeX
17372 which contains some bug fixes for \SpecialChar LaTeX
17374 If you use this module your typeset document may look different when you process it,
17375 depending on the respective version of
17383 \begin_layout Paragraph
17385 \change_inserted 564990737 1671884699
17389 \begin_layout Standard
17391 \change_inserted 564990737 1671884699
17392 recent \SpecialChar LaTeX
17393 kernels (as of 2015/01/01) include the functionality of
17402 module is obsolete with newer \SpecialChar LaTeX
17407 \begin_layout Subsection
17409 \change_inserted 564990737 1671884699
17410 Minimalistic Insets
17413 \begin_layout Standard
17415 \change_inserted 564990737 1671884699
17416 This module redefines several insets (Index,
17418 URL) as being Minimalistic.
17421 \begin_layout Subsection
17423 \change_inserted 564990737 1671884699
17424 Title and Preamble Hacks
17427 \begin_layout Standard
17429 \change_inserted 564990737 1671884699
17430 This module provides two new paragraph styles:
17434 \begin_layout Enumerate
17436 \change_inserted 564990737 1671884699
17441 which puts whatever is entered into it into the preamble.
17444 to include preamble code in the body of a LyX document.
17448 \begin_layout Enumerate
17450 \change_inserted 564990737 1671884699
17455 which that will put its contents into the body of the LaTeX document,
17463 This is useful for making branches and notes in title-related material.
17465 if you put these in a Standard layout,
17466 this signals to LyX to output
17473 which may then come too early.)
17476 \begin_layout Section
17478 \change_inserted 564990737 1672081439
17482 \begin_layout Subsection
17484 \change_inserted 564990737 1672081439
17488 \begin_layout Standard
17490 \change_inserted 564990737 1672081439
17491 This module uses the
17495 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
17496 Use the Algorithm paragraph style to enter and indent the algorithm.
17498 \begin_inset CommandInset href
17500 name "algorithm2e documentation"
17501 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
17509 \begin_layout Subsection
17511 \change_inserted 564990737 1672081439
17512 Bilingual Captions AKA Multilingual Captions
17515 \begin_layout Standard
17517 \change_inserted 564990737 1672081439
17518 This module provides the paragraph style
17521 \begin_inset space ~
17526 with which to typeset multilingual captions.
17527 Within this paragraph style
17529 Insert\SpecialChar menuseparator
17532 allows you to enter the desired language using one of the babel names.
17535 File\SpecialChar menuseparator
17536 Open Example\SpecialChar menuseparator
17537 Multilingual Captions
17541 Help\SpecialChar menuseparator
17542 Specific Manuals\SpecialChar menuseparator
17543 Multilingual Captions
17545 further information on its use.
17548 \begin_layout Subsection
17550 \change_inserted 564990737 1672081439
17551 Number Figures by Section
17554 \begin_layout Standard
17556 \change_inserted 564990737 1672081439
17557 This module resets the figure number at section start and prepends the section number to the figure number,
17558 as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
17561 \begin_layout Subsection
17563 \change_inserted 564990737 1672081439
17564 Number Tables by Section
17567 \begin_layout Standard
17569 \change_inserted 564990737 1672081439
17570 This module resets the table number at section start and prepends the section number to the table number,
17571 as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
17574 \begin_layout Section
17576 \change_inserted 564990737 1672081439
17580 \begin_layout Subsection
17582 \change_inserted 564990737 1672081439
17586 \begin_layout Standard
17588 \change_inserted 564990737 1672081439
17589 This module adds an endnote inset,
17590 in addition to footnotes.
17596 which has some limitations but works with older LaTeX distributions as well.
17599 Insert\SpecialChar menuseparator
17600 Custom Inset\SpecialChar menuseparator
17603 to insert an endnote and
17605 Insert\SpecialChar menuseparator
17606 List/Contents/References\SpecialChar menuseparator
17609 to insert the endnotes list where you want the endnotes to appear.
17612 Help\SpecialChar menuseparator
17613 Embedded\SpecialChar menuseparator
17614 Objects\SpecialChar menuseparator
17615 Notes\SpecialChar menuseparator
17621 \begin_layout Subsection
17623 \change_inserted 564990737 1672081439
17624 Endnotes (Extended)
17627 \begin_layout Standard
17629 \change_inserted 564990737 1672081439
17630 This module adds an endnote inset,
17631 in addition to footnotes.
17636 package which is more powerful and customizable than the
17641 but requires a fairly modern LaTeX distribution (with LaTeX3).
17644 Insert\SpecialChar menuseparator
17645 Custom Inset\SpecialChar menuseparator
17648 to insert an endnote and
17650 Insert\SpecialChar menuseparator
17651 List/Contents/References\SpecialChar menuseparator
17654 to insert the endnotes list where you want the endnotes to appear.
17657 Help\SpecialChar menuseparator
17658 Embedded\SpecialChar menuseparator
17659 Objects\SpecialChar menuseparator
17660 Notes\SpecialChar menuseparator
17666 \begin_layout Subsection
17668 \change_inserted 564990737 1672081439
17669 Footnotes as Endnotes (Basic)
17672 \begin_layout Standard
17674 \change_inserted 564990737 1672081439
17675 This module sets all footnotes as endnotes.
17681 which has some limitations but works with older LaTeX distributions as well.
17684 Insert\SpecialChar menuseparator
17685 List/Contents/References\SpecialChar menuseparator
17688 to insert the endnotes list where you want the endnotes to appear.
17691 Help\SpecialChar menuseparator
17692 Embedded\SpecialChar menuseparator
17693 Objects\SpecialChar menuseparator
17694 Notes\SpecialChar menuseparator
17700 \begin_layout Subsection
17702 \change_inserted 564990737 1672081439
17703 Footnotes as Endnotes (Extended)
17706 \begin_layout Standard
17708 \change_inserted 564990737 1672081439
17709 This module sets all footnotes as endnotes.
17714 package which is more powerful and customizable than then
17719 but requires a fairly modern LaTeX distribution (with LaTeX3).
17722 Insert\SpecialChar menuseparator
17723 List/Contents/References\SpecialChar menuseparator
17726 to insert the endnotes list where you want the endnotes to appear.
17729 Help\SpecialChar menuseparator
17730 Embedded\SpecialChar menuseparator
17731 Objects\SpecialChar menuseparator
17732 Notes\SpecialChar menuseparator
17738 \begin_layout Section
17740 \change_inserted 564990737 1672081439
17745 \begin_layout Subsection
17747 \change_inserted 564990737 1672081439
17751 \begin_layout Standard
17753 \change_inserted 564990737 1672081439
17754 This module provides support for the
17758 package to print chess games.
17761 File\SpecialChar menuseparator
17762 Open Example\SpecialChar menuseparator
17763 Articles\SpecialChar menuseparator
17766 where you will find
17775 \begin_inset CommandInset href
17777 name "chessboard documentation"
17778 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
17786 \begin_layout Subsection
17788 \change_inserted 564990737 1672081439
17789 Lilypond Music Notation
17792 \begin_layout Standard
17794 \change_inserted 564990737 1672081439
17795 This module provides an inset via
17800 nsert\SpecialChar menuseparator
17801 Custom Inset\SpecialChar menuseparator
17804 in which to enter code for the LilyPond music editor.
17805 It will then be processed in the output.
17808 Help\SpecialChar menuseparator
17809 Specific Manuals\SpecialChar menuseparator
17814 File\SpecialChar menuseparator
17815 Open Example\SpecialChar menuseparator
17816 Modules\SpecialChar menuseparator
17820 It cannot be used if the modules
17823 \begin_inset space \thinspace{}
17831 \begin_layout Section
17833 \change_inserted 564990737 1672138150
17837 \begin_layout Subsection
17839 \change_inserted 564990737 1672138150
17841 \begin_inset CommandInset label
17843 name "subsec:Customizable-Lists"
17850 \begin_layout Standard
17852 \change_inserted 564990737 1672138150
17853 This module uses the
17857 package to enable the customization of various list environments.
17860 \begin_layout Subsubsection
17862 \change_inserted 564990737 1672138150
17863 Custom Enumerate Lists
17866 \begin_layout Standard
17869 \change_inserted 564990737 1672138150
17870 The default numbering of numbered lists can be changed by adding an optional argument (menu
17875 nsert\SpecialChar menuseparator
17882 ) to the first item of each level in the list.
17883 There you add the command
17886 \begin_layout Standard
17888 \change_inserted 564990737 1672138150
17896 \begin_layout Standard
17898 \change_inserted 564990737 1672138150
17899 in \SpecialChar TeX
17909 \begin_layout Standard
17911 \change_inserted 564990737 1672138150
17916 is the first level counter of the enumeration.
17917 To change the numbering for the list sublevels,
17922 ” in the command by the small Roman numeral of the level (
17944 \begin_layout Standard
17946 \change_inserted 564990737 1672138150
17953 outputs the counter as a small Roman numeral.
17954 For capital Roman numerals replace
17966 in the command above.
17967 For Arabic numerals use
17975 \begin_inset Quotes eld
17979 \begin_inset Quotes erd
17982 items with capital or small Latin letters use
17998 \begin_layout Standard
18001 \change_inserted 564990737 1672138150
18002 \begin_inset Note Greyedout
18005 \begin_layout Plain Layout
18007 \change_inserted 564990737 1672138150
18013 You can only number 26
18014 \begin_inset space ~
18017 items with Latin letters,
18018 because this numbering is limited to single letters.
18026 \begin_layout Standard
18028 \change_inserted 564990737 1672138150
18029 Here is a list with custom numbering:
18032 \begin_layout Enumerate
18034 \change_inserted 564990737 1672138150
18035 \begin_inset Argument 1
18038 \begin_layout Plain Layout
18040 \change_inserted 564990737 1672138150
18044 \begin_layout Plain Layout
18046 \change_inserted 564990737 1672138150
18067 \begin_inset Separator latexpar
18074 \begin_layout Enumerate
18076 \change_inserted 564990737 1672138150
18077 \begin_inset Argument 1
18080 \begin_layout Plain Layout
18082 \change_inserted 564990737 1672138150
18086 \begin_layout Plain Layout
18088 \change_inserted 564990737 1672138150
18109 \begin_layout Enumerate
18111 \change_inserted 564990737 1672138150
18113 \begin_inset Separator latexpar
18120 \begin_layout Enumerate
18122 \change_inserted 564990737 1672138150
18123 \begin_inset Argument 1
18126 \begin_layout Plain Layout
18128 \change_inserted 564990737 1672138150
18132 \begin_layout Plain Layout
18134 \change_inserted 564990737 1672138150
18137 \change_deleted 274215730 1672889016
18141 \change_inserted 274215730 1672889016
18145 \change_inserted 564990737 1672138150
18161 \begin_inset Separator latexpar
18168 \begin_layout Enumerate
18170 \change_inserted 564990737 1672138150
18171 \begin_inset Argument 1
18174 \begin_layout Plain Layout
18176 \change_inserted 564990737 1672138150
18180 \begin_layout Plain Layout
18182 \change_inserted 564990737 1672138150
18206 \begin_layout Standard
18208 \change_inserted 564990737 1672138150
18209 For this list these commands were used:
18212 \begin_layout Standard
18215 \change_inserted 564990737 1672138150
18225 \begin_inset Newline newline
18233 \begin_inset Newline newline
18237 \change_deleted 274215730 1672889037
18241 \change_inserted 274215730 1672889037
18245 \change_inserted 564990737 1672138150
18249 \begin_inset Newline newline
18259 \begin_layout Standard
18261 \change_inserted 564990737 1672138150
18268 makes the label emphasized and
18269 \change_deleted 274215730 1672889045
18275 \change_inserted 274215730 1672889046
18279 \change_inserted 564990737 1672138150
18285 \begin_layout Standard
18287 \change_inserted 564990737 1672138150
18288 \begin_inset Note Greyedout
18291 \begin_layout Plain Layout
18293 \change_inserted 564990737 1672138150
18299 When you change the label of a list level,
18300 it will be used for all following lists until you change the definition.
18308 \begin_layout Standard
18310 \change_inserted 564990737 1672138150
18314 \begin_layout Plain Layout
18316 \change_inserted 564990737 1672138150
18334 \begin_layout Subsubsection
18336 \change_inserted 564990737 1672138150
18337 Numbered Paragraphs in Reports
18340 \begin_layout Enumerate
18342 \change_inserted 564990737 1672138213
18343 Official reports often include numbered paragraphs;
18344 you can achieve this with a variation on the approach outlined in the footnote
18345 \begin_inset space ~
18349 \begin_inset CommandInset ref
18351 reference "fn:If-you-really"
18364 in each command with
18371 \begin_layout Enumerate
18373 \change_inserted 564990737 1672138150
18374 These numbered paragraphs were generated by inserting the \SpecialChar TeX
18376 \begin_inset Separator latexpar
18383 \begin_layout Standard
18385 \change_inserted 564990737 1672138150
18399 \begin_layout Standard
18401 \change_inserted 564990737 1672138150
18402 before the start of the section;
18409 uses the \SpecialChar LaTeX
18410 section counter to generate the first part of the number.
18414 \begin_layout Enumerate
18416 \change_inserted 564990737 1672138150
18417 I have ignored the subsection heading in this example because,
18418 with paragraphs numbered in this way,
18419 subsections are less likely to be used.
18422 \begin_layout Subsubsection
18424 \change_inserted 564990737 1672138150
18425 Resumed Enumeration
18428 \begin_layout Standard
18430 \change_inserted 564990737 1672138150
18434 \begin_layout Plain Layout
18436 \change_inserted 564990737 1672138150
18452 \begin_layout Standard
18454 \change_inserted 564990737 1672138150
18455 Enumerations can be resumed after intermediate paragraphs:
18458 \begin_layout Enumerate
18460 \change_inserted 564990737 1672138150
18461 \begin_inset Argument 1
18464 \begin_layout Plain Layout
18466 \change_inserted 564990737 1672138150
18470 \begin_layout Plain Layout
18472 \change_inserted 564990737 1672138150
18489 \begin_inset Note Note
18492 \begin_layout Plain Layout
18494 \change_inserted 564990737 1672138150
18495 goes back to default numbering
18503 \begin_layout Enumerate
18505 \change_inserted 564990737 1672138150
18509 \begin_layout Standard
18511 \change_inserted 564990737 1672138150
18515 \begin_layout Enumerate-Resume
18517 \change_inserted 564990737 1672138150
18521 \begin_layout Standard
18523 \change_inserted 564990737 1672138150
18524 To resume an enumeration,
18530 Its numbering appears in blue within \SpecialChar LyX
18531 to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
18536 \begin_layout Standard
18538 \change_inserted 564990737 1672138150
18539 \begin_inset Note Greyedout
18542 \begin_layout Plain Layout
18544 \change_inserted 564990737 1672138150
18550 If there is no previous enumeration to resume,
18551 you will get a \SpecialChar LaTeX
18560 \begin_layout Standard
18562 \change_inserted 564990737 1672138150
18563 Perhaps you might want to resume the list with a different number from the next one.
18564 Or you want to start a new enumeration with a defined number.
18565 This is possible by adding an optional argument to the first list item of a normal enumeration.
18570 \begin_layout Standard
18572 \change_inserted 564990737 1672138150
18578 \begin_layout Standard
18580 \change_inserted 564990737 1672138150
18585 is the number with which you want to resume the list.
18589 \begin_layout Enumerate
18591 \change_inserted 564990737 1672138150
18595 \begin_layout Enumerate
18597 \change_inserted 564990737 1672138150
18601 \begin_layout Standard
18603 \change_inserted 564990737 1672138150
18604 Enumeration starting at a given value:
18607 \begin_layout Enumerate
18609 \change_inserted 564990737 1672138150
18610 \begin_inset Argument 1
18613 \begin_layout Plain Layout
18615 \change_inserted 564990737 1672138150
18619 \begin_layout Plain Layout
18621 \change_inserted 564990737 1672138150
18635 This enumeration starts at 4
18638 \begin_layout Subsubsection
18640 \change_inserted 564990737 1672138150
18642 \begin_inset Index idx
18647 \begin_layout Plain Layout
18649 \change_inserted 564990737 1672138150
18661 \begin_layout Standard
18663 \change_inserted 564990737 1672138150
18664 In some cases you might want less or more vertical space between the items of a list.
18665 For example if the default space is too much in your opinion in this case:
18668 \begin_layout Itemize
18670 \change_inserted 564990737 1672138150
18674 \begin_layout Itemize
18676 \change_inserted 564990737 1672138150
18677 with standard spacing
18680 \begin_layout Standard
18682 \change_inserted 564990737 1672138150
18683 You can decrease the space by adding an optional argument to the first item of the list.
18684 Add there the command
18688 to get no additional list space like in this example:
18691 \begin_layout Itemize
18693 \change_inserted 564990737 1672138150
18694 \begin_inset Argument 1
18697 \begin_layout Plain Layout
18699 \change_inserted 564990737 1672138150
18703 \begin_layout Plain Layout
18705 \change_inserted 564990737 1672138150
18722 \begin_layout Itemize
18724 \change_inserted 564990737 1672138150
18728 \begin_layout Itemize
18730 \change_inserted 564990737 1672138150
18734 \begin_layout Standard
18736 \change_inserted 564990737 1672138150
18737 To add space you can use several other commands provided by the
18742 \begin_inset Index idx
18747 \begin_layout Plain Layout
18749 \change_inserted 564990737 1672138150
18760 For more information see the
18761 \begin_inset CommandInset href
18763 name "enumitem documentation"
18764 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18772 \begin_layout Standard
18774 \change_inserted 564990737 1672138150
18775 There are also many commands available to change the horizontal spacing and indentation.
18776 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
18777 \begin_inset space \thinspace{}
18780 cm so that the number is in the page margin:
18783 \begin_layout Enumerate
18785 \change_inserted 564990737 1672138150
18786 \begin_inset Argument 1
18789 \begin_layout Plain Layout
18791 \change_inserted 564990737 1672138150
18795 \begin_layout Plain Layout
18797 \change_inserted 564990737 1672138150
18817 \begin_layout Enumerate
18819 \change_inserted 564990737 1672138150
18820 with negative indentation
18823 \begin_layout Subsubsection
18825 \change_inserted 564990737 1672138150
18826 Further Customization
18827 \begin_inset Index idx
18832 \begin_layout Plain Layout
18834 \change_inserted 564990737 1672138150
18846 \begin_layout Standard
18848 \change_inserted 564990737 1672138150
18849 You can also change the style of description lists.
18853 \begin_layout Standard
18855 \change_inserted 564990737 1672138150
18861 \begin_layout Standard
18863 \change_inserted 564990737 1672138150
18864 changes the description label font,
18868 \begin_layout Standard
18870 \change_inserted 564990737 1672138150
18879 \begin_layout Standard
18881 \change_inserted 564990737 1672138150
18882 sets the list style.
18885 \begin_layout Standard
18887 \change_inserted 564990737 1672138150
18888 An example where the command
18891 \begin_layout Standard
18893 \change_inserted 564990737 1672138150
18902 \begin_layout Standard
18904 \change_inserted 564990737 1672138150
18908 \begin_layout Description
18910 \change_inserted 564990737 1672138150
18912 \begin_inset space ~
18917 \begin_inset Argument 1
18920 \begin_layout Plain Layout
18922 \change_inserted 564990737 1672138150
18926 \begin_layout Plain Layout
18928 \change_inserted 564990737 1672138150
18947 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
18948 therefore ionizing them.
18951 \begin_layout Description
18953 \change_inserted 564990737 1672138150
18955 \begin_inset space ~
18959 In computer science,
18960 reference counting is a technique of storing the number of references,
18962 or handles to a resource such as an object,
18964 disk space or other resource.
18967 \begin_layout Standard
18969 \change_inserted 564990737 1672138150
18970 There are many more commands and features provided by the
18975 \begin_inset Index idx
18980 \begin_layout Plain Layout
18982 \change_inserted 564990737 1672138150
18993 For more information see the
18994 \begin_inset CommandInset href
18996 name "enumitem documentation"
18997 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
19005 \begin_layout Subsection
19007 \change_inserted 564990737 1672138150
19013 \begin_layout Standard
19015 \change_inserted 564990737 1672138150
19016 This module uses the package
19020 to provide nine new list environments.
19021 Itemized and enumerated lists can be typeset within paragraphs,
19022 as paragraphs and in a compact version.
19023 Most environments have optional arguments to format the labels.
19025 the \SpecialChar LaTeX
19026 list environments itemize and enumerate are extended to use a similar optional argument.
19027 For further details see
19029 File\SpecialChar menuseparator
19030 Open Example\SpecialChar menuseparator
19031 Modules\SpecialChar menuseparator
19032 Paragraph Lists (paralist)
19037 Help\SpecialChar menuseparator
19038 Specific Manuals\SpecialChar menuseparator
19042 \begin_inset CommandInset href
19044 name "paralist documentation"
19045 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
19053 \begin_layout Section
19055 \change_inserted 564990737 1672161542
19056 Literate Programming
19059 \begin_layout Subsection
19061 \change_inserted 564990737 1672161542
19065 \begin_layout Standard
19067 \change_inserted 564990737 1672161542
19068 This module allows the use of Noweb as a literate programming tool.
19069 The files and the documentation for Noweb can be obtained from
19070 \begin_inset CommandInset href
19073 target "https://www.ctan.org/pkg/noweb"
19079 Literate programming is described in section
19080 \begin_inset space ~
19084 \begin_inset CommandInset ref
19086 reference "sec:Literate-Programming"
19091 and there are three example files:
19094 File\SpecialChar menuseparator
19095 Open Example\SpecialChar menuseparator
19096 Modules\SpecialChar menuseparator
19102 File\SpecialChar menuseparator
19103 Open Example\SpecialChar menuseparator
19104 Modules\SpecialChar menuseparator
19109 File\SpecialChar menuseparator
19110 Open Example\SpecialChar menuseparator
19111 Modules\SpecialChar menuseparator
19112 Noweb2\SpecialChar LyX
19118 \begin_layout Subsection
19120 \change_inserted 564990737 1672161542
19124 \begin_layout Standard
19126 \change_inserted 564990737 1672161542
19127 This module uses the
19137 \begin_inset Flex Code
19140 \begin_layout Plain Layout
19142 \change_inserted 564990737 1672161542
19150 package in R for dynamic report generation has to be installed for this module to work:
19152 \begin_inset Flex Code
19155 \begin_layout Plain Layout
19157 \change_inserted 564990737 1672161542
19158 install.packages(“knitr”)
19169 \begin_layout Paragraph
19171 \change_inserted 564990737 1672161542
19175 \begin_layout Standard
19177 \change_inserted 564990737 1672161542
19178 it depends on R >= 2.14.1.
19180 \begin_inset Flex URL
19183 \begin_layout Plain Layout
19185 \change_inserted 564990737 1672161542
19187 http://yihui.name/knitr
19198 \begin_layout Standard
19200 \change_inserted 564990737 1672161542
19205 also has to be installed.
19206 It cannot be used if the modules
19209 \begin_inset space ~
19221 Help\SpecialChar menuseparator
19222 Specific Manuals\SpecialChar menuseparator
19228 File\SpecialChar menuseparator
19229 Open Example\SpecialChar menuseparator
19230 Modules\SpecialChar menuseparator
19234 \begin_inset space ~
19238 \begin_inset CommandInset ref
19240 reference "sec:Literate-Programming"
19245 for information about literate programming.
19248 \begin_layout Subsection
19250 \change_inserted 564990737 1672161542
19254 \begin_layout Standard
19256 \change_inserted 564990737 1672161542
19257 This module allows the use of the statistical language S/R as a literate programming tool.
19268 \begin_inset CommandInset href
19271 target "https://www.ctan.org/pkg/includernw"
19277 \begin_inset CommandInset href
19280 target "https://www.ctan.org/pkg/fancyvrb"
19285 are available from CTAN.
19286 It cannot be used if the module
19289 \begin_inset space ~
19297 Help\SpecialChar menuseparator
19298 Specific Manuals\SpecialChar menuseparator
19304 File\SpecialChar menuseparator
19305 Open Example\SpecialChar menuseparator
19306 Modules\SpecialChar menuseparator
19310 \begin_inset space ~
19314 \begin_inset CommandInset ref
19316 reference "sec:Literate-Programming"
19321 for information about literate programming.
19324 \begin_layout Section
19326 \change_inserted 564990737 1672224959
19330 \begin_layout Subsection
19332 \change_inserted 564990737 1672224959
19336 \begin_layout Standard
19338 \change_inserted 564990737 1672224959
19339 This modules defines theorem environments and the proof environment using the extended AMS machinery.
19340 Both numbered and unnumbered types are provided.
19342 the theorems are numbered consecutively throughout the document.
19343 This can be changed by loading one of the
19345 AMS Theorems (Numbered by \SpecialChar ldots
19349 It cannot be used if the modules
19355 Standard Theorems (Unnumbered)
19360 \begin_layout Subsection
19362 \change_inserted 564990737 1672224959
19363 AMS Theorems (Extended)
19366 \begin_layout Standard
19368 \change_inserted 564990737 1672224959
19369 This module defines some additional theorem environments for use with the
19373 package (which must be loaded).
19374 It includes Criterion,
19385 Case and Question in both numbered and unnumbered forms.
19388 \begin_layout Subsection
19390 \change_inserted 564990737 1672224959
19391 AMS Theorems (Extended,
19392 Numbered by Type within Chapters)
19395 \begin_layout Standard
19397 \change_inserted 564990737 1672224959
19398 This module defines some additional theorem environments for use with the
19400 AMS Theorems (Numbered by Type within Chapters)
19402 package (which must be loaded).
19403 It includes Criterion,
19412 Assumption and Case in both numbered and unnumbered forms.
19415 AMS Theorems (Extended)
19418 the different theorem types provided here each have a separate counter,
19419 restarted with each new chapter (e.g.,
19426 axiom 2.1\SpecialChar ldots
19428 as opposed to criterion 1,
19434 \begin_layout Subsection
19436 \change_inserted 564990737 1672224959
19437 AMS Theorems (Extended,
19441 \begin_layout Standard
19443 \change_inserted 564990737 1672224959
19444 This module defines some additional theorem environments for use with the
19446 AMS Theorems (Numbered by Type)
19448 package (which must be loaded).
19449 It includes Criterion,
19458 Assumption and Case in both numbered and unnumbered forms.
19461 AMS Theorems (Extended)
19464 the different theorem types provided here each have a separate counter (e.g.,
19472 as opposed to criterion 1,
19480 \begin_layout Subsection
19482 \change_inserted 564990737 1672224959
19483 AMS Theorems (Numbered by Type within Chapters)
19486 \begin_layout Standard
19488 \change_inserted 564990737 1672224959
19489 This module defines theorem environments and the proof environment using the extended AMS machinery.
19490 Both numbered and unnumbered types are provided.
19496 the different theorem types provided here each have a separate counter (e.g.,
19505 as opposed to theorem 1,
19511 The numbering restarts for each chapter:
19515 It cannot be used if the modules
19527 Standard Theorems (Numbered by Type)
19531 Standard Theorems (Unnumbered)
19536 \begin_layout Subsection
19538 \change_inserted 564990737 1672224959
19539 AMS Theorems (Numbered by Type)
19542 \begin_layout Standard
19544 \change_inserted 564990737 1672224959
19545 This module defines theorem environments and the proof environment using the extended AMS machinery.
19546 Both numbered and unnumbered types are provided.
19552 the different theorem types provided here each have a separate counter (e.g.,
19561 as opposed to theorem 1,
19567 The numbering’s scope is the whole document.
19568 For chapter- and section-wide numbering,
19569 use one of the ‘within Sections’/‘within Chapters’ modules,
19571 It cannot be used if the modules
19583 Standard Theorems (Numbered by Type)
19587 Standard Theorems (Unnumbered)
19592 \begin_layout Subsection
19594 \change_inserted 564990737 1672224959
19595 Number Equations by Section
19598 \begin_layout Standard
19600 \change_inserted 564990737 1672224959
19601 This module resets the equation number at section start and prepends the section number to the equation number,
19605 \begin_layout Subsection
19607 \change_inserted 564990737 1672224959
19611 \begin_layout Standard
19613 \change_inserted 564990737 1672224959
19614 This module defines some theorem environments for use with non-AMS classes.
19616 the theorems are numbered consecutively throughout the document.
19617 This can be changed by loading one of the
19619 Standard Theorems (Numbered by \SpecialChar ldots
19623 It cannot be used if the modules
19629 Standard Theorems (Unnumbered)
19635 \begin_layout Subsection
19637 \change_inserted 564990737 1672224959
19638 Standard Theorems (Nameable)
19641 \begin_layout Standard
19643 \change_inserted 564990737 1672224959
19644 This module facilitates the use of named theorems.
19645 The name of the theorem goes into the “Additional Theorem Text” argument.
19649 \begin_layout Subsection
19651 \change_inserted 564990737 1672224959
19652 Standard Theorems (Numbered by Chapter)
19655 \begin_layout Standard
19657 \change_inserted 564990737 1672224959
19658 This module numbers theorems and the like by chapter (i.e.,
19659 the counter is reset at each chapter start).
19660 Use this module only with document classes that provide a chapter environment.
19670 It cannot be used if the module
19672 Standard Theorems (Numbered by Section)
19677 \begin_layout Subsection
19679 \change_inserted 564990737 1672224959
19680 Standard Theorems (Numbered by Section)
19683 \begin_layout Standard
19685 \change_inserted 564990737 1672224959
19686 This module numbers theorems and the like by section (i.e.,
19687 the counter is reset at each section start).
19697 It cannot be used if the module
19699 Standard Theorems (Numbered by Chapter)
19704 \begin_layout Subsection
19706 \change_inserted 564990737 1672224959
19707 Standard Theorems (Numbered by Type within Chapters)
19710 \begin_layout Standard
19712 \change_inserted 564990737 1672224959
19713 This module defines some theorem environments for use with non-AMS classes.
19723 the different theorem types provided here each have a separate counter (e.g.,
19732 as opposed to theorem 1,
19738 The numbering is reset at each chapter start.
19741 AMS Theorems (Numbered by Type)
19745 Standard Theorems (Numbered by Type)
19748 It cannot be used if any of the modules
19760 Standard Theorems (Unnumbered)
19765 Standard Theorems (Numbered by Sections)
19769 Standard Theorems (Numbered by Type within Sections)
19774 \begin_layout Subsection
19776 \change_inserted 564990737 1672224959
19777 Standard Theorems (Numbered by Type within Sections)
19780 \begin_layout Standard
19782 \change_inserted 564990737 1672224959
19783 This module defines some theorem environments for use with non-AMS classes.
19793 the different theorem types provided here each have a separate counter (e.g.,
19802 as opposed to theorem 1,
19808 The numbering is reset at each section start.
19811 AMS Theorems (Numbered by Type)
19815 Standard Theorems (Numbered by Type)
19818 It cannot be used if any of the modules
19830 Standard Theorems (Unnumbered)
19835 Standard Theorems (Numbered by Chapters)
19839 Standard Theorems (Numbered by Type within Chapters)
19844 \begin_layout Subsection
19846 \change_inserted 564990737 1672224959
19847 Standard Theorems (Numbered by Type)
19850 \begin_layout Standard
19852 \change_inserted 564990737 1672224959
19853 This module defines some theorem environments for use with non-AMS classes.
19863 the different theorem types provided here each have a separate counter (e.g.,
19872 as opposed to theorem 1,
19878 The numbering’s scope is the whole document.
19879 For chapter- and section-wide numbering,
19880 use one of the “within Chapters”/“within Sections” modules,
19882 It cannot be used if any of the modules
19894 Standard Theorems (Unnumbered)
19898 AMS Theorems (Numbered by Type)
19903 \begin_layout Subsection
19905 \change_inserted 564990737 1672224959
19906 Standard Theorems (Unnumbered)
19909 \begin_layout Standard
19911 \change_inserted 564990737 1672224959
19912 This module defines only unnumbered theorem environments and the proof environment,
19913 using the extended AMS machinery.
19914 It cannot be used if either of the modules
19925 \begin_layout Subsection
19927 \change_inserted 564990737 1672224959
19931 \begin_layout Standard
19933 \change_inserted 564990737 1672224959
19934 This module provides a straightforward way to segregate subequations in LyX.
19937 Help\SpecialChar menuseparator
19938 Math\SpecialChar menuseparator
19945 \begin_layout Section
19947 \change_inserted 564990737 1672236008
19951 \begin_layout Subsection
19953 \change_inserted 564990737 1672236008
19954 Custom Header/Footer Text
19957 \begin_layout Standard
19959 \change_inserted 564990737 1672236008
19960 This module requires the
19963 \begin_inset space ~
19977 ocument\SpecialChar menuseparator
19982 ettings\SpecialChar menuseparator
19984 \begin_inset space ~
19989 dialog to be set to
19994 It adds six environments to document classes which support the
20001 \begin_layout Itemize
20003 \change_inserted 564990737 1672236008
20009 \begin_layout Itemize
20011 \change_inserted 564990737 1672236008
20017 \begin_layout Itemize
20019 \change_inserted 564990737 1672236008
20025 \begin_layout Itemize
20027 \change_inserted 564990737 1672236008
20033 \begin_layout Itemize
20035 \change_inserted 564990737 1672236008
20041 \begin_layout Itemize
20043 \change_inserted 564990737 1672236008
20049 \begin_layout Subsubsection
20051 \change_inserted 564990737 1672236008
20052 Fancy Headers and Footers
20055 \begin_layout Standard
20057 \change_inserted 564990737 1672236008
20058 The default page layout is rather plain;
20060 \begin_inset Flex Code
20063 \begin_layout Plain Layout
20065 \change_inserted 564990737 1672236008
20074 all you get is a centered page number at the bottom of the page.
20075 This document uses KOMA-script’s book class;
20076 so it appears to be a bit fancier.
20080 \begin_inset space ~
20094 ocument\SpecialChar menuseparator
20099 ettings\SpecialChar menuseparator
20103 \begin_inset Quotes eld
20107 \begin_inset Quotes erd
20111 you will find that the page header is divided into three fields,
20112 not surprisingly labeled
20113 \begin_inset Quotes eld
20117 \begin_inset Quotes erd
20122 \begin_inset Quotes eld
20126 \begin_inset Quotes erd
20131 \begin_inset Quotes eld
20135 \begin_inset Quotes erd
20139 The footer is also divided into these three fields.
20140 The \SpecialChar LaTeX
20141 commands to set these fields in the simplest manner are
20170 Suppose you wish to put your name in the upper left hand corner of each page.
20171 Simply insert the following command in the preamble:
20175 \begin_layout Standard
20177 \change_inserted 564990737 1672236008
20193 \begin_layout Standard
20195 \change_inserted 564990737 1672236008
20196 You will now see your name in the upper left.
20197 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,
20199 \begin_inset space \thinspace{}
20205 \begin_layout Standard
20207 \change_inserted 564990737 1672236008
20215 \begin_layout Standard
20217 \change_inserted 564990737 1672236008
20220 an easier way to make simple changes.
20226 ocument\SpecialChar menuseparator
20231 ettings\SpecialChar menuseparator
20232 Modules\SpecialChar menuseparator
20233 Page Layout\SpecialChar menuseparator
20234 Custom Header/Footer Text
20237 you will find you have six new environments corresponding to the six fields described above.
20240 \begin_layout Standard
20242 \change_inserted 564990737 1672236008
20243 Let's get really fancy:
20244 lets put the section number with the word
20245 \begin_inset Quotes eld
20249 \begin_inset Quotes erd
20253 \begin_inset space \thinspace{}
20257 \begin_inset space \space{}
20260 Section 3) in the upper left,
20261 the page number (e.
20262 \begin_inset space \thinspace{}
20266 \begin_inset space \space{}
20269 Page 4) in the upper right,
20270 your name in the lower left,
20271 and the date in the lower right.
20272 Use your newly enabled environments to add these entries:
20275 \begin_layout Standard
20277 \change_inserted 564990737 1672236008
20278 \begin_inset VSpace defskip
20284 \begin_layout Standard
20286 \change_inserted 564990737 1672236008
20290 \begin_inset space ~
20308 \begin_layout Standard
20310 \change_inserted 564990737 1672236008
20316 \begin_layout Standard
20318 \change_inserted 564990737 1672236008
20333 \begin_layout Standard
20335 \change_inserted 564990737 1672236008
20345 \begin_layout Standard
20347 \change_inserted 564990737 1672236008
20353 \begin_layout Standard
20355 \change_inserted 564990737 1672236008
20370 \begin_layout Standard
20372 \change_inserted 564990737 1672236008
20373 \begin_inset VSpace defskip
20379 \begin_layout Standard
20381 \change_inserted 564990737 1672236008
20382 Make sure you enter the commands
20401 as \SpecialChar TeX
20419 access \SpecialChar LaTeX
20420 ’s section and page counters,
20421 and so print out the current section and page numbers.
20428 simply prints out today’s date.
20431 \begin_layout Standard
20433 \change_inserted 564990737 1672236008
20434 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
20435 If you don't want one of the rules,
20436 set its thickness to 0.
20437 The header rule has a default thickness of 0.4pt,
20438 the footer rule is 0pt.
20439 For this you will need to use \SpecialChar TeX
20443 \begin_layout Standard
20445 \change_inserted 564990737 1672236008
20452 headrulewidth}{0.4pt}
20457 \begin_layout Standard
20459 \change_inserted 564990737 1672236008
20466 footrulewidth}{0.4pt}
20468 to set the thicknesses.
20471 \begin_layout Standard
20473 \change_inserted 564990737 1672236008
20474 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
20479 thispagestyle{empty}
20486 thispagestyle{plain}
20493 thispagestyle{fancy}
20496 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
20499 title pages are marked as plain by default,
20500 while following pages are marked fancy when using the global fancy setting.
20504 \begin_layout Standard
20506 \change_inserted 564990737 1672236008
20507 If you want a header or footer to be on the outer side of a two sided document,
20508 you need to use something like:
20511 \begin_layout Standard
20513 \change_inserted 564990737 1672236008
20516 \begin_inset Flex Strong
20519 \begin_layout Plain Layout
20521 \change_inserted 564990737 1672236008
20537 \begin_layout Standard
20539 \change_inserted 564990737 1672236008
20542 \begin_inset Flex Strong
20545 \begin_layout Plain Layout
20547 \change_inserted 564990737 1672236008
20565 \begin_layout Standard
20567 \change_inserted 564990737 1672236008
20568 The first command clears all existing footers avoiding any conflicts with your new command.
20571 \begin_layout Standard
20573 \change_inserted 564990737 1672236008
20574 You can enter any of these commands,
20575 the simpler ones in any of your new environments,
20576 the more complex ones as \SpecialChar TeX
20578 at any point in your document and they will take effect on the next page.
20581 \begin_layout Standard
20583 \change_inserted 564990737 1672236008
20584 As a final example,
20585 it is possible to include an image in the header or footer.
20586 Suppose you want to put a company logo in the upper left hand corner.
20587 You might try something like
20590 \begin_layout Standard
20592 \change_inserted 564990737 1672236008
20601 includegraphics{logo.eps}}}
20604 \begin_layout Standard
20607 \change_inserted 564990737 1672236008
20608 (you may need to preface this with
20612 usepackage{graphics}
20614 if you don't include graphics elsewhere in your document).
20617 \begin_layout Standard
20619 \change_inserted 564990737 1672236008
20620 For more information on fancy headers,
20622 \begin_inset Flex Code
20625 \begin_layout Plain Layout
20627 \change_inserted 564990737 1672236008
20636 \begin_inset CommandInset href
20639 target "http://www.ctan.org/pkg/fancyhdr"
20648 \begin_layout Subsection
20650 \change_inserted 564990737 1672236008
20651 Landscape Document Parts
20654 \begin_layout Standard
20656 \change_inserted 564990737 1672236008
20657 This module outputs parts of the document in landscape mode using
20659 Insert\SpecialChar menuseparator
20660 Custom Insets\SpecialChar menuseparator
20665 Insert\SpecialChar menuseparator
20666 Custom Insets\SpecialChar menuseparator
20667 Landscape (Floating)
20672 \begin_layout Subsection
20674 \change_inserted 564990737 1672236008
20675 \begin_inset CommandInset label
20677 name "sec:Multiple-Columns"
20684 \begin_layout Standard
20686 \change_inserted 564990737 1672236008
20687 This module uses the
20692 \begin_inset Index idx
20697 \begin_layout Plain Layout
20699 \change_inserted 564990737 1672236008
20709 package and is independent of the option
20722 ocument\SpecialChar menuseparator
20727 ettings\SpecialChar menuseparator
20729 \begin_inset space ~
20735 If you want to have two columns for the whole document,
20736 you are recommended to use the
20745 For all other cases use this module.
20746 \change_deleted 564990737 1672236008
20747 Multiple Text Columns
20750 \begin_layout Standard
20752 \change_deleted 564990737 1672236008
20753 This feature is independent of the option
20755 Two-column document
20757 in the document settings under
20762 If you want to have 2
20763 \begin_inset space ~
20766 columns for the whole document,
20767 it is recommended to use the
20769 Two-column document
20772 For all other cases use this feature.
20775 \begin_layout Standard
20777 \change_deleted 564990737 1672236008
20778 To use multiple text columns in your document,
20779 you have to load the module
20785 Document\SpecialChar menuseparator
20786 Settings\SpecialChar menuseparator
20789 ) and must have the \SpecialChar LaTeX
20791 \begin_inset Flex Code
20794 \begin_layout Plain Layout
20805 \begin_layout Standard
20806 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
20807 Within the different columns you can use everything,
20808 with the limitation that for floats you need to
20809 \change_deleted 564990737 1672236179
20810 use the float option
20813 \change_inserted 564990737 1672236179
20822 \begin_inset space ~
20832 dit\SpecialChar menuseparator
20838 \begin_inset space ~
20848 \begin_layout Subsubsection
20852 \begin_layout Standard
20853 If you want to have 2
20854 \begin_inset space ~
20857 columns in your text,
20858 insert a multicolumn inset via the menu
20860 Insert\SpecialChar menuseparator
20862 \begin_inset space ~
20865 Insets\SpecialChar menuseparator
20867 \begin_inset space ~
20872 where the columns should start.
20873 Write all text that should be printed in 2
20874 \begin_inset space ~
20877 columns into this inset.
20880 \begin_layout Standard
20881 Here is an example:
20884 \begin_layout Standard
20886 \begin_inset Flex Multiple Columns
20889 \begin_layout Plain Layout
20894 The Adventure of the Empty House
20897 \begin_inset Newline newline
20900 by Sir Arthur Conan Doyle
20903 \begin_layout Plain Layout
20906 It was in the spring of the year 1894 that all London was interested,
20907 and the fashionable world dismayed,
20908 by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
20909 The public has already learned those particulars of the crime which came out in the police investigation,
20910 but a good deal was suppressed upon that occasion,
20911 since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
20913 at the end of nearly ten years,
20914 am I allowed to supply those missing links which make up the whole of that remarkable chain.
20915 The crime was of interest in itself,
20916 but that interest was as nothing to me compared to the inconceivable sequel,
20917 which afforded me the greatest shock and surprise of any event in my adventurous life.
20919 after this long interval,
20920 I find myself thrilling as I think of it,
20921 and feeling once more that sudden flood of joy,
20923 and incredulity which utterly submerged my mind.
20924 Let me say to that public,
20925 which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
20926 that they are not to blame me if I have not shared my knowledge with them,
20927 for I should have considered it my first duty to do so,
20928 had I not been barred by a positive prohibition from his own lips,
20929 which was only withdrawn upon the third of last month.
20937 \begin_layout Standard
20938 To get 3 or more columns,
20939 set the cursor into the multicolumn inset and use the menu
20941 Insert\SpecialChar menuseparator
20943 \begin_inset space ~
20947 \begin_inset space ~
20953 The number of the desired columns is written into that inset (for 3
20954 \begin_inset space ~
20958 \begin_inset Quotes eld
20962 \begin_inset Quotes erd
20966 \begin_inset Newline newline
20969 Here is an example with 3
20970 \begin_inset space ~
20976 \begin_layout Standard
20977 \begin_inset Flex Multiple Columns
20980 \begin_layout Plain Layout
20983 \begin_inset Argument 1
20986 \begin_layout Plain Layout
20993 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
20994 and that after his disappearance I never failed to read with care the various problems which came before the public.
20995 And I even attempted,
20997 for my own private satisfaction,
20998 to employ his methods in their solution,
20999 though with indifferent success.
21002 which appealed to me like this tragedy of Ronald Adair.
21003 As I read the evidence at the inquest,
21004 which led up to a verdict of willful murder against some person or persons unknown,
21005 I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
21006 There were points about this strange business which would,
21008 have specially appealed to him,
21009 and the efforts of the police would have been supplemented,
21010 or more probably anticipated,
21011 by the trained observation and the alert mind of the first criminal agent in Europe.
21013 as I drove upon my round,
21014 I turned over the case in my mind and found no explanation which appeared to me to be adequate.
21015 At the risk of telling a twice-told tale,
21016 I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
21024 \begin_layout Standard
21025 You can have up to 10
21026 \begin_inset space ~
21029 columns if you want to,
21030 but that might not be very pleasant for the readers of your document.
21033 \begin_layout Standard
21035 \change_deleted 564990737 1672236245
21036 \begin_inset Newpage newpage
21044 \begin_layout Subsubsection
21045 Columns inside Columns
21048 \begin_layout Standard
21049 You can also have columns inside columns:
21052 \begin_layout Standard
21053 \begin_inset Flex Multiple Columns
21056 \begin_layout Plain Layout
21059 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
21060 at that time governor of one of the Australian colonies.
21061 Adair's mother had returned from Australia to undergo the operation for cataract,
21064 and her daughter Hilda were living together at 427 Park Lane.
21067 \begin_layout Plain Layout
21068 \begin_inset Flex Multiple Columns
21071 \begin_layout Plain Layout
21074 The youth moved in the best society
21075 \begin_inset space ~
21079 so far as was known,
21080 no enemies and no particular vices.
21081 He had been engaged to Miss Edith Woodley,
21083 but the engagement had been broken off by mutual consent some months before,
21084 and there was no sign that it had left any very profound feeling behind it.
21085 For the rest {sic} the man's life moved in a narrow and conventional circle,
21086 for his habits were quiet and his nature unemotional.
21087 Yet it was upon this easy-going young aristocrat that death came,
21088 in most strange and unexpected form,
21089 between the hours of ten and eleven-twenty on the night of March 30,
21098 \begin_layout Plain Layout
21101 Ronald Adair was fond of cards
21102 \begin_inset space ~
21105 – playing continually,
21106 but never for such stakes as would hurt him.
21107 He was a member of the Baldwin,
21109 and the Bagatelle card clubs.
21111 after dinner on the day of his death,
21112 he had played a rubber of whist at the latter club.
21113 He had also played there in the afternoon.
21118 The evidence of those who had played with him
21119 \begin_inset space ~
21126 \begin_inset space ~
21129 – showed that the game was whist,
21130 and that there was a fairly equal fall of the cards.
21131 Adair might have lost five pounds,
21133 His fortune was a considerable one,
21134 and such a loss could not in any way affect him.
21135 He had played nearly every day at one club or other,
21136 but he was a cautious player,
21137 and usually rose a winner.
21138 It came out in evidence that,
21139 in partnership with Colonel Moran,
21140 he had actually won as much as four hundred and twenty pounds in a sitting,
21142 from Godfrey Milner and Lord Balmoral.
21143 So much for his recent history as it came out at the inquest.
21151 \begin_layout Subsubsection
21155 \begin_layout Standard
21156 The examples in this section show some more special features of multiple columns.
21159 \begin_layout Standard
21160 For more features of multiple columns,
21162 \begin_inset CommandInset href
21164 name "documentation"
21165 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
21170 of the \SpecialChar LaTeX
21172 \begin_inset Flex Code
21175 \begin_layout Plain Layout
21184 \begin_layout Paragraph
21188 \begin_layout Standard
21189 To add a preface text for multiple columns,
21190 set the cursor into the multicolumn inset and use the menu
21192 Insert\SpecialChar menuseparator
21196 Write your preface text into that inset.
21197 \begin_inset Newline newline
21200 This is an example with some preface text:
21203 \begin_layout Standard
21204 \begin_inset VSpace bigskip
21210 \begin_layout Standard
21211 \begin_inset Flex Multiple Columns
21214 \begin_layout Plain Layout
21215 \begin_inset Argument 2
21218 \begin_layout Plain Layout
21219 And the story continues and continues and continues and continues\SpecialChar ldots
21227 On the evening of the crime,
21228 he returned from the club exactly at ten.
21229 His mother and sister were out spending the evening with a relation.
21230 The servant deposed that she heard him enter the front room on the second floor,
21231 generally used as his sitting-room.
21232 She had lit a fire there,
21233 and as it smoked she had opened the window.
21234 No sound was heard from the room until eleven-twenty,
21235 the hour of the return of Lady Maynooth and her daughter.
21236 Desiring to say good-night,
21237 she attempted to enter her son's room.
21238 The door was locked on the inside,
21239 and no answer could be got to their cries and knocking.
21241 and the door forced.
21242 The unfortunate young man was found lying near the table.
21243 His head had been horribly mutilated by an expanding revolver bullet,
21244 but no weapon of any sort was to be found in the room.
21252 \begin_layout Standard
21253 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
21255 For example the command
21258 \begin_layout LyX-Code
21261 subsection{subsection title}
21264 \begin_layout Standard
21265 creates a subsection.
21266 In this example the preface is a subsubsection:
21269 \begin_layout Standard
21270 \begin_inset Flex Multiple Columns
21273 \begin_layout Plain Layout
21274 \begin_inset Argument 2
21277 \begin_layout Plain Layout
21281 \begin_layout Plain Layout
21290 This is a subsubsection heading as a preface
21294 \begin_layout Plain Layout
21308 A minute examination of the circumstances served only to make the case more complex.
21309 In the first place,
21310 no reason could be given why the young man should have fastened the door upon the inside.
21311 There was the possibility that the murderer had done this,
21312 and had afterwards escaped by the window.
21313 The drop was at least twenty feet,
21315 and a bed of crocuses in full bloom lay beneath.
21316 Neither the flowers nor the earth showed any sign of having been disturbed,
21317 nor were there any marks upon the narrow strip of grass which separated the house from the road.
21320 it was the young man himself who had fastened the door.
21321 But how did he come by his death?
21322 No one could have climbed up to the window without leaving traces.
21323 Suppose a man had fired through the window,
21324 he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
21326 Park Lane is a frequented thoroughfare;
21327 there is a cab stand within a hundred yards of the house.
21328 No one had heard a shot.
21336 \begin_layout Standard
21337 If there is less vertical space than 6
21338 \begin_inset space ~
21341 text lines is left on the page at the beginning of the multiple columns,
21342 a page break will be inserted before the multiple columns.
21343 Depending on the number of lines of the preface text,
21344 you might want to change this space.
21345 This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
21347 Insert\SpecialChar menuseparator
21349 \begin_inset space ~
21353 \begin_inset space ~
21357 \begin_inset space ~
21363 Insert into that inset the amount of space like e.
21364 \begin_inset space \thinspace{}
21368 \begin_inset space \space{}
21372 \begin_inset Quotes eld
21376 \begin_inset Quotes erd
21380 \begin_inset Newline newline
21383 In this example the space is set to 7
21384 \begin_inset space ~
21387 text lines by using
21388 \begin_inset Flex Code
21391 \begin_layout Plain Layout
21400 \begin_inset Flex Code
21403 \begin_layout Plain Layout
21411 needs to be inserted as \SpecialChar TeX
21415 \begin_layout Standard
21416 \begin_inset Flex Multiple Columns
21419 \begin_layout Plain Layout
21420 \begin_inset Argument 3
21423 \begin_layout Plain Layout
21428 \begin_layout Plain Layout
21444 On the evening of the crime,
21445 he returned from the club exactly at ten.
21446 His mother and sister were out spending the evening with a relation.
21447 The servant deposed that she heard him enter the front room on the second floor,
21448 generally used as his sitting-room.
21449 She had lit a fire there,
21450 and as it smoked she had opened the window.
21451 No sound was heard from the room until eleven-twenty,
21452 the hour of the return of Lady Maynooth and her daughter.
21453 Desiring to say good-night,
21454 she attempted to enter her son's room.
21455 The door was locked on the inside,
21456 and no answer could be got to their cries and knocking.
21458 and the door forced.
21459 The unfortunate young man was found lying near the table.
21460 His head had been horribly mutilated by an expanding revolver bullet,
21461 but no weapon of any sort was to be found in the room.
21469 \begin_layout Paragraph
21473 \begin_layout Standard
21474 The amount of space before and after multiple columns can be changed by changing the length
21475 \begin_inset Flex Code
21478 \begin_layout Plain Layout
21487 For example the command
21490 \begin_layout LyX-Code
21498 \begin_layout Standard
21499 in \SpecialChar TeX
21500 Code changes its value to 3
21501 \begin_inset space \thinspace{}
21505 The change must be made before the multiple columns' start.
21506 The predefined value is 13
21507 \begin_inset space \thinspace{}
21513 \begin_layout Standard
21515 \begin_inset Flex Code
21518 \begin_layout Plain Layout
21527 \begin_inset space \thinspace{}
21533 \begin_layout Standard
21537 \begin_layout Plain Layout
21543 multicolsep}{2.5cm}
21551 \begin_layout Standard
21552 \begin_inset Flex Multiple Columns
21555 \begin_layout Plain Layout
21558 All day I turned these facts over in my mind,
21559 endeavouring to hit upon some theory which could reconcile them all,
21560 and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
21561 I confess that I made little progress.
21562 In the evening I strolled across the Park,
21563 and found myself about six o'clock at the Oxford Street end of Park Lane.
21564 A group of loafers upon the pavements,
21565 all staring up at a particular window,
21566 directed me to the house which I had come to see.
21568 thin man with coloured glasses,
21569 whom I strongly suspected of being a plain-clothes detective,
21570 was pointing out some theory of his own,
21571 while the others crowded round to listen to what he said.
21572 I got as near him as I could,
21573 but his observations seemed to me to be absurd,
21574 so I withdrew again in some disgust.
21575 As I did so I struck against an elderly,
21577 who had been behind me,
21578 and I knocked down several books which he was carrying.
21586 \begin_layout Standard
21587 \begin_inset Note Greyedout
21590 \begin_layout Plain Layout
21596 The values you set with
21597 \begin_inset Flex Code
21600 \begin_layout Plain Layout
21608 will be used for all following multiple columns until you change them again.
21616 \begin_layout Standard
21620 \begin_layout Plain Layout
21632 \begin_inset Note Note
21635 \begin_layout Plain Layout
21636 go back to the default
21644 \begin_layout Standard
21646 \change_deleted 564990737 1672236355
21647 \begin_inset Newpage newpage
21655 \begin_layout Paragraph
21659 \begin_layout Standard
21660 A column break can be forced by inserting the command
21661 \begin_inset Flex Code
21664 \begin_layout Plain Layout
21672 as \SpecialChar TeX
21673 Code to that position in the text where the column should be broken.
21674 Note that this leads in most cases to whitespace in the text.
21675 \begin_inset Newline newline
21678 Here is an example:
21681 \begin_layout Standard
21682 \begin_inset Flex Multiple Columns
21685 \begin_layout Plain Layout
21688 \begin_inset Quotes eld
21691 You're surprised to see me,
21693 \begin_inset Quotes erd
21701 \begin_layout Plain Layout
21704 I acknowledged that I was.
21707 \begin_layout Plain Layout
21710 \begin_inset Quotes eld
21716 and when I chanced to see you go into this house,
21717 as I came hobbling after you,
21718 I thought to myself,
21719 I'll just step in and see that kind gentleman,
21720 and tell him that if I was a bit gruff in my manner there was not any harm meant,
21721 and that I am much obliged to him for picking up my books.
21722 \begin_inset Quotes erd
21728 \begin_layout Plain Layout
21731 \begin_inset Quotes eld
21734 You make too much of a trifle,
21735 \begin_inset Quotes erd
21740 \begin_inset Quotes eld
21743 May I ask how you knew who I was?
21744 \begin_inset Quotes erd
21747 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
21751 \begin_layout Plain Layout
21763 \begin_layout Plain Layout
21766 \begin_inset Quotes eld
21771 if it isn't too great a liberty,
21772 I am a neighbour of yours,
21773 for you'll find my little bookshop at the corner of Church Street,
21774 and very happy to see you,
21776 Maybe you collect yourself,
21781 \begin_inset space ~
21797 \begin_inset space ~
21802 With five volumes you could just fill that gap on that second shelf.
21806 \begin_inset Quotes erd
21817 \begin_layout Paragraph
21821 \begin_layout Standard
21822 The width of the columns is automatically calculated,
21823 but you can modify the space between the columns.
21824 This is done by changing the length
21825 \begin_inset Flex Code
21828 \begin_layout Plain Layout
21837 Its predefined value is 10
21838 \begin_inset space \thinspace{}
21842 Here is an example where
21843 \begin_inset Flex Code
21846 \begin_layout Plain Layout
21855 \begin_inset space \thinspace{}
21861 \begin_layout Standard
21865 \begin_layout Plain Layout
21879 \begin_layout Standard
21880 \begin_inset Flex Multiple Columns
21883 \begin_layout Plain Layout
21886 My observations of No.
21887 \begin_inset space \space{}
21890 427 Park Lane did little to clear up the problem in which I was interested.
21891 The house was separated from the street by a low wall and railing,
21892 the whole not more than five feet high.
21893 It was perfectly easy,
21895 for anyone to get into the garden,
21896 but the window was entirely inaccessible,
21897 since there was no water pipe or anything which could help the most active man to climb it.
21898 More puzzled than ever,
21899 I retraced my steps to Kensington.
21900 I had not been in my study five minutes when the maid entered to say that a person desired to see me.
21901 To my astonishment it was none other than my strange old book collector,
21903 wizened face peering out from a frame of white hair,
21904 and his precious volumes,
21905 a dozen of them at least,
21906 wedged under his right arm.
21914 \begin_layout Standard
21918 \begin_layout Plain Layout
21930 \begin_inset Note Note
21933 \begin_layout Plain Layout
21934 go back to the default
21942 \begin_layout Paragraph
21946 \begin_layout Standard
21947 Between the columns a rule with a width of the length
21948 \begin_inset Flex Code
21951 \begin_layout Plain Layout
21960 If this rule width is set to 0
21961 \begin_inset space \thinspace{}
21964 pt (this is the default),
21965 the rule is suppressed.
21966 In the following example the rule is 2
21967 \begin_inset space \thinspace{}
21973 \begin_layout Standard
21977 \begin_layout Plain Layout
21983 columnseprule}{2pt}
21991 \begin_layout Standard
21992 \begin_inset Flex Multiple Columns
21995 \begin_layout Plain Layout
21998 \begin_inset Quotes eld
22001 You're surprised to see me,
22003 \begin_inset Quotes erd
22011 \begin_layout Plain Layout
22014 I acknowledged that I was.
22017 \begin_layout Plain Layout
22020 \begin_inset Quotes eld
22026 and when I chanced to see you go into this house,
22027 as I came hobbling after you,
22028 I thought to myself,
22029 I'll just step in and see that kind gentleman,
22030 and tell him that if I was a bit gruff in my manner there was not any harm meant,
22031 and that I am much obliged to him for picking up my books.
22032 \begin_inset Quotes erd
22038 \begin_layout Plain Layout
22041 \begin_inset Quotes eld
22044 You make too much of a trifle,
22045 \begin_inset Quotes erd
22050 \begin_inset Quotes eld
22053 May I ask how you knew who I was?
22054 \begin_inset Quotes erd
22060 \begin_layout Plain Layout
22063 \begin_inset Quotes eld
22068 if it isn't too great a liberty,
22069 I am a neighbour of yours,
22070 for you'll find my little bookshop at the corner of Church Street,
22071 and very happy to see you,
22073 Maybe you collect yourself,
22078 \begin_inset space ~
22094 \begin_inset space ~
22099 With five volumes you could just fill that gap on that second shelf.
22103 \begin_inset Quotes erd
22114 \begin_layout Standard
22115 \begin_inset VSpace defskip
22121 \begin_layout Standard
22122 The rule can be colored by redefining the command
22123 \begin_inset Flex Code
22126 \begin_layout Plain Layout
22135 This is done by inserting the command
22138 \begin_layout LyX-Code
22143 columnseprulecolor}{
22148 \begin_layout Standard
22149 as \SpecialChar TeX
22150 Code before the multicolumn inset.
22152 \begin_inset Flex Code
22155 \begin_layout Plain Layout
22161 in this command by a color of your choice.
22162 You can use all pre- and self-defined colors.
22171 \begin_inset space ~
22176 for more information about pre- and self-defined colors.
22177 To go back to the default color insert the command
22180 \begin_layout LyX-Code
22185 columnseprulecolor}{
22190 \begin_layout Standard
22191 Here is the example with a cyan rule and 1
22192 \begin_inset space \thinspace{}
22195 cm column separation:
22198 \begin_layout Standard
22202 \begin_layout Plain Layout
22211 \begin_layout Plain Layout
22217 columnseprulecolor}{
22227 \begin_layout Standard
22228 \begin_inset Flex Multiple Columns
22231 \begin_layout Plain Layout
22234 \begin_inset Quotes eld
22237 You're surprised to see me,
22239 \begin_inset Quotes erd
22247 \begin_layout Plain Layout
22250 I acknowledged that I was.
22253 \begin_layout Plain Layout
22256 \begin_inset Quotes eld
22262 and when I chanced to see you go into this house,
22263 as I came hobbling after you,
22264 I thought to myself,
22265 I'll just step in and see that kind gentleman,
22266 and tell him that if I was a bit gruff in my manner there was not any harm meant,
22267 and that I am much obliged to him for picking up my books.
22268 \begin_inset Quotes erd
22274 \begin_layout Plain Layout
22277 \begin_inset Quotes eld
22280 You make too much of a trifle,
22281 \begin_inset Quotes erd
22286 \begin_inset Quotes eld
22289 May I ask how you knew who I was?
22290 \begin_inset Quotes erd
22296 \begin_layout Plain Layout
22299 \begin_inset Quotes eld
22304 if it isn't too great a liberty,
22305 I am a neighbour of yours,
22306 for you'll find my little bookshop at the corner of Church Street,
22307 and very happy to see you,
22309 Maybe you collect yourself,
22314 \begin_inset space ~
22330 \begin_inset space ~
22335 With five volumes you could just fill that gap on that second shelf.
22339 \begin_inset Quotes erd
22350 \begin_layout Standard
22354 \begin_layout Plain Layout
22360 columnseprule}{0pt}
22363 \begin_layout Plain Layout
22369 columnseprulecolor}{
22377 \begin_inset Note Note
22380 \begin_layout Plain Layout
22381 go back to the default
22389 \begin_layout Section
22391 \change_inserted 564990737 1671270380
22395 \begin_layout Subsection
22397 \change_inserted 564990737 1671270398
22399 \change_deleted 564990737 1671270396
22405 \begin_layout Standard
22408 as well as any other text processor uses by default rectangular paragraphs.
22409 For special cases like for example posters,
22410 invitation cards or poems you can modify the paragraph shape to one of your choice.
22412 \change_deleted 564990737 1672311802
22413 This can be done by using the \SpecialChar LaTeX
22415 \begin_inset Flex Code
22418 \begin_layout Plain Layout
22424 which is loaded by using in the document settings the module
22426 Custom paragraph shapes
22429 \change_inserted 564990737 1672311802
22430 This module uses the
22434 package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
22440 \begin_layout Subsubsection
22444 \begin_layout Standard
22449 provides the following shapes:
22452 \begin_layout Standard
22453 \begin_inset Tabular
22454 <lyxtabular version="3" rows="13" columns="3">
22455 <features booktabs="true" islongtable="true" longtabularalignment="center">
22456 <column alignment="left" valignment="middle" width="16col%">
22457 <column alignment="left" valignment="middle" width="40col%">
22458 <column alignment="left" valignment="middle" width="35col%">
22459 <row endhead="true">
22460 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22463 \begin_layout Plain Layout
22472 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22475 \begin_layout Plain Layout
22484 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22487 \begin_layout Plain Layout
22497 <row interlinespace="default">
22498 <cell alignment="left" valignment="top" usebox="none">
22501 \begin_layout Plain Layout
22509 <cell alignment="left" valignment="top" usebox="none">
22512 \begin_layout Plain Layout
22515 Circle with circular hole (in the size of a CD/DVD)
22520 <cell alignment="left" valignment="top" usebox="none">
22523 \begin_layout Plain Layout
22527 take care there is not too much text
22533 <row interlinespace="default">
22534 <cell alignment="left" valignment="top" usebox="none">
22537 \begin_layout Plain Layout
22545 <cell alignment="left" valignment="top" usebox="none">
22548 \begin_layout Plain Layout
22556 <cell alignment="left" valignment="top" usebox="none">
22559 \begin_layout Plain Layout
22563 calculation might fail
22569 <row interlinespace="default">
22570 <cell alignment="left" valignment="top" usebox="none">
22573 \begin_layout Plain Layout
22581 <cell alignment="left" valignment="top" usebox="none">
22584 \begin_layout Plain Layout
22587 Rhomboid (symbolizing a
22588 \begin_inset Quotes eld
22592 \begin_inset Quotes erd
22600 <cell alignment="left" valignment="top" usebox="none">
22603 \begin_layout Plain Layout
22612 <row interlinespace="default">
22613 <cell alignment="left" valignment="top" usebox="none">
22616 \begin_layout Plain Layout
22624 <cell alignment="left" valignment="top" usebox="none">
22627 \begin_layout Plain Layout
22635 <cell alignment="left" valignment="top" usebox="none">
22638 \begin_layout Plain Layout
22647 <row interlinespace="default">
22648 <cell alignment="left" valignment="top" usebox="none">
22651 \begin_layout Plain Layout
22659 <cell alignment="left" valignment="top" usebox="none">
22662 \begin_layout Plain Layout
22670 <cell alignment="left" valignment="top" usebox="none">
22673 \begin_layout Plain Layout
22682 <row interlinespace="default">
22683 <cell alignment="left" valignment="top" usebox="none">
22686 \begin_layout Plain Layout
22694 <cell alignment="left" valignment="top" usebox="none">
22697 \begin_layout Plain Layout
22700 Nut for bolt (hexagon with circular hole)
22705 <cell alignment="left" valignment="top" usebox="none">
22708 \begin_layout Plain Layout
22717 <row interlinespace="default">
22718 <cell alignment="left" valignment="top" usebox="none">
22721 \begin_layout Plain Layout
22729 <cell alignment="left" valignment="top" usebox="none">
22732 \begin_layout Plain Layout
22740 <cell alignment="left" valignment="top" usebox="none">
22743 \begin_layout Plain Layout
22752 <row interlinespace="default">
22753 <cell alignment="left" valignment="top" usebox="none">
22756 \begin_layout Plain Layout
22764 <cell alignment="left" valignment="top" usebox="none">
22767 \begin_layout Plain Layout
22775 <cell alignment="left" valignment="top" usebox="none">
22778 \begin_layout Plain Layout
22787 <row interlinespace="default">
22788 <cell alignment="left" valignment="top" usebox="none">
22791 \begin_layout Plain Layout
22799 <cell alignment="left" valignment="top" usebox="none">
22802 \begin_layout Plain Layout
22810 <cell alignment="left" valignment="top" usebox="none">
22813 \begin_layout Plain Layout
22822 <row interlinespace="default">
22823 <cell alignment="left" valignment="top" usebox="none">
22826 \begin_layout Plain Layout
22834 <cell alignment="left" valignment="top" usebox="none">
22837 \begin_layout Plain Layout
22840 Normal/reversed rain drop
22845 <cell alignment="left" valignment="top" usebox="none">
22848 \begin_layout Plain Layout
22852 calculation might fail
22858 <row interlinespace="default">
22859 <cell alignment="left" valignment="top" usebox="none">
22862 \begin_layout Plain Layout
22871 <cell alignment="left" valignment="top" usebox="none">
22874 \begin_layout Plain Layout
22877 The \SpecialChar TeX
22883 <cell alignment="left" valignment="top" usebox="none">
22886 \begin_layout Plain Layout
22895 <row interlinespace="default">
22896 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22899 \begin_layout Plain Layout
22903 \begin_inset Newline newline
22911 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22914 \begin_layout Plain Layout
22917 Triangles in different orientations
22922 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22925 \begin_layout Plain Layout
22941 \begin_layout Standard
22942 To use a shape for your paragraph,
22943 simply select it in \SpecialChar LyX
22944 's pull-down box for environments in the toolbar.
22947 \begin_layout Standard
22948 \begin_inset Newpage newpage
22954 \begin_layout Standard
22955 Here is an example paragraph in the shape of a nut:
22958 \begin_layout Standard
22959 \begin_inset VSpace bigskip
22968 Lorem ipsum dolor sit amet,
22969 consetetur sadipscing elitr,
22970 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22972 At vero eos et accusam et justo duo dolores et ea rebum.
22973 Stet clita kasd gubergren,
22974 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22975 Lorem ipsum dolor sit amet,
22976 consetetur sadipscing elitr,
22977 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22981 \begin_layout Standard
22982 \begin_inset VSpace bigskip
22988 \begin_layout Standard
22989 \begin_inset Note Greyedout
22992 \begin_layout Plain Layout
23002 paragraphs cannot run over a page break.
23010 \begin_layout Standard
23011 \begin_inset VSpace bigskip
23017 \begin_layout Standard
23019 \begin_inset Flex Code
23022 \begin_layout Plain Layout
23028 takes care that the shape will always be preserved,
23029 no matter how much text is in the paragraph.
23030 Therefore the paragraph size changes with the amount of contained text.
23031 This can lead to paragraph sizes exceeding the page margins.
23032 To demonstrate the size scaling,
23033 here is the same example paragraph but with twice as much text:
23036 \begin_layout Standard
23037 \begin_inset Newpage newpage
23046 Lorem ipsum dolor sit amet,
23047 consetetur sadipscing elitr,
23048 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23050 At vero eos et accusam et justo duo dolores et ea rebum.
23051 Stet clita kasd gubergren,
23052 no sea takimata sanctus est Lorem ipsum dolor sit amet.
23053 Lorem ipsum dolor sit amet,
23054 consetetur sadipscing elitr,
23055 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23057 Lorem ipsum dolor sit amet,
23058 consetetur sadipscing elitr,
23059 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23061 At vero eos et accusam et justo duo dolores et ea rebum.
23062 Stet clita kasd gubergren,
23063 no sea takimata sanctus est Lorem ipsum dolor sit amet.
23064 Lorem ipsum dolor sit amet,
23065 consetetur sadipscing elitr,
23066 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23070 \begin_layout Standard
23071 \begin_inset VSpace bigskip
23077 \begin_layout Standard
23078 An exception is the shape
23083 It cannot be scaled because it must fit the size of a CD/DVD.
23084 Therefore the amount of text that fits into the shape is limited.
23085 \begin_inset Newline newline
23097 meaning that the calculation of their size can fail,
23098 depending on the amount of text.
23099 You will then get the \SpecialChar LaTeX
23101 \begin_inset Quotes eld
23104 Arithmetic overflow
23105 \begin_inset Quotes erd
23109 In this case one can try to remove or add some text;
23110 if nothing works one has to use another shape.
23113 \begin_layout Standard
23114 \begin_inset VSpace bigskip
23120 \begin_layout Standard
23121 For shapes with tips you will maybe see that \SpecialChar LaTeX
23122 's hyphenation routine fails for text in the tips.
23123 Therefore it is often necessary to add hyphenation points
23128 arg "specialchar-insert hyphenation"
23133 ) to the corresponding text parts.
23136 \begin_layout Standard
23137 \begin_inset VSpace bigskip
23143 \begin_layout Standard
23144 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
23145 You can therefore not use the paragraph dialog to align such paragraphs.
23146 A solution is to put the paragraph into a minipage or parbox and align the box.
23147 The problem is hereby to find the right width for the box.
23148 Because if it is too wide and you center the box,
23149 the paragraph is not centered too because it sticks at the left side of the box.
23150 So you might have to play a bit with the width until it fits.
23151 Here are two heart-shaped paragraphs,
23152 the first one is not aligned,
23153 the second one is right-aligned:
23156 \begin_layout Standard
23157 \begin_inset Newpage newpage
23163 \begin_layout Heart
23167 Lo\SpecialChar softhyphen
23168 rem ipsum dolor sit amet,
23169 consetetur sadipscing elitr,
23170 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23172 At vero eos et accusam et justo duo dolores et ea rebum.
23173 Stet clita kasd gubergren,
23174 no sea takimata sanctus est Lorem ipsum dolor sit amet.
23177 \begin_layout Standard
23178 \begin_inset VSpace bigskip
23184 \begin_layout Standard
23187 \begin_inset Box Frameless
23197 height_special "totalheight"
23202 backgroundcolor "none"
23205 \begin_layout Heart
23209 Lo\SpecialChar softhyphen
23210 rem ipsum dolor sit amet,
23211 consetetur sadipscing elitr,
23212 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23214 At vero eos et accusam et justo duo dolores et ea rebum.
23215 Stet clita kasd gubergren,
23216 no sea takimata sanctus est Lorem ipsum dolor sit amet.
23224 \begin_layout Subsubsection
23228 \begin_layout Standard
23229 You can define any shape you want.
23230 Doing this manually is a lot of work because every coordinate must be specified.
23231 But there is a way to let the computer calculate the coordinates:
23234 \begin_layout Enumerate
23235 Install the program
23236 \begin_inset CommandInset href
23239 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
23247 \begin_layout Enumerate
23254 TeX/LaTeX\SpecialChar menuseparator
23255 Settings\SpecialChar menuseparator
23258 and select the font size you are using in your document.
23259 For example this document uses the size 12
23260 \begin_inset space \thinspace{}
23266 \begin_layout Enumerate
23270 \begin_layout Enumerate
23273 TeX/LaTeX\SpecialChar menuseparator
23276 to export the shape to coordinates.
23277 In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
23281 \begin_layout Plain Layout
23282 For more information see
23283 \begin_inset CommandInset href
23285 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
23298 \begin_layout Standard
23299 The coordinates are written into a \SpecialChar TeX
23301 To use it for your \SpecialChar LyX
23305 \begin_layout Enumerate
23306 Place the cursor before the first character of your paragraph (or into a new empty one).
23309 \begin_layout Enumerate
23310 Open in \SpecialChar LyX
23313 Insert\SpecialChar menuseparator
23314 File\SpecialChar menuseparator
23316 \begin_inset space ~
23322 select the file and use
23331 \begin_layout Standard
23332 \begin_inset VSpace defskip
23338 \begin_layout Standard
23339 \begin_inset Note Greyedout
23342 \begin_layout Plain Layout
23348 The changed shape only applies to the current paragraph;
23349 everything is reset to normal for the next paragraph.
23350 Therefore the shape definition file must be input into every paragraph with the desired shape.
23358 \begin_layout Standard
23359 \begin_inset VSpace bigskip
23365 \begin_layout Standard
23366 Here is an example:
23369 \begin_layout Standard
23370 \begin_inset VSpace bigskip
23376 \begin_layout Standard
23377 \begin_inset CommandInset include
23379 filename "SpecialParagraphShape.tex"
23386 Lorem ipsum dolor sit amet,
23387 consetetur sadipscing elitr,
23388 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23390 At vero eos et accusam et justo duo dolores et ea rebum.
23391 Stet clita kasd gubergren,
23392 no sea takimata sanctus est Lorem ipsum dolor sit amet.
23393 Lorem ipsum dolor sit amet,
23394 consetetur sadipscing elitr,
23395 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
23399 \begin_layout Standard
23400 \begin_inset VSpace bigskip
23406 \begin_layout Standard
23412 to draw complexer shapes in
23416 you can draw the shape in a program of your choice and import the resulting image to
23421 Then you only need to draw a line or spline along the outline of the image.
23424 \begin_layout Standard
23425 \begin_inset VSpace bigskip
23431 \begin_layout Standard
23434 Custom paragraph shapes
23436 also provides the two commands
23444 which can be used to define custom shapes coordinate by coordinate.
23448 \begin_layout Plain Layout
23449 These commands are internally used for all shapes described here.
23454 For information how these styles are used and about further customization possibilities,
23456 \begin_inset CommandInset href
23458 name "documentation"
23459 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
23465 \begin_inset Flex Code
23468 \begin_layout Plain Layout
23477 \begin_layout Subsection
23479 \change_inserted 564990737 1672311925
23483 \begin_layout Hanging
23485 \change_inserted 564990737 1672311925
23486 This module adds the
23492 one where all but the first line of the paragraph is indented.
23493 This may not appear in your \SpecialChar LyX
23494 document but will appear in the final output.
23497 \begin_layout Subsection
23499 \change_inserted 564990737 1672311925
23500 \begin_inset CommandInset label
23502 name "subsec:Initials"
23506 Initials (Drop Caps)
23509 \begin_layout Initial
23511 \change_inserted 564990737 1672311925
23512 \begin_inset Argument 2
23515 \begin_layout Plain Layout
23517 \change_inserted 564990737 1672311925
23526 \begin_inset Argument 3
23529 \begin_layout Plain Layout
23531 \change_inserted 564990737 1672311925
23539 module adds a drop capitals paragraph style
23543 for paragraph environments which you can use wherever you want to have drop capitals.
23544 You then have three more items in the
23551 \begin_layout Itemize
23553 \change_inserted 564990737 1672311925
23558 which creates an inset for the drop capital
23561 \begin_layout Itemize
23563 \change_inserted 564990737 1672311925
23568 which creates an inset for the rest of the word
23571 \begin_layout Itemize
23573 \change_inserted 564990737 1672311925
23578 which allow you configure the formatting of the drop capital.
23581 \begin_layout Standard
23583 \change_inserted 564990737 1672311925
23584 To customize the appearance of the style,
23587 Help\SpecialChar menuseparator
23588 Embedded Objects\SpecialChar menuseparator
23589 Objects Surrounded by Text\SpecialChar menuseparator
23595 \begin_layout Section
23597 \change_inserted 564990737 1672312011
23601 \begin_layout Subsection
23603 \change_inserted 564990737 1672312011
23604 Hyphenatable Text Markup
23607 \begin_layout Standard
23609 \change_inserted 564990737 1672312011
23610 This package defines text styles to highlight,
23613 underline and capitalize/small-cap text by means of the
23618 As opposed to the markup provided by the Text Properties dialog,
23619 words marked-up with
23625 \begin_inset CommandInset href
23627 name "soul documentation"
23628 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
23636 \begin_layout Subsection
23638 \change_inserted 564990737 1672312011
23642 \begin_layout Standard
23644 \change_inserted 564990737 1672312011
23645 This module defines some character styles for logical markup:
23649 \begin_inset Flex Noun
23652 \begin_layout Plain Layout
23654 \change_inserted 564990737 1672312011
23670 \begin_inset Flex Emph
23673 \begin_layout Plain Layout
23675 \change_inserted 564990737 1672312011
23689 \begin_inset Flex Strong
23692 \begin_layout Plain Layout
23694 \change_inserted 564990737 1672312011
23704 \begin_inset Flex Code
23707 \begin_layout Plain Layout
23709 \change_inserted 564990737 1672312011
23717 which are accessed via the
23722 dit\SpecialChar menuseparator
23724 \begin_inset space ~
23728 \begin_inset space ~
23740 \begin_layout Chapter
23742 \change_deleted 564990737 1671304317
23746 \change_inserted 564990737 1671304322
23748 \change_deleted 564990737 1671304331
23749 ies with Bib\SpecialChar TeX
23755 \begin_layout Standard
23756 The most basic information about how to use Bib\SpecialChar TeX
23761 with \SpecialChar LyX
23762 is contained in the section
23764 Bibliography databases
23771 The following subsections explain special bibliography features supported by \SpecialChar LyX
23775 \begin_layout Section
23776 Alternative Citation Styles
23779 \begin_layout Standard
23780 Standard Bib\SpecialChar TeX
23782 \begin_inset space \thinspace{}
23786 \begin_inset space \space{}
23790 \begin_inset Quotes eld
23794 \begin_inset Quotes erd
23797 ) to refer to a cited work.
23799 in many scientific disciplines,
23800 other citation styles are in use.
23801 The most common one is the author-year style (e.
23802 \begin_inset space \thinspace{}
23806 \begin_inset space \space{}
23810 \begin_inset Quotes eld
23814 \begin_inset Quotes erd
23819 supports three packages that provide this style,
23821 \begin_inset Flex Code
23824 \begin_layout Plain Layout
23832 \begin_inset Flex Code
23835 \begin_layout Plain Layout
23843 \begin_inset Flex Code
23846 \begin_layout Plain Layout
23853 Each of these packages has their pros and cons,
23854 which cannot be listed in detail.
23855 If you only want to have simple author-year (or author-numerical) style,
23856 or if you want to use one of the countless style files for
23857 \begin_inset Flex Code
23860 \begin_layout Plain Layout
23867 then the established
23868 \begin_inset Flex Code
23871 \begin_layout Plain Layout
23877 package is probably your choice.
23878 If you look for specific citation styles common in law studies,
23879 you might consider the
23880 \begin_inset Flex Code
23883 \begin_layout Plain Layout
23890 If you want to have full control over the formatting or look for advanced features such as ibidem,
23891 footnote citations,
23892 full title citations,
23893 advanced date formats (such as 400 BC) or full localization to other languages than English,
23894 you should definitely consider
23895 \begin_inset Flex Code
23898 \begin_layout Plain Layout
23905 which exceeds all other packages in terms of features,
23906 but is also quite heavy and more resource-hungry.
23909 \begin_layout Standard
23910 The handling of these packages in \SpecialChar LyX
23911 is basically the same.
23913 \begin_inset Flex Noun
23916 \begin_layout Plain Layout
23917 Document\SpecialChar menuseparator
23924 \begin_inset Flex Noun
23927 \begin_layout Plain Layout
23934 \begin_inset Flex Noun
23937 \begin_layout Plain Layout
23944 \begin_inset Flex Noun
23947 \begin_layout Plain Layout
23955 \begin_inset Flex Noun
23958 \begin_layout Plain Layout
23966 \begin_inset Flex Noun
23969 \begin_layout Plain Layout
23970 Biblatex (Natbib mode)
23977 \begin_inset Flex Noun
23980 \begin_layout Plain Layout
23987 \begin_inset Flex Noun
23990 \begin_layout Plain Layout
23997 \begin_inset space ~
24000 6.5.3 in the User's Guide for more information on these choices).
24001 With all these packages,
24002 you will get some extra features in the citation dialog and you can select the style of the reference (
24003 \begin_inset Quotes eld
24007 \begin_inset Quotes erd
24012 \begin_inset Quotes eld
24016 \begin_inset Quotes erd
24021 \begin_inset Quotes eld
24026 \begin_inset Quotes erd
24031 \begin_inset Quotes eld
24035 \begin_inset Quotes erd
24039 Note that either package needs specifically designed style files.
24040 They all ship their own,
24041 but there are lots of additional style files,
24042 and there is even an interactive style file builder
24046 \begin_layout Plain Layout
24048 \begin_inset Flex URL
24051 \begin_layout Plain Layout
24053 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
24064 \begin_inset Flex Code
24067 \begin_layout Plain Layout
24076 \begin_layout Section
24077 Subdivided Bibliographies
24080 \begin_layout Standard
24081 Sometimes you might need to divide your bibliography into several sections.
24082 If you are for instance a historian,
24083 the possibility to separate sources and scientific works is most likely a
24084 \begin_inset Quotes eld
24088 \begin_inset Quotes erd
24093 Bib\SpecialChar TeX
24094 itself does not allow you to do this.
24095 But with the help of some \SpecialChar LaTeX
24097 Bib\SpecialChar TeX
24098 can be extended to fit your needs.
24101 \begin_layout Standard
24103 provides native support for one of these packages,
24112 \begin_layout Plain Layout
24114 \begin_inset Flex URL
24117 \begin_layout Plain Layout
24119 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
24129 The advantage of this package (compared to other packages such as
24133 ) is that you don't need to define new citation commands.
24135 you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
24137 If you want to divide your bibliography into the sections
24138 \begin_inset Quotes eld
24142 \begin_inset Quotes erd
24146 \begin_inset Quotes eld
24150 \begin_inset Quotes erd
24154 you first need to create two bibliographic databases,
24156 \begin_inset space \thinspace{}
24160 \begin_inset space \space{}
24164 \begin_inset Flex Code
24167 \begin_layout Plain Layout
24174 \begin_inset Flex Code
24177 \begin_layout Plain Layout
24187 \begin_layout Standard
24189 \begin_inset Flex Noun
24192 \begin_layout Plain Layout
24193 Document\SpecialChar menuseparator
24200 \begin_inset Flex Noun
24203 \begin_layout Plain Layout
24210 \begin_inset Flex Noun
24213 \begin_layout Plain Layout
24214 Subdivided bibliography
24220 Now you can insert multiple Bib\SpecialChar TeX
24222 one for each section of your bibliography.
24223 Returning to our example:
24224 Insert the Bib\SpecialChar TeX
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24235 and a second one for the database
24236 \begin_inset Flex Code
24239 \begin_layout Plain Layout
24246 You are free to use the same or different styles for each section.
24248 you can choose if the bibliography section should contain
24249 \begin_inset Quotes eld
24252 all cited references
24253 \begin_inset Quotes erd
24256 of the specified database(s) (which is the default),
24258 \begin_inset Quotes eld
24261 all uncited references
24262 \begin_inset Quotes erd
24266 \begin_inset Quotes eld
24270 \begin_inset Quotes erd
24274 This might be useful if you would like to separate your bibliography into three sections:
24276 \begin_inset Quotes eld
24280 \begin_inset Quotes erd
24285 \begin_inset Quotes eld
24289 \begin_inset Quotes erd
24294 \begin_inset Quotes eld
24298 \begin_inset Quotes erd
24302 The titles for the sections can be added as ordinary sections or subsections.
24304 \begin_inset Flex Code
24307 \begin_layout Plain Layout
24313 removes the bibliography title,
24314 you have to manually re-add that,
24315 too (as a chapter* or section*,
24319 \begin_layout Standard
24325 the procedure is a bit different.
24336 \begin_inset Flex Noun
24339 \begin_layout Plain Layout
24340 Subdivided bibliography
24345 option is disabled if you use
24355 provides its own means to generate subdivided bibliographies.
24356 You can either add keywords to bibliography entries via the
24357 \begin_inset Flex Code
24360 \begin_layout Plain Layout
24366 entry option and then filter bibliography sections by keyword (by adding
24367 \begin_inset Flex Code
24370 \begin_layout Plain Layout
24377 \begin_inset Flex Noun
24380 \begin_layout Plain Layout
24386 field of the dialog that opens if you left-click on the
24387 \begin_inset Flex Noun
24390 \begin_layout Plain Layout
24391 Biblatex Generated Bibliography
24397 or you can filter by entry types (such as
24406 \begin_inset space \thinspace{}
24411 \begin_inset Flex Code
24414 \begin_layout Plain Layout
24421 \begin_inset Flex Code
24424 \begin_layout Plain Layout
24431 \begin_inset Flex Noun
24434 \begin_layout Plain Layout
24441 or you can create so-called
24442 \begin_inset Quotes eld
24445 Bibliography Categories
24446 \begin_inset Quotes erd
24449 to which you can assign individual entries.
24450 Please refer to the Biblatex manual,
24453 Subdivided Bibliographies
24459 \begin_layout Section
24460 Multiple Bibliographies
24461 \begin_inset CommandInset label
24463 name "subsec:Multiple-Bibliographies"
24470 \begin_layout Standard
24471 Multiple bibliographies,
24473 \begin_inset space \thinspace{}
24477 \begin_inset space \space{}
24480 a bibliography for each part,
24483 subsection or child (sub-document) of the document,
24484 are also supported by \SpecialChar LyX
24486 In order to enable it,
24488 \begin_inset Flex Noun
24491 \begin_layout Plain Layout
24492 Document\SpecialChar menuseparator
24493 Settings\SpecialChar menuseparator
24499 and select the relevant unit (e.
24500 \begin_inset space \thinspace{}
24505 \begin_inset Quotes eld
24509 \begin_inset Quotes erd
24513 \begin_inset Flex Noun
24516 \begin_layout Plain Layout
24517 Multiple Bibliographies
24523 Then add a Bib(la)\SpecialChar TeX
24524 bibliography to each unit (e.
24525 \begin_inset space \thinspace{}
24529 section) of your document.
24531 a separate bibliography,
24532 containing only the references done in the current unit is generated.
24535 \begin_layout Standard
24536 If you use Bib\SpecialChar TeX
24539 \begin_inset Flex Code
24542 \begin_layout Plain Layout
24549 \begin_inset Flex Code
24552 \begin_layout Plain Layout
24558 package is used to create multiple bibliographies.
24559 The former package is used if you select
24560 \begin_inset Quotes eld
24564 \begin_inset Quotes erd
24572 \begin_inset Flex Noun
24575 \begin_layout Plain Layout
24576 Sectioned Bibliography
24582 In all other cases,
24584 \begin_inset Flex Code
24587 \begin_layout Plain Layout
24597 \begin_layout Plain Layout
24598 An alternative approach,
24599 if you are willing to use some
24600 \begin_inset Flex Noun
24603 \begin_layout Plain Layout
24611 \begin_inset space ~
24615 \begin_inset CommandInset ref
24617 reference "sec:Inserting-TeX-Code"
24624 \begin_inset Flex Code
24627 \begin_layout Plain Layout
24639 \begin_inset Flex Code
24642 \begin_layout Plain Layout
24650 encloses the specified units in
24651 \begin_inset Flex Code
24654 \begin_layout Plain Layout
24661 \begin_inset Flex Code
24664 \begin_layout Plain Layout
24673 \begin_inset Flex Code
24676 \begin_layout Plain Layout
24684 in order to create the units.
24685 Note that this approach has some limitations.
24687 every citation reference has to be inside some
24688 \begin_inset Flex Code
24691 \begin_layout Plain Layout
24698 So citations outside a defined unit (e.
24699 \begin_inset space \thinspace{}
24703 before the first section if you use
24704 \begin_inset Quotes eld
24708 \begin_inset Quotes erd
24712 \begin_inset Quotes eld
24716 \begin_inset Quotes erd
24720 You can also create your own units by entering
24721 \begin_inset Flex Code
24724 \begin_layout Plain Layout
24733 \begin_inset Flex Code
24736 \begin_layout Plain Layout
24744 as \SpecialChar TeX
24745 code (for instance to work around the mentioned limitation).
24749 \begin_inset Flex Code
24752 \begin_layout Plain Layout
24758 s cannot be nested.
24759 A second limitation is that
24760 \begin_inset Flex Code
24763 \begin_layout Plain Layout
24769 always processes all references of a bibliography database,
24770 even if they are not cited.
24771 This can result in odd labels (e.
24772 \begin_inset space \thinspace{}
24777 \begin_inset Quotes eld
24781 \begin_inset Quotes erd
24784 if two works of this author from 2014 are in the database,
24785 even if only one is cited).
24788 \begin_layout Standard
24795 \begin_inset Flex Code
24798 \begin_layout Plain Layout
24804 option is used instead.
24805 If you need specific units,
24806 you can start them with the \SpecialChar TeX
24808 \begin_inset Flex Code
24811 \begin_layout Plain Layout
24820 \begin_inset Flex Code
24823 \begin_layout Plain Layout
24833 If you also want to control the end of the unit,
24834 use the environment
24835 \begin_inset Flex Code
24838 \begin_layout Plain Layout
24848 \begin_inset Flex Code
24851 \begin_layout Plain Layout
24863 \begin_inset Flex Code
24866 \begin_layout Plain Layout
24872 s cannot be nested.
24873 In addition to the individual bibliography of the current unit,
24878 also provides an easy way to output all bibliographies,
24881 \begin_inset space \thinspace{}
24885 at the end of the document).
24887 \begin_inset Quotes eld
24890 all reference units
24891 \begin_inset Quotes erd
24894 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
24895 Please refer to the
24899 manual for more information on this topic.
24902 \begin_layout Chapter
24904 \change_deleted 564990737 1671355654
24908 \change_inserted 564990737 1671355667
24910 \change_deleted 564990737 1671355661
24912 \change_inserted 564990737 1671355684
24914 \begin_inset CommandInset label
24916 name "chap:bullets"
24921 \change_deleted 564990737 1671355684
24923 \begin_inset CommandInset label
24934 \begin_layout Standard
24940 \begin_layout Section
24944 \begin_layout Standard
24946 provides 216 bullet shapes that can be accessed from a simple dialog.
24947 Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
24948 These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
24952 \begin_layout Plain Layout
24954 actually you can but you'll have to do it by hand.
24962 \begin_layout Section
24966 \begin_layout Standard
24967 Open the dialog by selecting the
24968 \begin_inset Flex Noun
24971 \begin_layout Plain Layout
24972 Document\SpecialChar menuseparator
24978 menu item and then select the
24979 \begin_inset Flex Noun
24982 \begin_layout Plain Layout
24991 \begin_layout Standard
24992 The dialog provides you with a table of bullet shapes.
24993 A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
24994 The row of buttons across the top is used to select which bullet depth you are changing.
24996 \change_deleted 244031559 1603875981
24997 A text entry under the table shows the currently selected bullet shape's \SpecialChar LaTeX
24998 equivalent and this can be edited if desired.
24999 If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
25005 \begin_layout Standard
25006 The six panels are divided up by the packages they require.
25007 The following table shows the mappings from button name to \SpecialChar LaTeX
25011 \begin_layout Standard
25013 \begin_inset Tabular
25014 <lyxtabular version="3" rows="7" columns="2">
25015 <features tabularvalignment="middle">
25016 <column alignment="center" valignment="top" width="0pt">
25017 <column alignment="center" valignment="top" width="0pt">
25019 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25022 \begin_layout Plain Layout
25037 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25040 \begin_layout Plain Layout
25057 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25060 \begin_layout Plain Layout
25075 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25078 \begin_layout Plain Layout
25087 base \SpecialChar LaTeX
25095 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25098 \begin_layout Plain Layout
25113 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25116 \begin_layout Plain Layout
25133 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25136 \begin_layout Plain Layout
25151 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25154 \begin_layout Plain Layout
25171 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25174 \begin_layout Plain Layout
25189 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25192 \begin_layout Plain Layout
25209 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25212 \begin_layout Plain Layout
25227 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25230 \begin_layout Plain Layout
25247 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25250 \begin_layout Plain Layout
25265 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25268 \begin_layout Plain Layout
25291 \begin_layout Standard
25293 doesn't stop you using bullets from packages you don't have.
25294 If you get errors from \SpecialChar LaTeX
25295 when you try to view or print the file,
25296 then it is likely you are missing a package.
25300 \begin_layout Plain Layout
25302 doesn't restrict your use since you may be editing locally and exporting elsewhere.
25310 \begin_layout Section
25314 \begin_layout Standard
25315 Select which bullet depth you want to change then select the bullet shape and size.
25316 Any changes will not be visible in \SpecialChar LyX
25318 but are visible when viewing the document.
25321 \begin_layout Standard
25322 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
25326 \begin_layout Plain Layout
25328 \change_inserted 564990737 1672138075
25329 \begin_inset CommandInset label
25331 name "fn:If-you-really"
25341 want to have multiple sets of paragraphs with different sets of bullets in each,
25342 then you're going to have to get your hands dirty with \SpecialChar TeX
25344 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
25345 code for a wide range of bullet shapes.
25346 To make your own custom paragraphs you have the following options:
25349 \begin_layout Plain Layout
25353 \begin_layout Plain Layout
25369 \begin_layout Plain Layout
25373 \begin_layout Plain Layout
25395 \begin_layout Itemize
25396 Use the \SpecialChar LaTeX
25398 \begin_inset Flex Code
25401 \begin_layout Plain Layout
25409 to specify a new bullet shape for a given depth.
25410 You'll also need to save the current bullet shape so you can restore it again afterwards.
25411 In this itemized list the following \SpecialChar LaTeX
25412 code was used to change the bullet used for the first depth.
25416 \begin_layout LyX-Code
25426 \begin_layout LyX-Code
25443 \begin_layout Itemize
25444 Note that the itemize depth is specified in Roman numerals as part of the
25453 \begin_layout Itemize
25454 \begin_inset Argument item:1
25457 \begin_layout Plain Layout
25461 \begin_layout Plain Layout
25479 Specify each individual entry by starting each item with the bullet shape enclosed in a
25480 \begin_inset Quotes eld
25484 \begin_inset Quotes erd
25487 inset (available at
25489 Insert\SpecialChar menuseparator
25493 \begin_inset Flex Noun
25496 \begin_layout Plain Layout
25505 this item was started with
25506 \begin_inset Flex Code
25509 \begin_layout Plain Layout
25524 \begin_layout Plain Layout
25528 \begin_layout Plain Layout
25544 \begin_layout Plain Layout
25545 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
25546 The way used here was:
25549 \begin_layout LyX-Code
25564 \begin_layout Chapter
25568 \begin_layout Section
25569 Multipart Documents
25572 \begin_layout Subsection
25576 \begin_layout Standard
25577 When you are working on a large file with many sections,
25578 it is often convenient to break up the document into several files,
25579 or perhaps you have something where a table may change from time to time,
25580 but the preceding text does not.
25582 you should seriously consider using multipart documents.
25584 scientific papers often have five major sections:
25590 Each of these could be its own separate \SpecialChar LyX
25593 \begin_inset Quotes eld
25597 \begin_inset Quotes erd
25600 file which contains the title,
25605 plus the five included files.
25606 It is important to note that each of these files is a full \SpecialChar LyX
25607 file which can be formatted and printed on its own,
25608 as well as included in a master file.
25609 Each of these files must have the same document class,
25611 don't attempt to mix book classes with article classes.
25612 You may also include \SpecialChar LaTeX
25615 these files must not have their own preamble (i.
25616 \begin_inset space \thinspace{}
25620 \begin_inset space \space{}
25623 everything up to and including the
25624 \begin_inset Flex Code
25627 \begin_layout Plain Layout
25635 line as well as the
25636 \begin_inset Flex Code
25639 \begin_layout Plain Layout
25647 line must be deleted) or else errors will be generated when you try to make a DVI file.
25650 \begin_layout Standard
25652 allows you to include files quite easily with
25653 \begin_inset Flex Noun
25656 \begin_layout Plain Layout
25657 Insert\SpecialChar menuseparator
25659 \begin_inset space ~
25668 When you click on this selection a small box is inserted into the file at the current cursor location.
25669 Clicking on the box raises a dialog which allows you to select the file to be included,
25670 and the method of its inclusion.
25674 \begin_layout Standard
25675 The file selection box should by now be obvious.
25676 The three inclusion methods are
25677 \begin_inset Quotes eld
25681 \begin_inset Quotes erd
25686 \begin_inset Quotes eld
25690 \begin_inset Quotes erd
25695 \begin_inset Quotes eld
25699 \begin_inset Quotes erd
25704 \begin_inset Quotes eld
25708 \begin_inset Quotes erd
25712 \begin_inset Quotes eld
25716 \begin_inset Quotes erd
25719 are similar in many ways,
25720 but there are also some notable differences:
25723 \begin_layout Enumerate
25725 \begin_inset Quotes eld
25729 \begin_inset Quotes erd
25732 are typeset beginning on a new page,
25733 while files that are
25734 \begin_inset Quotes eld
25738 \begin_inset Quotes erd
25741 are typeset starting on the current page.
25744 \begin_layout Enumerate
25745 \begin_inset Quotes eld
25749 \begin_inset Quotes erd
25752 files cannot themselves
25753 \begin_inset Quotes eld
25757 \begin_inset Quotes erd
25761 \begin_inset Quotes eld
25765 \begin_inset Quotes erd
25770 \begin_inset Quotes eld
25774 \begin_inset Quotes erd
25779 infinite sub-inputting is possible.
25782 \begin_layout Enumerate
25783 \begin_inset Quotes eld
25787 \begin_inset Quotes erd
25790 allow for the output of only selected
25791 \begin_inset Quotes eld
25795 \begin_inset Quotes erd
25799 while maintaining the actual counters (pagination etc.) and references (please refer to the section
25802 \begin_inset space ~
25810 \begin_inset space ~
25815 manual for details).
25818 \begin_layout Standard
25821 \begin_inset Quotes eld
25825 \begin_inset Quotes erd
25828 is the preferred method for chapters that are outsourced to child documents,
25830 \begin_inset Quotes eld
25834 \begin_inset Quotes erd
25837 is more suitable for arbitrary file inheritance.
25840 \begin_layout Standard
25842 \begin_inset Quotes eld
25846 \begin_inset Quotes erd
25849 included file allows you to include a file typeset exactly as it appears in the file,
25851 \begin_inset space \thinspace{}
25855 \begin_inset space \space{}
25859 \begin_inset Flex Code
25862 \begin_layout Plain Layout
25869 with the characters set in a fixed-width typewriter font.
25871 spaces in this file are invisible,
25872 though two consecutive spaces are conserved,
25873 unlike \SpecialChar LyX
25874 's normal treatment of spaces.
25877 \begin_inset Flex Noun
25880 \begin_layout Plain Layout
25882 \begin_inset space ~
25886 \begin_inset space ~
25890 \begin_inset space ~
25898 checkbox typesets a mark to unambiguously define the presence of a space.
25902 \begin_layout Standard
25904 the master file is converted into a full \SpecialChar LaTeX
25905 file before typesetting,
25906 while the included files are converted to \SpecialChar LaTeX
25907 files that do not have all the preamble information.
25910 \begin_layout Subsection
25911 Cross-References Between Files
25914 \begin_layout Standard
25915 \begin_inset Box Shadowbox
25925 height_special "totalheight"
25930 backgroundcolor "none"
25933 \begin_layout Plain Layout
25934 This section is somewhat out of date.
25935 Need to describe default master documents and how children are opened when the master is.
25944 \begin_layout Standard
25945 It is possible to set up cross-references between the different files.
25947 open all the files in question:
25948 let's call them A and B in a two file example,
25949 where B is included in A.
25950 Let's say you insert a label in A,
25951 then want to reference it in B.
25952 Open the cross-reference dialog whilst in document B,
25953 and you can select the
25954 \begin_inset Quotes eld
25958 \begin_inset Quotes erd
25964 \begin_layout Subsection
25965 Bibliography Lists in all Subdocuments
25968 \begin_layout Standard
25969 If you work with child documents,
25970 you might want to have only one main bibliography at the end,
25971 but still be able to have a selected bibliography for the child if you output it on its own.
25972 Here is how to achieve this.
25975 \begin_layout Standard
25976 For the main document,
25977 you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
25978 If the bibliography inset is in the master file,
25979 the references will be inherited by all children,
25980 so they are available in the citation dialog within each child.
25983 \begin_layout Standard
25984 For child-specific bibliographies,
25985 insert bibliography insets within the child documents,
25986 at the place where the bibliography should appear when the child is compiled separately.
25988 the trick is to insert them into a branch (
25990 Insert\SpecialChar menuseparator
25991 Branch\SpecialChar menuseparator
25992 Insert New Branch...
25996 \begin_inset space \thinspace{}
26001 \begin_inset Quotes eld
26005 \begin_inset Quotes erd
26009 Within the children,
26010 activate the branch (
26012 Document\SpecialChar menuseparator
26013 Settings...\SpecialChar menuseparator
26018 deactivate the branch (
26020 Document\SpecialChar menuseparator
26021 Settings...\SpecialChar menuseparator
26025 Now the child's bibliography will be ignored by the master,
26026 but considered by the child.
26029 \begin_layout Standard
26030 If you need multiple bibliographies (e.
26031 \begin_inset space \thinspace{}
26035 one per child in the
26040 please refer to sec.
26041 \begin_inset space ~
26045 \begin_inset CommandInset ref
26047 reference "subsec:Multiple-Bibliographies"
26055 \begin_layout Section
26060 \begin_layout Standard
26061 Users sometimes need to be able to
26062 \begin_inset Quotes eld
26066 \begin_inset Quotes erd
26070 file together with all the images (and other files) on which it depends,
26071 either for sending to a publisher or for sharing with a co-author.
26073 includes a Python script (
26074 \begin_inset Flex Code
26077 \begin_layout Plain Layout
26083 ) that automates this process.
26085 you must have either the
26086 \begin_inset Flex Code
26089 \begin_layout Plain Layout
26096 \begin_inset Flex Code
26099 \begin_layout Plain Layout
26105 python modules installed on your system.
26107 the script prefers the
26108 \begin_inset Flex Code
26111 \begin_layout Plain Layout
26118 \begin_inset Flex Code
26121 \begin_layout Plain Layout
26127 format on Unix-like systems and the
26128 \begin_inset Flex Code
26131 \begin_layout Plain Layout
26140 \begin_layout Standard
26142 's configuration process will set the script up to export a `\SpecialChar LyX
26144 and this format will then be available under
26145 \begin_inset Flex Code
26148 \begin_layout Plain Layout
26149 File\SpecialChar menuseparator
26158 \begin_layout Standard
26159 Independently of the platform,
26160 the generation of a particular archive format can be forced by adding either the
26161 \begin_inset Flex Code
26164 \begin_layout Plain Layout
26171 \begin_inset Flex Code
26174 \begin_layout Plain Layout
26181 \begin_inset Flex Code
26184 \begin_layout Plain Layout
26191 \begin_inset Flex Code
26194 \begin_layout Plain Layout
26200 format) switch to the
26201 \begin_inset Flex Code
26204 \begin_layout Plain Layout
26206 \SpecialChar menuseparator
26214 \begin_inset Flex Code
26217 \begin_layout Plain Layout
26218 Tools\SpecialChar menuseparator
26219 Preferences\SpecialChar menuseparator
26220 File Handling\SpecialChar menuseparator
26227 (Make sure you add the switch after the script name,
26231 \begin_layout Section
26232 Fancy Headers and Footers
26235 \begin_layout Standard
26236 The default page layout is rather plain;
26238 \begin_inset Flex Code
26241 \begin_layout Plain Layout
26248 all you get is a centered page number at the bottom of the page.
26249 This document uses KOMA-script's book class,
26250 so it appears to be a bit fancier.
26251 But to really put on a show,
26252 you need to set the document page style to
26253 \begin_inset Quotes eld
26257 \begin_inset Quotes erd
26261 as mentioned in the
26266 This section describes the \SpecialChar LaTeX
26267 code you need to insert in your \SpecialChar LaTeX
26268 preamble in order to get the desired effects.
26271 \begin_layout Standard
26272 For more information on fancy headers,
26274 \begin_inset Flex Code
26277 \begin_layout Plain Layout
26283 package documentation.
26285 \begin_inset Flex URL
26288 \begin_layout Plain Layout
26290 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
26298 \begin_layout Standard
26299 The page header is divided into three fields,
26300 not surprisingly labeled
26301 \begin_inset Quotes eld
26305 \begin_inset Quotes erd
26310 \begin_inset Quotes eld
26314 \begin_inset Quotes erd
26319 \begin_inset Quotes eld
26323 \begin_inset Quotes erd
26327 The footer is also divided into these three fields.
26328 The \SpecialChar LaTeX
26329 commands to set these fields in the simplest manner are
26330 \begin_inset Flex Code
26333 \begin_layout Plain Layout
26343 \begin_inset Flex Code
26346 \begin_layout Plain Layout
26356 \begin_inset Flex Code
26359 \begin_layout Plain Layout
26369 \begin_inset Flex Code
26372 \begin_layout Plain Layout
26382 Suppose you wish to put your name in the upper left hand corner of each page.
26383 Simply insert the following command in the preamble:
26387 \begin_layout Standard
26396 \begin_layout Standard
26397 You will now see your name in the upper left.
26398 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,
26400 \begin_inset space \thinspace{}
26406 \begin_layout Standard
26414 \begin_layout Standard
26415 Let's get really fancy:
26416 lets put the section number with the word
26417 \begin_inset Quotes eld
26421 \begin_inset Quotes erd
26425 \begin_inset space \thinspace{}
26429 \begin_inset space \space{}
26432 Section 3) in the upper left,
26433 the page number (e.
26434 \begin_inset space \thinspace{}
26438 \begin_inset space \space{}
26441 Page 4) in the upper right,
26442 your name in the lower left,
26443 and the date in the lower right.
26444 The following commands should now appear in the preamble:
26447 \begin_layout Standard
26457 \begin_layout Standard
26465 \begin_layout Standard
26475 \begin_layout Standard
26484 \begin_layout Standard
26492 \begin_layout Standard
26502 \begin_layout Standard
26504 \begin_inset Flex Code
26507 \begin_layout Plain Layout
26516 \begin_inset Flex Code
26519 \begin_layout Plain Layout
26527 access \SpecialChar LaTeX
26528 's section and page counters,
26529 and so print out the current section and page number.
26531 \begin_inset Flex Code
26534 \begin_layout Plain Layout
26542 simply prints out today's date.
26545 \begin_layout Standard
26546 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
26547 If you don't want one of the rules,
26548 set its thickness to 0.
26549 The header rule has a default thickness of 0.4pt,
26550 the footer rule is 0pt.
26556 \begin_inset Flex Code
26559 \begin_layout Plain Layout
26564 headrulewidth}{0.4pt}
26570 \begin_inset Flex Code
26573 \begin_layout Plain Layout
26578 footrulewidth}{0.4pt}
26583 to set the thicknesses.
26586 \begin_layout Standard
26587 You can switch the header/footer settings on and off for individual pages using commands like
26588 \begin_inset Flex Code
26591 \begin_layout Plain Layout
26594 thispagestyle{empty}
26601 \begin_inset Flex Code
26604 \begin_layout Plain Layout
26607 thispagestyle{plain}
26614 \begin_inset Flex Code
26617 \begin_layout Plain Layout
26620 thispagestyle{fancy}
26626 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
26629 title pages are marked as plain by default,
26630 while following pages are marked fancy when using the global fancy setting.
26633 \begin_layout Standard
26634 As a final example,
26635 it is possible to include an image in the header or footer.
26636 Suppose you want to put a company logo in the upper lefthand corner.
26637 You might try something like
26640 \begin_layout Standard
26649 includegraphics{logo.eps}}}
26652 \begin_layout Standard
26654 (you may need to preface this with
26655 \begin_inset Flex Code
26658 \begin_layout Plain Layout
26661 usepackage{graphics}
26666 if you don't include graphics elsewhere in your document).
26669 \begin_layout Chapter
26671 and the World Wide Web
26674 \begin_layout Standard
26676 has long supported the export of documents to various web-friendly formats,
26678 Before version 2.0,
26680 HTML export was always accomplished by the use of external converters.
26684 \begin_layout Plain Layout
26685 For details on the use of external converters with \SpecialChar LyX
26691 section of the Customization manual.
26696 These fall into two large groups:
26697 there are converters that use \SpecialChar LaTeX
26698 as an intermediate format,
26700 \begin_inset Flex Code
26703 \begin_layout Plain Layout
26711 \begin_inset Flex Code
26714 \begin_layout Plain Layout
26722 \begin_inset Flex Code
26725 \begin_layout Plain Layout
26732 relying upon \SpecialChar LyX
26733 to produce the \SpecialChar LaTeX
26735 and there is a converter that works directly on \SpecialChar LyX
26738 \begin_inset Flex Code
26741 \begin_layout Plain Layout
26749 All of these have different advantages and disadvantages.
26753 \begin_layout Standard
26754 The \SpecialChar LaTeX
26755 -based converters have the advantage that,
26757 they know everything about the exported document that \SpecialChar LaTeX
26759 Such converters do not care,
26761 if a certain block of code was produced by \SpecialChar LyX
26762 or was Evil Red Text.
26763 These converters know about
26764 \begin_inset Flex Code
26767 \begin_layout Plain Layout
26776 and can often make use of the
26777 \begin_inset Flex Code
26780 \begin_layout Plain Layout
26786 files generated by Bib\SpecialChar TeX
26790 is a very hard language to parse—
26791 it is sometimes said that only \SpecialChar TeX
26792 itself understands \SpecialChar TeX
26794 and \SpecialChar LaTeX
26795 -based converters will often choke on what seem to be quite simple constructs;
26796 complex ones can throw them completely,
26797 and as of this writing,
26803 manual will not export with
26804 \begin_inset Flex Code
26807 \begin_layout Plain Layout
26814 though the others will.
26815 The other issue concerns how math is handled.
26816 These converters typically convert the formulae into little pictures that are then linked from the HTML document.
26817 Since these are actually generated by \SpecialChar LaTeX
26820 But they do not scale well,
26821 and just getting them to look as if they are actually meant to be in your document—
26822 so that the font sizes seem to be roughly the same—
26823 can be a challenge.
26826 \begin_layout Standard
26828 \begin_inset Flex Code
26831 \begin_layout Plain Layout
26839 \begin_inset CommandInset href
26841 name "http://pinchito.es/elyxer/"
26842 target "http://pinchito.es/elyxer/"
26847 ) solves some of these problems.
26849 the formulae it produces scale perfectly,
26850 since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
26851 But even moderately complex formula are rendered less well than with
26852 \begin_inset Flex Code
26855 \begin_layout Plain Layout
26862 this reflects the limitations of HTML.
26866 \begin_layout Plain Layout
26869 \begin_inset Flex Code
26872 \begin_layout Plain Layout
26879 can also use jsMath and MathJax for equations,
26880 but this setting is only available globally and requires one to have access to a server that runs the backend.
26885 More importantly (as of version 1.1.1,
26888 \begin_inset Flex Code
26891 \begin_layout Plain Layout
26898 has limited support for math macros and no support for user-defined paragraph or character styles.
26899 These limitations make
26900 \begin_inset Flex Code
26903 \begin_layout Plain Layout
26910 unsuitable for many of the documents \SpecialChar LyX
26914 these problems could be solved,
26915 but the \SpecialChar LyX
26916 developers have decided to follow a different path and have made \SpecialChar LyX
26917 itself capable of writing XHTML,
26918 just as it is capable of writing \SpecialChar LaTeX
26924 \begin_layout Standard
26925 As of this writing,
26926 XHTML output remains under development and should probably be regarded as
26927 \begin_inset Quotes eld
26931 \begin_inset Quotes erd
26938 \begin_layout Plain Layout
26940 \begin_inset Flex Code
26943 \begin_layout Plain Layout
26944 development/HTML/HTML.notes
26950 which can be found in the \SpecialChar LyX
26952 \begin_inset CommandInset href
26954 name "accessed online"
26955 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
26961 usually contains up-to-date information about the state of XHTML output.
26962 See also the list of XHTML bugs on
26963 \begin_inset CommandInset href
26965 name "the bug tracker"
26966 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"
26977 the developers have chosen this approach because it has several potential advantages over the other two.
26980 \begin_layout Standard
26981 These advantages are primarily due to the fact that the XHTML output routines,
26982 since they are part of \SpecialChar LyX
26984 know everything \SpecialChar LyX
26985 knows about the document being exported.
26989 \begin_layout Plain Layout
26990 Another advantage is that,
26991 since these routines are internal to \SpecialChar LyX
26993 they are immune to changes in \SpecialChar LyX
26995 or to changes in the semantics of existing insets.
27000 So they know about the table of contents (as displayed in the outline),
27001 about the counters associated with different paragraph styles,
27002 and about user-defined styles.
27003 The XHTML output routines know what \SpecialChar LyX
27004 knows about internationalization,
27006 so they will output
27007 \begin_inset Quotes eld
27011 \begin_inset Quotes erd
27015 \begin_inset Quotes eld
27023 \begin_inset Quotes erd
27027 depending upon the language in effect at the time.
27031 \begin_layout Standard
27033 the output routines know what \SpecialChar LyX
27034 knows about document layout,
27036 about how the document is to be rendered on screen.
27037 We use this information when we output the document as XHTML.
27044 generates CSS style information corresponding to the layout information it uses to render the document on screen:
27045 if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
27047 then (by default) they will be sans-serif and bold when viewed in a web browser,
27049 And this is true not just for pre-defined styles,
27052 including user-defined styles.
27054 the XHTML output routines make no distinction between user-defined paragraph and
27055 \change_deleted 244031559 1603876931
27057 \change_inserted 244031559 1603876940
27060 styles and \SpecialChar LyX
27061 's own pre-defined styles:
27063 everything \SpecialChar LyX
27064 knows about the styles is contained in the layout files.
27065 And much the same is true as regards pre-defined textual insets,
27067 and various custom insets.
27071 \begin_layout Standard
27072 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
27073 output can be customized and extended:
27074 through layout files and modules.
27075 See chapter five of the
27079 manual for the details.
27082 \begin_layout Standard
27083 The remainder of this chapter contains more detailed information on XHTML output,
27085 and ways to work around those limitations.
27088 \begin_layout Section
27089 Math Output in XHTML
27092 \begin_layout Standard
27094 offers four choices for how math is rendered.
27095 These have various advantages and disadvantages:
27098 \begin_layout Itemize
27100 \begin_inset Newline newline
27103 MathML is a dialect of XML designed specifically for mathematics on the web,
27104 and it typically renders very well in browsers that support it.
27105 The disadvantage is that not all browsers support MathML,
27106 and support is not complete even in the Gecko-based browsers,
27108 \begin_inset Newline newline
27111 If \SpecialChar LyX
27112 is unable to render a formula as MathML—
27114 if the formula uses the
27115 \begin_inset Flex Code
27118 \begin_layout Plain Layout
27125 then it will instead output the formula as an image.
27129 \begin_layout Itemize
27131 \begin_inset Newline newline
27134 As mentioned above,
27136 \begin_inset Flex Code
27139 \begin_layout Plain Layout
27145 outputs math as HTML,
27150 \begin_layout Plain Layout
27152 has borrowed some of the CSS for its HTML output from
27153 \begin_inset Flex Code
27156 \begin_layout Plain Layout
27167 For simple formulae,
27168 this can work quite well,
27169 though with more complicated formulae it tends to break down.
27171 this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
27172 fairly simple math.
27173 \begin_inset Newline newline
27176 If Lyx is unable to render a formula as HTML—
27178 if the formula uses the
27179 \begin_inset Flex Code
27182 \begin_layout Plain Layout
27189 then it will instead output the formula as an image.
27193 \begin_layout Itemize
27195 \begin_inset Newline newline
27199 \begin_inset Flex Code
27202 \begin_layout Plain Layout
27210 will output formulae as images,
27211 the very same images,
27213 that are used for instant preview.
27217 \begin_layout Plain Layout
27218 Instant preview does
27222 have to be on for images to be output,
27228 The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
27230 so they are very accurate.
27232 as mentioned earlier,
27233 is that these are bitmapped images,
27234 so they do not scale terribly well,
27235 and one cannot copy them,
27237 \begin_inset Newline newline
27240 The size of the images can be controlled by setting the
27241 \begin_inset Quotes eld
27244 Math Images Scaling
27245 \begin_inset Quotes erd
27249 \begin_inset Flex Noun
27252 \begin_layout Plain Layout
27253 Document\SpecialChar menuseparator
27254 Settings\SpecialChar menuseparator
27264 \begin_layout Plain Layout
27265 For those who want to know,
27266 this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
27272 \begin_inset Newline newline
27275 If \SpecialChar LyX
27276 for some reason fails to create an image for a formula (e.g.,
27277 if a required \SpecialChar LaTeX
27278 package is not installed),
27279 then it will fall back to outputing the raw \SpecialChar LaTeX
27283 \begin_layout Itemize
27286 \begin_inset Newline newline
27291 will happily output math as \SpecialChar LaTeX
27293 As well as being the output of last resort,
27294 this method can be used with such tools as
27295 \begin_inset CommandInset href
27298 target "http://www.math.union.edu/~dpvc/jsMath/"
27304 which uses JavaScript to render \SpecialChar LaTeX
27305 embedded in HTML documents.
27307 wraps the \SpecialChar LaTeX
27309 \begin_inset Flex Code
27312 \begin_layout Plain Layout
27318 (for inline formulas) or
27319 \begin_inset Flex Code
27322 \begin_layout Plain Layout
27328 (for displayed formulas) with
27329 \begin_inset Flex Code
27332 \begin_layout Plain Layout
27339 as is required for jsMath.
27342 \begin_layout Standard
27343 One of these output methods must be selected under
27344 \begin_inset Flex Noun
27347 \begin_layout Plain Layout
27348 Document\SpecialChar menuseparator
27349 Settings\SpecialChar menuseparator
27359 This is a document-wide setting,
27363 \begin_layout Standard
27366 will offer the user the option to select an alternate output method for a particular inset,
27368 one that isn't being rendered very well by MathML.
27372 \begin_layout Plain Layout
27374 since \SpecialChar LyX
27375 falls back to images if the inset contains ERT,
27376 then one can force output as an image by putting some harmless ERT into the math,
27379 \begin_inset Formula $a=b\relax$
27390 \begin_layout Section
27391 Bibliography and Citations
27394 \begin_layout Standard
27395 XHTML output fully supports bibliographies and citations.
27399 \begin_layout Standard
27400 Citation labels are generated by the same machinery that generates \SpecialChar LyX
27401 's on-screen labels,
27402 so the labels will look in the output much as they do in \SpecialChar LyX
27405 If you are using numerical citations,
27406 then \SpecialChar LyX
27407 will output numerical labels,
27408 such as [1] or [17],
27409 rather than simply showing the citation key in square brackets,
27410 as it does on-screen.
27411 If you are using author-year citations,
27412 then \SpecialChar LyX
27413 will add lowercase letters to the years,
27414 just as Bib\SpecialChar TeX
27416 if it finds more than one citation for a given author-year combination.
27417 The labels will be printed with the bibliography entries.
27418 Note that there is,
27420 no way to customize the appearance of the labels,
27422 to choose between square brackets and parentheses.
27425 \begin_layout Standard
27426 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
27427 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.
27428 The formatting can be customized in your layout file or,
27435 manual for the details.
27438 \begin_layout Standard
27439 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
27440 So you can see things like this:
27443 \begin_layout Quote
27446 \begin_inset Quotes eld
27449 Context and Logical Form
27450 \begin_inset Quotes erd
27456 Language in Context:
27460 Oxford University Press,
27466 \begin_layout Quote
27469 \begin_inset Quotes eld
27472 Semantics in Context
27473 \begin_inset Quotes erd
27479 Language in Context:
27483 Oxford University Press,
27489 \begin_layout Standard
27490 This should be fixed before long.
27493 \begin_layout Standard
27494 There is no support at present for sectioned bibliographies.
27495 If you have multiple bibliographies,
27496 then \SpecialChar LyX
27497 will print the same bibliography over and over.
27500 \begin_layout Section
27504 \begin_layout Standard
27506 will happily export indexes as XHTML,
27507 but with certain limitations at the moment.
27510 \begin_layout Standard
27511 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
27519 \begin_layout Plain Layout
27520 The main issue here is that \SpecialChar LyX
27521 itself does not really handle these.
27522 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
27528 We'll describe how they are handled using the subsection headings from that section.
27531 \begin_layout Itemize
27532 Grouping Index Entries (aka,
27535 makes an effort to support these,
27536 but the entries must be separated by
27537 \begin_inset Quotes eld
27542 \begin_inset Quotes erd
27547 there must be spaces around the exclamation point.
27548 This is because it is otherwise too difficult to check for escaped exclamation points,
27553 \begin_layout Itemize
27555 There is no support at all for page ranges,
27556 since these make no sense with XHMTL.
27558 you will just get two index entries,
27562 \begin_layout Itemize
27564 There is no support for cross-referencing.
27565 If \SpecialChar LyX
27566 finds an entry containing the
27567 \begin_inset Quotes eld
27570 |see\SpecialChar ldots
27572 \begin_inset Quotes erd
27576 it is just dropped,
27577 and the rest is treated as an ordinary index entry.
27580 \begin_layout Itemize
27583 does support attempts to fix the sorting order.
27584 It will take what is before the first `@' it finds and use that for sorting,
27585 taking what follows the first `@' to be the actual entry.
27588 does not check for escaped `@',
27589 so do not try to index email addresses.
27592 \begin_layout Itemize
27593 Index Entry Layout:
27594 You can format entries by using the text style dialog,
27595 or by using any other method available within \SpecialChar LyX
27597 There is no support for constructs like:
27599 \begin_inset Quotes eld
27603 \begin_inset Quotes erd
27608 if \SpecialChar LyX
27609 finds a pipe symbol,
27612 it will delete it and everything that follows it.
27615 \begin_layout Itemize
27617 There is no support for multiple indexes.
27619 all index entries will be printed as one large index.
27620 To avoid our printing several versions of the index,
27621 we print only the main index,
27622 so make sure you have one.
27625 \begin_layout Section
27626 Nomenclature and Glossary
27629 \begin_layout Standard
27630 There is at present no support for glossaries.
27631 Adding it would be fairly trivial,
27635 \begin_layout Chapter
27637 \change_inserted 1075283030 1616534180
27641 \begin_layout Standard
27643 \change_inserted 1075283030 1616534386
27646 can generate documents in the DocBook XML vocabulary.
27647 With versions 2.3 and before,
27648 only select templates could be used to generate DocBook documents (only version 4).
27649 Starting with \SpecialChar LyX
27651 most \SpecialChar LyX
27652 layouts can generate valid DocBook documents (only version 5).
27653 This feature is built into \SpecialChar LyX
27654 and does not require the use of external tools.
27657 \begin_layout Standard
27659 \change_inserted 1075283030 1616534437
27660 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
27661 output can be customized and extended:
27662 through layout files and modules.
27663 See chapter five of the
27667 manual for the details.
27670 \begin_layout Standard
27672 \change_inserted 1075283030 1616534475
27673 Most \SpecialChar LyX
27674 features are supported with DocBook,
27678 \begin_layout Itemize
27680 \change_inserted 1075283030 1616534741
27681 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
27685 All formulae are also available in raw \SpecialChar TeX
27686 in the DocBook output for further processing.
27689 \begin_layout Itemize
27691 \change_inserted 1075283030 1616534852
27692 Bibliographies and citations are implemented,
27693 including with an external BibTeX file.
27694 Bibliography entries are not prerendered when the detailed information are available,
27695 but rather output with the standard DocBook constructs.
27696 The external DocBook processor is expected to handle the rendering of entries.
27699 \begin_layout Itemize
27701 \change_inserted 1075283030 1616534863
27702 Indexes are supported,
27703 including multiple indices.
27710 and cross-references (
27715 with the exception of the same symbols escaped.
27724 ) are not supported.
27725 There is no support for escaping of index entries.
27728 \begin_layout Itemize
27730 \change_inserted 1075283030 1616534884
27731 Glossaries are implemented.
27734 \begin_layout Standard
27736 \change_inserted 1075283030 1616534894
27737 Two major parameters can be set at the document level.
27740 \begin_layout Itemize
27742 \change_inserted 1075283030 1616534948
27745 can generate tables either as HTML (default value) or CALS,
27746 depending on the user's requirements.
27747 Most DocBook processors accept both formats.
27750 \begin_layout Itemize
27752 \change_inserted 1075283030 1616535006
27755 MathML is included within its own name space,
27757 The implication is that there must be an indication of the tags belonging to the MathML standard.
27758 Three choices are offered:
27763 \begin_layout Itemize
27765 \change_inserted 1075283030 1616535044
27767 the MathML name space is defined for each formula (using the
27771 attribute on each formula)
27774 \begin_layout Itemize
27776 \change_inserted 1075283030 1616535090
27782 the MathML name space is defined at the document level (using the
27786 attribute on the root element).
27787 Each MathML is prefixed with
27798 \begin_layout Itemize
27800 \change_inserted 1075283030 1616620405
27816 \begin_layout Standard
27818 \change_inserted 1075283030 1616620470
27819 This option is especially useful if you want \SpecialChar LyX
27820 to match your personal style or to work with buggy software that only accepts one prefix for MathML.
27826 \begin_layout Chapter
27827 The \SpecialChar LyX
27831 \begin_layout Section
27835 \begin_layout Standard
27836 The `\SpecialChar LyX
27837 server' allows other programs to talk to \SpecialChar LyX
27839 invoke \SpecialChar LyX
27841 and retrieve information about the \SpecialChar LyX
27843 This is only intended for advanced users,
27844 but they should find it useful.
27845 It is by writing to the \SpecialChar LyX
27848 that bibliography managers,
27851 \begin_inset Quotes eld
27855 \begin_inset Quotes erd
27858 citations to \SpecialChar LyX
27862 \begin_layout Section
27863 Starting the \SpecialChar LyX
27865 \begin_inset CommandInset label
27867 name "sec:Starting-the-Server"
27874 \begin_layout Standard
27875 The \SpecialChar LyX
27876 server works through the use of a pair of named pipes.
27877 These are usually located in
27878 \begin_inset Flex Code
27881 \begin_layout Plain Layout
27888 (except on Windows,
27893 named pipes are special objects located in
27894 \begin_inset Flex Code
27897 \begin_layout Plain Layout
27909 ) and have the names
27910 \begin_inset Quotes eld
27914 \begin_inset Flex Code
27917 \begin_layout Plain Layout
27924 \begin_inset Quotes erd
27928 \begin_inset Quotes eld
27932 \begin_inset Flex Code
27935 \begin_layout Plain Layout
27942 \begin_inset Quotes erd
27946 External programs write into
27947 \begin_inset Flex Code
27950 \begin_layout Plain Layout
27956 and read back data from
27957 \begin_inset Flex Code
27960 \begin_layout Plain Layout
27967 The stem of the pipe names can be defined in the
27968 \begin_inset Flex Noun
27971 \begin_layout Plain Layout
27972 Tools\SpecialChar menuseparator
27980 \begin_inset Flex Code
27983 \begin_layout Plain Layout
27984 "/home/myhome/lyxpipe"
27991 \begin_inset Flex Code
27994 \begin_layout Plain Layout
28008 on Windows (where any working path instead of lyxpipe can be used,
28010 \begin_inset Flex Code
28013 \begin_layout Plain Layout
28036 configure this manually in order for the server to start.
28039 \begin_layout Standard
28042 \begin_inset Flex Code
28045 \begin_layout Plain Layout
28052 \begin_inset Flex Code
28055 \begin_layout Plain Layout
28061 ' to create the pipes.
28062 If one of the pipes already exists,
28064 will assume that another \SpecialChar LyX
28065 process is already running and will not start the server.
28066 On POSIX (Unix like) systems,
28067 if for some other reason,
28069 \begin_inset Quotes eld
28073 \begin_inset Quotes erd
28076 pipe is left in existence when \SpecialChar LyX
28078 then \SpecialChar LyX
28079 will try to delete it.
28080 If this fails for some reason,
28081 you will need to delete the pipes manually and then restart \SpecialChar LyX
28084 pipes are deleted by the OS on program termination or crash,
28086 \begin_inset Quotes eld
28090 \begin_inset Quotes erd
28093 pipes should not be possible.
28096 \begin_layout Standard
28097 To have several \SpecialChar LyX
28098 processes with servers at the same time,
28099 you have to use different configurations,
28100 perhaps by using separate user directories,
28102 \begin_inset Flex Code
28105 \begin_layout Plain Layout
28115 \begin_layout Standard
28116 If you are developing a client program,
28117 you might find it useful to enable debugging information from the \SpecialChar LyX
28119 Do this by starting \SpecialChar LyX
28121 \begin_inset Flex Code
28124 \begin_layout Plain Layout
28133 \begin_layout Standard
28134 You can find a complete example client written in C++ in the source distribution as
28135 \begin_inset Flex Code
28138 \begin_layout Plain Layout
28139 development/lyxserver/server_monitor.cpp
28147 \begin_layout Standard
28148 Another useful tool is the command-line based client found in
28149 \begin_inset Flex Code
28152 \begin_layout Plain Layout
28153 src/client/lyxclient
28161 \begin_layout Section
28162 Normal communication
28165 \begin_layout Standard
28166 To issue a \SpecialChar LyX
28168 the client writes a line of ASCII text into the input pipe.
28169 This line has the following format:
28172 \begin_layout Quote
28186 \begin_layout Description
28187 clientname is a name that the client can choose arbitrarily.
28188 Its only use is that \SpecialChar LyX
28189 will echo it if it sends an answer—
28190 so a client can dispatch results from different requesters.
28193 \begin_layout Description
28194 function is the function you want \SpecialChar LyX
28196 It is the same as the commands you'd use in the minibuffer.
28199 \begin_layout Description
28200 argument is an optional argument which is meaningful only to some functions (for instance,
28202 \begin_inset Quotes eld
28206 \begin_inset Quotes erd
28209 LFUN will insert the argument as text at the cursor position).
28212 \begin_layout Standard
28213 The answer from \SpecialChar LyX
28214 will arrive in the output pipe and be of the form
28217 \begin_layout Quote
28231 \begin_layout Standard
28240 are just echoed from the command request,
28245 is more or less useful information filled according to how the command execution worked out.
28248 \begin_inset Quotes eld
28252 \begin_inset Quotes erd
28256 will return information about the internal state of \SpecialChar LyX
28258 while other will return an empty data-response.
28259 This means that the command execution went fine.
28262 \begin_layout Standard
28264 the response from \SpecialChar LyX
28265 will have this form
28268 \begin_layout Quote
28282 \begin_layout Standard
28287 should contain an explanation of why the command failed.
28290 \begin_layout Standard
28294 \begin_layout LyX-Code
28295 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
28296 \begin_inset Newline newline
28299 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
28300 \begin_inset Newline newline
28303 read a <~/.lyxpipe.out
28304 \begin_inset Newline newline
28310 \begin_layout Subsection
28311 AppleScript (Mac OS X)
28314 \begin_layout Standard
28315 Since \SpecialChar LyX
28318 supports basic interactions with AppleScript for normal communication through the command run.
28319 This command takes a direct argument (the
28323 to perform) and an optional argument.
28324 It either returns the output of the function or triggers an error with the error message and code.
28327 \begin_layout Standard
28331 \begin_layout LyX-Code
28332 tell application "\SpecialChar LyX
28336 \begin_layout LyX-Code
28340 \begin_layout LyX-Code
28341 -- Stores the current file name into f
28344 \begin_layout LyX-Code
28345 set f to (run "server-get-filename" with argument "")
28348 \begin_layout LyX-Code
28349 on error the error_message number the error_number
28352 \begin_layout LyX-Code
28353 display dialog "Error:
28354 " & the error_number & ".
28358 \begin_layout LyX-Code
28359 & the error_message buttons {"OK"} default button 1
28362 \begin_layout LyX-Code
28366 \begin_layout LyX-Code
28370 \begin_layout Section
28374 \begin_layout Standard
28376 can notify clients of events going on asynchronously.
28377 Currently it will only do this if the user binds a key sequence with the function
28378 \begin_inset Quotes eld
28382 \begin_inset Quotes erd
28386 The format of the string \SpecialChar LyX
28387 sends is as follows:
28390 \begin_layout Quote
28391 \begin_inset Flex Code
28394 \begin_layout Plain Layout
28405 \begin_layout Standard
28410 is the printed representation of the key sequence that was actually typed by the user.
28413 \begin_layout Standard
28414 This mechanism can be used to extend \SpecialChar LyX
28415 's command set and implement macros.
28416 Bind some key sequence to
28417 \begin_inset Quotes eld
28421 \begin_inset Quotes erd
28425 Then start a client that listens on the output pipe,
28426 dispatches the command according to the sequence,
28427 and starts a function that may use \SpecialChar LyX
28428 calls and \SpecialChar LyX
28429 requests to issue a command or a series of commands to \SpecialChar LyX
28433 \begin_layout Section
28434 The simple \SpecialChar LyX
28438 \begin_layout Standard
28440 implements a simple protocol that can be used for session management.
28441 All messages are of the form
28444 \begin_layout Quote
28454 \begin_layout Standard
28460 \begin_inset Quotes eld
28464 \begin_inset Quotes erd
28468 \begin_inset Quotes eld
28472 \begin_inset Quotes erd
28477 \begin_inset Quotes eld
28481 \begin_inset Quotes erd
28484 is received from a client,
28486 will report back to inform the client that it's listening to it's messages,
28488 \begin_inset Quotes eld
28492 \begin_inset Quotes erd
28495 sent from \SpecialChar LyX
28496 will inform clients that \SpecialChar LyX
28500 \begin_layout Section
28501 Reverse DVI/PDF search
28504 \begin_layout Standard
28505 Some DVI/PDF viewers
28509 \begin_layout Plain Layout
28510 The following viewers offer the reverse PDF search feature:
28511 Okular on KDE/Linux,
28513 Skim on Mac OSX and SumatraPDF on Windows.
28522 facility (also called
28527 This means that you can tell \SpecialChar LyX
28528 to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
28530 the viewer must be able to communicate with \SpecialChar LyX
28532 This is done via the \SpecialChar LyX
28533 server either by using the named pipe (
28538 or the UNIX domain socket (
28542 ) that \SpecialChar LyX
28543 creates in its temporary directory (this is the way the
28544 \begin_inset Flex Code
28547 \begin_layout Plain Layout
28553 program communicates with \SpecialChar LyX
28556 you need a helper script that mediates between the viewer and \SpecialChar LyX
28559 the viewer can communicate with \SpecialChar LyX
28561 This depends on the selected viewer and on your operating system.
28562 The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
28564 we will thus describe how to setup reverse search for specific viewers.
28565 Before we turn to this,
28567 we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
28570 \begin_layout Subsection
28572 \begin_inset CommandInset label
28574 name "subsec:rev-search"
28581 \begin_layout Standard
28582 In most cases \SpecialChar LyX
28583 will do the work for you by pressing the following button in the toolbar:
28587 arg "buffer-toggle-output-sync"
28592 you can also enable the feature by checking
28594 Synchronize with Output
28597 \begin_inset Flex Noun
28600 \begin_layout Plain Layout
28601 Document\SpecialChar menuseparator
28602 Settings\SpecialChar menuseparator
28609 In such a case \SpecialChar LyX
28610 will automatically insert the necessary Sync\SpecialChar TeX
28611 macro (for PDF) or load the srcltx package (for DVI) respectively.
28612 This option can be easily reached also on
28613 \begin_inset Flex Code
28616 \begin_layout Plain Layout
28625 \begin_layout Standard
28626 If you need a different setting,
28627 you can select or input a custom macro from the drop down box just below
28628 \begin_inset Flex Noun
28631 \begin_layout Plain Layout
28632 Document\SpecialChar menuseparator
28633 Settings\SpecialChar menuseparator
28634 Output\SpecialChar menuseparator
28635 Synchronize with Output
28643 \begin_layout Standard
28644 Note that the method
28645 \begin_inset Flex Code
28648 \begin_layout Plain Layout
28656 enables gzip compression.
28657 If your viewer does not support it,
28658 you should instead use
28659 \begin_inset Flex Code
28662 \begin_layout Plain Layout
28673 \begin_layout Standard
28674 Please also note that including the
28675 \begin_inset Flex Code
28678 \begin_layout Plain Layout
28685 \begin_inset Flex Code
28688 \begin_layout Plain Layout
28694 sometimes has an undesired impact on the typesetting.
28696 you should switch output synchronization off for the final typesetting if you use the
28697 \begin_inset Flex Code
28700 \begin_layout Plain Layout
28707 \begin_inset Flex Code
28710 \begin_layout Plain Layout
28720 \begin_layout Standard
28721 In case you need some more special settings that are not covered by the automatic settings,
28722 read the next section about how to set up output synchronization manually.
28723 If the automatic setup suits your needs,
28724 you can readily jump to section
28725 \begin_inset space ~
28729 \begin_inset CommandInset ref
28731 reference "subsec:configuring-viewers"
28737 where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
28740 \begin_layout Subsection
28744 \begin_layout Standard
28746 provides several different methods for reverse search.
28747 Some are built-in in the
28748 \begin_inset Flex Code
28751 \begin_layout Plain Layout
28758 some are provided by external packages.
28759 Your choice depends on whether your \SpecialChar LaTeX
28760 distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
28761 The available methods are described in the following.
28764 \begin_layout Subsubsection*
28765 Built-in DVI-search via src-specials (DVI only)
28768 \begin_layout Standard
28769 This method provides the DVI file with the necessary information for reverse search.
28770 It is available in \SpecialChar LaTeX
28771 since quite some time (any somewhat recent \SpecialChar LaTeX
28772 distribution should include it),
28773 and it works reliably.
28776 \begin_inset Flex Noun
28779 \begin_layout Plain Layout
28790 \begin_inset Flex Noun
28793 \begin_layout Plain Layout
28804 \begin_inset Flex Noun
28807 \begin_layout Plain Layout
28808 Preferences\SpecialChar menuseparator
28809 File Handling\SpecialChar menuseparator
28816 \begin_inset Flex Code
28819 \begin_layout Plain Layout
28820 latex -src-specials $$i
28826 If this doesn't work,
28827 check if your \SpecialChar TeX
28828 engine needs different options (the syntax might differ in some distributions).
28831 \begin_layout Subsubsection*
28832 External Packages (PDFSync and scrltx)
28835 \begin_layout Standard
28844 provide reverse search facility for PDF output (via pdflatex) and DVI output,
28846 In order to enable it,
28847 load the packages in the \SpecialChar LyX
28852 \begin_layout Itemize
28853 \begin_inset Flex Code
28856 \begin_layout Plain Layout
28859 usepackage{pdfsync}
28864 for reverse PDF search,
28867 \begin_layout Itemize
28868 \begin_inset Flex Code
28871 \begin_layout Plain Layout
28874 usepackage[active]{srcltx}
28879 for reverse DVI search.
28882 \begin_layout Standard
28883 If you want to be able to perform both DVI and PDF reverse searches,
28884 you can also insert in the preamble the following lines
28887 \begin_layout LyX-Code
28891 \begin_inset Newline newline
28897 \begin_inset Newline newline
28902 usepackage{pdfsync}
28903 \begin_inset Newline newline
28909 \begin_inset Newline newline
28914 usepackage[active]{srcltx}
28915 \begin_inset Newline newline
28923 \begin_layout Standard
28925 you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
28928 \begin_layout Standard
28929 Note that PDFSync might affect the output layout of your document.
28930 It is therefore advised to disable PDFsync for final documents.
28933 \begin_layout Subsubsection*
28934 Built-in reverse search via Sync\SpecialChar TeX
28938 \begin_layout Standard
28940 \begin_inset Flex Code
28943 \begin_layout Plain Layout
28949 have built-in support for both PDF and DVI reverse search.
28952 Sync\SpecialChar TeX
28955 facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
28960 You need at least \SpecialChar TeX
28961 Live 2008 or a recent Mik\SpecialChar TeX
28962 distribution in order to use it.
28966 \begin_layout Plain Layout
28968 Mik\SpecialChar TeX
28969 does not understand/obey the command \SpecialChar LyX
28970 inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
28973 \begin_layout Plain Layout
28974 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
28975 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
28976 by adding the -synctex=1 switch).
28981 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
28983 SumatraPDF on Windows;
28984 see the next section for details) already provide Sync\SpecialChar TeX
28988 \begin_layout Standard
28989 To enable Sync\SpecialChar TeX
28992 \begin_inset Flex Noun
28995 \begin_layout Plain Layout
29006 \begin_inset Flex Noun
29009 \begin_layout Plain Layout
29014 (plain) -> DraftDVI
29020 \begin_inset Flex Noun
29023 \begin_layout Plain Layout
29024 Preferences\SpecialChar menuseparator
29025 File Handling\SpecialChar menuseparator
29032 \begin_inset Flex Code
29035 \begin_layout Plain Layout
29036 latex -synctex=1 $$i
29042 and for PDF output,
29044 \begin_inset Flex Noun
29047 \begin_layout Plain Layout
29052 (pdflatex) -> PDF (pdflatex)
29058 \begin_inset Flex Code
29061 \begin_layout Plain Layout
29062 pdflatex -synctex=1 $$i
29068 Should your viewer not be considered in the following description,
29069 or in case of missing success,
29070 please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
29075 \begin_layout Plain Layout
29076 Note that the option
29077 \begin_inset Flex Code
29080 \begin_layout Plain Layout
29086 option enables gzip compression.
29087 If your viewer does not support it,
29088 you should instead use
29089 \begin_inset Flex Code
29092 \begin_layout Plain Layout
29106 \begin_layout Subsection
29107 Configuring and using specific viewers
29108 \begin_inset CommandInset label
29110 name "subsec:configuring-viewers"
29117 \begin_layout Subsubsection*
29118 Xdvi (all platforms)
29121 \begin_layout Standard
29123 \begin_inset Flex Code
29126 \begin_layout Plain Layout
29133 you don't need to do anything else for performing a reverse DVI search,
29134 as \SpecialChar LyX
29135 already provides the necessary hooks for automatically using the
29136 \begin_inset Flex Code
29139 \begin_layout Plain Layout
29146 Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
29150 \begin_layout Standard
29152 if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
29154 simply change the DVI viewer in
29155 \begin_inset Flex Noun
29158 \begin_layout Plain Layout
29159 Preferences\SpecialChar menuseparator
29160 File Handling\SpecialChar menuseparator
29170 \begin_layout Plain Layout
29171 On Mac OSX you have to use
29172 \begin_inset Flex Code
29175 \begin_layout Plain Layout
29176 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
29187 \begin_inset Flex Code
29190 \begin_layout Plain Layout
29191 xdvi -editor "lyxeditor.sh %f %l"
29198 \begin_inset Flex Code
29201 \begin_layout Plain Layout
29207 is a suitable script.
29209 a minimal shell script is the following one:
29212 \begin_layout LyX-Code
29214 \begin_inset Newline newline
29217 LYXPIPE="/path/to/lyxpipe"
29218 \begin_inset Newline newline
29221 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
29222 \begin_inset Newline newline
29225 echo "$COMMAND" > "${LYXPIPE}".in || exit
29226 \begin_inset Newline newline
29229 read TMP < "${LYXPIPE}".out || exit
29232 \begin_layout Standard
29234 \begin_inset Flex Code
29237 \begin_layout Plain Layout
29243 is the LyXServer pipe path specified in
29244 \begin_inset Flex Noun
29247 \begin_layout Plain Layout
29248 Preferences\SpecialChar menuseparator
29258 \begin_layout Plain Layout
29260 \begin_inset Flex Code
29263 \begin_layout Plain Layout
29269 folder of a source distribution you can find a
29270 \begin_inset Flex Code
29273 \begin_layout Plain Layout
29279 script which is able to locate the
29283 based on your preferences.
29291 \begin_layout Subsubsection*
29295 \begin_layout Standard
29297 \begin_inset Flex Code
29300 \begin_layout Plain Layout
29301 /Applications/MacDviX_Folder/calleditor.script
29307 add the following lines:
29310 \begin_layout LyX-Code
29311 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
29312 \begin_inset Newline newline
29318 \begin_layout Standard
29319 Modify the lines accordingly if you install \SpecialChar LyX
29320 somewhere else than in the Applications folder.
29323 \begin_layout Standard
29324 Reverse search is triggered by Alt-click (OPTION-click).
29327 \begin_layout Subsubsection*
29331 \begin_layout Standard
29333 \begin_inset Flex Code
29336 \begin_layout Plain Layout
29337 open -a Skim.app $$i
29342 to the viewer setting in
29343 \begin_inset Flex Noun
29346 \begin_layout Plain Layout
29347 Preferences\SpecialChar menuseparator
29348 File Handling\SpecialChar menuseparator
29349 File formats\SpecialChar menuseparator
29357 \begin_inset Flex Noun
29360 \begin_layout Plain Layout
29361 Skim\SpecialChar menuseparator
29362 Preferences\SpecialChar menuseparator
29369 \begin_inset Flex Noun
29372 \begin_layout Plain Layout
29378 preset and enter command
29379 \begin_inset Flex Noun
29382 \begin_layout Plain Layout
29383 /Applications/\SpecialChar LyX
29384 .app/Contents/MacOS/lyxeditor
29392 \begin_layout Standard
29393 Reverse search is triggered by COMMAND-SHIFT-click
29396 \begin_layout Subsubsection*
29400 \begin_layout Standard
29401 Reverse search with evince does not work out of the box,
29402 but it can be achieved by means of some third party helper scripts.
29404 \begin_inset CommandInset href
29406 target "https://wiki.lyx.org/LyX/SyncTeX"
29414 \begin_layout Subsubsection*
29418 \begin_layout Standard
29420 \begin_inset Flex Noun
29423 \begin_layout Plain Layout
29424 Settings\SpecialChar menuseparator
29425 Configure Okular\SpecialChar menuseparator
29432 \begin_inset Quotes erd
29436 This inserts the appropriate command (
29437 \begin_inset Flex Code
29440 \begin_layout Plain Layout
29449 \begin_layout Standard
29450 Reverse search is triggered by SHIFT-click.
29452 \change_inserted -712698321 1578211026
29453 Note that this only works if Okular is in
29454 \begin_inset Quotes eld
29458 \begin_inset Quotes erd
29462 \begin_inset space \thinspace{}
29466 the hand symbol is clicked).
29471 \begin_layout Subsubsection*
29475 \begin_layout Standard
29476 Qpdfview supports Sync\SpecialChar TeX
29477 since version 0.3.5.
29479 \begin_inset Flex Noun
29482 \begin_layout Plain Layout
29483 Edit\SpecialChar menuseparator
29484 Settings\SpecialChar menuseparator
29491 click on the input field of the
29492 \begin_inset Quotes eld
29496 \begin_inset Quotes erd
29499 item and add the command
29500 \begin_inset Flex Code
29503 \begin_layout Plain Layout
29512 \begin_layout Standard
29513 Reverse search is triggered by double-click or,
29514 in more recent versions,
29518 \begin_layout Subsubsection*
29522 \begin_layout Standard
29525 \begin_inset Flex Noun
29528 \begin_layout Plain Layout
29529 View\SpecialChar menuseparator
29535 menu and select the
29536 \begin_inset Quotes eld
29540 \begin_inset Quotes erd
29545 \begin_inset Quotes eld
29548 New\SpecialChar ldots
29550 \begin_inset Quotes erd
29554 in the window that opens,
29556 \begin_inset Quotes eld
29561 \begin_inset Quotes erd
29564 (or any other name you like) in the
29565 \begin_inset Quotes eld
29569 \begin_inset Quotes erd
29573 Now click on the button labeled
29574 \begin_inset Quotes eld
29579 \begin_inset Quotes erd
29582 to open a file dialog and navigate to the directory containing the batch file
29583 \begin_inset Flex Code
29586 \begin_layout Plain Layout
29594 \begin_inset Flex Code
29597 \begin_layout Plain Layout
29603 and then specify the program arguments as
29604 \begin_inset Flex Code
29607 \begin_layout Plain Layout
29615 \begin_inset Flex Code
29618 \begin_layout Plain Layout
29624 wrapper is used for communicating with \SpecialChar LyX
29632 \begin_layout LyX-Code
29634 \begin_inset Newline newline
29637 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
29646 \begin_inset Newline newline
29660 \begin_layout Standard
29661 Make sure that the \SpecialChar LyX
29662 Server pipe path you specified in \SpecialChar LyX
29664 \begin_inset Flex Code
29667 \begin_layout Plain Layout
29682 otherwise change the
29683 \begin_inset Flex Code
29686 \begin_layout Plain Layout
29692 wrapper accordingly.
29695 \begin_layout Standard
29697 reverse search is triggered by double-click.
29700 \begin_layout Subsubsection*
29701 SumatraPDF (Windows)
29704 \begin_layout Standard
29705 In order to use SumatraPDF for inverse search,
29707 \begin_inset Flex Code
29710 \begin_layout Plain Layout
29711 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
29716 in the viewer setting in
29717 \begin_inset Flex Noun
29720 \begin_layout Plain Layout
29721 Preferences\SpecialChar menuseparator
29722 File Handling\SpecialChar menuseparator
29723 File formats\SpecialChar menuseparator
29731 \begin_inset Flex Code
29734 \begin_layout Plain Layout
29740 is the previous wrapper.
29741 If SumatraPDF.exe is not in your command PATH,
29742 use its full file name.
29745 \begin_layout Standard
29746 Reverse search is triggered by double-click.
29749 \begin_layout Subsubsection*
29753 \begin_layout Standard
29755 make sure that yap is your default DVI viewer in the Windows environment,
29758 \begin_inset Flex Noun
29761 \begin_layout Plain Layout
29762 View\SpecialChar menuseparator
29768 menu and select the
29769 \begin_inset Quotes eld
29773 \begin_inset Quotes erd
29778 \begin_inset Quotes eld
29781 New\SpecialChar ldots
29783 \begin_inset Quotes erd
29787 in the window that opens,
29789 \begin_inset Quotes eld
29794 \begin_inset Quotes erd
29797 (or any other name you like) in the
29798 \begin_inset Quotes eld
29802 \begin_inset Quotes erd
29806 Now click on the button labeled
29807 \begin_inset Quotes eld
29812 \begin_inset Quotes erd
29815 to open a file dialog and navigate to the directory containing the
29816 \begin_inset Flex Code
29819 \begin_layout Plain Layout
29825 program (which is installed by default on Cygwin along with the \SpecialChar LyX
29828 \begin_inset Flex Code
29831 \begin_layout Plain Layout
29837 and then specify the program arguments as
29838 \begin_inset Flex Code
29841 \begin_layout Plain Layout
29849 you will be using the
29853 for communicating with \SpecialChar LyX
29856 for whatever reason,
29857 you want to use the
29863 \begin_inset Flex Code
29866 \begin_layout Plain Layout
29872 option and be sure to specify the \SpecialChar LyX
29873 Server pipe path in the \SpecialChar LyX
29877 \begin_layout Standard
29879 reverse search is triggered by double-click.
29882 \begin_layout Subsubsection*
29883 SumatraPDF (Cygwin)
29886 \begin_layout Standard
29887 In order to use SumatraPDF for inverse search,
29889 \begin_inset Flex Code
29892 \begin_layout Plain Layout
29893 SumatraPDF -inverse-search "lyxeditor -g %f %l"
29898 in the viewer setting in
29899 \begin_inset Flex Noun
29902 \begin_layout Plain Layout
29903 Preferences\SpecialChar menuseparator
29904 File Handling\SpecialChar menuseparator
29905 File formats\SpecialChar menuseparator
29912 If SumatraPDF.exe is not in your command PATH,
29913 use its full posix path.
29915 \begin_inset Flex Code
29918 \begin_layout Plain Layout
29924 enables communication via the
29931 \begin_inset Flex Code
29934 \begin_layout Plain Layout
29940 option if you want to use the
29945 and be sure to specify the \SpecialChar LyX
29946 Server pipe path in the \SpecialChar LyX
29950 \begin_layout Standard
29951 Reverse search is triggered by double-click.
29954 \begin_layout Section
29958 \begin_layout Standard
29960 as the name implies,
29962 \begin_inset Quotes eld
29966 \begin_inset Quotes erd
29970 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
29972 If forward search is set up (as described in what follows),
29973 you can put the cursor anywhere in your \SpecialChar LyX
29976 \begin_inset Flex Noun
29979 \begin_layout Plain Layout
29980 Navigate\SpecialChar menuseparator
29987 \begin_inset Flex Noun
29990 \begin_layout Plain Layout
29996 in the context menu via right mouse click),
29997 and then the viewer will jump to that position as well.
30000 that your viewer supports this function.
30003 \begin_layout Standard
30004 To make forward search possible,
30005 you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
30007 This can be done via the methods described in the section
30008 \begin_inset CommandInset ref
30010 reference "subsec:rev-search"
30018 \begin_layout Standard
30020 you need to configure \SpecialChar LyX
30021 for using your viewers in
30022 \begin_inset Flex Noun
30025 \begin_layout Plain Layout
30026 Tools\SpecialChar menuseparator
30027 Preferences\SpecialChar menuseparator
30028 Output\SpecialChar menuseparator
30035 We provide a range of tested configurations for some viewers,
30036 which you can select from the drop down list.
30037 If none of these configurations suits you,
30038 you have to find out and enter a suitable configuration yourself.
30039 The definition syntax uses the following placeholders:
30042 \begin_layout Itemize
30044 \begin_inset Flex Code
30047 \begin_layout Plain Layout
30057 \begin_layout Itemize
30059 \begin_inset Flex Code
30062 \begin_layout Plain Layout
30069 name of the (temporary) exported .tex file (without path)
30072 \begin_layout Itemize
30074 \begin_inset Flex Code
30077 \begin_layout Plain Layout
30084 name of the (temporary) exported .tex file (including path)
30087 \begin_layout Itemize
30089 \begin_inset Flex Code
30092 \begin_layout Plain Layout
30099 name of the exported output file (either dvi or pdf,
30100 depending on which one exists in the temporary directory)
30103 \begin_layout Standard
30104 Note that only some of the viewers provide full and usable forward search functionality out of the box,
30111 \begin_layout Plain Layout
30112 You might want to set
30113 \begin_inset Flex Code
30116 \begin_layout Plain Layout
30123 \begin_inset Flex Noun
30126 \begin_layout Plain Layout
30127 Tools\SpecialChar menuseparator
30128 Preferences\SpecialChar menuseparator
30129 File Handling\SpecialChar menuseparator
30131 \begin_inset space ~
30150 \begin_layout Plain Layout
30151 SumatraPDF can also use DDE commands through the external program CMCDDE —
30153 \begin_inset CommandInset href
30155 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
30171 \begin_layout Plain Layout
30172 Forward search with evince can be achieved by means of third party helper scripts.
30174 \begin_inset CommandInset href
30176 target "https://wiki.lyx.org/LyX/SyncTeX"
30187 require some extra tools in order to use forward search.
30188 While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
30189 some other viewers – e.
30190 \begin_inset space \thinspace{}
30194 xpdf – allow at least to reload the document and jump to a specific page of the file,
30195 so you can at least navigate
30196 \begin_inset Quotes eld
30200 \begin_inset Quotes erd
30204 This latter functionality is provided by an external call of synctex (see the predefined example configurations).
30208 \begin_layout Standard
30209 Forward search works both with DVI and PDF output.
30211 simply checks which preview format you have used before (i.
30212 \begin_inset space \thinspace{}
30216 which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
30217 \change_deleted 564990737 1672743015
30221 \begin_layout Standard
30223 \change_deleted 564990737 1672743015
30224 Special Document Classes
30227 \begin_layout Standard
30229 \change_deleted 564990737 1669742044
30233 \begin_layout Standard
30235 \change_deleted 564990737 1669742044
30241 \begin_layout Standard
30243 \change_deleted 564990737 1669742044
30247 \begin_layout Standard
30249 \change_deleted 564990737 1669742044
30250 This section describes how \SpecialChar LyX
30251 can be used to write articles for submission to the scientific journal
30253 Astronomy and Astrophysics
30256 \begin_inset Flex URL
30259 \begin_layout Plain Layout
30261 https://www.aanda.org/
30266 ) using Version 5.01 of the document class
30271 This package can be downloaded from the ftp site
30274 \begin_layout Standard
30276 \change_deleted 564990737 1669742044
30277 \begin_inset VSpace medskip
30283 \begin_layout Standard
30286 \change_deleted 564990737 1669742044
30287 \begin_inset Flex URL
30290 \begin_layout Plain Layout
30292 ftp://ftp.edpsciences.org/pub/aa/readme.html
30300 \begin_layout Standard
30302 \change_deleted 564990737 1669742044
30303 \begin_inset VSpace medskip
30309 \begin_layout Standard
30311 \change_deleted 564990737 1669742044
30312 A manual comes together with that package,
30313 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.
30317 \begin_layout Standard
30319 \change_deleted 564990737 1669742044
30320 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
30322 That change involved also some slight changes to the style files,
30323 namely the removal of the thesaurus command.
30324 The \SpecialChar LyX
30325 class aa supports the newest version of these style files,
30327 If you have an older version installed,
30330 the old (version 4) layout has been kept as
30335 Please refer to the comments in
30338 Dir/layouts/aapaper.layout
30343 \begin_layout Standard
30345 \change_deleted 564990737 1669742044
30349 \begin_layout Standard
30351 \change_deleted 564990737 1669742044
30352 It is recommended you start from the example template distributed with \SpecialChar LyX
30354 If you are not using a template,
30355 note the following settings:
30358 \begin_layout Itemize
30360 \change_deleted 564990737 1669742044
30367 Document\SpecialChar menuseparator
30371 that one was obvious).
30374 \begin_layout Itemize
30376 \change_deleted 564990737 1669742044
30377 Don't change the option
30380 \begin_inset space ~
30391 The whole layout is done by the macros,
30392 you shouldn't change anything.
30395 \begin_layout Standard
30397 \change_deleted 564990737 1669742044
30401 \begin_layout Standard
30403 \change_deleted 564990737 1669742044
30404 First thing to enter is the header information.
30405 It consists of seven entries,
30406 of which some are optional.
30410 \begin_layout Itemize
30412 \change_deleted 564990737 1669742044
30421 \begin_layout Itemize
30423 \change_deleted 564990737 1669742044
30432 \begin_layout Itemize
30434 \change_deleted 564990737 1669742044
30443 \begin_layout Itemize
30445 \change_deleted 564990737 1669742044
30454 \begin_layout Itemize
30456 \change_deleted 564990737 1669742044
30462 [optional] if more than one author:
30463 whom to contact for offprint requests.
30466 \begin_layout Itemize
30468 \change_deleted 564990737 1669742044
30474 [optional] mail address for contacts.
30477 \begin_layout Itemize
30479 \change_deleted 564990737 1669742044
30486 Suggested format is
30493 \begin_layout Standard
30495 \change_deleted 564990737 1669742044
30496 There is no need to issue the
30503 this is done automatically by \SpecialChar LyX
30504 when the header is finished.
30505 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
30506 just to get the best optics and meets the layout of the real document.
30509 \begin_layout Standard
30511 \change_deleted 564990737 1669742044
30512 If you want to place footnotes in the header block,
30514 \begin_inset space \thinspace{}
30518 \begin_inset space \space{}
30521 to state your present address,
30522 just use the standard footnote via the menu
30524 Insert\SpecialChar menuseparator
30529 will automagically use the term
30538 \begin_layout Standard
30540 \change_deleted 564990737 1669742044
30543 Edit\SpecialChar menuseparator
30547 you'll find two insets which are relevant for the titling:
30550 \begin_layout Itemize
30552 \change_deleted 564990737 1669742044
30559 to mark corresponding author\SpecialChar breakableslash
30561 The institutes are numbered sequentially as they appear in the
30566 so you have to put a marker to each author.
30569 \begin_layout Itemize
30571 \change_deleted 564990737 1669742044
30576 to supply an email address for fast contact.
30579 \begin_layout Standard
30581 \change_deleted 564990737 1669742044
30582 In addition to these topics,
30583 the macros use one additional \SpecialChar LaTeX
30584 command that has no counterpart in \SpecialChar LyX
30588 \begin_layout Itemize
30590 \change_deleted 564990737 1669742044
30597 to separate different names for more than one author and institute,
30601 \begin_layout Standard
30603 \change_deleted 564990737 1669742044
30604 The appropriate command has to be entered in \SpecialChar LyX
30605 and marked as \SpecialChar LaTeX
30611 \begin_layout Standard
30613 \change_deleted 564990737 1669742044
30617 \begin_layout Standard
30619 \change_deleted 564990737 1669742044
30620 The abstract should immediately follow the header block.
30621 With version 5 the abstract environment was changed to a command,
30622 and there is now a restriction to only one paragraph.
30624 it should contain an entry with the keywords.
30625 This is done via the paragraph style
30630 Refer to the example paper.
30633 \begin_layout Standard
30635 \change_deleted 564990737 1669742044
30636 Supported environments
30639 \begin_layout Standard
30641 \change_deleted 564990737 1669742044
30642 The A&A paper layout supports the following environments for structuring your text:
30645 \begin_layout Itemize
30647 \change_deleted 564990737 1669742044
30653 \begin_layout Itemize
30655 \change_deleted 564990737 1669742044
30661 \begin_layout Itemize
30663 \change_deleted 564990737 1669742044
30669 \begin_layout Itemize
30671 \change_deleted 564990737 1669742044
30677 \begin_layout Itemize
30679 \change_deleted 564990737 1669742044
30685 \begin_layout Itemize
30687 \change_deleted 564990737 1669742044
30693 \begin_layout Itemize
30695 \change_deleted 564990737 1669742044
30701 \begin_layout Itemize
30703 \change_deleted 564990737 1669742044
30709 \begin_layout Itemize
30711 \change_deleted 564990737 1669742044
30717 \begin_layout Itemize
30719 \change_deleted 564990737 1669742044
30725 \begin_layout Itemize
30727 \change_deleted 564990737 1669742044
30733 \begin_layout Itemize
30735 \change_deleted 564990737 1669742044
30742 \begin_layout Standard
30744 \change_deleted 564990737 1669742044
30745 Commands not supported by \SpecialChar LyX
30749 \begin_layout Standard
30751 \change_deleted 564990737 1669742044
30752 Some commands are not yet supported by the
30756 layout for \SpecialChar LyX
30758 Some have already been mentioned.
30759 For the sake of completeness,
30760 they are listed all together here:
30763 \begin_layout Itemize
30765 \change_deleted 564990737 1669742044
30773 \begin_layout Itemize
30775 \change_deleted 564990737 1669742044
30783 \begin_layout Itemize
30785 \change_deleted 564990737 1669742044
30793 \begin_layout Itemize
30795 \change_deleted 564990737 1669742044
30803 \begin_layout Standard
30805 \change_deleted 564990737 1669742044
30806 If you want to use any of these commands,
30807 you have to enter them yourself.
30810 Do not forget to mark them as \SpecialChar LaTeX
30814 \begin_layout Standard
30816 \change_deleted 564990737 1669742044
30817 Figure and Table Floats
30820 \begin_layout Standard
30822 \change_deleted 564990737 1669742044
30824 provides support for the necessary float environments
30835 therefore we won't tell much about it here.
30839 \begin_inset space ~
30845 Just remember that tables should be left-aligned.
30847 select the table and change the alignment in
30849 Edit\SpecialChar menuseparator
30851 \begin_inset space ~
30857 \begin_layout Standard
30859 \change_deleted 564990737 1669742044
30860 There is only one special thing:
30861 the figures with caption besides the figure.
30862 To create such a figure,
30863 you have to do the following:
30866 \begin_layout Enumerate
30868 \change_deleted 564990737 1669742044
30869 Create a wide figure float:
30872 Insert\SpecialChar menuseparator
30873 Float\SpecialChar menuseparator
30877 then right click in the figure and select
30880 \begin_inset space ~
30888 \begin_layout Enumerate
30890 \change_deleted 564990737 1669742044
30891 Enter your caption text.
30894 \begin_layout Enumerate
30896 \change_deleted 564990737 1669742044
30901 to move the cursor above the caption.
30904 \begin_layout Enumerate
30906 \change_deleted 564990737 1669742044
30910 \begin_layout Enumerate
30912 \change_deleted 564990737 1669742044
30913 Position the cursor behind the figure and insert a horizontal fill:
30916 Insert\SpecialChar menuseparator
30918 \begin_inset space ~
30921 Character\SpecialChar menuseparator
30923 \begin_inset space ~
30931 \begin_layout Enumerate
30933 \change_deleted 564990737 1669742044
30934 Switch to \SpecialChar LaTeX
30939 \begin_inset space ~
30947 \begin_layout Enumerate
30949 \change_deleted 564990737 1669742044
30959 Do not close the brace!
30962 \begin_layout Enumerate
30964 \change_deleted 564990737 1669742044
30965 Position the cursor behind the caption text,
30966 switch to \SpecialChar LaTeX
30967 mode and insert the closing brace:
30971 \begin_inset space ~
30983 \begin_layout Standard
30985 \change_deleted 564990737 1669742044
30987 refer to the figures in the example paper.
30990 \begin_layout Standard
30992 \change_deleted 564990737 1669742044
30996 \begin_layout Standard
30998 \change_deleted 564990737 1669742044
31000 the paper has to be formated in a special double-spacing layout.
31002 you have to give the option
31006 to the document class.
31007 This must be done using the custom class options field in the
31009 Document\SpecialChar menuseparator
31013 Just enter the string
31020 \begin_layout Standard
31022 \change_deleted 564990737 1669742044
31026 \begin_layout Standard
31028 \change_deleted 564990737 1669742044
31033 directory contains an example paper written with \SpecialChar LyX
31035 It is the example paper from the original macro package,
31036 translated to \SpecialChar LyX
31038 Use it for inspiration,
31039 and compare the original \SpecialChar LaTeX
31040 code with \SpecialChar LyX
31044 \begin_layout Standard
31046 \change_deleted 564990737 1671097429
31050 \begin_layout Standard
31052 \change_deleted 564990737 1671097429
31057 can be used to type letters according to German conventions.
31058 A template file is included in
31060 .../lyx/share/templates
31062 for you to use as a starting point.
31065 \begin_layout Standard
31067 \change_deleted 564990737 1671097429
31071 \begin_layout Standard
31073 \change_deleted 564990737 1671097429
31074 See the \SpecialChar LyX
31080 It contains all infos you need.
31083 \begin_layout Standard
31085 \change_deleted 564990737 1669755802
31089 \begin_layout Standard
31091 \change_deleted 564990737 1669755802
31094 Panayotis Papasotiriou
31097 \begin_layout Standard
31099 \change_deleted 564990737 1669755802
31103 \begin_layout Standard
31105 \change_deleted 564990737 1669755802
31106 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
31108 International Journal of Modern Physics C
31112 the ijmpd package is for creating manuscripts to be submitted to the
31114 International Journal of Modern Physics D
31117 Both journals are published by World Scientific.
31118 The corresponding document classes are named
31129 together with instructions for the authors,
31130 can be downloaded from the sites
31131 \begin_inset Flex URL
31134 \begin_layout Plain Layout
31136 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
31142 \begin_inset Flex URL
31145 \begin_layout Plain Layout
31147 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
31153 Both packages are modified versions of the standard
31154 \begin_inset Quotes eld
31158 \begin_inset Quotes erd
31162 and they are almost (but not exactly) identical.
31163 Most of their features are supported by \SpecialChar LyX
31165 I have used \SpecialChar LyX
31166 successfully to write articles submitted to both journals without any problem.
31169 \begin_layout Standard
31171 \change_deleted 564990737 1669755802
31175 \begin_layout Standard
31177 \change_deleted 564990737 1669755802
31179 the easiest way to write a paper is to start with a template.
31182 File\SpecialChar menuseparator
31199 This will give an (almost) empty document that includes the most common fields found in a manuscript.
31200 Simply overwrite the existing text (including the brackets,
31206 You should keep in mind the following remarks.
31209 \begin_layout Enumerate
31211 \change_deleted 564990737 1669755802
31213 won't let you change the font size and the page style of the document,
31214 because such modifications are not allowed by both packages.
31217 \begin_layout Enumerate
31219 \change_deleted 564990737 1669755802
31220 The language of the document should not be changed.
31221 Before previewing your paper,
31222 be sure that the babel package is not used.
31227 arg "dialog-show document"
31232 \SpecialChar menuseparator
31237 \begin_inset Quotes eld
31241 \begin_inset Quotes erd
31251 \begin_layout Enumerate
31253 \change_deleted 564990737 1669755802
31255 \begin_inset Quotes eld
31259 \begin_inset Quotes erd
31262 style must be used to define keywords.
31265 \begin_layout Enumerate
31267 \change_deleted 564990737 1669755802
31268 The ijmpc package provides a style named
31269 \begin_inset Quotes eld
31272 Classification Codes
31273 \begin_inset Quotes erd
31277 which can be used to define classification codes,
31278 such as PACS numbers.
31279 Note that this facility is not supported by the ijmpd package.
31282 \begin_layout Enumerate
31284 \change_deleted 564990737 1669755802
31285 Several new environments are available:
31287 \begin_inset Quotes eld
31291 \begin_inset Quotes erd
31296 \begin_inset Quotes eld
31300 \begin_inset Quotes erd
31305 \begin_inset Quotes eld
31309 \begin_inset Quotes erd
31314 \begin_inset Quotes eld
31318 \begin_inset Quotes erd
31323 \begin_inset Quotes eld
31327 \begin_inset Quotes erd
31332 \begin_inset Quotes eld
31336 \begin_inset Quotes erd
31341 \begin_inset Quotes eld
31345 \begin_inset Quotes erd
31350 \begin_inset Quotes eld
31354 \begin_inset Quotes erd
31359 \begin_inset Quotes eld
31363 \begin_inset Quotes erd
31368 \begin_inset Quotes eld
31372 \begin_inset Quotes erd
31377 \begin_inset Quotes eld
31381 \begin_inset Quotes erd
31386 \begin_inset Quotes eld
31390 \begin_inset Quotes erd
31395 \begin_inset Quotes eld
31399 \begin_inset Quotes erd
31404 \begin_inset Quotes eld
31408 \begin_inset Quotes erd
31412 Their use is more or less obvious.
31414 supports all these environments;
31415 it will use the proper label,
31417 and numbering scheme for each of them.
31420 \begin_layout Enumerate
31422 \change_deleted 564990737 1669755802
31423 Both packages use basic citations;
31424 the natbib package should not be used.
31425 In \SpecialChar LyX
31427 citation references are shown as usual;
31429 citations are shown as superscripts.
31430 If you want to use a citation as normal text,
31437 \begin_inset space \thinspace{}
31441 \begin_inset space \space{}
31445 \begin_inset Quotes eld
31449 \begin_inset space \space{}
31459 \begin_inset Quotes erd
31465 \begin_layout Enumerate
31467 \change_deleted 564990737 1669755802
31469 \begin_inset Quotes eld
31473 \begin_inset Quotes erd
31476 section in both packages.
31477 To put acknowledgments,
31479 \begin_inset Quotes eld
31483 \begin_inset Quotes erd
31489 \begin_layout Enumerate
31491 \change_deleted 564990737 1669755802
31492 Appendices may be added to the paper,
31497 the Acknowledgments and
31503 provides a special environment,
31505 \begin_inset Quotes eld
31509 \begin_inset Quotes erd
31512 which marks the beginning of the appendices.
31513 This environment should be left blank;
31514 it just sends a \SpecialChar LaTeX
31516 but nothing is really printed.
31517 In \SpecialChar LyX
31520 \begin_inset Quotes eld
31524 \begin_inset Quotes erd
31527 is printed with blue letters,
31528 as a signal that all sections after that point are appendices.
31529 To write an appendix,
31531 \begin_inset Quotes eld
31535 \begin_inset Quotes erd
31540 will number each appendix with capital letters,
31541 as required by both journals.
31543 \begin_inset Quotes eld
31547 \begin_inset Quotes erd
31554 be present before the first appendix;
31556 all appendices will be numbered as normal sections in the output.
31559 \begin_layout Enumerate
31561 \change_deleted 564990737 1669755802
31562 The ijmpc and the ijmpd packages use the
31566 command to implement table captions.
31568 a table created by \SpecialChar LyX
31569 is printed correctly,
31570 but its caption is ignored.
31572 you can use some \SpecialChar TeX
31573 code to overcome this problem,
31574 so that captions are printed as expected.
31576 create a float table as usual,
31577 remove the caption,
31578 and replace it with the \SpecialChar TeX
31590 you must also the \SpecialChar TeX
31595 immediately after the tabular material.
31596 Study the example table included in the template files to see how this trick is implemented.
31598 If you need table captions,
31599 you should implement the whole table float in a
31604 then include this file to the \SpecialChar LyX
31607 Insert\SpecialChar menuseparator
31608 File\SpecialChar menuseparator
31610 \begin_inset space ~
31616 Details on how to create a table float can be found in the files
31625 included in the corresponding packages.
31628 \begin_layout Standard
31630 \change_deleted 564990737 1669755802
31631 Preparing a paper for submission
31634 \begin_layout Standard
31636 \change_deleted 564990737 1669755802
31637 Before you submit your paper you must export the \SpecialChar LyX
31638 document as a \SpecialChar LaTeX
31641 File\SpecialChar menuseparator
31642 Export\SpecialChar menuseparator
31650 \begin_layout Plain Layout
31651 Actually you have the choice between \SpecialChar LaTeX
31652 (plain) and pdflatex.
31653 If you intend to use pdflatex to prepare the paper,
31654 you should use the pdflatex option so that included graphics are converted to PDF format,
31655 ready for use by pdflatex.
31661 then make the following changes to the resulting
31668 \begin_layout Enumerate
31670 \change_deleted 564990737 1669755802
31671 Remove the comment lines before the
31680 \begin_layout Enumerate
31682 \change_deleted 564990737 1669755802
31683 Remove everything between (and including) the
31696 except for any commands you specifically put into the \SpecialChar LaTeX
31700 \begin_layout Standard
31702 \change_deleted 564990737 1672743015
31707 file should be saved and processed through \SpecialChar LaTeX
31708 as many times as necessary.
31709 You may also want to check the resulting
31716 \begin_layout Standard
31718 \change_deleted 564990737 1669801478
31722 \begin_layout Standard
31724 \change_deleted 564990737 1669801478
31730 \begin_layout Standard
31732 \change_deleted 564990737 1669801478
31736 \begin_layout Standard
31738 \change_deleted 564990737 1669801478
31739 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
31740 Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
31741 \begin_inset Flex URL
31744 \begin_layout Plain Layout
31746 ftp://ftp.iop.org/pub/journals/latex2e
31754 \begin_layout Standard
31756 \change_deleted 564990737 1669801478
31760 \begin_layout Standard
31762 \change_deleted 564990737 1669801478
31763 The easiest way to write a paper is to start with the template
31767 that is available via
31769 File\SpecialChar menuseparator
31772 The template explains how to use the special text environments.
31773 Here are the most important advices:
31776 \begin_layout Itemize
31778 \change_deleted 564990737 1669801478
31779 To be able to compile your document to a PDF,
31782 ensure that the no AMS packages are loaded in
31784 Document\SpecialChar menuseparator
31785 Settings\SpecialChar menuseparator
31791 \begin_layout Itemize
31793 \change_deleted 564990737 1669801478
31796 The title environment defines the kind of your paper.
31797 So use one of the following environments for the title:
31801 \begin_layout Itemize
31803 \change_deleted 564990737 1669801478
31812 \begin_layout Itemize
31814 \change_deleted 564990737 1669801478
31823 \begin_layout Itemize
31825 \change_deleted 564990737 1669801478
31831 for a Topical review
31834 \begin_layout Itemize
31836 \change_deleted 564990737 1669801478
31845 \begin_layout Itemize
31847 \change_deleted 564990737 1669801478
31856 \begin_layout Itemize
31858 \change_deleted 564990737 1669801478
31864 for a Paper (same as Title)
31867 \begin_layout Itemize
31869 \change_deleted 564990737 1669801478
31875 for a Preliminary communication
31878 \begin_layout Itemize
31880 \change_deleted 564990737 1669801478
31886 for a Rapid communication
31889 \begin_layout Itemize
31891 \change_deleted 564990737 1669801478
31897 for a Letter to the editor
31901 \begin_layout Itemize
31903 \change_deleted 564990737 1669801478
31906 All title environments except of
31910 can have an optional short title.
31913 \begin_layout Itemize
31915 \change_deleted 564990737 1669801478
31916 There is a general title environment
31920 which is not directly supported by \SpecialChar LyX
31922 This can be used as \SpecialChar TeX
31923 code when your document doesn't fit into one of the other title types.
31926 \begin_layout Standard
31928 \change_deleted 564990737 1672743015
31929 For more informations like hints for special table and formula formatting,
31930 look at the IOP author guidelines.
31933 \begin_layout Standard
31935 \change_deleted 564990737 1670317155
31939 \begin_layout Standard
31941 \change_deleted 564990737 1670317155
31944 Panayotis Papasotiriou
31947 \begin_layout Standard
31949 \change_deleted 564990737 1670317155
31953 \begin_layout Standard
31955 \change_deleted 564990737 1670317155
31956 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
31957 Most known of them (at least in my domain of interest) are
31959 Astrophysics and Space Science
31966 but there are many others (see a complete list at
31967 \begin_inset Flex URL
31970 \begin_layout Plain Layout
31972 http://www.wkap.nl/jrnllist.htm/JRNLHOME
31978 The Kluwer package may be downloaded from the site
31979 \begin_inset Flex URL
31982 \begin_layout Plain Layout
31984 http://www.wkap.nl/kaphtml.htm/STYLEFILES
31990 A complete user guide is contained in that package (but it can also be downloaded separately).
31993 \begin_layout Standard
31995 \change_deleted 564990737 1670317155
31997 supports many features of the package but not everything.
31999 the \SpecialChar TeX
32000 code needed is reduced to some
32001 \begin_inset Quotes eld
32005 \begin_inset Quotes erd
32008 commands of the package (see
32009 \begin_inset space ~
32013 \begin_inset CommandInset ref
32015 reference "subsec:kluwer_peculiarities"
32021 I have recently used \SpecialChar LyX
32022 to write an article submitted to the
32024 Astrophysics and Space Science
32026 without any problem.
32029 \begin_layout Standard
32031 \change_deleted 564990737 1670317155
32035 \begin_layout Standard
32037 \change_deleted 564990737 1670317155
32038 The easiest way to write a paper is to start with the Kluwer template file.
32041 File\SpecialChar menuseparator
32054 This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
32055 As in most templates,
32056 simply overwrite the existing text (including the brackets,
32061 ) with the correct information.
32064 \begin_layout Standard
32066 \change_deleted 564990737 1670317155
32067 Preparing a paper for submission
32070 \begin_layout Standard
32072 \change_deleted 564990737 1670317155
32073 As in the AAS\SpecialChar TeX
32075 before you submit your paper to a journal you must
32076 \begin_inset Quotes eld
32080 \begin_inset Quotes erd
32086 \begin_layout Enumerate
32088 \change_deleted 564990737 1670317155
32089 Export your paper as a \SpecialChar LaTeX
32094 File\SpecialChar menuseparator
32095 Export\SpecialChar menuseparator
32103 \begin_layout Enumerate
32105 \change_deleted 564990737 1670317155
32110 file with a text editor and make the following changes
32114 \begin_layout Enumerate
32116 \change_deleted 564990737 1670317155
32117 remove the comment lines before the
32126 \begin_layout Enumerate
32128 \change_deleted 564990737 1670317155
32129 remove everything between (and including) the
32142 except for any commands you specifically put into the \SpecialChar LaTeX
32146 \begin_layout Standard
32148 \change_deleted 564990737 1670317155
32157 \begin_layout Enumerate
32159 \change_deleted 564990737 1670317155
32164 file through \SpecialChar LaTeX
32165 as many times as necessary (usually up to three).
32168 \begin_layout Enumerate
32170 \change_deleted 564990737 1670317155
32177 \begin_inset space \thinspace{}
32181 \begin_inset space \space{}
32189 and check if everything is OK (it should,
32190 if you didn't make any mistake).
32193 \begin_layout Standard
32195 \change_deleted 564990737 1670317155
32196 \begin_inset Quotes eld
32200 \begin_inset Quotes erd
32203 of the Kluwer package
32204 \begin_inset CommandInset label
32206 name "subsec:kluwer_peculiarities"
32213 \begin_layout Standard
32215 \change_deleted 564990737 1670317155
32216 The Kluwer package has the following
32217 \begin_inset Quotes eld
32221 \begin_inset Quotes erd
32227 \begin_layout Enumerate
32229 \change_deleted 564990737 1670317155
32230 It is possible to write multiple articles in the same \SpecialChar LaTeX
32235 \begin_layout Plain Layout
32236 I can't imagine any good reason to do this.
32242 Each article must be included in the environment
32243 \begin_inset Quotes eld
32247 \begin_inset Quotes erd
32252 this environment cannot be omitted,
32253 even if you write just one article.
32255 each article starts with the command
32263 ends with the command
32270 Although this can be implemented in \SpecialChar LyX
32272 I didn't included it,
32273 since it looks ugly and can confuse the novice user.
32275 you need to enter them directly and mark them as \SpecialChar LaTeX
32276 code (the well-known
32277 \begin_inset Quotes eld
32282 \begin_inset Quotes erd
32288 \begin_layout Enumerate
32290 \change_deleted 564990737 1670317155
32291 Information given at the beginning of the article (i.
32292 \begin_inset space \thinspace{}
32296 \begin_inset space \space{}
32305 abstract and keywords) must be included in an environment called
32306 \begin_inset Quotes eld
32310 \begin_inset Quotes erd
32314 This is not implemented in \SpecialChar LyX
32316 so you must enter title,
32318 \begin_inset space ~
32321 between two \SpecialChar TeX
32337 \begin_layout Enumerate
32339 \change_deleted 564990737 1670317155
32340 According to the user manual,
32341 the label of each bibliography item must be written as
32364 \begin_layout Standard
32366 \change_deleted 564990737 1670317155
32371 template takes care of all these
32372 \begin_inset Quotes eld
32376 \begin_inset Quotes erd
32380 If you start a new paper using this template you don't need to do anything special.
32384 \begin_layout Enumerate
32386 \change_deleted 564990737 1670317155
32387 don't delete the \SpecialChar TeX
32388 code included in the template,
32392 \begin_layout Enumerate
32394 \change_deleted 564990737 1670317155
32395 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
32398 \begin_layout Standard
32400 \change_deleted 564990737 1671097446
32404 \begin_layout Standard
32406 \change_deleted 564990737 1671097446
32411 provides an alternative to the standard
32416 It provides similar functionality,
32417 but you might prefer this layout with sans serif sections,
32422 \begin_layout Standard
32424 \change_deleted 564990737 1671097446
32425 Springer Journals (
32432 \begin_layout Standard
32434 \change_deleted 564990737 1671097446
32440 \begin_layout Standard
32442 \change_deleted 564990737 1671097446
32446 \begin_layout Standard
32448 \change_deleted 564990737 1671097446
32449 These are the layout files for some of the journal formats used by Springer Verlag and listed on
32450 \begin_inset Flex URL
32453 \begin_layout Plain Layout
32455 http://www.springer.de/author/tex/help-journals.html
32461 where you should also go to fetch the class files (yes,
32462 these are \SpecialChar LaTeX2e
32464 It is a modular system:
32465 the things common to all journals are implemented in
32470 which journal-specific layout files (such as,
32472 \begin_inset space \thinspace{}
32476 \begin_inset space \space{}
32483 for Journal of Geodesy) can include.
32486 \begin_layout Standard
32488 \change_deleted 564990737 1671097446
32489 This means that implementing support for any other Springer journal on this list is as simple as writing your own
32497 file following the outline given in
32505 \begin_layout Standard
32507 \change_deleted 564990737 1671097446
32508 It is reasonably well tested only for the Journal of Geodesy.
32517 come with the standard \SpecialChar LyX
32519 Install the relevant class file (downloaded from Springer) in a proper directory,
32520 reconfigure \SpecialChar LaTeX
32521 (in the te\SpecialChar TeX
32527 as root if necessary —
32528 doesn't \SpecialChar LyX
32529 take care of this?),
32530 reconfigure \SpecialChar LyX
32531 and it should work.
32534 \begin_layout Standard
32536 \change_deleted 564990737 1671097446
32540 \begin_layout Standard
32542 \change_deleted 564990737 1671097446
32543 A large number of theorem-like styles —
32558 \begin_layout Standard
32560 \change_deleted 564990737 1671097446
32566 Running_\SpecialChar LaTeX
32577 See the Springer class file documentation for details.
32580 \begin_layout Standard
32582 \change_deleted 564990737 1671097446
32586 \begin_layout Itemize
32588 \change_deleted 564990737 1671097446
32602 \begin_layout Itemize
32604 \change_deleted 564990737 1671097446
32607 Probability Theory and Related Fields
32615 Jean-Marc Lasgouttes
32618 \begin_layout Standard
32620 \change_deleted 564990737 1671097446
32625 \begin_layout Standard
32627 \change_deleted 564990737 1671097446
32631 \begin_layout Standard
32633 \change_deleted 564990737 1671097446
32634 These files are partly based on the older
32639 which was again based on a tinkered-with version of an old \SpecialChar LaTeX
32640 2.09 style file from Springer.
32648 Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
32649 layout file mechanism.
32652 \begin_layout Standard
32654 \change_deleted 564990737 1671097446
32658 \begin_layout Standard
32660 \change_deleted 564990737 1671097446
32662 But probably less than in the old hacked-\SpecialChar LaTeX
32670 \begin_layout Chapter
32672 Features needing Extra Software
32675 \begin_layout Section
32676 Checking \SpecialChar TeX
32680 \begin_layout Standard
32686 \begin_layout Subsection
32690 \begin_layout Standard
32699 \begin_layout Plain Layout
32704 is not yet available when you are using the \SpecialChar LaTeX
32705 distribution MiK\SpecialChar TeX
32720 \begin_inset space ~
32731 \begin_inset Newline newline
32735 \begin_inset CommandInset href
32737 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
32745 \begin_layout Standard
32748 Chk\SpecialChar TeX
32751 package is a program that was written by
32752 \begin_inset Flex Noun
32755 \begin_layout Plain Layout
32757 \begin_inset space ~
32765 in frustration because some constructs in \SpecialChar LaTeX
32766 are sometimes non-intuitive,
32767 and easy to forget.
32768 The program runs over your \SpecialChar LaTeX
32770 checks the integrity of the file,
32771 and flags some common errors.
32772 In other technical words,
32777 for \SpecialChar LaTeX
32781 \begin_layout Standard
32783 what is a syntax checker doing in \SpecialChar LyX
32784 which is supposed to produce correct \SpecialChar LaTeX
32786 The answer is simple:
32791 not only checks the
32800 checks for type-errors,
32803 Chk\SpecialChar TeX
32806 catches some common
32811 in addition to the syntactical ones.
32815 Chk\SpecialChar TeX
32818 is capable of detecting several common errors,
32822 \begin_layout Itemize
32823 Ellipsis detection:
32824 \begin_inset Newline newline
32827 Use \SpecialChar ldots
32831 \begin_layout Itemize
32832 No space in front of/after parenthesis:
32833 \begin_inset Newline newline
32839 \begin_layout Itemize
32840 Enforcement of normal space after common abbreviations:
32841 \begin_inset Newline newline
32845 \begin_inset space \thinspace{}
32849 \begin_inset space \space{}
32852 is too wide spacing.
32855 \begin_layout Itemize
32856 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
32857 \begin_inset Newline newline
32861 And this is wrong spacing.
32864 \begin_layout Itemize
32865 Space in front of labels and similar commands:
32866 \begin_inset Newline newline
32869 The label should stick right up to the text to avoid falling to a wrong page.
32871 \begin_inset CommandInset label
32881 \begin_layout Plain Layout
32882 This footnote is in danger of falling off to a wrong page
32887 The label is separated too much.
32890 \begin_layout Itemize
32891 Space in front of references,
32892 instead of hard spaces:
32893 \begin_inset Newline newline
32896 If you have bad luck,
32897 the text will break right between the referenced text and reference number,
32900 \begin_inset CommandInset ref
32902 reference "sec:chktex"
32910 \begin_layout Itemize
32912 \begin_inset Quotes eld
32916 \begin_inset Quotes erd
32920 \begin_inset Formula $\times$
32924 \begin_inset Newline newline
32927 2x2 looks cheap compared to
32928 \begin_inset Formula $2\times2$
32934 \begin_layout Standard
32935 and more \SpecialChar ldots
32936 It is an invaluable tool when you are
32937 \begin_inset Quotes eld
32941 \begin_inset Quotes erd
32944 your document before printing,
32945 and you should run it right after the obligatory spelling check,
32946 and before you go fine tuning the typesetting.
32949 \begin_layout Subsection
32953 \begin_layout Standard
32954 If you have the program installed,
32955 usage is as simple as choosing
32957 Tools\SpecialChar menuseparator
32959 \begin_inset space ~
32965 This will make \SpecialChar LyX
32966 generate a \SpecialChar LaTeX
32967 file of your document,
32970 Chk\SpecialChar TeX
32974 and then make \SpecialChar LyX
32976 \begin_inset Quotes eld
32980 \begin_inset Quotes erd
32983 with the warnings from
32985 Chk\SpecialChar TeX
32990 The warnings will be placed close to the point of the mistake,
32991 and you can quickly find them by using the
32993 Navigate\SpecialChar menuseparator
32997 or the shortcut key
33006 Open the error boxes by clicking on them with the mouse,
33007 or use the shortcut key
33016 or the corresponding
33025 Read the warning and correct the mistake,
33026 if it is a mistake.
33027 If you have trouble understanding what the warning is about,
33028 you can safely ignore it.
33029 Remember that there is a hidden layer between the document on screen and the technical details in invoking
33031 Chk\SpecialChar TeX
33035 and this gap can make some warnings seem arcane or just plain silly.
33038 \begin_layout Standard
33039 This document is an excellent testing bed for the feature,
33040 and it should provide quite a few warnings for you to fiddle with.
33041 Since computers are only so smart,
33042 expect most of the warnings to be false alarms,
33046 \begin_layout Subsection
33047 How to fine tune it
33050 \begin_layout Standard
33054 Chk\SpecialChar TeX
33057 makes more noise than suits your mood.
33058 Then you can choose not to use it,
33059 wait until your mood changes,
33060 or try to customize
33062 Chk\SpecialChar TeX
33065 to get better along with you.
33068 \begin_layout Standard
33071 Chk\SpecialChar TeX
33078 very configurable and extensible,
33079 you should not expect to solve all problems with
33081 Chk\SpecialChar TeX
33084 in \SpecialChar LyX
33086 Since \SpecialChar LyX
33087 has to generate a somewhat special \SpecialChar LaTeX
33088 file to be able to match the line numbers from the
33090 Chk\SpecialChar TeX
33097 \begin_layout Plain Layout
33098 You can inspect the specific output from
33104 Document\SpecialChar menuseparator
33107 \begin_inset space ~
33121 to the internal document structure,
33122 some of the warnings will not appear correctly.
33123 There are two things you can do about this:
33126 \begin_layout Itemize
33129 Chk\SpecialChar TeX
33132 invocation command line in
33133 \begin_inset Flex Noun
33136 \begin_layout Plain Layout
33137 Tools\SpecialChar menuseparator
33138 Preferences\SpecialChar menuseparator
33139 Output\SpecialChar menuseparator
33140 LaTeX\SpecialChar menuseparator
33149 Chk\SpecialChar TeX
33152 installation configuration file (usually with the file
33157 See below to learn what warnings can be enabled and disabled on the command line.
33160 \begin_layout Itemize
33161 Export your document as a raw \SpecialChar LaTeX
33164 File\SpecialChar menuseparator
33165 Export\SpecialChar menuseparator
33174 Invoked in this way,
33175 it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
33177 but with a little patience,
33178 you should be able to do it.
33181 \begin_layout Standard
33182 Here follows the warning messages that can be enabled and disabled in
33191 to disable a warning,
33196 to enable a warning.
33197 The emphasized entries are disabled by default,
33198 because the default is "
33200 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
33205 \begin_layout Standard
33206 Notice that you should only use the options that enable and disable warnings,
33207 because \SpecialChar LyX
33208 relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
33215 \begin_layout Enumerate
33219 Command terminated with space.
33222 \begin_layout Enumerate
33225 Non-breaking space (
33226 \begin_inset Quotes eld
33234 \begin_inset Quotes erd
33237 ) should have been used.
33240 \begin_layout Enumerate
33244 You should enclose the previous parenthesis with
33245 \begin_inset Quotes eld
33253 \begin_inset Quotes erd
33259 \begin_layout Enumerate
33262 Italic correction (
33263 \begin_inset Quotes eld
33273 \begin_inset Quotes erd
33276 ) found in non-italic buffer.
33279 \begin_layout Enumerate
33282 Italic correction (
33283 \begin_inset Quotes eld
33293 \begin_inset Quotes erd
33296 ) found more than once.
33299 \begin_layout Enumerate
33303 No italic correction (
33304 \begin_inset Quotes eld
33314 \begin_inset Quotes erd
33320 \begin_layout Enumerate
33324 \begin_inset Quotes eld
33332 \begin_inset Quotes erd
33336 \begin_inset Quotes eld
33344 \begin_inset Quotes erd
33350 \begin_layout Enumerate
33353 Wrong length of dash may have been used.
33356 \begin_layout Enumerate
33360 \begin_inset Quotes eld
33368 \begin_inset Quotes erd
33373 \begin_inset Quotes eld
33381 \begin_inset Quotes erd
33387 \begin_layout Enumerate
33391 \begin_inset Quotes eld
33399 \begin_inset Quotes erd
33405 \begin_layout Enumerate
33409 \begin_inset Quotes eld
33417 \begin_inset Quotes erd
33420 to achieve an ellipsis.
33423 \begin_layout Enumerate
33426 Inter-word spacing (
33427 \begin_inset Quotes eld
33437 \begin_inset Quotes eld
33440 ) should perhaps be used.
33443 \begin_layout Enumerate
33446 Inter-sentence spacing (
33447 \begin_inset Quotes eld
33457 \begin_inset Quotes erd
33460 ) should perhaps be used.
33463 \begin_layout Enumerate
33466 Could not find argument for command.
33469 \begin_layout Enumerate
33473 \begin_inset Quotes eld
33481 \begin_inset Quotes erd
33487 \begin_layout Enumerate
33490 Math mode still on at end of \SpecialChar LaTeX
33494 \begin_layout Enumerate
33498 \begin_inset Quotes eld
33506 \begin_inset Quotes erd
33509 doesn't match the number of
33510 \begin_inset Quotes eld
33518 \begin_inset Quotes erd
33524 \begin_layout Enumerate
33527 You should use either
33530 \begin_inset Quotes eld
33538 \begin_inset Quotes erd
33543 as an alternative to
33544 \begin_inset Quotes eld
33552 \begin_inset Quotes erd
33558 \begin_layout Enumerate
33565 " (ASCII 39) instead of "
33572 \begin_layout Enumerate
33575 User-specified pattern found.
33578 \begin_layout Enumerate
33581 This command might not be intended.
33584 \begin_layout Enumerate
33591 \begin_layout Enumerate
33609 \begin_layout Enumerate
33612 Delete this space to maintain correct page references.
33615 \begin_layout Enumerate
33619 You might wish to put this between a pair of
33620 \begin_inset Quotes eld
33628 \begin_inset Quotes erd
33634 \begin_layout Enumerate
33637 You ought to remove spaces in front of punctuation.
33640 \begin_layout Enumerate
33643 Could not execute \SpecialChar LaTeX
33647 \begin_layout Enumerate
33656 in front of small punctuation.
33659 \begin_layout Enumerate
33667 may look prettier here.
33670 \begin_layout Enumerate
33674 Multiple spaces detected in output.
33677 \begin_layout Enumerate
33680 This text may be ignored.
33683 \begin_layout Enumerate
33689 \begin_inset Quotes eld
33694 to begin quotation,
33702 \begin_layout Enumerate
33713 \begin_inset Quotes eld
33721 \begin_layout Enumerate
33727 \begin_layout Enumerate
33730 You should perhaps use
33731 \begin_inset Quotes eld
33739 \begin_inset Quotes erd
33745 \begin_layout Enumerate
33748 You should put a space in front of/after parenthesis.
33751 \begin_layout Enumerate
33754 You should avoid spaces in front of/after parenthesis.
33757 \begin_layout Enumerate
33761 You should not use punctuation in front of/after quotes.
33764 \begin_layout Enumerate
33767 Double space found.
33770 \begin_layout Enumerate
33773 You should put punctuation outside inner/inside display math mode.
33776 \begin_layout Enumerate
33779 You ought to not use primitive \SpecialChar TeX
33780 in \SpecialChar LaTeX
33784 \begin_layout Enumerate
33787 You should remove spaces in front of
33788 \begin_inset Quotes eld
33796 \begin_inset Quotes erd
33802 \begin_layout Enumerate
33805 \begin_inset Quotes eld
33813 \begin_inset Quotes erd
33816 is normally not followed by
33817 \begin_inset Quotes eld
33825 \begin_inset Quotes erd
33831 \begin_layout Standard
33832 In later versions of \SpecialChar LyX
33834 we hope to provide a more complete interface to this tool (and it's smaller cousin
33838 ) to exploit the full power of it.
33839 But it's not exactly useless as it is now:
33840 go try it on one of your existing documents of a certain length and be surprised.
33843 \begin_layout Section
33844 Version Control in \SpecialChar LyX
33848 \begin_layout Standard
33851 Lars Gullik Bjønnes
33858 \begin_layout Subsection
33862 \begin_layout Standard
33864 supports some of the most basic RCS/CVS/SVN/GIT commands.
33865 If you need something a bit more sophisticated you will have to do that manually in a terminal.
33868 \begin_layout Standard
33869 Also note that CVS support is not as good as subversion support,
33870 so we advise using SVN instead.
33871 A good place to start learning Subversion is the SVN Book
33875 \begin_layout Plain Layout
33876 \begin_inset CommandInset href
33878 target "http://svnbook.red-bean.com/"
33889 In the case of RCS you should read
33890 \begin_inset Quotes eld
33894 \begin_inset Quotes erd
33903 This file describes all the basic features of RCS.
33904 You should especially notice the comment about a RCS directory,
33905 and the notion of a master RCS file (the file ending in
33912 \begin_layout Standard
33913 Before you begin to use the version control features in \SpecialChar LyX
33915 you should be familiar with RCS/CVS/SVN/GIT usage.
33916 The implementation in \SpecialChar LyX
33917 assumes a recent version of the GNU RCS or CVS/SVN package —
33918 no guarantees are made for older versions.
33919 Most of the log messages are not currently displayed after operations —
33920 you can check them in the Messages pane if you are unsure.
33921 Regular users of version control will appreciate the VC toolbar,
33922 which can be enabled via
33924 View\SpecialChar menuseparator
33925 Toolbars\SpecialChar menuseparator
33927 \begin_inset space ~
33935 \begin_layout Standard
33936 For introducing your own external commands consult
33937 \begin_inset Flex Code
33940 \begin_layout Plain Layout
33954 \begin_layout Standard
33955 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
33957 Document\SpecialChar menuseparator
33961 Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
33962 Compressed LyX documents are binary files,
33963 which cannot be merged by version control systems.
33966 \begin_layout Subsection
33967 RCS commands in \SpecialChar LyX
33971 \begin_layout Standard
33972 The following sections describe the RCS commands supported by \SpecialChar LyX
33974 You can find them in the
33976 File\SpecialChar menuseparator
33978 \begin_inset space ~
33985 was tested against RCS 5.7/5.8.
33988 \begin_layout Subsubsection
33994 \begin_layout Standard
33995 If your document is not under revision control,
33996 this is the only item shown in the menu.
33997 And if it is under revision control,
34002 item is not visible.
34006 \begin_layout Standard
34007 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
34008 You are asked interactively to supply an initial description of the document.
34009 The document is now set in Read-Only mode and you have to
34012 \begin_inset space ~
34016 \begin_inset space ~
34020 \begin_inset space ~
34026 before making any changes to it.
34027 A document under revision control has a
34028 \begin_inset Quotes eld
34031 [RCS:<version> <locker>]
34032 \begin_inset Quotes erd
34035 item tagged to the filename in the minibuffer.
34038 \begin_layout Standard
34039 RCS command that is run:
34042 \begin_layout LyX-Code
34045 ci -q -u -i -t-"<initial description>" <file-name>
34048 \begin_layout Standard
34053 to understand the switches.
34057 \begin_layout Subsubsection
34063 \begin_layout Standard
34064 When you are finished editing a file,
34065 you check in your changes.
34067 you are asked for a description of the changes.
34068 This is stored in the history log.
34069 The version number is bumped,
34070 your changes are applied to the master RCS file,
34071 the document is unlocked and set to Read-Only mode.
34074 \begin_layout Itemize
34078 ci -q -u -m"<description>" <file-name>
34081 \begin_layout Subsubsection
34087 \begin_layout Standard
34088 By doing this you lock the document so that only you can edit it.
34089 This will also make the document Read-Write only for you.
34090 You will usually continue editing for a while and when you are finished you check in your changes.
34091 The status line is changed to reflect that you have locked the file.
34094 \begin_layout Itemize
34098 co -q -l <file-name>
34101 \begin_layout Subsubsection
34104 Revert To Repository Version
34107 \begin_layout Standard
34108 This will discard all changes made to the document since the last check in.
34109 You get a warning before changes are discarded.
34112 \begin_layout Itemize
34116 co -f -u<version> <file-name>
34119 \begin_layout Subsubsection
34125 \begin_layout Standard
34126 This will create a copy of the current document.
34127 Since RCS does not support copy operations natively,
34128 the version history is not preserved,
34129 and the copy is added as a new file.
34130 It requires a clean document without any changes since the last checkin.
34131 You are asked for a file name and a description of the copy operation.
34132 After that the copy is created,
34133 both locally and in the repository.
34134 If the parent directories of the copied and original document differ,
34135 all relative paths of included files of the copy are adjusted (like in
34137 File\SpecialChar menuseparator
34143 the copy is loaded instead of the original document.
34146 \begin_layout Labeling
34147 \labelwidthstring 00.00.0000
34149 \begin_inset space ~
34154 \begin_inset space ~
34158 \begin_inset Newline newline
34162 \begin_inset Flex Code
34165 \begin_layout Plain Layout
34168 \begin_inset Quotes qld
34172 \begin_inset Quotes qld
34181 \begin_inset Flex Code
34184 \begin_layout Plain Layout
34187 \begin_inset Quotes qld
34191 \begin_inset Quotes qld
34200 \begin_inset Newline newline
34204 \begin_inset Flex Code
34207 \begin_layout Plain Layout
34211 \begin_inset Quotes qld
34215 \begin_inset Quotes qld
34226 \begin_layout Subsubsection
34232 \begin_layout Standard
34233 This makes as if the last check in never happened.
34234 No changes are made to the document loaded into \SpecialChar LyX
34236 but the last version is removed from the master RCS file.
34239 \begin_layout Itemize
34243 rcs -o<version> <file-name>
34246 \begin_layout Subsubsection
34252 \begin_layout Standard
34253 This shows the complete history of the RCS document.
34258 is shown in a browser.
34266 \begin_layout Subsubsection
34270 \begin_layout Standard
34272 supports RCS version number,
34274 date and time of last commit.
34275 All those are extracted from
34277 rlog -r <file-name>
34281 \begin_inset CommandInset ref
34283 reference "subsec:VCS-Revision-Information"
34291 \begin_layout Subsection
34292 CVS commands in \SpecialChar LyX
34296 \begin_layout Standard
34297 A subset of CVS operations is supported by \SpecialChar LyX
34299 You can find the commands in the
34301 File\SpecialChar menuseparator
34303 \begin_inset space ~
34309 The version control system SVN is more powerful,
34310 so please use it instead of CVS if possible.
34313 \begin_layout Subsubsection
34319 \begin_layout Standard
34320 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
34321 If you're using a client-server setup you may need to login before doing the first repository checkout.
34324 \begin_layout Standard
34325 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.
34326 Standard CVS repositories don't operate with a file locking mechanism.
34327 This may be surprising,
34328 but conflicts only occur if people disagree on the proper content of the same part of a document.
34330 if co-workers are used to communicate regularly,
34331 these conflicts occur rarely.
34332 If they don't communicate they have a fundamental problem anyway.
34333 Nevertheless some people like to work with so called
34334 \begin_inset Quotes eld
34338 \begin_inset Quotes erd
34342 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.
34343 When the changes are checked in the working copy returns to readonly state.
34344 With \SpecialChar LyX
34345 one has to edit the
34346 \begin_inset Flex Code
34349 \begin_layout Plain Layout
34355 file and add the line
34356 \begin_inset Flex Code
34359 \begin_layout Plain Layout
34365 to work with reserved checkouts.
34366 The benefit is the possibility to see who is using a writable copy of some document.
34367 It's not guaranteed only one user makes a copy writable.
34370 \begin_layout Standard
34372 tries to guess if you're using reserved or non-reserved checkouts.
34373 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.
34374 When a reserved checkout is detected you have to use
34375 \begin_inset Flex Noun
34378 \begin_layout Plain Layout
34384 to make your working copy writable if it's readonly.
34386 \begin_inset Flex Noun
34389 \begin_layout Plain Layout
34395 operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
34398 \begin_layout Standard
34399 More information about CVS can be found here
34400 \begin_inset Flex URL
34403 \begin_layout Plain Layout
34405 http://www.nongnu.org/cvs
34411 \begin_inset Flex URL
34414 \begin_layout Plain Layout
34416 http://ximbiot.com/cvs
34424 \begin_layout Standard
34429 to understand the sub-commands and the switches mentioned below.
34432 \begin_layout Subsubsection
34438 \begin_layout Standard
34439 If your document is not under revision control,
34440 this is the only item shown in the menu.
34441 And if it is under revision control,
34446 item is not visible.
34450 \begin_layout Standard
34451 This command registers in CVS your document
34452 \begin_inset Flex Strong
34455 \begin_layout Plain Layout
34463 in the case you have already the documents directory under CVS control (in particular
34468 This means you have to create or checkout the archive by yourself using external tools.
34469 (In case you forget that step \SpecialChar LyX
34470 registers the document with RCS.)
34473 \begin_layout Standard
34474 Then you are asked interactively to supply an initial description of the document.
34475 Don't forget that registered file is not yet checked in.
34478 \begin_layout Standard
34479 CVS command that is run:
34482 cvs -q add -m"<entered message>" "<file-name>"
34485 \begin_layout Standard
34490 above and for all other CVS commands is an abbreviation for
34491 \begin_inset Quotes eld
34494 change the current working directory to file location and use the file name without path component as argument
34495 \begin_inset Quotes erd
34501 \begin_layout Subsubsection
34507 \begin_layout Standard
34508 When you are finished editing a file,
34509 you commit your changes.
34510 When you do this and you had changed the document,
34511 you are asked for a description of the changes.
34512 After that changes are written to the repository.
34513 In case you didn't change the document and a reserved checkout is detected the reservation made on
34514 \begin_inset Flex Noun
34517 \begin_layout Plain Layout
34526 \begin_layout Labeling
34527 \labelwidthstring 00.00.0000
34529 \begin_inset space ~
34534 \begin_inset space ~
34538 \begin_inset Newline newline
34542 \begin_inset Flex Code
34545 \begin_layout Plain Layout
34548 -q commit -m"<description>" "<file-name>"
34554 \begin_inset Newline newline
34558 \begin_inset Flex Code
34561 \begin_layout Plain Layout
34572 \begin_layout Subsubsection
34578 \begin_layout Standard
34579 When you are sharing a repository with others,
34580 you may have to incorporate their changes into your working copy.
34583 \begin_layout Standard
34587 cvs -q update "<file-name>"
34590 \begin_layout Standard
34591 If a readonly checkout is detected the working copy is made writable and reserved.
34594 \begin_layout Standard
34598 cvs -q edit "<file-name>"
34601 \begin_layout Subsubsection
34604 Revert To Repository Version
34607 \begin_layout Standard
34608 This will discard all changes made to the document since the last check in.
34609 You get a warning before changes are discarded.
34610 Firstly the file is deleted,
34611 secondly CVS update command is run.
34614 \begin_layout Standard
34618 cvs -q update "<file-name>"
34621 \begin_layout Standard
34622 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
34625 \begin_layout Standard
34629 cvs -q unedit "<file-name>"
34632 \begin_layout Subsubsection
34638 \begin_layout Standard
34639 This will create a copy of the current document.
34640 Since CVS does not support copy operations natively,
34641 the version history is not preserved,
34642 and the copy is added as a new file.
34643 It requires a clean document without any changes since the last checkin.
34644 You are asked for a file name and a description of the copy operation.
34645 After that the copy is created,
34646 both locally and in the repository.
34647 If the parent directories of the copied and original document differ,
34648 all relative paths of included files of the copy are adjusted (like in
34650 File\SpecialChar menuseparator
34656 the copy is loaded instead of the original document.
34659 \begin_layout Labeling
34660 \labelwidthstring 00.00.0000
34662 \begin_inset space ~
34667 \begin_inset space ~
34671 \begin_inset Newline newline
34675 \begin_inset Flex Code
34678 \begin_layout Plain Layout
34685 \begin_inset Flex Code
34688 \begin_layout Plain Layout
34695 \begin_inset Newline newline
34699 \begin_inset Flex Code
34702 \begin_layout Plain Layout
34703 cvs -q add "<new-file-name>"
34711 \begin_layout Subsubsection
34717 \begin_layout Standard
34718 This will rename the current document.
34719 Since CVS does not support rename operations natively,
34720 the version history is not preserved,
34721 the renamed document is added as a new file,
34722 and the original document is deleted.
34723 It requires a clean document without any changes since the last checkin.
34724 You are asked for a file name and a description of the rename operation.
34725 After that the document is renamed,
34726 both locally and in the repository.
34727 If the parent directories of the new and old file names differ,
34728 all relative paths of included files are adjusted (like in
34730 File\SpecialChar menuseparator
34736 the document is reloaded using the new name.
34739 \begin_layout Labeling
34740 \labelwidthstring 00.00.0000
34742 \begin_inset space ~
34747 \begin_inset space ~
34751 \begin_inset Newline newline
34755 \begin_inset Flex Code
34758 \begin_layout Plain Layout
34765 \begin_inset Flex Code
34768 \begin_layout Plain Layout
34775 \begin_inset Newline newline
34779 \begin_inset Flex Code
34782 \begin_layout Plain Layout
34783 cvs -q add "<new-file-name>"
34789 \begin_inset Newline newline
34793 \begin_inset Flex Code
34796 \begin_layout Plain Layout
34797 cvs -q remove "<file-name>"
34805 \begin_layout Subsubsection
34806 Update of the local directory checkout from repository
34809 \begin_layout Standard
34810 Once your documents gets more complex,
34811 containing sub-documents and pictures,
34813 \begin_inset Flex Code
34816 \begin_layout Plain Layout
34822 files and so on using version control becomes more complicated.
34824 supports updating the whole tree in which resides the document.
34825 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.
34826 You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
34827 It's good practice anyway to store multipart documents in an extra directory.
34830 \begin_layout Standard
34832 \begin_inset Flex Code
34835 \begin_layout Plain Layout
34836 Update local directory from repository
34841 command updates the whole directory.
34842 If local changes are detected user is warned before update starts.
34843 In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
34844 You have to review and correct the result of the merge.
34845 You'll find the conflicts enclosed in pairs of
34846 \begin_inset Flex Code
34849 \begin_layout Plain Layout
34856 \begin_inset Flex Code
34859 \begin_layout Plain Layout
34866 \begin_inset Flex Code
34869 \begin_layout Plain Layout
34876 The first part is your version as before the update operation with the document name prepended.
34877 The second one is the repository version with the version number after the sequence of
34878 \begin_inset Flex Code
34881 \begin_layout Plain Layout
34890 \begin_layout Labeling
34891 \labelwidthstring 00.00.0000
34893 \begin_inset space ~
34898 \begin_inset space ~
34902 \begin_inset Newline newline
34906 \begin_inset Flex Code
34909 \begin_layout Plain Layout
34918 (Ask if changes are detected.)
34919 \begin_inset Newline newline
34923 \begin_inset Flex Code
34926 \begin_layout Plain Layout
34938 \begin_layout Standard
34940 \begin_inset Flex Code
34943 \begin_layout Plain Layout
34949 stands for the path to the document.
34952 \begin_layout Subsubsection
34958 \begin_layout Standard
34959 This shows the complete history of the CVS document.
34962 cvs log "<file-name>"
34964 is shown in a browser.
34967 \begin_layout Subsubsection
34971 \begin_layout Standard
34973 supports CVS version number,
34975 date and time of last commit.
34976 All those are extracted from
34978 cvs log -r <file-name>
34982 \begin_inset CommandInset ref
34984 reference "subsec:VCS-Revision-Information"
34992 \begin_layout Subsection
34993 SVN commands in \SpecialChar LyX
34997 \begin_layout Standard
34998 SVN is now partially supported by \SpecialChar LyX
35000 You can find the commands in the
35002 File\SpecialChar menuseparator
35004 \begin_inset space ~
35010 Please note that if you use password protected access to repository via ssh,
35011 you will be asked in terminal window.
35013 was tested against SVN 1.5,
35019 \begin_layout Plain Layout
35020 Most of the commands will work with 1.4 too,
35022 \begin_inset CommandInset ref
35024 reference "subsec:SVN-Repo-Update"
35030 There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
35038 \begin_layout Subsubsection
35044 \begin_layout Standard
35045 If your document is not under revision control,
35046 this is the only item shown in the menu.
35047 And if it is under revision control,
35052 item is not visible.
35055 \begin_layout Standard
35056 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
35061 This means you have to checkout the archive by yourself.
35064 \begin_layout Standard
35065 Then you are asked interactively to supply an initial description of the document.
35066 Don't forget that registered file is not yet commited.
35069 \begin_layout Standard
35070 SVN command that is run:
35074 \begin_inset Quotes qld
35078 \begin_inset Quotes qld
35084 \begin_layout Standard
35089 to understand the switches.
35092 \begin_layout Subsubsection
35098 \begin_layout Standard
35099 When you are finished editing a file,
35100 you commit your changes.
35102 you are asked for a description of the changes.
35103 After that changes are commited.
35106 \begin_layout Standard
35111 \begin_layout Plain Layout
35112 In case locking is not enabled.
35114 \begin_inset CommandInset ref
35116 reference "subsec:SVN-File-Locking"
35128 svn commit -q -m"<description>" <file-name>
35131 \begin_layout Subsubsection
35137 \begin_layout Standard
35138 Updates the changes of this file from the repository.
35139 Be sure you understand SVN merging and conflicts resolving before using this function,
35140 because all conflicts has to be resolved manually by you!
35143 \begin_layout Standard
35148 \begin_layout Plain Layout
35156 svn update --non-interactive
35157 \begin_inset Quotes qld
35161 \begin_inset Quotes qld
35167 \begin_layout Subsubsection
35170 Revert To Repository Version
35173 \begin_layout Standard
35174 This will discard all changes made to the document since the last check in.
35175 You get a warning before changes are discarded.
35178 \begin_layout Standard
35183 \begin_inset Quotes qld
35187 \begin_inset Quotes qld
35193 \begin_layout Subsubsection
35199 \begin_layout Standard
35200 This will create a copy of the current document including the version history.
35201 It requires a clean document without any changes since the last checkin.
35202 You are asked for a file name and a description of the copy operation.
35203 After that the copy is created,
35204 both locally and in the repository.
35205 If the parent directories of the copied and original document differ,
35206 all relative paths of included files of the copy are adjusted (like in
35208 File\SpecialChar menuseparator
35214 the copy is loaded instead of the original document.
35217 \begin_layout Labeling
35218 \labelwidthstring 00.00.0000
35220 \begin_inset space ~
35225 \begin_inset space ~
35229 \begin_inset Newline newline
35233 \begin_inset Flex Code
35236 \begin_layout Plain Layout
35240 \begin_inset Quotes qld
35244 \begin_inset Quotes qld
35248 \begin_inset Quotes qld
35252 \begin_inset Quotes qld
35261 \begin_inset Newline newline
35265 \begin_inset Flex Code
35268 \begin_layout Plain Layout
35277 \begin_layout Subsubsection
35283 \begin_layout Standard
35284 This will rename the current document including the version history.
35285 It requires a clean document without any changes since the last checkin.
35286 You are asked for a file name and a description of the rename operation.
35287 After that the document is renamed,
35288 both locally and in the repository.
35289 If the parent directories of the new and old file names differ,
35290 all relative paths of included files are adjusted (like in
35292 File\SpecialChar menuseparator
35298 the document is reloaded using the new name.
35301 \begin_layout Labeling
35302 \labelwidthstring 00.00.0000
35304 \begin_inset space ~
35309 \begin_inset space ~
35313 \begin_inset Newline newline
35317 \begin_inset Flex Code
35320 \begin_layout Plain Layout
35324 \begin_inset Quotes qld
35328 \begin_inset Quotes qld
35332 \begin_inset Quotes qld
35336 \begin_inset Quotes qld
35345 \begin_inset Newline newline
35349 \begin_inset Flex Code
35352 \begin_layout Plain Layout
35361 \begin_layout Subsubsection
35362 \begin_inset CommandInset label
35364 name "subsec:SVN-Repo-Update"
35368 Update of the local directory checkout from repository
35372 \begin_layout Plain Layout
35373 Note that this command will work only with subversion
35374 \begin_inset Formula $\geqq1.5$
35385 \begin_layout Standard
35386 All the commands above have one shortcoming – they deal with the current document only.
35387 Once your document contains pictures,
35389 \begin_inset Flex Code
35392 \begin_layout Plain Layout
35398 files and so on administration becomes more complicated.
35400 now supports updating the whole tree in which resides the document
35404 \begin_layout Plain Layout
35405 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
35412 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.
35416 \begin_layout Standard
35417 \begin_inset Flex Code
35420 \begin_layout Plain Layout
35421 Update local directory from repository
35426 command updates the whole directory and in case of merge conflicts local version of the files are left,
35427 so no unintended data loss occurs.
35428 If local changes are detected user is warned before update starts.
35431 \begin_layout Labeling
35432 \labelwidthstring 00.00.0000
35434 \begin_inset space ~
35439 \begin_inset space ~
35443 \begin_inset Newline newline
35447 \begin_inset Flex Code
35450 \begin_layout Plain Layout
35456 (Ask if changes are detected.)
35457 \begin_inset Newline newline
35461 \begin_inset Flex Code
35464 \begin_layout Plain Layout
35465 svn update --accept mine-full $path
35473 \begin_layout Standard
35475 \begin_inset Flex Code
35478 \begin_layout Plain Layout
35484 stands for the path to the document.
35487 \begin_layout Subsubsection
35493 \begin_layout Standard
35494 This shows the complete history of the SVN document.
35498 \begin_inset Quotes qld
35502 \begin_inset Quotes qld
35507 is shown in a browser.
35510 \begin_layout Subsubsection
35512 \begin_inset CommandInset label
35514 name "subsec:SVN-File-Locking"
35521 \begin_layout Standard
35522 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.
35523 When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
35524 which guarantees that only one user is allowed to edit file at the given time.
35527 \begin_layout Standard
35528 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
35530 \begin_inset CommandInset ref
35532 reference "subsec:Automatical-Locking-Property"
35538 \begin_inset Flex Code
35541 \begin_layout Plain Layout
35551 \begin_layout Plain Layout
35552 \begin_inset Flex URL
35555 \begin_layout Plain Layout
35557 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
35568 If this property is detected for a given document \SpecialChar LyX
35569 starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
35570 This in particular means there are two different modes of file use in \SpecialChar LyX
35574 \begin_layout Itemize
35576 The loaded file is in the read-only mode.
35577 For editing on needs to check-out.
35582 consists of updating from the repository and gaining write lock.
35583 If the lock is not possible to obtain,
35584 we remain in unlocked state.
35587 \begin_layout Itemize
35589 The loaded file is in the
35590 \begin_inset Quotes els
35594 \begin_inset Quotes ers
35598 No other user is allowed to edit the file.
35603 consists of commiting changes and releasing write-lock.
35604 If no changes have been made to the document,
35605 no commit will be produced
35609 \begin_layout Plain Layout
35610 Don't be puzzled by the fact that you will be asked for commit message anyway.
35615 and only the write-lock will be released.
35618 \begin_layout Standard
35622 \begin_layout Labeling
35623 \labelwidthstring 00.00.0000
35627 svn commit -q -m"<description>" "<file-name>"
35628 \begin_inset Newline newline
35631 svn unlock "<file-name>"
35634 \begin_layout Labeling
35635 \labelwidthstring 00.00.0000
35639 svn update "<file-name>"
35640 \begin_inset Newline newline
35643 svn lock "<file-name>"
35646 \begin_layout Subsubsection
35649 \begin_inset CommandInset label
35651 name "subsec:Automatical-Locking-Property"
35657 Automatic Locking Property
35660 \begin_layout Standard
35661 The above mentioned automatic setting of write permissions of the .lyx file can be set through
35663 File\SpecialChar menuseparator
35665 \begin_inset space ~
35668 Control\SpecialChar menuseparator
35669 Use Locking Property
35672 This command is active only when the file is not locked on the svn server (i.e.
35673 you need to check-out before proceeding).
35676 \begin_layout Labeling
35677 \labelwidthstring 00.00.0000
35679 \begin_inset space ~
35685 \begin_layout Labeling
35686 \labelwidthstring 00.00.0000
35690 svn propset svn:needs-lock ON "<file-name>"
35693 \begin_layout Labeling
35694 \labelwidthstring 00.00.0000
35698 svn propdel svn:needs-lock "<file-name>"
35701 \begin_layout Subsubsection
35702 \begin_inset CommandInset label
35704 name "subsec:VCS-Revision-Information"
35708 Revision Information in Documents
35711 \begin_layout Standard
35712 There are more possibilities how to activate revision information in our document.
35715 \begin_layout Itemize
35721 \begin_layout Itemize
35722 tree revision information (
35723 \begin_inset Flex Code
35726 \begin_layout Plain Layout
35733 The result is the output of the
35734 \begin_inset Flex Code
35737 \begin_layout Plain Layout
35744 the following table gives you an idea,
35745 how to read the results.
35748 \begin_layout Standard
35750 \begin_inset Tabular
35751 <lyxtabular version="3" rows="6" columns="2">
35752 <features tabularvalignment="middle">
35753 <column alignment="left" valignment="top">
35754 <column alignment="left" valignment="top">
35756 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
35759 \begin_layout Plain Layout
35767 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
35770 \begin_layout Plain Layout
35780 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35783 \begin_layout Plain Layout
35789 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35792 \begin_layout Plain Layout
35793 mixed revision working copy
35800 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35803 \begin_layout Plain Layout
35809 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35812 \begin_layout Plain Layout
35813 modified working copy
35820 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35823 \begin_layout Plain Layout
35829 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35832 \begin_layout Plain Layout
35833 switched working copy
35840 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
35843 \begin_layout Plain Layout
35849 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
35852 \begin_layout Plain Layout
35853 partial working copy,
35854 from a sparse checkout
35861 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
35864 \begin_layout Plain Layout
35870 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
35873 \begin_layout Plain Layout
35876 switched working copy
35889 \begin_layout Itemize
35890 file revision information.
35891 The result comes from parsing the output of
35892 \begin_inset Flex Code
35895 \begin_layout Plain Layout
35897 \begin_inset space ~
35901 \begin_inset space ~
35905 \begin_inset space ~
35914 Supported flags are:
35918 \begin_layout Itemize
35919 version number of the last commit (
35920 \begin_inset Flex Code
35923 \begin_layout Plain Layout
35932 \begin_layout Itemize
35933 author of the last commit (
35934 \begin_inset Flex Code
35937 \begin_layout Plain Layout
35946 \begin_layout Itemize
35947 date of the last commit (
35948 \begin_inset Flex Code
35951 \begin_layout Plain Layout
35960 \begin_layout Itemize
35961 time of the last commit (
35962 \begin_inset Flex Code
35965 \begin_layout Plain Layout
35975 \begin_layout Standard
35976 You can obtain this info via InsetInfo (
35977 \change_inserted 5863208 1564400022
35978 Insert\SpecialChar menuseparator
35979 Field\SpecialChar menuseparator
35980 Version Control Revision
35981 \change_deleted 5863208 1564399852
35984 \begin_inset Flex Code
35987 \begin_layout Plain Layout
35988 info-insert buffer vcs-date
35996 The information will be available only when you have the file stored under svn managment (i.e.
35998 \begin_inset Flex Code
36001 \begin_layout Plain Layout
36007 directory is available with your document).
36011 \begin_layout Itemize
36014 possibility is to use svn keywords
36018 \begin_layout Plain Layout
36019 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
36025 In short – you set file keywords property (e.g.
36028 svn propset svn:keywords 'Rev' file.lyx
36030 ) and then paste keyword \SpecialChar TeX
36035 \begin_layout Plain Layout
36036 This is an easy way how to ensure that \SpecialChar LyX
36037 won't break the line in the middle of keyword tag.
36042 tag in your document (e.g.
36044 \begin_inset Flex Code
36047 \begin_layout Plain Layout
36054 This way svn client will automatically substitute revision number (e.g.
36056 \begin_inset Flex Code
36059 \begin_layout Plain Layout
36066 ) after each update and commit.
36067 There are more problems with this approach.
36069 the '$' character is used in \SpecialChar TeX
36070 world for math equations,
36071 so any occurence of math formula
36072 \begin_inset Formula $Rev$
36076 \begin_inset Formula $Rev:59$
36079 in your \SpecialChar LyX
36081 Similarly for other keywords like Id,
36085 Secondly svn output is dependent on your locales,
36086 so its very easy that svn would produce some problematic strings once Date is used.
36087 Thirdly you get the whole 'Rev:
36088 59' string in your document instead of the plain number.
36089 Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
36090 to support it directly.
36093 \begin_layout Subsection
36094 SVN and Windows Environment
36097 \begin_layout Quote
36098 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
36099 they would be well advised to use TortoiseSVN.
36106 \begin_layout Subsubsection
36110 \begin_layout Standard
36111 In addition to installing \SpecialChar LyX
36113 and having access to a Subversion repository,
36114 the user will need to install the Subversion client program.
36115 A Windows installer for the client program is available from
36116 \begin_inset CommandInset href
36119 target "http://www.collab.net/nonav/downloads/subversion/"
36125 The user may also want to install
36126 \begin_inset CommandInset href
36129 target "http://tortoisesvn.tigris.org/"
36135 which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
36136 Operations done outside \SpecialChar LyX
36137 will typically be more convenient using the Explorer context menu.
36138 Note that TortoiseSVN is not a replacement for the client program,
36139 which is what \SpecialChar LyX
36143 \begin_layout Subsubsection
36144 Bringing a document under Subversion control
36147 \begin_layout Standard
36148 Before a \SpecialChar LyX
36149 document can be brought under version control in Subversion,
36150 its parent directory needs to be under version control.
36151 If the document is being added to a project already in the repository,
36152 this is accomplished by checking the project out to the directory where the new document will be placed.
36153 If the project itself is not yet under version control (for instance,
36154 if this document starts a new project),
36155 the directory must be imported into the repository.
36156 This is done outside \SpecialChar LyX
36158 Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
36159 or alternatively can be done using the command line client at a DOS prompt.
36160 The procedure for importing the project using TortoiseSVN is described below,
36161 assuming an existing repository and a new project being started in
36168 For information on using the Subversion client program,
36176 \begin_layout Enumerate
36183 in Windows Explorer,
36187 TortoiseSVN\SpecialChar menuseparator
36192 adjust the URL for the repository,
36196 \begin_layout Enumerate
36197 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
36201 Supply a name for the project folder and click OK.
36202 Add a message for the log file if desired,
36203 then click OK again.
36204 The new project folder should appear in the repository.
36206 click OK again to exit the repository browser.
36209 \begin_layout Enumerate
36210 Once again right click
36217 this time selecting SVN Checkout\SpecialChar ldots
36218 Select the URL of the project folder you just created in the repository,
36219 and set the checkout directory to
36227 You will be warned about a non-empty folder;
36228 click OK to proceed.
36229 You should now have a
36240 \begin_layout Enumerate
36241 Create or open your document in \SpecialChar LyX
36244 File\SpecialChar menuseparator
36246 \begin_inset space ~
36249 Control\SpecialChar menuseparator
36253 Add a log message and click OK to commit the document to version control.
36256 \begin_layout Standard
36257 From this point onward,
36258 you should have full functionality in the
36260 File\SpecialChar menuseparator
36262 \begin_inset space ~
36268 You also have the option of checking the document in and out,
36269 viewing its history,
36271 using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
36274 \begin_layout Subsubsection
36275 SSH tunnel used with SVN under Windows
36278 \begin_layout Standard
36279 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
36280 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,
36281 also be prepared for a great deal of frustration\SpecialChar ldots
36285 \begin_layout Enumerate
36286 Get an svn client for windows,
36287 as described in the previous sections.
36288 When it is a fresh install run some svn command (e.g.
36290 \begin_inset Flex Code
36293 \begin_layout Plain Layout
36299 ) to create config files,
36300 which you will need to change later on.
36303 \begin_layout Enumerate
36304 Choose an ssh client for Windows.
36305 There are several possibilities,
36306 we will use the one from Putty tools
36310 \begin_layout Plain Layout
36311 \begin_inset Flex URL
36314 \begin_layout Plain Layout
36316 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
36327 You will need to set the connection up so that the client doesn't ask for any password from you.
36328 To keep things easy we will use only keys without any additional password protection etc.
36332 \begin_layout Enumerate
36334 \begin_inset Flex Code
36337 \begin_layout Plain Layout
36344 Save your private .ppk key file and put the public one on the server side.
36345 If the SVN server runs on Linux,
36346 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
36347 \begin_inset Quotes eld
36352 Public key for pasting into OpenSSH authorized_keys file
36355 \begin_inset Quotes erd
36358 edit field into the server's
36359 \begin_inset Flex Code
36362 \begin_layout Plain Layout
36363 ~/.ssh/authorized_keys
36369 \begin_inset Flex Code
36372 \begin_layout Plain Layout
36381 \begin_layout Enumerate
36383 \begin_inset Flex Code
36386 \begin_layout Plain Layout
36393 In the SVN config file
36397 \begin_layout Plain Layout
36398 Exact path depends on Windows version,
36399 usually somewhere around
36400 \begin_inset Flex Code
36403 \begin_layout Plain Layout
36406 Documents and Settings
36420 \begin_inset Flex Code
36423 \begin_layout Plain Layout
36443 \begin_inset Flex Code
36446 \begin_layout Plain Layout
36447 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
36456 \begin_layout Plain Layout
36457 It will usually take a lot of time to get exact command right and it depends on many things.
36458 For example do not have some remote server saved as a default session in Putty etc.
36460 try to connect via plink without SVN first.
36469 \begin_layout Enumerate
36470 Checkout the SVN archive,
36472 \begin_inset space \thinspace{}
36476 \begin_inset Newline newline
36480 \begin_inset Flex Code
36483 \begin_layout Plain Layout
36484 svn co svn+ssh://user@server/repository_path
36492 \begin_layout Subsubsection
36493 End-of-Line Conversions
36496 \begin_layout Standard
36497 When the collaborators are mixing Linux and Windows environments,
36499 will use different line endings inside the .lyx files.
36500 This is not a problem as far as \SpecialChar LyX
36501 functionality is concerned,
36502 but the commit diffs will be huge and merge-conflicts prone.
36503 Fortunately SVN itself knows
36507 \begin_layout Plain Layout
36508 \begin_inset Flex URL
36511 \begin_layout Plain Layout
36513 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
36523 how to deal with CR/LF problems when switching .lyx files to the
36524 \begin_inset Flex Code
36527 \begin_layout Plain Layout
36537 \begin_layout Plain Layout
36540 \begin_inset Flex Code
36543 \begin_layout Plain Layout
36544 svn propset svn:eol-style native FILE_NAME
36557 \begin_layout Subsection
36558 GIT commands in \SpecialChar LyX
36562 \begin_layout Standard
36563 A minimal subset of GIT commands is now supported by \SpecialChar LyX
36565 You can find the commands in the
36567 File\SpecialChar menuseparator
36569 \begin_inset space ~
36575 Please note that if you use password protected access to repository via ssh,
36576 you will be asked in terminal window.
36578 was tested against GIT 1.7.
36582 \begin_layout Plain Layout
36583 Windows users please note that you need to ensure that git is on the path.
36584 This can be set from within \SpecialChar LyX
36587 Tools\SpecialChar menuseparator
36588 Preferences\SpecialChar menuseparator
36589 Paths\SpecialChar menuseparator
36600 \begin_layout Standard
36601 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
36602 With traditional version control systems there is one central server which hosts the repository.
36603 Users commit their changes to the server,
36604 and get updates made by other users from it.
36606 users commit to a local repository.
36607 The local repository can be synchronized with one or more remote repositories using the
36608 \begin_inset Flex Code
36611 \begin_layout Plain Layout
36618 \begin_inset Flex Code
36621 \begin_layout Plain Layout
36629 does not interact in any way with remote GIT repositories.
36630 It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
36631 If you use remote GIT repositories you need to do the
36632 \begin_inset Flex Code
36635 \begin_layout Plain Layout
36642 \begin_inset Flex Code
36645 \begin_layout Plain Layout
36651 operations with your favourite GIT client.
36654 \begin_layout Subsubsection
36660 \begin_layout Standard
36661 If your document is not under revision control,
36662 this is the only item shown in the menu.
36663 And if it is under revision control,
36668 item is not visible.
36671 \begin_layout Standard
36672 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
36677 This means you have to checkout the archive by yourself.
36680 \begin_layout Standard
36681 Then you are asked interactively to supply an initial description of the document.
36682 Don't forget that registered file is not yet committed.
36685 \begin_layout Standard
36686 GIT command that is run:
36690 \begin_inset Quotes qld
36694 \begin_inset Quotes qld
36700 \begin_layout Standard
36705 to understand the switches.
36708 \begin_layout Subsubsection
36714 \begin_layout Standard
36715 When you are finished editing a file,
36716 you commit your changes.
36718 you are asked for a description of the changes.
36719 After that changes are committed.
36722 \begin_layout Standard
36726 git commit -q -m"<description>" <file-name>
36729 \begin_layout Subsubsection
36732 Revert To Repository Version
36735 \begin_layout Standard
36736 This will discard all changes made to the document since the last check in.
36737 You get a warning before changes are discarded.
36740 \begin_layout Standard
36745 \begin_inset Quotes qld
36749 \begin_inset Quotes qld
36755 \begin_layout Subsubsection
36761 \begin_layout Standard
36762 This will rename the current document including the version history.
36763 It requires a clean document without any changes since the last checkin.
36764 You are asked for a file name and a description of the rename operation.
36765 After that the document is renamed,
36766 both locally and in the repository.
36767 If the parent directories of the new and old file names differ,
36768 all relative paths of included files are adjusted (like in
36770 File\SpecialChar menuseparator
36776 the document is reloaded using the new name.
36779 \begin_layout Labeling
36780 \labelwidthstring 00.00.0000
36782 \begin_inset space ~
36787 \begin_inset space ~
36791 \begin_inset Newline newline
36795 \begin_inset Flex Code
36798 \begin_layout Plain Layout
36802 \begin_inset Quotes qld
36806 \begin_inset Quotes qld
36810 \begin_inset Quotes qld
36814 \begin_inset Quotes qld
36823 \begin_inset Newline newline
36827 \begin_inset Flex Code
36830 \begin_layout Plain Layout
36839 \begin_layout Subsubsection
36845 \begin_layout Standard
36846 This shows the complete history of the GIT document.
36850 \begin_inset Quotes qld
36854 \begin_inset Quotes qld
36859 is shown in a browser.
36862 \begin_layout Subsubsection
36866 \begin_layout Standard
36868 supports GIT hash number of the last commit to the file,
36870 \change_inserted 1119979965 1564297456
36871 its abbreviated form,
36875 date and time of last commit.
36876 All those are extracted from
36878 git log -n 1 --pretty=format:%H%n
36879 \change_inserted 1119979965 1564297427
36885 Tree version information is obtained via
36887 git describe --abbrev --dirty --long
36891 \begin_inset CommandInset ref
36893 reference "subsec:VCS-Revision-Information"
36901 \begin_layout Subsection
36905 \begin_layout Standard
36906 With the recent addition of the
36907 \begin_inset Flex Code
36910 \begin_layout Plain Layout
36916 function \SpecialChar LyX
36917 power users are allowed to create their own commands for revision control.
36920 \begin_layout Standard
36921 As an example you can see how two TortoiseSVN commands could be integrated directly:
36924 \begin_layout Description
36927 \begin_inset Flex Code
36930 \begin_layout Plain Layout
36931 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
36939 \begin_layout Description
36942 \begin_inset Flex Code
36945 \begin_layout Plain Layout
36946 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
36954 \begin_layout Subsection
36955 Version control and Document comparison
36958 \begin_layout Standard
36959 One of the typical uses of version control is to inspect the changes between revisions,
36960 usually by creating
36961 \begin_inset Flex Code
36964 \begin_layout Plain Layout
36971 While this is useful for plain text files,
36972 it is much less useful in the case of \SpecialChar LyX
36974 which have more a complicated structure.
36975 Hence we provide binding to the Document comparison feature.
36976 There are two ways of calling this feature – either by direct call of
36977 \begin_inset Flex Code
36980 \begin_layout Plain Layout
36987 function (for details see \SpecialChar LyX
36988 functions manual) or by the toolbar icon
37002 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 '
37003 \begin_inset Flex Noun
37006 \begin_layout Plain Layout
37012 ' revisions back means comparison of the edited file with last commited revision).
37016 \begin_layout Standard
37017 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,
37018 numbers always point to the last number in RCS revision number,
37021 We don't currently support GIT addressing of revisions,
37022 one can just compare edited document with its revision X steps backs,
37023 where X is addressed as
37024 \begin_inset Flex Code
37027 \begin_layout Plain Layout
37036 \begin_layout Section
37038 \change_inserted 564990737 1672161575
37039 \begin_inset CommandInset label
37041 name "sec:Literate-Programming"
37047 Literate Programming
37050 \begin_layout Standard
37055 (kayvan@sylvan.com)
37060 original documentation written by
37062 Edmar Wienskoski Jr.
37065 (edmar-w-jr@technologist.com)
37068 \begin_layout Subsection
37072 \begin_layout Standard
37073 The main purpose of this documentation is to show you how to use \SpecialChar LyX
37074 for literate programming,
37075 where it is assumed that you are familiar with this programming technique,
37077 \begin_inset Quotes eld
37081 \begin_inset Quotes erd
37085 \begin_inset Quotes eld
37089 \begin_inset Quotes erd
37093 If that is not the case,
37094 please follow the web links provided in the following sections.
37095 There is a lot of good documentation out there covering old development history to the latest tools tips.
37098 \begin_layout Standard
37099 It is also assumed that you are familiar with \SpecialChar LyX
37100 itself to a point that you are comfortable changing your \SpecialChar LyX
37102 and X resources file.
37103 If that is not the case please refer to other \SpecialChar LyX
37104 documentation to cover your specific needs.
37107 \begin_layout Subsection
37108 Literate Programming
37111 \begin_layout Standard
37112 From the Literate Programming FAQ:
37116 \begin_layout Quotation
37117 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
37119 literate programs should be enjoyable reading,
37122 I couldn't resist!) In general,
37123 literate programs combine source and documentation in a single file.
37124 Literate programming tools then parse the file to produce either readable documentation or compilable source.
37125 The WEB style of literate programming was created by D.
37126 \begin_inset space \thinspace{}
37130 Knuth during the development of his \SpecialChar TeX
37131 typesetting software.
37135 \begin_layout Standard
37136 Another excerpt says:
37139 \begin_layout Quotation
37142 How is literate programming different from verbose commenting?
37145 \begin_layout Quotation
37146 There are three distinguishing characteristics.
37147 In order of importance,
37153 \begin_layout Itemize
37154 flexible order of elaboration
37157 \begin_layout Itemize
37158 automatic support for browsing
37161 \begin_layout Itemize
37162 typeset documentation,
37163 especially diagrams and mathematics
37167 \begin_layout Standard
37168 Now that I sparked your curiosity,
37169 take a look in the references.
37172 \begin_layout Subsubsection
37176 \begin_layout Standard
37177 The complete Literate Programming FAQ can be found at:
37180 \begin_layout Quote
37181 Literate Programming FAQ
37182 \begin_inset Flex URL
37185 \begin_layout Plain Layout
37187 http://www.literateprogramming.com/lpfaq.pdf
37195 \begin_layout Standard
37196 The FAQ lists 23 (twenty three!) different literate programming tools.
37197 Where some are specialized or
37198 \begin_inset Quotes eld
37202 \begin_inset Quotes erd
37205 for particular programming languages,
37206 while other have general scope.
37211 for my own use for several reasons:
37214 \begin_layout Itemize
37215 It can generate the documentation either in \SpecialChar LaTeX
37219 \begin_layout Itemize
37220 It has a open architecture,
37222 \begin_inset space \thinspace{}
37226 \begin_inset space \space{}
37229 it is easy to plug in new filters
37233 \begin_layout Plain Layout
37238 are programs that read a given data stream and output a manipulated data stream.
37240 a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
37246 and to perform special processing that you may need.
37250 \begin_layout Itemize
37251 There is a good selection of filters available already (the HTML is one of them).
37254 \begin_layout Itemize
37258 \begin_layout Standard
37259 The Noweb web page can be found at:
37263 \begin_layout Quote
37265 \begin_inset Flex URL
37268 \begin_layout Plain Layout
37270 https://www.cs.tufts.edu/~nr/noweb/
37278 \begin_layout Standard
37279 Starting from there you can reach many other interesting links and even some literate program examples.
37282 \begin_layout Subsection
37284 and Literate Programming with Noweb
37287 \begin_layout Standard
37288 The \SpecialChar LyX
37289 support for Literate Programming is provided by using the generic \SpecialChar LyX
37290 converters mechanism.
37291 This support is provided in a
37292 \begin_inset Quotes eld
37296 \begin_inset Quotes erd
37301 \begin_inset space \thinspace{}
37305 \begin_inset space \space{}
37308 you will be able to use this new \SpecialChar LyX
37309 feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
37313 \begin_layout Subsubsection
37314 Generating documents and code (weaving and tangling)
37317 \begin_layout Paragraph
37318 Using the noweb module
37321 \begin_layout Standard
37322 If you have installed Noweb and \SpecialChar LyX
37324 whenever you open a new document,
37325 after you have chosen its document class,
37328 Document\SpecialChar menuseparator
37332 \begin_inset Quotes eld
37336 \begin_inset Quotes erd
37340 If Noweb is correctly installed,
37341 when you click on the
37342 \begin_inset Quotes eld
37346 \begin_inset Quotes erd
37351 \begin_inset Quotes eld
37355 \begin_inset Quotes erd
37358 module in the available list and you can add it to your document.
37361 \begin_layout Paragraph
37365 \begin_layout Standard
37367 enables you to write code with a custom inset named
37368 \begin_inset Flex Noun
37371 \begin_layout Plain Layout
37378 Noweb delimits chunks like this:
37381 \begin_layout LyX-Code
37385 \begin_layout LyX-Code
37389 \begin_layout LyX-Code
37393 \begin_layout LyX-Code
37397 \begin_layout LyX-Code
37401 \begin_layout Standard
37402 The problem is that whatever is written in between the << and the
37406 must be taken literally,
37408 \begin_inset space \thinspace{}
37412 \begin_inset space \space{}
37416 should be prevented from making any special interpretation of what has been written.
37417 This is also handled by
37418 \begin_inset Flex Noun
37421 \begin_layout Plain Layout
37428 that works like a normal text inset but has a free spacing capability.
37431 \begin_layout Standard
37433 you can also use the
37434 \begin_inset Quotes eld
37438 \begin_inset Quotes erd
37441 construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
37444 \begin_layout LyX-Code
37448 \begin_layout LyX-Code
37449 def some_function(args):
37452 \begin_layout LyX-Code
37453 "This is the doc string for this function."
37456 \begin_layout LyX-Code
37462 \begin_layout LyX-Code
37463 @ %def some_function
37466 \begin_layout Standard
37467 For an example of this usage and the resulting cross-reference output,
37468 look at the Literate python program in
37470 LIBDIR/examples/listerrors.lyx
37472 which should make this all clear.
37475 \begin_layout Paragraph
37476 Generating the documentation
37479 \begin_layout Standard
37480 At this point you already have a new document file with a proper document class,
37481 and with some code and text on it.
37483 The answer is simple,
37486 View\SpecialChar menuseparator
37491 Just like you would do for a plain document.
37492 No special procedure is required.
37495 \begin_layout Standard
37496 To help orientate you,
37497 I will now explain what happens inside \SpecialChar LyX
37501 \begin_layout Enumerate
37504 Update\SpecialChar menuseparator
37507 menu option is chosen,
37508 a \SpecialChar LaTeX
37514 \begin_layout Standard
37515 If the document is of any literate class the generated file will be named with an extension name defined by the
37516 \begin_inset Quotes eld
37520 \begin_inset Quotes erd
37523 format (defined in the Preferences panel),
37524 otherwise the file will have the usual
37532 \begin_layout Enumerate
37533 Note that the only difference so far is in the name of the file,
37534 no special processing is required by \SpecialChar LyX
37536 Given that you formatted the code using the
37537 \begin_inset Flex Noun
37540 \begin_layout Plain Layout
37548 takes care of the business.
37551 \begin_layout Enumerate
37552 If the document is of any literate class \SpecialChar LyX
37553 will then use the internal \SpecialChar LyX
37554 to Noweb converter,
37555 followed by the Noweb to \SpecialChar LaTeX
37560 \begin_layout Plain Layout
37561 The converters are defined in the
37563 Tools\SpecialChar menuseparator
37568 \begin_inset Quotes eld
37572 \begin_inset Quotes erd
37584 manual for general information about converters.
37589 to generate the \SpecialChar LaTeX
37594 \begin_layout Standard
37595 Otherwise it will just skip this step.
37599 \begin_layout Enumerate
37602 is invoked and the regular post processing continues as in a plain document.
37605 \begin_layout Standard
37606 Independence from a particular
37607 \begin_inset Quotes eld
37611 \begin_inset Quotes erd
37614 is easily achieved by changing the commands that are run by the various converters.
37617 \begin_layout Paragraph
37618 Generating the code
37621 \begin_layout Standard
37622 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
37623 a \SpecialChar LaTeX
37624 file is generated just like step 1 above.
37632 This converter needs to be defined by the user and is not installed by default,
37633 though the Program format is.
37634 This converter (like any other converter) will have two parts:
37637 \begin_layout Enumerate
37638 The converter program itself.
37639 This program performs the conversion from the one format to the other (in this case,
37640 from the Noweb format to the Program pseudo-format).
37643 \begin_layout Enumerate
37644 The error log parser.
37645 This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
37647 This makes it possible for \SpecialChar LyX
37648 to place error boxes in the right places in the file buffer.
37651 \begin_layout Standard
37654 \begin_inset Quotes eld
37658 \begin_inset Quotes erd
37665 \begin_layout LyX-Code
37673 \begin_layout Standard
37674 This basically means that \SpecialChar LyX
37676 \begin_inset Quotes eld
37680 \begin_inset Quotes erd
37683 (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
37684 temp directory) and the directory path of the original \SpecialChar LyX
37689 \begin_layout Standard
37690 This is an implementation of
37691 \begin_inset Quotes eld
37695 \begin_inset Quotes erd
37698 that you can place in a directory on your path:
37701 \begin_layout LyX-Code
37707 \begin_layout LyX-Code
37713 \begin_layout LyX-Code
37716 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
37719 \begin_layout Standard
37720 The next part of the converter setting is the
37721 \begin_inset Quotes eld
37725 \begin_inset Quotes erd
37728 which is to be set to
37731 \begin_layout LyX-Code
37734 parselog=$$s/scripts/listerrors
37737 \begin_layout Standard
37738 This will run any errors that are generated by the
37739 \begin_inset Quotes eld
37743 \begin_inset Quotes erd
37746 process through the
37747 \begin_inset Quotes eld
37751 \begin_inset Quotes erd
37757 \begin_layout Standard
37758 The build will normally take place in \SpecialChar LyX
37759 's temporary directory,
37760 so the files produced by the conversion will be in that directory.
37762 will copy out what it regards as the `main' file,
37767 conversion may produce several files,
37768 and so most of these would then be deleted when \SpecialChar LyX
37770 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.
37773 \begin_layout Paragraph
37774 Build instructions in the document
37777 \begin_layout Standard
37778 The last piece of the integration between \SpecialChar LyX
37780 \begin_inset Quotes eld
37784 \begin_inset Quotes erd
37789 the instructions for building your program should be embedded in a chunk of its own.
37791 \begin_inset Quotes eld
37795 \begin_inset Quotes erd
37798 above uses the notangle command to look for this chunk (called
37799 \begin_inset Quotes eld
37803 \begin_inset Quotes erd
37806 ) and runs its contents through
37807 \begin_inset Quotes eld
37811 \begin_inset Quotes erd
37817 \begin_layout Standard
37819 such a chunk would look something like this:
37822 \begin_layout LyX-Code
37826 \begin_layout LyX-Code
37828 \begin_inset Newline newline
37831 if [ -z "${NOWEB_SOURCE}" ]
37832 \begin_inset Newline newline
37838 \begin_layout LyX-Code
37839 NOWEB_SOURCE=myfile.nw
37840 \begin_inset Newline newline
37844 \begin_inset Newline newline
37848 code to extract files ...
37849 use NOWEB_OUTPUT_DIR here ...]
37850 \begin_inset Newline newline
37854 code to compile files ...]
37855 \begin_inset Newline newline
37861 \begin_layout Standard
37863 \change_deleted 564990737 1672161716
37866 LIBDIR/examples/listerrors.lyx
37870 LIBDIR/examples/Literate.lyx
37871 \change_inserted 564990737 1672161716
37875 File\SpecialChar menuseparator
37876 Open Example\SpecialChar menuseparator
37877 Modules\SpecialChar menuseparator
37883 \change_deleted 564990737 1672161729
37887 \begin_inset Quotes eld
37891 \begin_inset Quotes erd
37894 program for some illustrations of how all of these pieces go together or in
37895 \change_deleted 564990737 1672161756
37898 LIBDIR/examples/noweb2lyx.lyx
37899 \change_inserted 564990737 1672161756
37903 File\SpecialChar menuseparator
37904 Open Example\SpecialChar menuseparator
37905 Modules\SpecialChar menuseparator
37906 Noweb2\SpecialChar LyX
37917 \change_deleted 564990737 1672161767
37920 files show off the language-indepence of the \SpecialChar LyX
37921 literate programming support since they are written in Python
37922 \change_deleted 564990737 1672161782
37926 and Perl respectively.
37929 \begin_layout Subsubsection
37930 Configuring \SpecialChar LyX
37934 \begin_layout Standard
37935 All the Literate Programming support is configured by the
37937 Tools\SpecialChar menuseparator
37941 \begin_inset Quotes eld
37945 \begin_inset Quotes erd
37949 The important parts are:
37952 \begin_layout Description
37954 \begin_inset space ~
37958 \begin_inset Quotes eld
37962 \begin_inset Quotes erd
37966 \begin_inset space ~
37969 format Set up via the File Formats tab,
37970 this is where the Noweb-specific pieces are set up.
37980 the file extension is set to
37985 This tells \SpecialChar LyX
37986 to create a file with a
37990 extension in the first step of the conversion process.
37993 \begin_layout Description
37995 \begin_inset space ~
38003 \begin_inset space ~
38006 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).
38009 \begin_layout Description
38019 This converter performs the
38020 \begin_inset Quotes eld
38024 \begin_inset Quotes erd
38027 of the literate document.
38030 \begin_inset Quotes eld
38035 noweave -delay -index $$i > $$o
38038 \begin_inset Quotes erd
38044 \begin_layout Description
38054 \begin_inset Quotes eld
38058 \begin_inset Quotes erd
38063 the Converter is set to
38064 \begin_inset Quotes eld
38072 \begin_inset Quotes erd
38077 \begin_inset Newline newline
38081 \begin_inset Quotes eld
38086 parselog=$$s/scripts/listerrors
38089 \begin_inset Quotes erd
38095 \begin_layout Subsubsection
38099 \begin_layout Standard
38100 There is also a new function implemented in the \SpecialChar LyX
38103 \begin_inset Quotes eld
38106 server-goto-file-row" function,
38107 to be used with ddd/gdb or other debugger.
38111 \begin_layout Standard
38112 When debugging code with ddd/gdb,
38113 it is possible to invoke a text editor at the current execution position with a single key stroke.
38114 The default ddd configuration for that is shift-ctrl-V.
38115 It happens that you can define the editor command line invocation in ddd by accessing the
38117 Edit\SpecialChar menuseparator
38118 Preferences\SpecialChar menuseparator
38121 dialog and changing the "Edit Sources" entry.
38124 \begin_layout Standard
38125 I take advantage of the newly created \SpecialChar LyX
38126 server function and this ddd feature,
38128 \begin_inset Quotes eld
38132 \begin_inset Quotes erd
38138 \begin_layout LyX-Code
38139 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
38142 \begin_layout Standard
38144 whenever you are using ddd and find a point in the program that you want to edit,
38145 you just press shift-ctrl-V (in the ddd window),
38146 and ddd will forward this information to \SpecialChar LyX
38147 through the \SpecialChar LyX
38148 server and then the \SpecialChar LyX
38149 window will show the same file with the cursor at the same position ddd was pointing to.
38150 No more guessing or long scrolling to locate a point in the program back from debugging !
38153 \begin_layout Standard
38154 Note however that you must enable the \SpecialChar LyX
38155 server to get this feature working (it is disabled by default).
38157 \begin_inset space ~
38161 \begin_inset CommandInset ref
38163 reference "sec:Starting-the-Server"
38168 explains how to do that.
38171 \begin_layout Subsubsection
38175 \begin_layout Standard
38176 There are six new buttons that can be added to your \SpecialChar LyX
38178 Four of these buttons are short cuts to layout styles:
38201 one for the custom inset
38206 The last one is a short cut to the
38207 \begin_inset Quotes eld
38211 \begin_inset Quotes erd
38218 \begin_layout Standard
38220 has a range of buttons that are available for tool bar customization.
38221 In my toolbar I like to combine the six short cuts above with two more:
38226 \SpecialChar menuseparator
38231 \SpecialChar menuseparator
38238 Document\SpecialChar menuseparator
38239 View\SpecialChar menuseparator
38243 Here is how it looks like:
38246 \begin_layout LyX-Code
38250 \begin_layout LyX-Code
38254 \begin_layout LyX-Code
38255 Icon "layout Standard"
38258 \begin_layout LyX-Code
38259 Icon "layout Section"
38262 \begin_layout LyX-Code
38263 Icon "layout \SpecialChar LaTeX
38267 \begin_layout LyX-Code
38268 Icon "layout \SpecialChar LyX
38272 \begin_layout LyX-Code
38273 Icon "flex.insert Chunk"
38276 \begin_layout LyX-Code
38280 \begin_layout LyX-Code
38284 \begin_layout LyX-Code
38285 Icon "buffer-typeset"
38288 \begin_layout LyX-Code
38289 Icon "build-program"
38292 \begin_layout LyX-Code
38296 \begin_layout LyX-Code
38300 \begin_layout LyX-Code
38304 \begin_layout LyX-Code
38308 \begin_layout LyX-Code
38312 \begin_layout Subsubsection
38313 Colors customization
38316 \begin_layout Standard
38317 There are a number of colors in \SpecialChar LyX
38318 that can be customized in
38323 One of the things that bothers people is the \SpecialChar LaTeX
38325 The default color is red,
38326 since the chunks uses \SpecialChar LaTeX
38328 and there is a lot of chunks in literate documents,
38329 you may get tired of seeing everything in red.
38330 You can change it by going to the tabs
38340 \begin_layout Standard
38341 The next thing is the visible presence of the newline character in the screen.
38342 You can choose the color of this particular character and make it blend in the background.
38343 I recommend you choosing a color that is close to the background but not equal,
38344 that way you still can see it is there,
38345 but it is not bothering you anymore.
38348 \begin_layout Subsection
38353 \begin_layout Standard
38363 \change_inserted 564990737 1672161863
38366 Help\SpecialChar menuseparator
38367 Specific Manuals\SpecialChar menuseparator
38373 \change_deleted 564990737 1671643409
38379 \change_inserted 564990737 1672161856
38382 File\SpecialChar menuseparator
38383 Open Example\SpecialChar menuseparator
38384 Modules\SpecialChar menuseparator
38390 \change_deleted 564990737 1671643461
38391 the Sweave manual (menu
38393 Help\SpecialChar menuseparator
38397 \change_inserted 564990737 1672161856
38400 Help\SpecialChar menuseparator
38401 Specific Manuals\SpecialChar menuseparator
38403 \change_deleted 564990737 1672161921
38408 \change_inserted 564990737 1672161917
38411 File\SpecialChar menuseparator
38412 Open Example\SpecialChar menuseparator
38413 Modules\SpecialChar menuseparator
38417 \change_deleted 564990737 1672742969
38421 \begin_layout Standard
38423 \change_deleted 564990737 1671355343
38427 \begin_layout Standard
38429 \change_deleted 564990737 1671355343
38430 You can do everything with \SpecialChar LyX
38431 that you can do with \SpecialChar LaTeX
38435 cannot support every \SpecialChar LaTeX
38437 But you can always use \SpecialChar TeX
38439 This chapter shows you some more special things you might want to use.
38440 For other special things you can do with figures,
38447 \begin_inset space ~