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
2922 and the \SpecialChar LyX
2926 \change_deleted 564990737 1672345297
2929 AMS \SpecialChar LaTeX
2933 \begin_layout Standard
2935 \change_deleted 564990737 1672345297
2943 Richard Kimberly Heck
2948 \begin_layout Standard
2949 \begin_inset VSpace bigskip
2955 \begin_layout Standard
2957 The AMS \SpecialChar LaTeX
2958 layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
2959 The layouts are not tailored to a specific journal,
2961 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
2963 That documentation is available on the Web at
2964 \begin_inset Flex URL
2967 \begin_layout Plain Layout
2975 \begin_inset Flex URL
2978 \begin_layout Plain Layout
2980 ftp://ftp.ams.org/pub/tex/amslatex/
2986 These layouts are appropriate,
2988 for any mathematical writing.
2992 \begin_layout Standard
2993 There are two basic AMS \SpecialChar LaTeX
2998 \begin_layout Itemize
3000 The standard AMS article format
3001 \change_inserted 564990737 1672345333
3005 File\SpecialChar menuseparator
3006 Open Example\SpecialChar menuseparator
3007 Articles\SpecialChar menuseparator
3008 American Mathematical Society (AMS)
3015 \begin_layout Itemize
3017 the standard AMS book (really,
3019 \change_inserted 564990737 1672345366
3023 File\SpecialChar menuseparator
3024 Open Example\SpecialChar menuseparator
3025 Books\SpecialChar menuseparator
3026 American Mathematical Society (AMS)
3031 \change_inserted 564990737 1672345369
3035 \begin_layout Itemize
3037 \change_inserted 564990737 1672345383
3043 the standard AMS proceedings format.
3046 \begin_layout Standard
3048 \change_inserted 564990737 1672345383
3050 only supports the first two natively;
3053 Installing New Document Classes
3059 manual if you want to use
3066 \begin_layout Standard
3067 The layouts themselves contain only the minimum necessary to use the AMS classes.
3070 contain any of the `theorem' environments used for setting theorems,
3073 These are contained,
3076 \change_deleted 564990737 1672345416
3078 \begin_inset Flex Code
3081 \begin_layout Plain Layout
3088 \change_inserted 564990737 1672345416
3096 which is loaded by default when you select one of the AMS classes.
3097 (It can also be used with other classes and can be removed,
3098 if you would rather use something else.) Less commonly used environments are in the
3099 \change_deleted 564990737 1672345436
3101 \begin_inset Flex Code
3104 \begin_layout Plain Layout
3105 Theorems (AMS-Extended)
3111 \change_inserted 564990737 1672345436
3114 AMS Theorems (Extended)
3119 which must be loaded manually.
3122 \begin_layout Standard
3124 theorems and the like are numbered consecutively throughout the document,
3125 but this may be modified by loading the module
3126 \change_deleted 564990737 1672345461
3128 \begin_inset Flex Code
3131 \begin_layout Plain Layout
3132 Theorems (Order by Section)
3138 \change_inserted 564990737 1672345461
3141 Standard Theorems (Numbered by Section)
3147 \begin_inset Flex Code
3150 \begin_layout Plain Layout
3158 \change_deleted 564990737 1672345479
3160 \begin_inset Flex Code
3163 \begin_layout Plain Layout
3164 Theorems (Order by Chapter)
3170 \change_inserted 564990737 1672345480
3173 Standard Theorems (Numbered by Chapter)
3178 These will number the results as
3179 \begin_inset Formula $n.m$
3183 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).
3184 Many environments are also available unnumbered.
3185 These are indicated by an asterisk at the end.
3186 If you happen to want
3192 \change_deleted 564990737 1672345498
3194 \begin_inset Flex Code
3197 \begin_layout Plain Layout
3204 \change_inserted 564990737 1672345498
3207 Standard Theorems (Unnumbered)
3211 provides that option.
3214 \begin_layout Standard
3215 Note that these modules do not
3219 to be used with the AMS classes.
3220 It is perfectly possible to use the
3221 \change_deleted 564990737 1672345520
3223 \begin_inset Flex Code
3226 \begin_layout Plain Layout
3233 \change_inserted 564990737 1672345520
3241 and the others mentioned,
3244 \begin_inset Flex Code
3247 \begin_layout Plain Layout
3255 \begin_inset Flex Code
3258 \begin_layout Plain Layout
3266 \begin_inset Flex Code
3269 \begin_layout Plain Layout
3279 \begin_layout Subsubsection
3280 What these layouts provide
3283 \begin_layout Standard
3284 There is a long list of included environments provided by these layouts.
3285 In AMS-\SpecialChar LaTeX
3289 an opportunity to define an unlimited variety of `theorem' environments.
3291 the AMS recommends the environments that are available in \SpecialChar LyX
3296 \begin_layout Standard
3297 The following environments—
3298 as well as the standard environments,
3300 \begin_inset Flex Noun
3303 \begin_layout Plain Layout
3311 \begin_inset Flex Noun
3314 \begin_layout Plain Layout
3322 \begin_inset Flex Noun
3325 \begin_layout Plain Layout
3333 \begin_inset Flex Noun
3336 \begin_layout Plain Layout
3344 \begin_inset Flex Noun
3347 \begin_layout Plain Layout
3355 \begin_inset Flex Code
3358 \begin_layout Plain Layout
3365 \begin_inset Flex Code
3368 \begin_layout Plain Layout
3377 \begin_layout Description
3378 Address This should be the author's permanent address.
3381 \begin_layout Description
3383 \begin_inset space ~
3386 Address This should be the author's temporary address at the time of submission,
3387 if different from the Address.
3390 \begin_layout Description
3391 Email Author's e-mail address
3394 \begin_layout Description
3395 URL Author's Web address,
3399 \begin_layout Description
3400 Keywords Key words or phrases used to identify specific topics discussed in the paper.
3403 \begin_layout Description
3404 Subjectclass These refer to the AMS Subject Classifications,
3405 published and described in
3407 Mathematical Reviews
3410 These are also available online at the AMS cites listed above.
3413 \begin_layout Description
3417 \begin_layout Description
3421 \begin_layout Description
3425 \begin_layout Standard
3426 The following environments are provided by both the
3427 \change_deleted 564990737 1672345566
3429 \begin_inset Flex Code
3432 \begin_layout Plain Layout
3439 \change_inserted 564990737 1672345566
3447 \change_deleted 564990737 1672345580
3449 \begin_inset Flex Code
3452 \begin_layout Plain Layout
3459 \change_inserted 564990737 1672345580
3467 in the latter case in both starred (unnumbered) and unstarred (numbered) versions.
3468 These same environments are provided only in the starred versions by the
3469 \change_deleted 564990737 1672345596
3471 \begin_inset Flex Code
3474 \begin_layout Plain Layout
3481 \change_inserted 564990737 1672345596
3491 \begin_layout Theorem
3492 This is typically used for the statements of major results.
3496 \begin_layout Corollary*
3497 This is used for statements which follow fairly directly from previous statements.
3499 these can be major results.
3504 These are smaller results needed to prove other statements.
3507 \begin_layout Proposition
3508 These are less major results which (hopefully) add to the general theory being discussed.
3511 \begin_layout Conjecture
3512 These are statements provided without justification,
3513 which the author does not know how to prove,
3514 but which seem to be true (to the author,
3518 \begin_layout Definition*
3519 Guess what this is for.
3520 The font is different for this environment than for the previous ones.
3524 \begin_layout Example*
3525 Used for examples illustrating proven results.
3528 \begin_layout Problem
3529 It's not really known what this is for.
3530 You should figure it out.
3533 \begin_layout Exercise*
3534 Write a description for this one.
3537 \begin_layout Remark
3538 This environment is also a type of theorem,
3539 usually a lesser sort of observation.
3542 \begin_layout Claim*
3543 Often used in the course of giving a proof of a larger result.
3548 these are used to break up long arguments,
3549 using specific instances of some condition.
3554 The numbering scheme for cases is on its own,
3555 not together with other numbered statements.
3560 At the end of this environment,
3561 a QED symbol (usually a square,
3562 but it can vary with different styles) is placed.
3563 If you want to have other environments within this one—
3566 and have the QED symbol appear only after them,
3567 then the other environments need to be nested within the proof environment.
3570 Nesting Environments
3576 for information on nesting.
3581 \change_inserted 564990737 1672345651
3582 Used in a way similar to Proposition,
3583 though perhaps lower on the scale.
3586 \begin_layout Standard
3587 And these environments are provided by
3588 \change_deleted 564990737 1672345684
3590 \begin_inset Flex Code
3593 \begin_layout Plain Layout
3594 Theorems (AMS-Extended)
3600 \change_inserted 564990737 1672345689
3603 AMS Theorems (Extended
3610 \begin_layout Criterion*
3611 A required condition.
3614 \begin_layout Algorithm*
3615 A general procedure to be used.
3618 \begin_layout Axiom*
3619 This is a property or statement taken as true within the system being discussed.
3622 \begin_layout Condition*
3623 Sometimes used to state a condition assumed within the present context of discussion.
3627 Similar to a Remark.
3630 \begin_layout Notation*
3631 Used for the explanation of,
3636 \begin_layout Summary
3637 Do we really need to tell you?
3641 \begin_layout Acknowledgement*
3645 \begin_layout Conclusion*
3646 Sometimes used at the end of a long train of argument.
3647 \change_deleted 564990737 1672345729
3653 \change_deleted 564990737 1672345638
3654 Used in a way similar to Proposition,
3655 though perhaps lower on the scale.
3656 \change_inserted 564990737 1672345720
3660 \begin_layout Assumption*
3662 \change_inserted 564990737 1672345721
3666 \begin_layout Question*
3668 \change_inserted 564990737 1672345721
3672 \begin_layout Standard
3674 \change_inserted 564990737 1672345721
3675 There are ten more Maths modules available including several offering options ordered on
3677 (Numbered by Type \SpecialChar ldots
3685 \begin_layout Standard
3687 the AMS classes automatically provide the AMS \SpecialChar LaTeX
3688 and AMS fonts packages.
3689 They need to be available on your system in order to use these environments.
3692 \begin_layout Subsection
3694 \change_inserted 564990737 1671383236
3695 \begin_inset CommandInset label
3697 name "subsec:Extra-font-sizes"
3704 \begin_layout Standard
3706 \change_inserted 564990737 1671383236
3707 The “Extra font sizes” collection provides the document classes
3710 \begin_inset space \thinspace{}
3713 (with extra font sizes)
3719 \begin_inset space \thinspace{}
3722 (with extra font sizes)
3728 \begin_inset space \thinspace{}
3731 (with extra font sizes)
3736 \begin_inset space \thinspace{}
3739 (with extra font sizes)
3759 document classes respectively but offer the additional
3765 \begin_inset space ~
3778 ocument\SpecialChar menuseparator
3783 ettings\SpecialChar menuseparator
3789 \begin_layout Subsection
3791 \change_inserted 564990737 1671383236
3795 \begin_layout Standard
3797 \change_inserted 564990737 1671383236
3798 The document classes
3801 \begin_inset space \thinspace{}
3809 \begin_inset space \thinspace{}
3824 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3828 \begin_layout Subsection
3830 \change_inserted 564990737 1671383236
3831 \begin_inset CommandInset label
3833 name "subsec:Japanese"
3840 \begin_layout Standard
3842 \change_inserted 564990737 1671383236
3843 The document classes
3846 \begin_inset space \thinspace{}
3855 \begin_inset space \thinspace{}
3858 (Japanese Standard Class Vertical Writing)
3864 \begin_inset space \thinspace{}
3867 (Japanese Standard Class)
3873 \begin_inset space \thinspace{}
3882 \begin_inset space \thinspace{}
3885 (Japanese Standard Class Vertical Writing)
3891 \begin_inset space \thinspace{}
3894 (Japanese Standard Class)
3900 \begin_inset space \thinspace{}
3903 (Japanese Vertical Writing)
3908 \begin_inset space \thinspace{}
3911 (Japanese Standard Class)
3913 provide document classes for the Japanese language.
3916 \begin_layout Subsection
3918 \change_inserted 564990737 1672429136
3919 \begin_inset CommandInset label
3921 name "subsec:KOMA-Script"
3928 \begin_layout Standard
3930 \change_inserted 564990737 1672429136
3940 and the \SpecialChar LyX
3942 \change_deleted 564990737 1672429136
3946 \begin_layout Standard
3948 \change_deleted 564990737 1672429136
3956 \begin_layout Subsubsection
3958 \change_inserted 564990737 1672429161
3962 \begin_layout Standard
3964 \change_inserted 564990737 1672429162
3965 The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
3966 it was formally launched with the addition of a letter class in 1994.
3968 a second letter class has been added.
3969 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.
3975 \begin_layout Standard
3976 The \SpecialChar LyX
3979 article (koma-script)
3984 report (koma-script)
4004 correspond to the \SpecialChar LaTeX
4026 \begin_inset space ~
4029 of the Koma-Script family.
4030 They are replacements for the standard document classes
4050 and fit better to European typography conventions in a number of points.
4053 \begin_layout Itemize
4055 \change_deleted 564990737 1672429262
4056 Standard character size is
4057 \change_inserted 564990737 1672429263
4058 The base character sizes when you select a KOMA-Script class are
4062 article (koma-script)
4067 report (koma-script)
4073 \change_deleted 564990737 1672429267
4081 letter (koma-script)
4086 \begin_layout Itemize
4088 labels of the description environment,
4089 and a number of elements of the
4091 letter (koma-script)
4093 document class are set in a bold sans serif font.
4097 \begin_layout Plain Layout
4098 There is a big difference between the bold sans serif old cm fonts and new ec fonts,
4099 especially in the appearance of headings.
4101 the ec bold sans serif fonts look a bit thin.
4102 Here the \SpecialChar LaTeX
4111 helps to produce the
4112 \begin_inset Quotes eld
4116 \begin_inset Quotes erd
4119 appearance when using the ec fonts.
4124 The numbering of chapter headings is made in the same way as the numbering of section headings,
4125 that is without the extra line
4126 \begin_inset Quotes eld
4129 Chapter\SpecialChar ldots
4131 \begin_inset Quotes erd
4136 the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
4137 to be entered in the field
4140 \begin_inset space ~
4147 Layout\SpecialChar menuseparator
4154 \begin_layout Itemize
4156 \change_deleted 564990737 1672429310
4157 The main means in the Koma-Script document classes to design the type area are the options
4165 (in \SpecialChar LyX
4166 to be entered in the extra class options field in the dialog
4168 Document\SpecialChar menuseparator
4172 They make a clearer modification of page margins possible as do the options of the dialog
4174 Document\SpecialChar menuseparator
4179 \change_inserted 564990737 1672429310
4180 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.
4181 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.
4182 You can change the sizes of the margins by changing the factor by which the page is divided into strips;
4183 the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
4188 \begin_layout Standard
4190 \change_inserted 564990737 1672429310
4191 Whatever the factor,
4192 two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
4193 leaving a text area occupying around half the page.
4194 Since most two-sided documents have a binding,
4195 this can make the inner margins appear too narrow;
4196 so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
4200 \begin_layout Standard
4202 \change_inserted 564990737 1672429310
4203 The main means in the Koma-Script document classes to design the type area are the options
4213 Document\SpecialChar menuseparator
4214 Settings\SpecialChar menuseparator
4215 Document Class\SpecialChar menuseparator
4216 Class Options\SpecialChar menuseparator
4223 \begin_layout Standard
4225 \change_inserted 564990737 1672429310
4227 the binding correction is 7.5mm which is added in the form
4234 \begin_inset space ~
4237 options\SpecialChar menuseparator
4245 To change the factor to 11,
4251 to the comma separated list of entries in the
4262 \begin_inset space ~
4268 If you want the default value of this factor for a page size other than A4,
4276 \begin_layout Standard
4278 \change_inserted 564990737 1672429310
4279 To use the circle method of calculating the page layout,
4290 \begin_layout Itemize
4291 The \SpecialChar LaTeX
4292 document classes of the Koma-Script family define a number of additional commands.
4293 Those part of it which makes sense in \SpecialChar LyX
4294 is implemented in corresponding paragraph types.
4297 \begin_layout Standard
4298 Detailed descriptions of the \SpecialChar LaTeX
4299 document classes of the Koma-Script family can be found in the Koma-Script documentation
4310 \begin_layout Subsubsection
4312 \change_inserted 564990737 1672429358
4315 \begin_inset CommandInset label
4317 name "subsec:article-(KOMA-Script),-report"
4323 article (KOMA-Script),
4324 report (KOMA-Script),
4325 and book (KOMA-Script)
4326 \change_deleted 564990737 1672429367
4327 article (koma-script),
4328 report (koma-script),
4329 and book (koma-script)
4334 \begin_layout Standard
4335 The document classes
4337 article (koma-script)
4342 report (koma-script)
4353 are implemented in the layout files
4369 They contain all the paragraph types of the corresponding standard document classes
4386 with the exception of the \SpecialChar LyX
4392 which is replaced by the new
4396 -type having the same functionality.
4401 -Type there is a number of new paragraph types added.
4408 letter (koma-script)
4413 \begin_layout Itemize
4436 additionally inserting an entry in the table of contents.
4445 are not contained in
4447 article (koma-script)
4452 \begin_layout Itemize
4473 additionally clearing running heads.
4480 article (koma-script)
4486 \begin_layout Plain Layout
4499 report (koma-script)
4502 but since this is identical to
4507 is has not been implemented in \SpecialChar LyX
4516 \begin_layout Itemize
4522 generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
4525 \begin_layout Itemize
4534 are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
4535 you might want to place table captions always above the table).
4536 You can also use the class option
4554 You need at least Koma-Script version 2.8q to use this.
4557 \begin_layout Itemize
4563 can be used to set a bonmot,
4565 \begin_inset space \thinspace{}
4569 \begin_inset space \space{}
4572 at the beginning of a chapter.
4573 If you use the optional argument (
4575 Insert\SpecialChar menuseparator
4577 \begin_inset space ~
4583 you can insert the dictum's author there.
4584 Dictum and author are separated by a line.
4585 You need at least Koma-Script version 2.8q to use this.
4592 article (koma-script)
4597 \begin_layout Standard
4598 The following types,
4599 together with the standard types
4614 form the title area of the document.
4615 They must be entered ahead of the first
4616 \begin_inset Quotes eld
4620 \begin_inset Quotes erd
4627 \begin_layout Plain Layout
4628 The corresponding \SpecialChar LaTeX
4629 commands must appear before the
4640 When such a type is used more than once,
4641 the latter usage overwrites the former one,
4643 for every type only the latest usage is valid.
4644 The order of the different types however has,
4660 no effect on the appearance of the produced document.
4663 \begin_layout Itemize
4669 produces a centered paragraph above the ordinary title (
4683 ) for the subject of the document.
4686 \begin_layout Itemize
4692 produces a centered paragraph below the ordinary title (
4706 ) for the publishers' name.
4709 \begin_layout Itemize
4717 report (koma-script)
4723 produces a centered paragraph on its own page behind the title page,
4726 article (koma-script)
4728 produces a centered paragraph below the ordinary title (
4750 \begin_layout Itemize
4756 produces a left aligned paragraph above the ordinary title (
4775 ) for a document`s head.
4778 \begin_layout Itemize
4784 produces in a double-sided print in
4786 report (koma-script)
4792 a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
4794 article (koma-script)
4799 \begin_layout Itemize
4805 produces in a double-sided print in
4807 report (koma-script)
4813 a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
4815 article (koma-script)
4820 \begin_layout Itemize
4827 \begin_inset Quotes eld
4831 \begin_inset Quotes erd
4834 page ahead of the actual document containing a paragraph without special formatting.
4837 \begin_layout Standard
4839 \change_inserted 564990737 1672429680
4840 KOMA-Script offers a wide range of
4847 \begin_inset space ~
4857 ocument\SpecialChar menuseparator
4862 ettings\SpecialChar menuseparator
4864 \begin_inset space ~
4869 dialog which you can apply to the whole document,
4873 \begin_layout Description
4875 \change_inserted 564990737 1672429680
4882 which produces a PDF with a small black box at the end any line in which a formatting error occurs;
4883 the default setting is
4888 \begin_layout Description
4890 \change_inserted 564990737 1672429680
4897 which may take the values
4911 the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
4914 \begin_layout Description
4916 \change_inserted 564990737 1672429680
4923 which may take the values
4937 the first leaves it up to KOMA-Script to add periods after chapter,
4940 the second forces the addition of periods and third suppresses them
4943 \begin_layout Standard
4945 \change_inserted 564990737 1672429680
4946 and the math options:
4949 \begin_layout Description
4951 \change_inserted 564990737 1672429680
4958 which causes equations to be numbered on the left rather than on the right,
4962 \begin_layout Description
4964 \change_inserted 564990737 1672429680
4971 which causes equations to be left justified rather than centered.
4974 \begin_layout Standard
4976 \change_inserted 564990737 1672429680
4977 It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
4978 commands and packages;
4980 if you want your captions in bold add
4983 \begin_layout Standard
4985 \change_inserted 564990737 1672429680
4990 setkomafont{captionlabel}{
4995 \begin_layout Standard
4997 \change_inserted 564990737 1672429680
5003 ocument\SpecialChar menuseparator
5010 \SpecialChar menuseparator
5015 \begin_inset space ~
5020 ) and the problem is solved.
5023 \begin_layout Standard
5025 \change_inserted 564990737 1672429680
5026 If you are writing a book,
5027 it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
5028 If you use the Chapter* environment,
5029 your Foreword and Preface will not appear in the Table of Contents;
5030 to make them to appear in the Table of contents,
5031 you need to use Chapter environments and add the \SpecialChar TeX
5035 \begin_layout Standard
5037 \change_inserted 564990737 1672429680
5045 \begin_layout Standard
5047 \change_inserted 564990737 1672429680
5048 at the very start of the book (not in the \SpecialChar LaTeX
5052 \begin_layout Standard
5054 \change_inserted 564990737 1672429680
5062 \begin_layout Standard
5064 \change_inserted 564990737 1672429680
5065 before the first chapter of the body of the text.
5066 You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
5071 \begin_layout Plain Layout
5073 \change_inserted 564990737 1672429680
5074 Appendices are normally “numbered” with letters.
5079 If you use the Chapter* environment,
5080 they will not appear in the Table of Contents;
5081 so add the \SpecialChar TeX
5085 \begin_layout Standard
5087 \change_inserted 564990737 1672429680
5095 \begin_layout Standard
5097 \change_inserted 564990737 1672429682
5098 before the first of these headings and use the Chapter environment.
5099 These commands will have no effect on the numbering in \SpecialChar LyX
5101 only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
5104 \begin_layout Standard
5105 The layout files for the document classes
5107 article (koma-script)
5112 report (koma-script)
5124 This is thought of as a place to define your own types.
5129 in your personal layout directory and edit the file!
5130 \change_deleted 564990737 1672430255
5134 \begin_layout Standard
5136 \change_deleted 564990737 1672430255
5137 letter (koma-script)
5140 \begin_layout Description
5142 \change_deleted 564990737 1672429749
5144 This section discusses the obsolete
5146 KOMA-Script-Letter (v.
5147 \begin_inset space ~
5153 which is not even included anymore in recent KOMA releases.
5154 Please refer to the next section for the current KOMA-Script-Letter class (v.
5155 \begin_inset space ~
5161 \begin_layout Standard
5164 \change_deleted 564990737 1672429749
5167 letter (koma-script)
5169 is implemented in the layout file
5174 It contains all the paragraph types of the corresponding standard document class
5180 with the exception of the \SpecialChar LyX
5195 which is replaced by the new
5202 in contrast to the standard document class,
5225 there are a number of new letter specific types.
5228 \begin_layout Standard
5230 \change_deleted 564990737 1672429749
5231 The appearance of the letter produced by this document class can be controlled by a number of \SpecialChar LaTeX
5233 which you can put in the \SpecialChar LaTeX
5238 \begin_layout Plain Layout
5240 the standard appearance of the letter`s heading,
5241 consisting of name and address,
5242 is quite self-willed.
5244 \begin_inset Quotes eld
5248 \begin_inset Quotes erd
5251 heading is produced by the following \SpecialChar LaTeX
5252 commands in the preamble:
5255 \begin_layout LyX-Code
5265 \begin_layout LyX-Code
5281 \begin_layout LyX-Code
5291 \begin_layout LyX-Code
5311 A detailed German description of such \SpecialChar LaTeX
5312 commands can be found in the Koma-Script documentation
5318 the letter's author can produce his personal letter layout.
5321 \begin_layout Standard
5323 \change_deleted 564990737 1672429749
5332 define the beginning of the letter and must be used in every letter.
5333 To emphasize them in the \SpecialChar LyX
5335 they are marked with the letter
5345 \begin_inset space ~
5349 It is possible to write any number of letters in one file.
5354 type produces a new letter using the same addressee and a
5358 type produces a new addressee.
5378 are ordinary paragraph types and can also be used several times in one and the same letter.
5381 \begin_layout Itemize
5383 \change_deleted 564990737 1672429749
5389 produces a paragraph for the addressee and implicitly defines the beginning of the letter.
5392 \begin_layout Itemize
5394 \change_deleted 564990737 1672429749
5400 produces a paragraph for the form of address and implicitly produces a new letter.
5403 \begin_layout Itemize
5405 \change_deleted 564990737 1672429749
5411 produces a paragraph for a close.
5414 \begin_layout Itemize
5416 \change_deleted 564990737 1672429749
5422 produces a paragraph for a postscript.
5425 \begin_layout Itemize
5427 \change_deleted 564990737 1672429749
5433 produces a paragraph for a distribution list.
5436 \begin_layout Itemize
5438 \change_deleted 564990737 1672429749
5444 produces a paragraph for enclosures.
5447 \begin_layout Standard
5449 \change_deleted 564990737 1672429749
5499 are input types provided with a label to enter information,
5500 which will be processed by the document class.
5504 \begin_layout Plain Layout
5505 It could be seen as a matter of inconsequence,
5514 described above are not such input types as well.
5515 Because of the special meaning of those types,
5517 I have implemented them as ordinary paragraph types with a one letter mark in the left margin.
5519 it would affect my feeling of symmetry,
5528 type had such a serious different appearance.
5533 The types must be used ahead of the corresponding
5540 \begin_layout Standard
5542 \change_deleted 564990737 1672429749
5543 An implementation of these types in a WYSIWYG fashion does not seem to make sense,
5544 because the real appearance of the produced letter does not only depend on the usage of the particular type,
5545 but also on other factors.
5547 a signature entered in the
5551 type will in the standard behavior appear in the produced letter only,
5552 when in the same letter also a
5557 The entered value of the
5561 type will in the standard behavior not appear in the produced letter at all.
5562 The possibility to design the letter`s heading freely is already indicated in a footnote above.
5565 \begin_layout Standard
5567 \change_deleted 564990737 1672429749
5568 The input types can also be used as empty paragraphs.
5570 \begin_inset space \thinspace{}
5574 \begin_inset space \space{}
5586 type is not used at all,
5587 in the standard behavior the value of the
5591 type is used as signature,
5597 no signature value is defined.
5600 \begin_layout Standard
5602 \change_deleted 564990737 1672429749
5603 By using the input types it is possible to write a letter template,
5604 containing filled input types with your personal dates (name,
5606 etc.) and empty input types for other dates you want to enter.
5609 \begin_layout Itemize
5611 \change_deleted 564990737 1672429749
5618 in the standard behavior appears as a centered paragraph in small caps in the letter`s heading.
5621 \begin_layout Itemize
5623 \change_deleted 564990737 1672429749
5630 in the standard behavior appears below the
5644 type appears instead.
5647 \begin_layout Itemize
5649 \change_deleted 564990737 1672429749
5656 in the standard behavior appears in a centered paragraph in the letter`s heading below the sender's name.
5659 \begin_layout Itemize
5661 \change_deleted 564990737 1672429749
5667 sender's telephone number,
5668 in the standard behavior only sets the \SpecialChar LaTeX
5678 \begin_layout Itemize
5680 \change_deleted 564990737 1672429749
5686 place of the letter`s making.
5689 \begin_layout Itemize
5691 \change_deleted 564990737 1672429749
5697 date of the letter`s making.
5707 in the standard behavior,
5708 produce the place and the date in a right-aligned line below the addressee's field.
5714 neither place nor date appear,
5715 independent of the value of the
5725 the date of the letter `s production is used.
5728 \begin_layout Itemize
5730 \change_deleted 564990737 1672429749
5736 sender`s back address,
5737 in the standard behavior appears above the addressee's field in a small sans serif font.
5740 \begin_layout Itemize
5742 \change_deleted 564990737 1672429749
5748 special mail information,
5749 in the standard behavior appears underlined above the addressee's field below the back address.
5752 \begin_layout Itemize
5754 \change_deleted 564990737 1672429749
5760 additional information,
5761 in the standard behavior appears on right side below the addressee`s field.
5764 \begin_layout Itemize
5766 \change_deleted 564990737 1672429749
5773 in the standard behavior appears in a big,
5775 sans serif font above the subject.
5778 \begin_layout Itemize
5780 \change_deleted 564990737 1672429749
5786 the letter's subject,
5787 in the standard behavior appears in a bold font above the
5794 \begin_layout Standard
5796 \change_deleted 564990737 1672429749
5821 produce a business letter like line above the
5825 line containing the fields
5826 \begin_inset Quotes eld
5830 \begin_inset Quotes erd
5835 \begin_inset Quotes eld
5839 \begin_inset Quotes erd
5844 \begin_inset Quotes eld
5848 \begin_inset Quotes erd
5853 \begin_inset Quotes eld
5857 \begin_inset Quotes erd
5862 \begin_inset Quotes eld
5866 \begin_inset Quotes erd
5871 \begin_inset Quotes eld
5875 \begin_inset Quotes erd
5886 \begin_inset Quotes eld
5889 business letter types
5890 \begin_inset Quotes erd
5898 type however does not appear,
5899 but only the \SpecialChar LaTeX
5907 The ordinary output of place and date in a right-aligned line below the addressee`s field is suppressed.
5908 The types are implemented as input types provided with a label and must be used ahead of the corresponding
5915 \begin_layout Itemize
5917 \change_deleted 564990737 1672429749
5926 \begin_layout Itemize
5928 \change_deleted 564990737 1672429749
5937 \begin_layout Itemize
5939 \change_deleted 564990737 1672429749
5948 \begin_layout Itemize
5950 \change_deleted 564990737 1672429749
5959 \begin_layout Itemize
5961 \change_deleted 564990737 1672429749
5972 \begin_layout Subsubsection
5974 \change_deleted 564990737 1672429773
5975 The new letter class:
5976 letter (koma-script v.2)
5977 \change_inserted 564990737 1672429774
5979 \begin_inset CommandInset label
5981 name "subsec:The-new-letter"
5985 The new letter class:
5986 letter (KOMA-Script v.2)
5991 \begin_layout Standard
5997 \begin_layout Standard
5998 \begin_inset VSpace medskip
6004 \begin_layout Standard
6006 Koma-Script version 2.8 has introduced a new letter class
6010 which supersedes the now unsupported
6016 on the \SpecialChar LaTeX
6018 a completely new interface and is not compatible with the old class.
6022 though it is recommended you use the new class.
6025 \begin_layout Standard
6026 This class covers the same functionality as
6028 letter (koma-script),
6036 (receiver's address,
6056 will start a new letter (i.
6057 \begin_inset space \thinspace{}
6061 \begin_inset space \space{}
6064 you can write several letters per document).
6065 New elements are sender's
6084 and the possibility to use a
6090 Insert\SpecialChar menuseparator
6096 \begin_layout Standard
6097 The biggest improvement is,
6099 that the letter's layout is configurable to meet almost any needs.
6100 This can be done via the preamble or with a special style file (Letter Class Option,
6106 that will be read in as a class option.
6110 \begin_layout Plain Layout
6111 The KOMA package comes with some default
6122 file that follows german typesetting rules,
6127 that provides the default layout of the old
6132 The latter can be loaded with the class option
6139 Layout\SpecialChar menuseparator
6140 Document\SpecialChar menuseparator
6149 \change_deleted 564990737 1671617922
6157 \change_deleted 564990737 1671617938
6158 that is included in \SpecialChar LyX
6160 \change_inserted 564990737 1671617997
6166 ile\SpecialChar menuseparator
6168 \begin_inset space ~
6176 \begin_inset space ~
6179 Template\SpecialChar menuseparator
6180 Letters\SpecialChar menuseparator
6181 KOMA-Script Letter (V.2)
6186 A detailed description is to be found in the Koma-Script documentation (
6193 \begin_layout Subsubsection
6197 \begin_layout Standard
6198 Visualizing the Koma-Script document classes in \SpecialChar LyX
6200 the \SpecialChar LyX
6201 internals cause some problems.
6204 \begin_layout Itemize
6205 The chapter number of a
6209 type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
6210 The cause for that is the \SpecialChar LyX
6211 internal behavior for the labeltype
6218 \begin_layout Itemize
6219 The headings of the types
6228 \begin_inset Quotes eld
6232 \begin_inset Quotes erd
6237 but not in the \SpecialChar LyX
6240 Document\SpecialChar menuseparator
6242 \begin_inset space ~
6246 \begin_inset space ~
6254 \begin_layout Itemize
6259 document class appear in a skip separation mode,
6261 This is the standard behavior,
6262 no special \SpecialChar LaTeX
6263 commands are needed for that.
6266 Document\SpecialChar menuseparator
6269 dialog the corresponding radio button indicates
6278 value always has the effect that extra \SpecialChar LaTeX
6279 commands are inserted in the document to produce the gap,
6280 which is not what is wanted in this case.
6283 \begin_layout Subsection
6285 \change_inserted 564990737 1672743555
6286 \begin_inset CommandInset label
6288 name "subsec:Polish-M.W.collection"
6293 \begin_inset space \thinspace{}
6297 \begin_inset space \space{}
6301 \change_deleted 564990737 1670924933
6303 book (mwbk) and report (mwrep)
6304 \begin_inset Argument status
6307 \begin_layout Plain Layout
6322 \begin_layout Standard
6328 \begin_layout Standard
6329 The \SpecialChar LyX
6347 correspond to the \SpecialChar LaTeX
6363 They are replacements for the standard document classes
6378 and fit better to Polish typography conventions in a number of points.
6382 \begin_layout Standard
6386 \begin_layout Itemize
6387 Unnumbered titles (with star,
6389 \begin_inset space \thinspace{}
6393 \begin_inset space \space{}
6400 ) are added into table of contents,
6403 \begin_layout Itemize
6404 Additional page styles:
6408 \begin_layout Description
6409 uheadings header with separated lines,
6412 \begin_layout Description
6413 myheadings custom header,
6414 contents headers via commands:
6430 \begin_layout Description
6431 myuheadings custom header with separated lines,
6434 \begin_layout Description
6435 outer page number is placed on outer side of page
6439 \begin_layout Itemize
6444 \begin_layout Description
6445 rmheadings serif titles —
6449 \begin_layout Description
6450 sfheadings sansserif titles,
6453 \begin_layout Description
6454 authortitle on title page first placed is author next title —
6458 \begin_layout Description
6459 titleauthor on title page first placed is title next author,
6462 \begin_layout Description
6463 withmarginpar reserve place on page for margins.
6467 \begin_layout Subsection
6469 \change_inserted 564990737 1672652245
6473 \begin_layout Standard
6475 \change_inserted 564990737 1672652245
6476 The document classes
6479 \begin_inset space \thinspace{}
6487 \begin_inset space \thinspace{}
6501 Detailed information about these document classes can be found in
6503 File\SpecialChar menuseparator
6504 Open Example\SpecialChar menuseparator
6505 Books\SpecialChar menuseparator
6510 File\SpecialChar menuseparator
6511 Open Example\SpecialChar menuseparator
6512 Handouts\SpecialChar menuseparator
6518 \begin_layout Section
6520 \change_inserted 564990737 1670439534
6524 \begin_layout Standard
6526 \change_inserted 564990737 1670794710
6527 See also the document classes in the Collections (section
6528 \begin_inset space ~
6532 \begin_inset CommandInset ref
6534 reference "sec:Collections"
6542 \begin_layout Subsection
6544 \change_inserted 564990737 1670794716
6548 \begin_layout Standard
6550 \change_inserted 564990737 1670794716
6556 updated by the \SpecialChar LyX
6560 \begin_layout Subsubsection
6562 \change_inserted 564990737 1670794716
6566 \begin_layout Standard
6568 \change_inserted 564990737 1670794716
6569 This section describes how \SpecialChar LyX
6570 can be used to write articles for submission to the scientific journal
6572 Astronomy and Astrophysics
6575 \begin_inset CommandInset href
6578 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6583 ) using Version 9.1 of the document class
6588 information about it is available at
6589 \begin_inset Flex URL
6592 \begin_layout Plain Layout
6594 \change_inserted 564990737 1670794716
6596 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
6606 \begin_layout Standard
6608 \change_inserted 564990737 1670794716
6609 A manual comes together with the package and should be consulted before installing this document class as described in the
6611 Installing New Document Classe
6621 \begin_layout Standard
6623 \change_inserted 564990737 1670794716
6624 \begin_inset Note Greyedout
6627 \begin_layout Plain Layout
6629 \change_inserted 564990737 1670794716
6630 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
6632 That change also involved some slight changes to the style files,
6633 namely the removal of the thesaurus command.
6634 If you have an older version installed,
6636 For information about compatibility with the old (version 4) layout,
6637 please refer to the comments in
6640 Dir/layouts/aapaper.layout
6650 \begin_layout Subsubsection
6652 \change_inserted 564990737 1670794716
6656 \begin_layout Standard
6658 \change_inserted 564990737 1671617129
6659 It is recommended you start from the template in the menu
6664 ile\SpecialChar menuseparator
6666 \begin_inset space ~
6674 \begin_inset space ~
6677 Template\SpecialChar menuseparator
6678 Articles\SpecialChar menuseparator
6679 Astronomy & Astrophysics
6682 If you are not using the template,
6683 note the following settings:
6686 \begin_layout Itemize
6688 \change_inserted 564990737 1670794716
6698 ocument\SpecialChar menuseparator
6703 ettings\SpecialChar menuseparator
6705 \begin_inset space ~
6711 that one was obvious).
6714 \begin_layout Itemize
6716 \change_inserted 564990737 1670794716
6720 \begin_inset space ~
6732 \begin_inset space ~
6743 The whole layout is done by the macros,
6744 you shouldn't change anything.
6747 \begin_layout Subsubsection
6749 \change_inserted 564990737 1670794716
6753 \begin_layout Standard
6755 \change_inserted 564990737 1670794716
6756 First thing to enter is the header information.
6757 It consists of five entries,
6758 of which one is optional.
6762 \begin_layout Itemize
6764 \change_inserted 564990737 1670794716
6773 \begin_layout Itemize
6775 \change_inserted 564990737 1670794716
6784 \begin_layout Itemize
6786 \change_inserted 564990737 1670794716
6795 \begin_layout Itemize
6797 \change_inserted 564990737 1670794716
6806 \begin_layout Itemize
6808 \change_inserted 564990737 1670794716
6822 \begin_layout Standard
6824 \change_inserted 564990737 1670794716
6825 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
6826 just to get the best optics and meets the layout of the real document.
6829 \begin_layout Standard
6831 \change_inserted 564990737 1670794716
6832 If you want to place footnotes in the header block,
6834 \begin_inset space \thinspace{}
6838 \begin_inset space \space{}
6841 to state your present address,
6842 just use the standard footnote via the menu
6847 nsert\SpecialChar menuseparator
6856 will automagically use the term
6865 \begin_layout Standard
6867 \change_inserted 564990737 1670794716
6868 In addition to these topics,
6869 the macros use three additional \SpecialChar LaTeX
6870 commands that have no counterpart in \SpecialChar LyX
6874 \begin_layout Itemize
6876 \change_inserted 564990737 1670794716
6883 to separate different names for more than one author and institute,
6887 \begin_layout Itemize
6889 \change_inserted 564990737 1670794716
6896 to mark corresponding author/institute pairs.
6897 The institutes are numbered sequentially as they appear in the
6902 so you have to put a marker to each author.
6905 \begin_layout Itemize
6907 \change_inserted 564990737 1670794716
6914 to supply an email address for fast contact.
6917 \begin_layout Standard
6919 \change_inserted 564990737 1671642374
6921 the appropriate command has to be entered as \SpecialChar TeX
6922 code in \SpecialChar LyX
6924 See the examples in the template and in
6926 File\SpecialChar menuseparator
6927 Open Example\SpecialChar menuseparator
6928 Articles\SpecialChar menuseparator
6929 Astronomy & Astrophysics
6936 \begin_layout Subsubsection
6938 \change_inserted 564990737 1670794716
6942 \begin_layout Standard
6944 \change_inserted 564990737 1670794716
6945 The abstract should immediately follow the header block and must contain five tokens:
6955 \begin_layout Enumerate
6957 \change_inserted 564990737 1670794716
6962 (optional) {} leave it empty if necessary
6965 \begin_layout Enumerate
6967 \change_inserted 564990737 1670794716
6975 \begin_layout Enumerate
6977 \change_inserted 564990737 1670794716
6985 \begin_layout Enumerate
6987 \change_inserted 564990737 1670794716
6995 \begin_layout Enumerate
6997 \change_inserted 564990737 1670794716
7002 (optional) {} leave it empty if necessary
7005 \begin_layout Standard
7007 \change_inserted 564990737 1670794716
7009 This structure not shown in
7016 \begin_layout Subsubsection
7018 \change_inserted 564990737 1670794716
7019 Supported environments
7022 \begin_layout Standard
7024 \change_inserted 564990737 1670794716
7025 The A&A paper layout supports the following environments for structuring your text:
7028 \begin_layout Itemize
7030 \change_inserted 564990737 1670794716
7036 \begin_layout Itemize
7038 \change_inserted 564990737 1670794716
7044 \begin_layout Itemize
7046 \change_inserted 564990737 1670794716
7052 \begin_layout Itemize
7054 \change_inserted 564990737 1670794716
7060 \begin_layout Itemize
7062 \change_inserted 564990737 1670794716
7068 \begin_layout Itemize
7070 \change_inserted 564990737 1670794716
7076 \begin_layout Itemize
7078 \change_inserted 564990737 1670794716
7084 \begin_layout Itemize
7086 \change_inserted 564990737 1670794716
7092 \begin_layout Itemize
7094 \change_inserted 564990737 1670794716
7100 \begin_layout Itemize
7102 \change_inserted 564990737 1670794716
7108 \begin_layout Itemize
7110 \change_inserted 564990737 1670794716
7116 \begin_layout Itemize
7118 \change_inserted 564990737 1670794716
7125 \begin_layout Subsubsection
7127 \change_inserted 564990737 1670794716
7128 Commands not supported by \SpecialChar LyX
7132 \begin_layout Standard
7134 \change_inserted 564990737 1670794716
7135 Some commands are not yet supported by the
7139 layout for \SpecialChar LyX
7141 Some have already been mentioned.
7142 For the sake of completeness,
7143 they are listed all together here:
7146 \begin_layout Itemize
7148 \change_inserted 564990737 1670794716
7156 \begin_layout Itemize
7158 \change_inserted 564990737 1670794716
7166 \begin_layout Itemize
7168 \change_inserted 564990737 1670794716
7176 \begin_layout Itemize
7178 \change_inserted 564990737 1670794716
7186 \begin_layout Itemize
7188 \change_inserted 564990737 1670794716
7196 \begin_layout Standard
7198 \change_inserted 564990737 1670794716
7199 If you want to use any of these commands,
7200 you have to enter them yourself.
7203 Do not forget to use
7209 nsert\SpecialChar menuseparator
7212 \begin_inset space ~
7221 \begin_layout Subsubsection
7223 \change_inserted 564990737 1670794716
7224 Figure and Table Floats
7227 \begin_layout Standard
7229 \change_inserted 564990737 1670794716
7231 provides support for the necessary float environments
7242 therefore we won't tell much about it here.
7246 \begin_inset space ~
7252 Just remember that tables should be left-aligned.
7254 select the table and change the alignment in
7259 dit\SpecialChar menuseparator
7265 \begin_inset space ~
7271 \begin_layout Standard
7273 \change_inserted 564990737 1670794716
7274 There is only one special thing:
7275 the figures with a caption beside the figure.
7276 To create such a figure,
7277 you have to do the following:
7280 \begin_layout Enumerate
7282 \change_inserted 564990737 1670794716
7283 Create a wide figure float:
7289 nsert\SpecialChar menuseparator
7294 t\SpecialChar menuseparator
7299 from within the float,
7305 dit\SpecialChar menuseparator
7311 \begin_inset space ~
7322 \begin_inset space ~
7334 \begin_layout Enumerate
7336 \change_inserted 564990737 1670794716
7337 Enter your caption text.
7340 \begin_layout Enumerate
7342 \change_inserted 564990737 1670794716
7347 to move the cursor above the caption.
7350 \begin_layout Enumerate
7352 \change_inserted 564990737 1670794716
7356 \begin_layout Enumerate
7358 \change_inserted 564990737 1670794716
7359 Position the cursor after the figure and insert a horizontal fill by using the menu:
7365 nsert\SpecialChar menuseparator
7370 rmatting\SpecialChar menuseparator
7376 \begin_inset space ~
7385 dialog and select the
7399 \begin_layout Enumerate
7401 \change_inserted 564990737 1670794716
7402 Switch to \SpecialChar LaTeX
7407 \begin_inset space ~
7415 \begin_layout Enumerate
7417 \change_inserted 564990737 1670794716
7426 Do not close the brace!
7429 \begin_layout Enumerate
7431 \change_inserted 564990737 1670794716
7432 Position the cursor behind the caption text,
7433 switch to \SpecialChar LaTeX
7434 mode and insert the closing brace:
7438 \begin_inset space ~
7450 \begin_layout Standard
7452 \change_inserted 564990737 1671642458
7454 refer to the figures in the file in
7456 File\SpecialChar menuseparator
7457 Open Example\SpecialChar menuseparator
7458 Articles\SpecialChar menuseparator
7459 Astronomy & Astrophysics
7464 \begin_layout Subsubsection
7466 \change_inserted 564990737 1670794716
7470 \begin_layout Standard
7472 \change_inserted 564990737 1670794716
7474 the paper has to be formatted in a special double-spacing layout.
7476 you have to add the option
7487 \begin_inset space ~
7497 ocument\SpecialChar menuseparator
7502 ettings\SpecialChar menuseparator
7504 \begin_inset space ~
7513 \begin_layout Subsubsection
7515 \change_inserted 564990737 1670794716
7519 \begin_layout Standard
7521 \change_inserted 564990737 1671642520
7524 File\SpecialChar menuseparator
7525 Open Example\SpecialChar menuseparator
7526 Articles\SpecialChar menuseparator
7527 Astronomy & Astrophysics
7529 was written with \SpecialChar LyX
7531 It is the example paper from the original macro package,
7537 \begin_inset CommandInset href
7540 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
7546 but translated to \SpecialChar LyX
7547 using the older unstructured abstract type.
7548 Use it for inspiration,
7549 and compare the \SpecialChar LaTeX
7554 with the \SpecialChar LyX
7558 \begin_layout Subsection
7563 \begin_layout Standard
7569 \begin_layout Subsubsection
7573 \begin_layout Standard
7575 is a set of macros produced by the American Astronomical Society to facilitate electronic manuscript submission to the three journals they publish:
7576 the Astrophysical Journal (including the Letters and Supplement),
7577 the Astronomical Journal,
7578 and the Publications of the Astronomical Society of the Pacific.
7580 has proven to be an excellent tool for generating these documents,
7581 especially given its equation,
7583 and figure handling capabilities.
7585 requires version 5.0 (or higher) of these macros;
7587 which is the version described here,
7589 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
7590 2.09 and are fundamentally incompatible with \SpecialChar LyX
7592 The AAS\SpecialChar TeX
7593 package may be downloaded from the AAS\SpecialChar TeX
7597 \begin_layout Standard
7598 \begin_inset VSpace medskip
7604 \begin_layout Standard
7606 \begin_inset Flex URL
7609 \begin_layout Plain Layout
7611 https://aas.org/aastex/aastex-downloads
7619 \begin_layout Standard
7620 \begin_inset VSpace medskip
7626 \begin_layout Standard
7627 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
7630 will not reduce the need to figure out all the AAS\SpecialChar TeX
7632 it will only reduce the drudgery of typing everything in.
7633 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
7634 document conforms completely to the requirements of the journal to which you are submitting your paper.
7637 \begin_layout Subsubsection
7638 Starting a New Paper
7641 \begin_layout Standard
7642 I strongly suggest that you start with the AAS\SpecialChar TeX
7646 File\SpecialChar menuseparator
7652 \change_inserted 564990737 1671617265
7653 \SpecialChar menuseparator
7654 Articles\SpecialChar menuseparator
7655 American Astronomical Society
7656 \change_deleted 564990737 1671617310
7660 enter the new file name,
7668 This will show the most common fields found in a manuscript.
7669 Simply overwrite the existing text (including the brackets,
7674 ) with the correct information.
7675 Many of the AAS\SpecialChar TeX
7676 commands and environments can be implemented directly in \SpecialChar LyX
7679 For commands such as these,
7680 the \SpecialChar LaTeX
7681 code must be entered directly and marked as such.
7682 Such commands are referred to as \SpecialChar TeX
7685 I tried to minimize the amount of \SpecialChar TeX
7686 code needed in an AAS\SpecialChar TeX
7690 \begin_layout Subsubsection
7691 Finishing Your Paper
7694 \begin_layout Standard
7695 When the paper is finished to your satisfaction and previews/prints correctly,
7697 \begin_inset Quotes eld
7701 \begin_inset Quotes erd
7704 actions which need to be done before you submit it to the journals.
7708 \begin_layout Enumerate
7709 Export your paper as a \SpecialChar LaTeX
7712 File\SpecialChar menuseparator
7713 Export\SpecialChar menuseparator
7721 \begin_layout Enumerate
7726 file with your favorite text editor
7730 \begin_layout Enumerate
7731 remove the comment lines before the
7740 \begin_layout Enumerate
7745 usepackage...{fontenc}
7747 line if it appears (usually just after
7763 \begin_layout Enumerate
7764 remove everything between (and including) the
7777 except for any commands you specifically put into the \SpecialChar LaTeX
7778 preamble (which should appear immediately after the
7779 \begin_inset Quotes eld
7782 User specified \SpecialChar LaTeX
7784 \begin_inset Quotes erd
7795 \begin_layout Enumerate
7796 Run the resulting file through \SpecialChar LaTeX
7797 to make sure it still processes correctly.
7800 \begin_layout Enumerate
7801 Reread the journal requirements to make sure your filenames and formats are correct.
7804 \begin_layout Enumerate
7808 \begin_layout Subsubsection
7809 Comments On Specific Commands
7812 \begin_layout Standard
7813 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
7815 the AAS\SpecialChar TeX
7820 ) gives a good description of each.
7821 Thus it's probably easiest for me to go down the list as found in the guide and offer comments where necessary.
7822 So let's begin \SpecialChar ldots
7826 \begin_layout Paragraph
7827 Things that work as expected
7830 \begin_layout Standard
7831 Because they work as you might expect,
7832 I simply list them and the section they are found in:
7949 begin{thebibliography}
7959 all the cite commands and their variations (2.13.2),
7960 the generic graphicx figure commands (2.14.1),
7989 amongst other places),
8020 \begin_layout Standard
8021 The following style options also work correctly:
8047 Simply put them in the
8053 Layout\SpecialChar menuseparator
8059 \begin_layout Paragraph
8061 but require more comment
8064 \begin_layout Standard
8065 The following items work,
8066 but require a little more discussion:
8069 \begin_layout Itemize
8070 These items are reserved for use by the journal editors,
8071 but you can put them into the \SpecialChar LaTeX
8072 preamble if you feel compelled to do so:
8110 \begin_layout Itemize
8111 These items may be placed in the \SpecialChar LaTeX
8113 and are included as blanks in the template file:
8137 \begin_layout Itemize
8144 (2.3) – can only be used
8145 \begin_inset Quotes eld
8149 \begin_inset Quotes erd
8153 not in the middle of a paragraph.
8154 Use \SpecialChar TeX
8155 code if you need to embed it.
8158 \begin_layout Itemize
8165 (2.3) – will have extra {} after it.
8166 This should not cause an error.
8169 \begin_layout Itemize
8176 (2.6) – can only be used
8177 \begin_inset Quotes eld
8181 \begin_inset Quotes erd
8185 not in the middle of a paragraph.
8186 Use \SpecialChar TeX
8187 code if you need to embed it.
8190 \begin_layout Itemize
8197 (2.8) – can't insert a cross-reference tag,
8198 you must type the tag name by hand
8201 \begin_layout Itemize
8215 \begin_layout Itemize
8222 (2.9) – will have extra {} after it.
8223 This should not cause an error.
8226 \begin_layout Itemize
8233 (2.11) – will have extra {} after it.
8234 This should not cause an error.
8237 \begin_layout Itemize
8244 (2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
8246 Insert\SpecialChar menuseparator
8251 \begin_inset Quotes eld
8255 \begin_inset Quotes erd
8258 inserts an optional argument of the type needed by
8265 Hopefully it will be renamed someday.
8268 \begin_layout Itemize
8281 for the catalog ID optional parameter
8284 \begin_layout Itemize
8297 for the catalog ID optional parameter
8300 \begin_layout Paragraph
8301 Things not implemented,
8302 use \SpecialChar TeX
8306 \begin_layout Standard
8318 setcounter{equation}
8321 Journal name abbreviations (2.13.4),
8364 insert it as the first element in the lefthand cell after where you want it.
8365 Don't use any of \SpecialChar LyX
8366 's rules in the table),
8441 \begin_layout Paragraph
8442 Things that cannot be implemented
8445 \begin_layout Standard
8447 at least in any meaningful sort of way,
8448 so I suggest ignoring them.
8449 They are the references environment (2.13.3),
8450 and the deluxetable environment (2.15).
8452 really need to use deluxetable,
8453 I suggest editing it in a separate file with a text editor,
8456 Insert\SpecialChar menuseparator
8458 \begin_inset space ~
8463 to include it in your \SpecialChar LyX
8466 \change_deleted 564990737 1671642564
8472 \change_inserted 564990737 1671642618
8475 File\SpecialChar menuseparator
8476 Open Example\SpecialChar menuseparator
8477 Articles\SpecialChar menuseparator
8478 American Astronomical Society
8483 \change_inserted 564990737 1671642621
8489 \begin_layout Subsubsection
8493 and Other Ruminations
8496 \begin_layout Paragraph
8497 Getting \SpecialChar LyX
8498 and AAS\SpecialChar TeX
8502 \begin_layout Standard
8503 It can be a bit tricky to get \SpecialChar LyX
8504 to recognize a new layout and document class.
8505 When all else fails,
8509 \begin_layout Enumerate
8510 Make certain that \SpecialChar LaTeX
8511 can find AAS\SpecialChar TeX
8513 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
8514 distribution into a directory completely unrelated to \SpecialChar LaTeX
8515 or AAS\SpecialChar TeX
8516 and run \SpecialChar LaTeX
8524 \begin_layout Enumerate
8529 appears in \SpecialChar LyX
8537 \begin_layout Enumerate
8540 Tools\SpecialChar menuseparator
8545 then restart \SpecialChar LyX
8549 \begin_layout Enumerate
8550 Open a regular new file,
8551 not from a template.
8552 Does AAS\SpecialChar TeX
8553 appear in the class list in
8555 Document\SpecialChar menuseparator
8561 \begin_layout Standard
8562 If you get a warning from an existing AAS\SpecialChar TeX
8563 document about not being able to find the AAS\SpecialChar TeX
8564 layout or a message about
8565 \begin_inset Quotes eld
8568 You should not mix title layouts with normal ones
8569 \begin_inset Quotes erd
8573 things haven't been installed correctly.
8576 \begin_layout Paragraph
8578 error processing a table
8581 \begin_layout Standard
8585 attempts to center the table caption/title.
8586 This seems to produce a bad interaction in AAS\SpecialChar TeX
8587 so you should click somewhere in the caption/title,
8590 Edit\SpecialChar menuseparator
8592 \begin_inset space ~
8607 This took care of it for me.
8610 \begin_layout Paragraph
8614 \begin_layout Standard
8616 1) I have noticed some funny spacing in the reference entries in the text.
8617 When you enter the bibliography item data,
8622 space between the last author and the parenthesis setting off the year;
8626 \begin_inset space \thinspace{}
8630 \begin_inset space \space{}
8645 2) Entering the references at all is not obvious.
8646 The easiest thing is to start typing your first reference at the end of the document,
8647 then mark it as type
8652 That will put a small gray box in front of what you just typed.
8653 Click on the box to fill in the rest of the information.
8655 go to the end of an existing reference and press return.
8656 That will create a new line with its own box,
8660 \begin_layout Paragraph
8664 \begin_layout Standard
8665 Even though AAS\SpecialChar TeX
8666 provides its own figure commands (
8674 I much prefer \SpecialChar LaTeX
8675 's standard figure commands (with the default graphicx).
8684 \begin_inset space ~
8687 commands as \SpecialChar TeX
8688 code into a Figure Float box if you desire,
8689 but I never have much luck getting the layout right.
8690 With the standard graphics,
8696 usepackage{graphicx}
8698 command into the \SpecialChar LaTeX
8699 preamble and handle the figures in the standard \SpecialChar LaTeX2e
8701 interspersing the figures in the text.
8702 I believe ApJ accepts figures exactly this way now;
8703 AJ might still use the
8704 \begin_inset Quotes eld
8707 stack everything at the end
8708 \begin_inset Quotes erd
8714 \begin_layout Paragraph
8715 Things I could have done,
8719 \begin_layout Standard
8721 \begin_inset Quotes eld
8725 \begin_inset Quotes erd
8728 things I could have implemented,
8731 I saw no point in double-spacing the text in the \SpecialChar LyX
8733 even though it is double-spaced in the paper manuscript.
8735 I chose not to make separate layouts for the preprint and preprint2 styles.
8736 Since I assume you will spend most of your time in the plain manuscript mode anyway,
8737 I decided not to chew up more disk space with this.
8741 \begin_layout Subsubsection
8745 \begin_layout Standard
8746 Your mileage may vary.
8747 I've now had papers published by both ApJ and AJ that have had 98% of the effort done in \SpecialChar LyX
8749 the last 2% was the \SpecialChar LaTeX
8750 post-processing and a few cleanups.
8751 I have had no trouble with the submission process,
8752 and I'm sure the journals were never aware that there might be a difference.
8754 go forth and publish!
8757 \begin_layout Subsection
8759 \change_inserted 564990737 1671442131
8763 \begin_layout Standard
8765 \change_inserted 564990737 1671642768
8769 \begin_inset space \thinspace{}
8778 document class together with the style
8782 to facilitate the description of chess games.
8785 File\SpecialChar menuseparator
8786 Open Example\SpecialChar menuseparator
8787 Articles\SpecialChar menuseparator
8801 \begin_layout Subsection
8803 \change_inserted 564990737 1671042028
8807 \begin_layout Standard
8809 \change_inserted 564990737 1671617396
8813 \begin_inset space \thinspace{}
8823 This provides the following additional environments:
8827 \begin_inset space ~
8836 \begin_inset space ~
8845 \begin_inset space ~
8865 A template is available in the menu
8870 ile\SpecialChar menuseparator
8872 \begin_inset space ~
8880 \begin_inset space ~
8883 Template\SpecialChar menuseparator
8884 Articles\SpecialChar menuseparator
8888 It has been customized with further environments and contains all the information you may need.
8890 the documentation is also available from
8891 \begin_inset CommandInset href
8894 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
8902 \begin_layout Subsection
8904 \change_inserted 564990737 1671042046
8908 \begin_layout Standard
8910 \change_inserted 564990737 1671042046
8914 \begin_inset space \thinspace{}
8919 provides an alternative to the
8924 It provides similar functionality,
8925 but you might prefer this layout with sans serif sections,
8930 \begin_layout Subsection
8935 \begin_layout Standard
8941 \begin_layout Standard
8942 \begin_inset VSpace bigskip
8948 \begin_layout Standard
8953 \begin_inset space ~
8958 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
8960 \begin_inset Formula $\beta$
8967 \begin_layout Standard
8974 which works with Rev\SpecialChar TeX
8977 v3.1 is basically obsolete,
8978 as it works with \SpecialChar LaTeX
8980 That means that it doesn't interact very well with \SpecialChar LyX
8982 which requires \SpecialChar LaTeX2e
8984 although it has been kludged to work.
8985 Since Rev\SpecialChar TeX
8986 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
8993 \begin_inset space ~
8998 textclass should also be pretty easy to use.
9001 \begin_layout Standard
9002 These documents are supposed to be used in
9006 to the Rev\SpecialChar TeX
9008 so we don't describe any of the special Rev\SpecialChar TeX
9010 and assume you'll know what to put in the preamble if necessary.
9013 \begin_layout Subsubsection
9017 \begin_layout Standard
9018 All you need to do is install Rev\SpecialChar TeX
9020 as described in the package's README file.
9021 The package can be found at The Rev\SpecialChar TeX
9023 \begin_inset Flex URL
9026 \begin_layout Plain Layout
9028 http://publish.aps.org/revtex4/
9034 Install it somewhere that \SpecialChar LaTeX
9036 Test it by trying to \SpecialChar LaTeX
9037 a short Rev\SpecialChar TeX
9038 4 document in some random directory (i.
9039 \begin_inset space \thinspace{}
9043 \begin_inset space \space{}
9046 not the directory where you installed the class file.) Then,
9047 if you reconfigure \SpecialChar LyX
9049 it will find the class file and let you use the Rev\SpecialChar TeX
9053 \begin_layout Standard
9054 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
9063 \begin_inset space ~
9069 found in the templates directory.
9072 \begin_layout Subsubsection
9076 \begin_layout Standard
9077 Optional arguments to
9085 \begin_inset Quotes eld
9089 \begin_inset Quotes erd
9093 \begin_inset Quotes eld
9097 \begin_inset Quotes erd
9104 \begin_inset space ~
9112 \begin_inset space ~
9119 Remember that in Rev\SpecialChar TeX
9121 at least one optional argument is required!
9125 \begin_layout Standard
9126 Other preamble matter,
9134 \begin_inset space ~
9141 \begin_inset space ~
9150 \begin_layout Subsubsection
9154 \begin_layout Standard
9155 The layouts basically correspond to the commands in Rev\SpecialChar TeX
9158 the Email layout corresponds to
9165 Note that (at least as of Rev\SpecialChar TeX
9175 layouts are exactly equivalent,
9176 so you shouldn't need to use both.
9180 \begin_layout Plain Layout
9181 In case you're curious,
9182 both were included so that
9186 would be able to translate both
9206 \begin_layout Subsubsection
9210 \begin_layout Standard
9211 There are a couple of important unique aspects of Rev\SpecialChar TeX
9212 4 which might cause bugs that will be even more confusing in \SpecialChar LyX
9216 \begin_layout Standard
9217 In Rev\SpecialChar TeX
9236 The \SpecialChar LyX
9237 equivalent is that there is a separate Thanks layout.
9242 write footnotes in the
9247 or weird things may happen.
9248 See the Rev\SpecialChar TeX
9249 4 documentation for more details.
9252 \begin_layout Standard
9257 \begin_inset space ~
9266 \begin_inset space ~
9276 layouts must be placed
9284 layout and the corresponding
9302 the \SpecialChar LaTeX
9306 \begin_layout Subsection
9308 \change_inserted 564990737 1671042072
9312 \begin_layout Standard
9314 \change_inserted 564990737 1671042072
9319 classes were replaced in 2013 with a completely new
9324 This package provides a \SpecialChar LaTeX
9325 class and templates for books to be published at Springer Gabler Research,
9326 Springer Vieweg Research,
9327 Springer Spektrum Research,
9328 Springer VS Research,
9329 or Springer VS Forschung.
9330 The documentation is available in German from
9331 \begin_inset CommandInset href
9334 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
9342 \begin_layout Section
9344 \change_inserted 564990737 1670439560
9348 \begin_layout Standard
9350 \change_inserted 564990737 1670439581
9351 See also the document classes in the Collections (section
9352 \begin_inset space ~
9356 \begin_inset CommandInset ref
9358 reference "sec:Collections"
9366 \begin_layout Subsection
9370 \begin_layout Standard
9376 \begin_layout Subsubsection
9380 \begin_layout Standard
9381 Memoir is a very powerful and constantly evolving class.
9382 It has been designed with regard to fictional and non-fictional literature.
9383 Its aim is to let the user have maximum control over the typesetting of his document.
9384 Memoir is based on the standard book class,
9385 but it can also emulate the article class (see below).
9388 \begin_layout Standard
9390 the developer of Memoir,
9391 is known as the author of lots of useful packages in the \SpecialChar LaTeX
9393 Most of them have been merged with Memoir.
9395 it is much easier to layout the table of contents,
9397 chapter designs and such.
9401 does not support all of these goodies natively.
9402 Some of them might be added to forthcoming releases
9406 \begin_layout Plain Layout
9407 You are invited to send suggestions to
9408 \begin_inset Flex URL
9411 \begin_layout Plain Layout
9413 lyx-devel@lists.lyx.org
9424 lots will probably never be supported,
9425 due to the limitations of \SpecialChar LyX
9427 Of course you can still use all features with the help of some native \SpecialChar LaTeX
9428 commands (\SpecialChar TeX
9433 \begin_layout Plain Layout
9438 \begin_layout Plain Layout
9448 \begin_inset space ~
9452 \begin_inset CommandInset ref
9454 reference "sec:Inserting-TeX-Code"
9466 we can only list those features that are natively supported by \SpecialChar LyX
9468 For detailed descriptions (and for the rest of features) we recommend you have a look at the detailed manual of the Memoir class
9472 \begin_layout Plain Layout
9477 \begin_layout Plain Layout
9487 \begin_inset Flex URL
9490 \begin_layout Plain Layout
9492 CTAN:/macros/latex/memoir/memman.pdf
9503 which is not only a user guide for the class,
9504 but also both a comprehensive description on good typesetting and a superb example for good typesetting itself.
9507 \begin_layout Subsubsection
9508 Basic features and restrictions
9511 \begin_layout Standard
9512 Memoir supports basically all features of the standard book classes.
9519 \begin_layout Description
9521 \begin_inset space ~
9525 Memoir has a broader range of font sizes:
9534 \begin_layout Description
9536 \begin_inset space ~
9540 The fancy page style is not supported,
9541 due to a command clash between Memoir and the fancyhdr package (they both define a command with the same name,
9542 which confuses \SpecialChar LaTeX
9545 Memoir comes with a number of its own page styles (see
9547 Document\SpecialChar menuseparator
9548 Settings\SpecialChar menuseparator
9550 \begin_inset space ~
9556 If you want to use these for the chapter pages,
9557 you have to use the command
9563 in the main text or in preamble (e.
9564 \begin_inset space \thinspace{}
9568 \begin_inset space \space{}
9575 chapterstyle{companion}
9580 \begin_layout Description
9582 Sectionings (chapter,
9584 subsection etc.) come with an optional argument in the standard classes.
9586 you can specify an alternative version of the title for the table of contents and the headers (for instance,
9587 if the title is too long).
9592 Insert\SpecialChar menuseparator
9594 \begin_inset space ~
9599 at the beginning of a chapter/section.
9600 Memoir features a second optional argument and thus separates the table of contents from the header.
9601 You can define three variants of a title with this:
9602 one for the main text,
9603 one for the table of contents,
9604 and one for the headers.
9606 makes these available in form of specific
9617 \begin_layout Description
9619 In the standard classes (and in many other classes),
9620 the table of contents,
9621 the list of figures and the list of table start a new page automatically.
9622 Memoir does not follow this route.
9623 You have to insert a page break yourself,
9624 if you want to have one.
9627 \begin_layout Description
9629 For some unknown reason,
9630 Memoir uses pagination on the title page (in the standard classes,
9632 \begin_inset Quotes eld
9636 \begin_inset Quotes erd
9640 If you want an empty title page,
9645 aliaspagestyle{title}{empty}
9650 \begin_layout Description
9652 With the class option
9658 Document\SpecialChar menuseparator
9659 Settings\SpecialChar menuseparator
9660 Class Settings\SpecialChar menuseparator
9662 \begin_inset space ~
9668 you can emulate article style.
9670 counters (footnotes,
9672 tables etc.) will not be reset on new chapters,
9673 chapters don't start a new page (but are—
9675 \begin_inset Quotes eld
9679 \begin_inset Quotes erd
9690 \begin_layout Description
9693 Memoir does not allow the use of the deprecated font commands,
9694 which have been used in the old \SpecialChar LaTeX
9696 \begin_inset space \thinspace{}
9700 \begin_inset space \space{}
9717 It produces an error and stops \SpecialChar LaTeX
9718 whenever such a command appears.
9723 reallows the commands and spits out warnings instead (which does at least not stop \SpecialChar LaTeX
9725 Since a lot of packages and particularly Bib\SpecialChar TeX
9726 style files are still using those commands,
9727 we have decided to use this option by default.
9730 \begin_layout Subsubsection
9734 \begin_layout Standard
9735 We will only describe the features supported by \SpecialChar LyX
9736 (which is not much currently).
9737 Please consult the Memoir manual
9741 \begin_layout Plain Layout
9746 \begin_layout Plain Layout
9756 \begin_inset Flex URL
9759 \begin_layout Plain Layout
9761 CTAN:/macros/latex/memoir/memman.pdf
9774 \begin_layout Description
9776 You may wonder why an abstract is an extra feature.
9778 it is in book class.
9779 Usually books don't have abstracts.
9783 You can use it wherever and how often you like.
9786 \begin_layout Description
9788 You may know this older typesetting style:
9789 The contents of a chapter are summarized below the title and also in the table of contents (e.
9790 \begin_inset space \thinspace{}
9794 \begin_inset space \space{}
9799 Our hero arrives in Troia;
9800 he loses some friends;
9804 Chapterprecis does exactly this.
9805 It is therefore only sensible below a chapter.
9808 \begin_layout Description
9810 An epigraph is a smart slogan or motto at the beginning of a chapter.
9811 The epigraph environment provides an elegant way of typesetting such a motto.
9812 The motto itself (text) and its (optional) author (source) are divided by a short line.
9813 The author (source) can be inserted via
9815 Insert\SpecialChar menuseparator
9822 \begin_layout Description
9824 Memoir has lots of possibilities to typeset poetry (up to very complex figurative poems).
9826 can only support a few of them.
9828 which is a centered title for poems,
9829 which will also be added to the table of contents (verse is the standard environment for poems.
9830 Memoir has some enhanced versions of verse,
9831 but you need to use \SpecialChar TeX
9833 because they have to be nested inside regular verse environments,
9834 which is not possible with \SpecialChar LyX
9838 \begin_layout Description
9841 but it adds no entry to the table of contents.
9844 \begin_layout Subsection
9846 \change_inserted 564990737 1671442175
9850 \begin_layout Standard
9852 \change_inserted 564990737 1671442175
9860 \begin_inset space \thinspace{}
9865 document class but adds two environments:
9868 \begin_layout Description
9870 \change_inserted 564990737 1671442175
9871 Recipe a numbered section environment at the
9875 level which generates a bold centered heading above a double horizontal rule
9878 \begin_layout Description
9880 \change_inserted 564990737 1671442175
9891 are what are being described and the environment ends with a horizontal rule.
9894 \begin_layout Standard
9896 \change_inserted 564990737 1671642866
9899 File\SpecialChar menuseparator
9900 Open Example\SpecialChar menuseparator
9901 Books\SpecialChar menuseparator
9904 illustrates its use.
9907 \begin_layout Standard
9909 \change_inserted 564990737 1671442175
9910 It is designed for typesetting one or two recipes per page,
9911 with dimensions of 5.5
9912 \begin_inset Quotes qrd
9916 \begin_inset Quotes qrd
9920 The hyperlinked table of contents (ToC) and page numbers make browsing recipes convenient,
9921 and the pages can be joined together or printed 2 per page to normal letterpaper easily.
9922 The size was chosen to work in half-page 3-ring binder cover sheets,
9923 because un-laminated paper just doesn't last in the kitchen.
9926 \begin_layout Standard
9928 \change_inserted 564990737 1671442175
9929 The half-letter pages can be printed two per page using your printer driver,
9930 or bound together using
9932 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
9942 is the compiled version of your recipes.
9945 \begin_layout Section
9947 \change_inserted 564990737 1671442207
9951 \begin_layout Subsection
9953 \change_inserted 564990737 1671442208
9957 \begin_layout Standard
9959 \change_inserted 564990737 1671642942
9963 \begin_inset space \space{}
9967 \begin_inset space \thinspace{}
9977 an unofficial implementation of the ‘Europass CV’ recommended by the European Commission in 2013.
9980 File\SpecialChar menuseparator
9981 Open Example\SpecialChar menuseparator
9982 Curricula Vitae\SpecialChar menuseparator
9985 offers guidance on its use.
9986 Its documentation is available from
9987 \begin_inset CommandInset href
9990 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
9998 \begin_layout Subsection
10000 \change_inserted 564990737 1671442208
10004 \begin_layout Standard
10006 \change_inserted 564990737 1671642984
10010 \begin_inset space \space{}
10014 \begin_inset space \thinspace{}
10024 an unofficial implementation of the “Europass CV” recommended by the European Commission in 2002.
10027 File\SpecialChar menuseparator
10028 Open Example\SpecialChar menuseparator
10029 Curricula Vitae\SpecialChar menuseparator
10032 offers guidance on its use.
10033 Its documentation is available from
10034 \begin_inset CommandInset href
10037 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
10045 \begin_layout Subsection
10047 \change_inserted 564990737 1671442208
10051 \begin_layout Standard
10053 \change_inserted 564990737 1671643003
10057 \begin_inset space \space{}
10061 \begin_inset space \thinspace{}
10071 This allows the creation of customizable CVs.
10074 File\SpecialChar menuseparator
10075 Open Example\SpecialChar menuseparator
10076 Curricula Vitae\SpecialChar menuseparator
10079 offers guidance on its use.
10080 Its documentation is available from
10081 \begin_inset CommandInset href
10084 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
10092 \begin_layout Subsection
10094 \change_inserted 564990737 1671442208
10098 \begin_layout Standard
10100 \change_inserted 564990737 1671643024
10104 \begin_inset space \space{}
10108 \begin_inset space \thinspace{}
10118 originally developed for use with \SpecialChar LyX
10122 File\SpecialChar menuseparator
10123 Open Example\SpecialChar menuseparator
10124 Curricula Vitae\SpecialChar menuseparator
10127 offers guidance on its use.
10128 Its documentation is available from
10129 \begin_inset CommandInset href
10132 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
10140 \begin_layout Section
10142 \change_inserted 564990737 1672652454
10146 \begin_layout Standard
10148 \change_inserted 564990737 1672652455
10152 \begin_inset space \space{}
10158 \begin_inset space ~
10162 \begin_inset CommandInset ref
10164 reference "subsec:The-new-letter"
10172 \begin_inset space \space{}
10175 (with extra font sizes)
10178 \begin_inset space ~
10182 \begin_inset CommandInset ref
10184 reference "subsec:Extra-font-sizes"
10189 ) document classes .
10192 \begin_layout Subsection
10194 \change_inserted 564990737 1671041970
10198 \begin_layout Standard
10200 \change_inserted 564990737 1671617528
10209 document class for writing letters according to the
10211 Deutsches Institut für Normung
10214 The file in the menu
10219 ile\SpecialChar menuseparator
10221 \begin_inset space ~
10229 \begin_inset space ~
10232 Template\SpecialChar menuseparator
10233 Letters\SpecialChar menuseparator
10236 offers guidance on its use.
10237 The documentation is available from
10238 \begin_inset CommandInset href
10241 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
10249 \begin_layout Subsection
10251 \change_inserted 564990737 1672652499
10255 \begin_layout Standard
10257 \change_inserted 564990737 1672652499
10261 \begin_inset space \space{}
10270 document class for writing letters according to French conventions.
10271 The file in the menu
10276 ile\SpecialChar menuseparator
10278 \begin_inset space ~
10286 \begin_inset space ~
10289 Template\SpecialChar menuseparator
10290 Letters\SpecialChar menuseparator
10292 \begin_inset space \space{}
10297 offers guidance on its use.
10300 \begin_layout Subsection
10302 \change_inserted 564990737 1672652499
10306 \begin_layout Standard
10308 \change_inserted 564990737 1672652499
10312 \begin_inset space \thinspace{}
10321 document class for writing letters in German.
10322 The file in the menu
10327 ile\SpecialChar menuseparator
10329 \begin_inset space ~
10337 \begin_inset space ~
10340 Template\SpecialChar menuseparator
10341 Letters\SpecialChar menuseparator
10343 \begin_inset space \thinspace{}
10348 offers guidance on its use.
10349 The documentation is available from
10350 \begin_inset CommandInset href
10353 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
10361 \begin_layout Subsection
10363 \change_inserted 564990737 1671458835
10367 \begin_layout Standard
10369 \change_inserted 564990737 1671617591
10378 document class for English letters and to create mailing labels.
10379 The file in the menu
10384 ile\SpecialChar menuseparator
10386 \begin_inset space ~
10394 \begin_inset space ~
10397 Template\SpecialChar menuseparator
10398 Letters\SpecialChar menuseparator
10399 Letter (Standard Class)
10401 offers guidance on its use.
10404 \begin_layout Subsection
10406 \change_inserted 564990737 1672652527
10410 \begin_layout Standard
10412 \change_inserted 564990737 1672652527
10416 \begin_inset space \space{}
10425 document class for writing letters,
10426 faxes and envelopes in French.
10427 The file in the menu
10432 ile\SpecialChar menuseparator
10434 \begin_inset space ~
10442 \begin_inset space ~
10445 Template\SpecialChar menuseparator
10446 Letters\SpecialChar menuseparator
10448 \begin_inset space \space{}
10453 offers guidance on its use.
10454 The documentation is available from
10455 \begin_inset CommandInset href
10458 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
10466 \begin_layout Section
10468 \change_inserted 564990737 1670439660
10472 \begin_layout Subsection
10474 \change_inserted 564990737 1671458922
10478 \begin_layout Standard
10480 \change_inserted 564990737 1671617655
10484 \begin_inset space \thinspace{}
10493 document class for creating presentations.
10494 The file in the menu
10499 ile\SpecialChar menuseparator
10501 \begin_inset space ~
10509 \begin_inset space ~
10512 Template\SpecialChar menuseparator
10513 Presentations\SpecialChar menuseparator
10516 offers guidance on its use.
10517 The documentation is available from
10518 \begin_inset CommandInset href
10521 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
10529 \begin_layout Subsection
10532 Foil\SpecialChar TeX
10536 \begin_inset CommandInset label
10545 \begin_layout Standard
10547 \change_inserted 564990737 1672743383
10553 updated by the \SpecialChar LyX
10557 \begin_layout Subsubsection
10559 \change_inserted 564990737 1672743383
10563 \begin_layout Standard
10565 \change_inserted 564990737 1672743396
10569 \begin_inset space \thinspace{}
10572 (Foil\SpecialChar TeX
10579 document class to make slides for overhead projectors.
10580 There are two document classes that can do this:
10584 \begin_inset space \thinspace{}
10589 document class (section
10590 \begin_inset space ~
10594 \begin_inset CommandInset ref
10596 reference "sec:slitex"
10606 Foil\SpecialChar TeX
10610 As of 2023 the former has continued to be maintained whereas
10612 Foil\SpecialChar TeX
10615 has not been maintained since 2008.
10616 This section documents the latter.
10617 If your machine doesn’t have the
10620 \begin_inset space \thinspace{}
10623 (Foil\SpecialChar TeX
10626 document class installed,
10627 you’ll probably have to use the
10630 \begin_inset space \thinspace{}
10636 If you want to install the
10641 it is available from
10642 \begin_inset CommandInset href
10645 target "https://www.ctan.org/pkg/foiltex"
10651 You should also read the
10653 Installing New Document Classes
10660 \change_deleted 564990737 1672743436
10666 \begin_layout Standard
10668 \change_deleted 564990737 1672743383
10672 \begin_layout Standard
10674 \change_deleted 564990737 1672743383
10675 This section describes how to use \SpecialChar LyX
10676 to make slides for overhead projectors.
10677 There are two document classes that can do this:
10678 the default slides class and the
10680 Foil\SpecialChar TeX
10684 This section documents the latter.
10687 \begin_layout Standard
10689 \change_deleted 564990737 1672743383
10690 I'm going to say this again,
10692 so that there's no misunderstanding:
10695 \begin_layout Standard
10697 \change_deleted 564990737 1672743383
10698 \begin_inset VSpace bigskip
10704 \begin_layout Standard
10707 \change_deleted 564990737 1672743383
10710 This section documents the class
10711 \begin_inset Quotes eld
10719 \begin_inset Quotes erd
10727 \begin_layout Standard
10729 \change_deleted 564990737 1672743383
10730 \begin_inset VSpace bigskip
10736 \begin_layout Standard
10738 \change_deleted 564990737 1672743383
10739 If you're looking for the documentation for
10740 \begin_inset Quotes eld
10748 \begin_inset Quotes erd
10753 \begin_inset space ~
10757 \begin_inset CommandInset ref
10759 reference "sec:slitex"
10765 If your machine doesn't have the
10774 you'll probably have to use the default
10779 which isn't quite as good as
10784 \begin_layout Standard
10786 \change_deleted 564990737 1672743383
10791 class is designed for use with version
10792 \begin_inset space ~
10800 class file which is now an integral part of \SpecialChar LaTeX2e
10806 \begin_layout Subsubsection
10810 \begin_layout Standard
10812 to use this document class,
10824 \begin_inset space ~
10830 There are some settings in the
10833 \begin_inset space ~
10838 dialog that you should know about that are specific to this class:
10841 \begin_layout Itemize
10842 Don't change the options
10853 \begin_inset space ~
10859 They're ignored by the
10866 \begin_layout Itemize
10867 The default font size is 20
10868 \begin_inset space \thinspace{}
10871 pt with the other options being 17
10872 \begin_inset space \thinspace{}
10877 \begin_inset space \thinspace{}
10881 \begin_inset space \thinspace{}
10887 \begin_layout Itemize
10888 The default font is
10896 but all math equations are still typeset in the usual roman font.
10899 \begin_layout Itemize
10902 Foil\SpecialChar TeX
10905 supports A4 and Letter paper sizes as well as a special size for working with 35
10906 \begin_inset space \thinspace{}
10910 It doesn't support A5,
10912 legal or executive paper sizes.
10915 \begin_layout Itemize
10916 Don't bother changing the
10920 settings because they are ignored anyway.
10921 All floats appear where they are defined in the text.
10924 \begin_layout Itemize
10929 setting behaves a bit differently for this class.
10932 Foil\SpecialChar TeX
10935 provides extensive footer and header capabilities including a user-defined logo.
10937 \begin_inset space ~
10941 \begin_inset CommandInset ref
10943 reference "sec:foilfoot"
10949 The title page is treated differently to all other pages in the document and is
10957 has the logo centered at the bottom of the page (if one is defined).
10958 The possible page style choices and what they do are as follows:
10962 \begin_layout Labeling
10963 \labelwidthstring MMMMMMM
10970 The final output contains no page numbers,
10971 or other headers or footers (except footnotes of course).
10975 \begin_layout Labeling
10976 \labelwidthstring MMMMMMM
10983 The final output contains page numbers centered at the bottom of the page.
10984 No other headings or footers (other than footnotes).
10987 \begin_layout Labeling
10988 \labelwidthstring MMMMMMM
10993 Page numbers in lower right corner.
10994 Additional headers and footers are also shown.
10995 This is also the default.
10998 \begin_layout Labeling
10999 \labelwidthstring MMMMMMM
11004 Gives you access to the
11008 package although its use with
11010 Foil\SpecialChar TeX
11013 is discouraged by the writer of the
11015 Foil\SpecialChar TeX
11018 package because of some potential page layout clashes.
11022 \begin_layout Paragraph
11026 \begin_layout Standard
11027 The following options may be used in the extra class options in the
11029 Document\SpecialChar menuseparator
11035 \begin_layout Labeling
11036 \labelwidthstring MMMMMMx
11041 This sets up the page layout for 7.33
11042 \begin_inset space \thinspace{}
11046 \begin_inset space \thinspace{}
11050 which is about the same aspect ratio as a 35
11051 \begin_inset space \thinspace{}
11055 making it a bit easier to work with this medium.
11058 \begin_layout Labeling
11059 \labelwidthstring MMMMMMx
11064 Places a rule across the page below the header on every page except the title page.
11067 \begin_layout Labeling
11068 \labelwidthstring MMMMMMx
11073 Places a rule across the page above the footer on every page except the title page.
11076 \begin_layout Labeling
11077 \labelwidthstring MMMMMMx
11082 This is automatically set each time you create a new
11089 Foil\SpecialChar TeX
11092 to use the dvips driver to rotate those pages that are set as landscape foils.
11095 \begin_layout Labeling
11096 \labelwidthstring MMMMMMx
11101 Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
11102 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.
11103 Note that this option effectively reverses the roles of the
11111 environments (don't worry these are described in the next section).
11114 \begin_layout Labeling
11115 \labelwidthstring MMMMMMx
11120 Equation numbers on the left.
11123 \begin_layout Labeling
11124 \labelwidthstring MMMMMMx
11129 Flush-left equations.
11132 \begin_layout Subsubsection
11133 Supported Environments
11136 \begin_layout Standard
11137 Most of the environments commonly supported in other classes are also supported by the
11142 There are several additional environments provided by
11144 Foil\SpecialChar TeX
11147 as well as a couple added by \SpecialChar LyX
11149 The following environments are shared with other classes:
11152 \begin_layout Standard
11153 \begin_inset Flex Multiple Columns
11156 \begin_layout Itemize
11162 \begin_layout Itemize
11168 \begin_layout Itemize
11174 \begin_layout Itemize
11180 \begin_layout Itemize
11186 \begin_layout Itemize
11193 \begin_layout Itemize
11199 \begin_layout Itemize
11205 \begin_layout Itemize
11211 \begin_layout Itemize
11217 \begin_layout Itemize
11223 \begin_layout Itemize
11229 \begin_layout Itemize
11235 \begin_layout Itemize
11241 \begin_layout Itemize
11252 \begin_layout Standard
11254 all the major environments apart from the sectioning environments.
11255 Since foils are essentially self-contained sections,
11256 with a title and body,
11259 Foil\SpecialChar TeX
11262 provides specific commands for starting new foils and these are:
11265 \begin_layout Itemize
11271 \begin_layout Itemize
11277 \begin_layout Standard
11279 also provides slightly modified versions of these two environments called:
11282 \begin_layout Itemize
11288 \begin_layout Itemize
11291 ShortRotatefoilhead
11294 \begin_layout Standard
11295 and the differences will be explained in the next section.
11298 \begin_layout Standard
11299 Since foils are often used in presenting ideas or new theorems and such
11301 Foil\SpecialChar TeX
11304 also provides a comprehensive box of goodies for presenting them:
11307 \begin_layout Standard
11308 \begin_inset Flex Multiple Columns
11311 \begin_layout Itemize
11317 \begin_layout Itemize
11323 \begin_layout Itemize
11329 \begin_layout Itemize
11335 \begin_layout Itemize
11341 \begin_layout Itemize
11347 \begin_layout Itemize
11353 \begin_layout Itemize
11359 \begin_layout Itemize
11365 \begin_layout Itemize
11371 \begin_layout Itemize
11382 \begin_layout Standard
11383 The starred versions are unnumbered while the unstarred versions are numbered.
11384 There are also two list environments added by \SpecialChar LyX
11388 \begin_layout Itemize
11394 \begin_layout Itemize
11400 \begin_layout Standard
11403 Foil\SpecialChar TeX
11406 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.
11407 If you want to change these settings in your document the best place to do so is at the very top of a foil,
11409 \begin_inset space \thinspace{}
11415 \begin_inset space \space{}
11420 straight after the foilhead.
11423 \begin_layout Standard
11425 the following command styles are provided [
11432 \begin_layout Standard
11433 \begin_inset Flex Multiple Columns
11436 \begin_layout Itemize
11440 \begin_inset space ~
11446 \begin_layout Itemize
11452 \begin_layout Itemize
11456 \begin_inset space ~
11462 \begin_layout Itemize
11466 \begin_inset space ~
11472 \begin_layout Itemize
11476 \begin_inset space ~
11483 \begin_layout Plain Layout
11484 \begin_inset space ~
11496 \begin_layout Standard
11497 There are also a few commands provided by
11499 Foil\SpecialChar TeX
11502 that aren't directly supported by \SpecialChar LyX
11503 but I'll tell you what they do and how to use them in section
11504 \begin_inset space ~
11508 \begin_inset CommandInset ref
11510 reference "sec:unsuppfoils"
11518 \begin_layout Subsubsection
11519 Building a Set of Foils
11522 \begin_layout Standard
11523 This section will give a simple introduction to using the different environments to build a set of foils.
11524 If you want to see an example set of foils,
11526 \change_deleted 564990737 1671643085
11531 file you find in \SpecialChar LyX
11537 \change_inserted 564990737 1671643099
11540 File\SpecialChar menuseparator
11541 Open Example\SpecialChar menuseparator
11542 Presentations\SpecialChar menuseparator
11550 \begin_layout Paragraph
11551 Give It a Title Page
11554 \begin_layout Standard
11555 Unlike other classes that provide
11578 creates the title on a page of its own.
11579 If you leave out the
11583 environment \SpecialChar LaTeX
11584 will substitute the current date (every time you regenerate the output).
11587 \begin_layout Paragraph
11591 \begin_layout Standard
11592 As I mentioned earlier,
11593 there are four ways of starting a new foil.
11594 For portrait foils you should use
11603 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.
11606 \begin_layout Standard
11607 Landscape foils are generated using the
11613 ShortRotatefoilhead
11616 Again the only difference is the spacing between foilhead and body.
11617 Both of the short versions have 0.5
11618 \begin_inset space ~
11621 inches less separation between the foilhead and the body.
11625 \begin_layout Standard
11626 One problem with the support for landscape foils is the requirement that you have to use the
11630 driver to generate the PostScript output otherwise the foils won't be rotated.
11631 It is possible to get landscape foils even if you haven't got the
11635 driver provided you can feed your foils sideways through your printer ;-)
11638 \begin_layout Paragraph
11644 \begin_layout Standard
11645 You can't have two of the same type of these environments directly following each other.
11646 If you use a normal paragraph break,
11648 you will just be extending the previous environment as if you had merged the two environments together.
11650 you need to insert a so-called separator.
11651 Please refer to the section entitled
11662 \begin_layout Paragraph
11666 \begin_layout Standard
11667 You get all the commonly supported list styles found in other classes as well as two new ones.
11668 I'll only describe the new ones here.
11669 If you want to find out more about the other list environments check out the
11674 If you intend to use itemized lists you might also want to read about the
11677 \begin_inset space ~
11681 \begin_inset space ~
11686 dialog described above in section
11687 \begin_inset space ~
11691 \change_inserted 564990737 1671355684
11693 \begin_inset CommandInset ref
11695 reference "chap:bullets"
11701 \change_deleted 564990737 1671355684
11703 \begin_inset CommandInset ref
11705 reference "sec:bullet"
11715 \begin_layout Standard
11716 The two new list styles,
11726 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.
11727 These lists are in fact dedicated variants of the
11732 They do however require that you have the
11736 packages installed.
11739 \begin_layout Paragraph
11743 \begin_layout Standard
11746 Foil\SpecialChar TeX
11749 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.
11750 In fact if you change the float placement settings they are simply ignored.
11753 \begin_layout Paragraph
11754 Page Headers and Footers
11755 \begin_inset CommandInset label
11757 name "sec:foilfoot"
11764 \begin_layout Standard
11768 \begin_inset space ~
11777 are two commands used to control the left-footer text string.
11778 The first is meant to allow you to include a graphic logo on your foils and defaults to
11779 \begin_inset Quotes eld
11784 Foil\SpecialChar TeX
11788 \begin_inset Quotes erd
11792 While the second is meant to provide a classification for the audience,
11796 \begin_inset space \thinspace{}
11802 \begin_inset space \space{}
11806 It is empty by default.
11809 \begin_layout Standard
11810 The remaining page corners can be filled by
11813 \begin_inset space ~
11818 (which defaults to page numbers),
11822 \begin_inset space ~
11830 \begin_inset space ~
11838 \begin_layout Subsubsection
11841 Foil\SpecialChar TeX
11845 \begin_inset CommandInset label
11847 name "sec:unsuppfoils"
11854 \begin_layout Standard
11855 All the commands mentioned below need to be set in a
11865 within another environment.
11868 \begin_layout Paragraph
11872 \begin_layout Standard
11873 All lengths are adjusted using the
11896 should be replaced by the name given to the length you want to change and
11900 is the length value.
11901 All lengths should be specified in units of length such as inches (
11914 ) or relative to some document or font-based length such as
11924 \begin_layout Standard
11925 It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
11938 \begin_inset space \space{}
11941 in closer to their bodies put the following in the preamble:
11948 foilheadskip}{-0.5in}
11951 \begin_layout Standard
11952 The spacings around floats can be adjusted by setting these lengths:
11955 \begin_layout Labeling
11956 \labelwidthstring MMMMMMMMMMM
11963 Separation between the text and the top of the float
11966 \begin_layout Labeling
11967 \labelwidthstring MMMMMMMMMMM
11974 Separation between the float and the caption
11977 \begin_layout Labeling
11978 \labelwidthstring MMMMMMMMMMM
11985 Separation between the caption and the following text
11988 \begin_layout Labeling
11989 \labelwidthstring MMMMMMMMMMM
11996 You can make the captions narrower than the surrounding text by adjusting this length.
11997 Best done relative to
12006 \begin_layout Standard
12007 There are also several title page related lengths that you may find useful if you have a long title or several authors:
12010 \begin_layout Labeling
12011 \labelwidthstring MMMMMMMMMMM
12018 Separation from headers to
12023 \begin_layout Labeling
12024 \labelwidthstring MMMMMMMMMMM
12042 \begin_layout Labeling
12043 \labelwidthstring MMMMMMMMMMM
12057 \begin_layout Labeling
12058 \labelwidthstring MMMMMMMMMMM
12074 \begin_layout Labeling
12075 \labelwidthstring MMMMMMMMMMM
12091 \begin_layout Standard
12092 The last length related command affects all the list environments.
12103 a list environment then all the vertical spacing between the list items is removed.
12104 Note that this is a command not a length so it doesn't require
12110 like the stuff mentioned above.
12113 \begin_layout Paragraph
12114 Headers and Footers
12117 \begin_layout Standard
12130 commands control whether the logo in the
12134 definition appear on a given page.
12141 in the preamble then none of the foils will have the logo on them.
12142 If you don't want the logo on a particular page place the
12148 directly after the foilhead of that page and the
12154 directly after the next foilhead.
12157 \begin_layout Standard
12158 If you decide to use the
12162 page style setting in the
12165 \begin_inset space ~
12170 dialog you should probably add
12180 to your preamble so headers and footers on landscape pages are correctly placed when rotated.
12181 This is due to some clashes between the page layouts provided by the
12192 \begin_layout Subsection
12194 \change_inserted 564990737 1671459032
12198 \begin_layout Standard
12200 \change_inserted 564990737 1671643165
12204 \begin_inset space \thinspace{}
12213 document class for creating presentations.
12216 File\SpecialChar menuseparator
12217 Open Example\SpecialChar menuseparator
12218 Presentations\SpecialChar menuseparator
12221 offers guidance on its use.
12222 The documentation is available from
12223 \begin_inset CommandInset href
12226 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
12234 \begin_layout Subsection
12236 \change_inserted 564990737 1671459032
12237 \begin_inset CommandInset label
12239 name "subsec:Seminar"
12248 \begin_layout Standard
12250 \change_inserted 564990737 1671643194
12254 \begin_inset space \thinspace{}
12263 document class for creating presentations.
12266 File\SpecialChar menuseparator
12267 Open Example\SpecialChar menuseparator
12268 Presentations\SpecialChar menuseparator
12271 offers guidance on its use.
12272 The documentation is available from
12273 \begin_inset CommandInset href
12276 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
12284 \begin_layout Subsection
12287 Sli\SpecialChar TeX
12291 \begin_inset CommandInset label
12300 \begin_layout Standard
12302 \change_inserted 564990737 1672743492
12308 updated by the \SpecialChar LyX
12312 \begin_layout Subsubsection
12314 \change_inserted 564990737 1672743492
12318 \begin_layout Standard
12320 \change_inserted 564990737 1672743492
12321 This section describes how to use \SpecialChar LyX
12322 to make slides for overhead projectors.
12323 There are two document classes that can do this:
12327 \begin_inset space \thinspace{}
12332 document class and the
12335 \begin_inset space \thinspace{}
12338 (Foil\SpecialChar TeX
12342 This section documents the former.
12343 If you’re looking for the documentation for
12346 \begin_inset space \thinspace{}
12349 (Foil\SpecialChar TeX
12354 \begin_inset space ~
12358 \begin_inset CommandInset ref
12360 reference "sec:Foiltex"
12366 As of 2023 the former has continued to be maintained whereas
12368 Foil\SpecialChar TeX
12371 has not been maintained since 2008.
12373 \change_deleted 564990737 1672743492
12381 \begin_layout Standard
12383 \change_deleted 564990737 1672743492
12387 \begin_layout Standard
12389 \change_deleted 564990737 1672743492
12390 This section describes how to use \SpecialChar LyX
12391 to make slides for overhead projectors.
12392 There are two document classes that can do this:
12393 the default slides class and the
12395 Foil\SpecialChar TeX
12399 This section documents the former.
12402 \begin_layout Standard
12404 \change_deleted 564990737 1672743492
12405 I'm going to say this again,
12407 so that there's no misunderstanding:
12410 \begin_layout Standard
12412 \change_deleted 564990737 1672743492
12413 \begin_inset VSpace bigskip
12419 \begin_layout Standard
12422 \change_deleted 564990737 1672743492
12425 This section documents the class
12426 \begin_inset Quotes eld
12434 \begin_inset Quotes erd
12442 \begin_layout Standard
12444 \change_deleted 564990737 1672743492
12445 \begin_inset VSpace bigskip
12451 \begin_layout Standard
12453 \change_deleted 564990737 1672743492
12454 If you're looking for the documentation for
12455 \begin_inset Quotes eld
12460 slides (Foil\SpecialChar TeX
12464 \begin_inset Quotes erd
12469 \begin_inset space ~
12473 \begin_inset CommandInset ref
12475 reference "sec:foiltex"
12486 \begin_inset Quotes eld
12491 slides (Foil\SpecialChar TeX
12495 \begin_inset Quotes erd
12498 ] is actually somewhat better than the default
12506 \begin_layout Plain Layout
12508 or so I've been told repeatedly by its advocates.
12509 Having never used it,
12510 I have no idea if this claim is true or not.
12515 which this section documents.
12518 \begin_layout Standard
12520 \change_deleted 564990737 1672743492
12521 This class is the \SpecialChar LaTeX2e
12522 improvement of the old
12524 Sli\SpecialChar TeX
12528 Every \SpecialChar LaTeX2e
12529 distribution includes this class [which I'll just refer to as
12530 \begin_inset Quotes eld
12538 \begin_inset Quotes erd
12542 so you're bound to have it.
12543 As I noted earlier,
12544 there are other classes,
12550 which also produce slides for overhead projectors and do a better job at it.
12552 there are some things which
12556 can do which the others can't,
12557 such as generate overlays.
12558 Read on to learn more!
12563 \begin_layout Subsubsection
12565 \begin_inset CommandInset label
12567 name "sec:slidesetup"
12574 \begin_layout Standard
12576 to use this document class,
12578 \begin_inset Quotes eld
12586 \begin_inset Quotes erd
12589 from the class list in the
12591 Document\SpecialChar menuseparator
12595 There are some other special things you should know about this class:
12598 \begin_layout Itemize
12599 Don't bother changing the options
12604 They're not supported by the
12612 \begin_layout Itemize
12616 \begin_inset space ~
12621 behaves a bit differently for this class.
12622 The possible choices and what they do are as follows:
12626 \begin_layout Description
12631 The final output contains page numbers in the lower right corner.
12634 \begin_layout Description
12644 but also prints out any time markers you've put in.
12645 This is the default.
12648 \begin_layout Description
12653 The final output contains no page numbers,
12655 or alignment markers.
12659 \begin_layout Itemize
12664 class has an extra option:
12672 \begin_inset Quotes eld
12680 \begin_inset Quotes erd
12683 in the extra class options.
12687 \begin_layout Standard
12688 Using this options allows you to add time markers to
12694 \begin_inset space ~
12698 \begin_inset CommandInset ref
12700 reference "sec:slideNote"
12709 \begin_layout Standard
12710 You can also use the template file
12711 \change_deleted 564990737 1671617694
12713 \begin_inset Quotes eld
12721 \begin_inset Quotes erd
12726 to automatically set up a document to use the
12731 \change_deleted 564990737 1671617699
12736 File\SpecialChar menuseparator
12738 \begin_inset space ~
12742 \begin_inset space ~
12746 \change_inserted 564990737 1671617723
12747 \SpecialChar menuseparator
12748 Presentations\SpecialChar menuseparator
12753 to open your new document
12754 \change_deleted 564990737 1671617728
12758 The template file also contains some examples of the special paragraph environments used by this class.
12759 I'll describe those next.
12762 \begin_layout Subsubsection
12763 Paragraph Environments
12766 \begin_layout Paragraph
12767 Supported Environments
12770 \begin_layout Standard
12771 The first thing you'll notice when you start up a new
12775 document is the font size and type:
12776 it's the equivalent of the size
12777 \begin_inset Quotes eld
12785 \begin_inset Quotes erd
12791 \begin_inset space ~
12797 This is also what's used in the output.
12799 \begin_inset Quotes eld
12803 \begin_inset Quotes erd
12806 to remind you that this is a slide.
12807 Your final slides will use a larger font;
12809 you'll have less space.
12811 the larger default screen font isn't WYSIWYG,
12815 \begin_layout Standard
12816 The next thing that becomes obvious is the changes to the paragraph environment pull-down box [at the far-left end of the toolbar].
12817 Most of the paragraph environments you're used to seeing are missing.
12818 There are also five new ones.
12823 class itself only supports certain paragraph environments:
12826 \begin_layout Itemize
12832 \begin_layout Itemize
12838 \begin_layout Itemize
12844 \begin_layout Itemize
12850 \begin_layout Itemize
12856 \begin_layout Itemize
12862 \begin_layout Itemize
12868 \begin_layout Itemize
12874 \begin_layout Itemize
12880 \begin_layout Itemize
12887 \begin_layout Standard
12888 All of the other standard environments,
12889 including the section-heading environments,
12897 \begin_layout Standard
12899 you'll notice the following new environments:
12902 \begin_layout Itemize
12908 \begin_layout Itemize
12914 \begin_layout Itemize
12920 \begin_layout Itemize
12926 \begin_layout Itemize
12932 \begin_layout Standard
12933 These five are kind of quirky,
12935 \begin_inset Quotes eld
12939 \begin_inset Quotes erd
12942 in \SpecialChar LyX
12946 doesn't permit you to nest any other paragraph environment into an empty environment.
12948 that's fine and dandy,
12949 but it means that you wouldn't be able to start a slide with anything except plain text.
12951 I've performed a little
12952 \begin_inset Quotes eld
12957 \begin_inset Quotes erd
12963 \begin_layout Paragraph
12964 Quirks of the New Environments
12965 \begin_inset CommandInset label
12967 name "sec:slideQuirk"
12974 \begin_layout Standard
12975 All five of the new paragraph environments are somewhat quirky due to inherent limitiations in the current version of \SpecialChar LyX
12977 As I just mentioned,
12979 forbids environments that begin with another environment.
12980 To get around this,
12985 environment isn't a paragraph environment as described in the
12993 \begin_layout Standard
12994 You should consider
13009 \begin_inset Quotes eld
13012 pseudo-environments.
13013 \begin_inset Quotes erd
13016 They look like a section heading or a
13017 \begin_inset Quotes eld
13025 \begin_inset Quotes erd
13028 but really begin a [and,
13030 end the previous] paragraph environment.
13041 \begin_inset Quotes eld
13045 \begin_inset Quotes erd
13048 These two perform some action.
13051 \begin_layout Standard
13052 A common feature of all five environments,
13077 is a rather long-ish label.
13078 The text following this label —
13079 ordinarily the contents of the paragraph environment —
13080 is utterly irrelevant for
13105 completely ignores it.
13107 you can leave these five environments completely empty.
13111 \begin_layout Standard
13116 to put any text after the rather long-ish label,
13118 This could be a short description of the contents of the
13125 enter your descriptive comment and hit
13129 as you normally would.
13132 \begin_layout Standard
13135 you don't want to enter any descriptive text,
13136 you'll hit another \SpecialChar LyX
13142 and will not let you start a new paragraph environment until you put something in the old one.
13147 \begin_layout Itemize
13148 Start entering the text that will
13179 \begin_layout Itemize
13180 Now move to the beginning of that paragraph.
13184 \begin_layout Itemize
13194 \begin_layout Itemize
13197 empty paragraph to a
13224 \begin_layout Standard
13225 Some future version of \SpecialChar LyX
13228 resolve this quirkiness\SpecialChar ldots
13232 \begin_layout Subsubsection
13233 Making a Presentation with
13247 \begin_layout Paragraph
13255 \begin_layout Standard
13256 If you're expecting this section to teach you how to actually make a presentation,
13257 you'll be sorely disappointed.
13259 I'll describe all of the ways the
13263 class can assist you in preparing the materials for a presentation.
13264 Filling in the contents,
13272 the \SpecialChar LyX
13276 \begin_layout Standard
13281 environment [in the manner described in section
13282 \begin_inset space ~
13286 \begin_inset CommandInset ref
13288 reference "sec:slideQuirk"
13293 ] tells \SpecialChar LyX
13294 to begin a new slide [duh].
13295 The label for this environment/
13296 \begin_inset Quotes erd
13300 \begin_inset Quotes erd
13304 \begin_inset Quotes eld
13308 \begin_inset Quotes erd
13312 followed by the label,
13314 \begin_inset Quotes eld
13318 \begin_inset Quotes erd
13322 Any text or paragraph environments that follow this one go on the new slide.
13326 \begin_layout Standard
13327 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
13328 (this can be specified in the
13335 once you finish entering the contents of one slide.
13336 If you've entered more text than can physically fit on a slide,
13337 the extra overflows onto a new slide.
13338 I don't recommend doing this,
13340 since the overflow slide won't have any page number on it.
13342 it may interfere with any
13346 you've made to accompany the oversized
13353 \begin_layout Standard
13362 environments work the same way as the
13367 They both create an
13368 \begin_inset Quotes eld
13372 \begin_inset Quotes erd
13375 followed by a label [
13376 \begin_inset Quotes eld
13380 \begin_inset Quotes erd
13384 \begin_inset Quotes eld
13388 \begin_inset Quotes erd
13393 The color is a stunning magenta instead of blue,
13395 \begin_inset Quotes eld
13399 \begin_inset Quotes erd
13402 will look different,
13403 in style and in length.
13404 The label fonts of all three also differ from one another.
13407 \begin_layout Standard
13413 if the contents of a
13421 exceed the physical size of a slide or sheet of paper,
13422 the extra will overflow onto a new sheet.
13424 you should avoid this.
13425 It defeats the whole purpose of
13436 \begin_layout Paragraph
13446 \begin_layout Standard
13451 is a slide that sits atop another slide.
13452 Perhaps you wish to discuss a figure on the main
13456 before displaying the text associated with it.
13457 One way to accomplish this is tape a flap of dark paper over the part of the
13461 you want to display later.
13464 if you wish to overlap one graph with another,
13466 You would then have to fumble while speaking to align the two separate,
13471 s to align the two graphs.
13476 environment in both cases makes life much easier.
13479 \begin_layout Standard
13484 receives the page number of its
13485 \begin_inset Quotes eld
13489 \begin_inset Quotes erd
13498 \begin_inset Quotes eld
13506 \begin_inset Quotes erd
13513 \begin_layout Plain Layout
13520 \begin_inset Quotes eld
13528 \begin_inset Quotes erd
13533 \begin_inset Quotes eld
13541 \begin_inset Quotes erd
13546 \begin_inset Quotes eld
13554 \begin_inset Quotes erd
13559 \begin_inset space ~
13562 appended to the page number of the parent
13573 you want the contents of both the
13581 to each fit on a single physical slide!
13582 You should probably consider an
13587 \begin_inset Quotes eld
13591 \begin_inset Quotes erd
13600 the \SpecialChar LyX
13605 class provides a visual cue for this:
13606 the label at the start of an
13610 is shorter than that at the start of a
13616 when you generate printable output,
13617 you'll find alignment markers in all four corners of both the
13621 page and its parent
13626 These will assist you in lining up the two physical slides.
13629 \begin_layout Standard
13630 The major problem in overlaying two slides is aligning the contents of the two transparencies.
13631 How much space should you leave for that graph on the second slide?
13633 what if you want a graph and a sentence on second slide,
13634 but there is text on the main transparency that goes in between them?
13635 You could try and insert vertical space of the right size.
13636 The better way is to use
13647 \begin_layout Standard
13648 As their names imply,
13657 are two command-like paragraph environments that make all subsequent text invisible and visible,
13660 \begin_inset space ~
13664 \begin_inset CommandInset ref
13666 reference "sec:slideQuirk"
13671 that you don't place anything
13675 these two environments,
13682 it inserts a centered,
13683 sky-blue label into the page reading
13684 \begin_inset Quotes eld
13687 <Invisible Text Follows>
13688 \begin_inset Quotes erd
13692 For paragraphs following this label,
13702 it doesn't matter which] where they would be contain instead blank space.
13706 \begin_layout Standard
13712 the corresponding centered label is
13713 \begin_inset Quotes eld
13716 <Visible Text Follows>
13717 \begin_inset Quotes erd
13721 Paragraphs following this label behave normally.
13722 Note that the beginning of a new
13736 automatically shuts off an
13741 It's therefore not necessary to use
13752 \begin_layout Standard
13754 it should be obvious how to create overlay transparencies using the proper combination of
13773 \begin_layout Enumerate
13779 including everything that will appear on it,
13780 whether on the main slide or on the
13787 \begin_layout Enumerate
13788 Before each figure or paragraph that will appear only on the
13803 environment after the
13810 \begin_layout Enumerate
13815 immediately following the
13822 \begin_layout Enumerate
13823 Copy the contents of this
13834 \begin_layout Enumerate
13851 \begin_layout Standard
13853 You've just made an
13860 \begin_layout Standard
13861 There's one problem with the way I've designed the \SpecialChar LyX
13867 you can't make text in the middle of a paragraph invisible,
13868 nor make text in the middle of an invisible paragraph visible again.
13869 To accomplish this feat,
13870 you'll need to use some inlined \SpecialChar LaTeX
13875 \begin_layout Plain Layout
13876 The commands of interest are:
13880 \begin_layout Itemize
13885 invisible \SpecialChar ldots
13889 \begin_layout Itemize
13894 visible \SpecialChar ldots
13898 \begin_layout Plain Layout
13900 and need to be marked as \SpecialChar TeX
13903 \begin_inset Quotes eld
13907 \begin_inset Quotes erd
13910 you wish to change goes in between the brackets [and after the
13923 If you don't know how to mark text as \SpecialChar TeX
13925 see the appropriate section of the
13937 \begin_layout Paragraph
13947 \begin_inset CommandInset label
13949 name "sec:slideNote"
13956 \begin_layout Standard
13966 is associated with a
13967 \begin_inset Quotes eld
13971 \begin_inset Quotes erd
13981 the \SpecialChar LyX
13986 class provides visual cues.
13991 is shorter than that of a
13995 [yet longer than that of an
14000 like the label of an
14004 is shockingly magenta.
14010 has the page number of its
14011 \begin_inset Quotes eld
14015 \begin_inset Quotes erd
14024 \begin_inset Quotes eld
14032 \begin_inset Quotes erd
14037 \begin_inset Quotes eld
14045 \begin_inset Quotes erd
14050 \begin_inset Quotes eld
14058 \begin_inset Quotes erd
14063 You can have multiple
14067 s associated with a single
14082 you'll probably want to break up long
14086 s so that they fit on a single sheet of paper.
14089 \begin_layout Standard
14095 it contains anything additional you might want to say about a
14100 It could also be used as a sheet of reminders for a particular
14105 In the case of the latter,
14106 you might want to make use of time markers.
14108 the \SpecialChar LyX
14114 \begin_inset Quotes eld
14118 \begin_inset Quotes erd
14121 support for time markers,
14124 Sli\SpecialChar TeX
14129 you'll have to resort to using the \SpecialChar LaTeX
14133 \begin_layout Standard
14134 To use time markers,
14135 you'll need to specify the extra class option
14136 \begin_inset Quotes eld
14144 \begin_inset Quotes erd
14148 \begin_inset space ~
14152 \begin_inset CommandInset ref
14154 reference "sec:slidesetup"
14160 This option turns on timing marks,
14161 which will appear in the lower-left-hand corner of every
14166 To set what appears in the time marker,
14167 you use the \SpecialChar LaTeX
14169 \begin_inset Quotes eld
14179 \begin_inset Quotes erd
14183 \begin_inset Quotes eld
14193 \begin_inset Quotes erd
14197 The arguments of both commands are time measured in seconds.
14199 \begin_inset Quotes eld
14209 \begin_inset Quotes erd
14212 sets the time marker to a given time.
14214 \begin_inset Quotes eld
14224 \begin_inset Quotes erd
14227 increments the time marker by the specified amount.
14228 Using time markers and
14233 you can remind yourself how much time to spend on a particular
14240 \begin_layout Standard
14241 There's one last feature to describe.
14243 you'd like to print out all of your
14251 s on transparencies while printing all of your
14269 with which it is associated.
14270 What's a person to do?
14273 \begin_layout Standard
14275 there are two \SpecialChar LaTeX
14276 commands that allow you to select what to print out.
14277 Both must be placed into the preamble of your document.
14279 \begin_inset Quotes eld
14291 \begin_inset Quotes erd
14294 will cause the output to contain only the
14305 \begin_inset Quotes eld
14317 \begin_inset Quotes erd
14320 prevents the output of anything but
14325 I'd advise placing both commands in the preamble and initially comment both out.
14326 You can then preview your entire presentation as you write.
14327 When you're done writing,
14328 you can then uncomment one of the two to select what you want to print.
14329 I like to uncomment
14330 \begin_inset Quotes eld
14342 \begin_inset Quotes erd
14346 print to a file with
14347 \begin_inset Quotes eld
14355 \begin_inset Quotes erd
14359 comment it back out,
14361 \begin_inset Quotes eld
14373 \begin_inset Quotes erd
14377 \begin_inset Quotes eld
14385 \begin_inset Quotes erd
14389 I can then send either file to a printer,
14390 loading transparencies or plain paper as appropriate.
14393 \begin_layout Standard
14394 You can also provide other arguments to the
14395 \begin_inset Quotes eld
14405 \begin_inset Quotes erd
14409 \begin_inset Quotes eld
14419 \begin_inset Quotes erd
14423 See a good \SpecialChar LaTeX
14427 \begin_layout Subsubsection
14432 Class Template File
14435 \begin_layout Standard
14436 I have also provided a template file
14437 \change_deleted 564990737 1671617750
14440 \begin_inset Quotes eld
14448 \begin_inset Quotes erd
14460 begin your new presentation with
14462 File\SpecialChar menuseparator
14464 \begin_inset space ~
14468 \begin_inset space ~
14472 \change_inserted 564990737 1671616988
14473 \SpecialChar menuseparator
14474 Presentations\SpecialChar menuseparator
14480 Your new \SpecialChar LyX
14481 presentation file will contain an example
14502 additionally contain an example of the use of
14512 the preamble will contain:
14515 \begin_layout LyX-Code
14516 % Uncomment to print out only slides and overlays
14519 \begin_layout LyX-Code
14523 \begin_layout LyX-Code
14529 \begin_inset Newline newline
14535 \begin_layout LyX-Code
14536 % Uncomment to print out only notes
14539 \begin_layout LyX-Code
14543 \begin_layout LyX-Code
14551 \begin_layout Standard
14553 I created this class to support the \SpecialChar LaTeX2e
14555 \begin_inset Quotes eld
14560 Sli\SpecialChar TeX
14564 \begin_inset Quotes erd
14568 one of the built-in \SpecialChar LaTeX2e
14570 Neither I nor the rest of the \SpecialChar LyX
14571 Team endorse or oppose the use of this built-in slide class.
14572 It's here if you want it or need it.
14573 There exist other \SpecialChar LaTeX2e
14574 classes for creating presentations,
14580 \begin_inset space ~
14584 \begin_inset CommandInset ref
14586 reference "sec:foiltex"
14592 \begin_inset Quotes eld
14600 \begin_inset Quotes erd
14603 package [present on some \SpecialChar TeX
14605 The latter is not yet supported under \SpecialChar LyX
14610 \begin_layout Plain Layout
14611 Perhaps you can take on the task\SpecialChar ldots
14617 I know nothing about these other classes.
14618 Try them out to see what sort of alternative they provide.
14621 \begin_layout Section
14623 \change_inserted 564990737 1670439661
14627 \begin_layout Subsection
14629 \change_inserted 564990737 1670439661
14633 \begin_layout Standard
14635 \change_inserted 564990737 1670439661
14644 document class for preparing reports.
14650 this provides parts,
14651 chapters and sections but does not provide the paragraph styles needed for a book;
14657 it provides the abstract paragraph style.
14659 it does not start a new chapter on the right hand page.
14662 \begin_layout Standard
14664 \change_inserted 564990737 1672743528
14669 document classes are described in the Collections (section
14670 \begin_inset space ~
14674 \begin_inset CommandInset ref
14676 reference "sec:Collections"
14684 \begin_layout Standard
14686 \change_inserted 564990737 1672743530
14690 \begin_inset space \thinspace{}
14693 (Japanese in vertical writing)
14698 \begin_inset space \thinspace{}
14705 \begin_inset space ~
14709 \begin_inset CommandInset ref
14711 reference "subsec:Japanese"
14719 \begin_layout Standard
14721 \change_inserted 564990737 1672743530
14725 \begin_inset space \thinspace{}
14732 \begin_inset space ~
14736 \begin_inset CommandInset ref
14738 reference "subsec:KOMA-Script"
14746 \begin_layout Standard
14748 \change_inserted 564990737 1672743530
14752 \begin_inset space \thinspace{}
14755 (with extra font sizes)
14759 \begin_inset space ~
14763 \begin_inset CommandInset ref
14765 reference "subsec:Extra-font-sizes"
14773 \begin_layout Standard
14775 \change_inserted 564990737 1672743569
14779 \begin_inset space \thinspace{}
14782 (Polish version by M.
14783 \begin_inset space \thinspace{}
14790 \begin_inset space ~
14794 \begin_inset CommandInset ref
14796 reference "subsec:Polish-M.W.collection"
14807 \begin_layout Section
14809 \change_inserted 564990737 1670439674
14813 \begin_layout Subsection
14817 \begin_layout Standard
14823 \begin_layout Subsubsection
14827 \begin_layout Standard
14828 Broadway is for writing plays.
14829 The format is more decorative than Hollywood,
14830 and much less standardized.
14831 This format should be suitable for workshops.
14834 \begin_layout Subsubsection
14838 \begin_layout Standard
14839 The same as in Hollywood.
14842 \begin_layout Subsubsection
14846 \begin_layout Standard
14851 names as labels then cross-reference the label to insert the name.
14852 The cross-reference dialog will show the current cast of characters.
14855 \begin_layout Subsubsection
14856 Paper size and Margins
14859 \begin_layout Standard
14867 \begin_layout Subsubsection
14871 \begin_layout Standard
14872 The following environments are available.
14873 You can use broadway.bind to get the bind keys shown at the right.
14876 \begin_layout Itemize
14880 \begin_inset Newline newline
14885 You should not have to use this,
14886 but it is here for anything that does not fit otherwise.
14889 \begin_layout Itemize
14893 \begin_inset space \hfill{}
14897 \begin_inset Newline newline
14902 Used to describe stage setting and the action.
14903 First use of speaker names in all CAPs.
14906 \begin_layout Itemize
14910 \begin_inset space \hfill{}
14914 \begin_inset Newline newline
14919 Automatically numbered.
14920 On screen it will be arabic,
14921 but will print as Roman.
14924 \begin_layout Itemize
14928 \begin_inset space \hfill{}
14932 \begin_inset Newline newline
14942 It is just centered text.
14945 \begin_layout Itemize
14949 \begin_inset space \hfill{}
14953 \begin_inset Newline newline
14958 Not automatically numbered.
14959 You supply the number.
14960 This is because I couldn't figure out how.
14963 \begin_layout Itemize
14967 \begin_inset space \hfill{}
14971 \begin_inset Newline newline
14976 A special case of Narrative to describe the setting and action as the curtain rises.
14979 \begin_layout Itemize
14983 \begin_inset space \hfill{}
14987 \begin_inset Newline newline
14992 The speaker's (actor's) title,
14993 centered in all CAPS.
14996 \begin_layout Itemize
15000 \begin_inset space \hfill{}
15004 \begin_inset Newline newline
15009 Instructions to the speaker.
15010 The parentheses are automatically inserted.
15011 The ( will appear on screen,
15012 but both will be in the printed play.
15013 This environment is only used within
15020 \begin_layout Itemize
15024 \begin_inset space \hfill{}
15028 \begin_inset Newline newline
15033 What the Speaker says.
15036 \begin_layout Itemize
15040 \begin_inset space \hfill{}
15044 \begin_inset Newline newline
15049 The curtain comes down.
15052 \begin_layout Itemize
15056 \begin_inset space \hfill{}
15062 \begin_layout Itemize
15066 \begin_inset space \hfill{}
15072 \begin_layout Itemize
15076 \begin_inset space \hfill{}
15082 \begin_layout Standard
15086 \begin_layout Subsection
15087 Hollywood (Hollywood spec scripts)
15090 \begin_layout Standard
15096 \begin_layout Subsubsection
15100 \begin_layout Standard
15101 Getting the format of a Hollywood script right is a
15102 \begin_inset Quotes eld
15106 \begin_inset Quotes erd
15109 It is designed to make the readers focus on content and to be easy and familiar for the actors to read.
15110 Each page of a script should be one minute of film.
15111 Nothing goes in a script that you cannot see or hear on screen.
15112 The courier 12 pt font should be used throughout.
15116 \begin_layout Subsubsection
15120 \begin_layout Standard
15121 Speakers' lines should NEVER break in mid-sentence.
15122 If a speaker's lines continue over a page break,
15127 title followed by (Cont'd).
15130 \begin_layout Subsubsection
15134 \begin_layout Standard
15139 names as labels then cross-reference the label to insert the name.
15140 The cross-reference dialog will show the current cast of characters.
15141 You can use this to insert the speaker name in narratives also.
15144 \begin_layout Subsubsection
15145 Paper size and Margins
15148 \begin_layout Standard
15156 \begin_layout Subsubsection
15160 \begin_layout Standard
15161 The following environments are available.
15162 You can use hollywood.bind to get the bind keys shown at the right.
15165 \begin_layout Itemize
15169 \begin_inset Newline newline
15174 Used where nothing else works.
15178 \begin_layout Itemize
15184 \begin_inset space \hfill{}
15192 \begin_inset Newline newline
15195 Usually followed by something like
15196 \begin_inset Quotes eld
15199 on Sally waking up.
15200 \begin_inset Quotes erd
15206 \begin_layout Itemize
15210 \begin_inset space \hfill{}
15214 \begin_inset Newline newline
15219 Introduces a new INTERIOR camera set-up.
15220 Always followed by DAY or NIGHT,
15221 or something similar to define the lighting required.
15222 Everthing on this line in CAPS.
15225 \begin_layout Itemize
15229 \begin_inset space \hfill{}
15233 \begin_inset Newline newline
15238 Introduces a new EXTERIOR camera set-up.
15239 Everthing on this line in CAPS.
15242 \begin_layout Itemize
15246 \begin_inset space \hfill{}
15250 \begin_inset Newline newline
15255 The character speaking.
15258 \begin_layout Itemize
15262 \begin_inset space \hfill{}
15266 \begin_inset Newline newline
15271 Instructions to the speaker.
15272 The () are automatically inserted.
15275 \begin_layout Itemize
15279 \begin_inset space \hfill{}
15283 \begin_inset Newline newline
15295 \begin_layout Itemize
15299 \begin_inset space \hfill{}
15303 \begin_inset Newline newline
15308 Camera movement instruction.
15310 \begin_inset space \thinspace{}
15314 \begin_inset space \space{}
15320 \begin_layout Itemize
15324 \begin_inset space \hfill{}
15330 \begin_layout Itemize
15334 \begin_inset space \hfill{}
15340 \begin_layout Itemize
15344 \begin_inset space \hfill{}
15350 \begin_layout Itemize
15354 \begin_inset space \hfill{}
15360 \begin_layout Subsubsection
15364 \begin_layout Itemize
15369 \begin_layout Itemize
15374 \begin_layout Itemize
15376 \begin_inset space \thinspace{}
15384 \begin_layout Itemize
15390 \begin_layout Itemize
15395 \begin_layout Itemize
15400 \begin_layout Chapter
15402 \change_inserted 564990737 1671185876
15406 \begin_layout Section
15408 \change_inserted 564990737 1671716212
15409 Academic Field Specifics
15412 \begin_layout Subsection
15414 \change_inserted 564990737 1671716212
15416 Hazard and Precautionary Statements
15419 \begin_layout Standard
15421 \change_inserted 564990737 1671716212
15422 This module provides two insets to typeset numbers and phrases of chemical hazard and precautionary statements.
15423 For a description see
15425 File\SpecialChar menuseparator
15426 Open Example\SpecialChar menuseparator
15427 Modules\SpecialChar menuseparator
15428 Hazard and Precautionary Statements
15432 Help\SpecialChar menuseparator
15433 Specific Manuals\SpecialChar menuseparator
15434 Hazard and Precautionary Statements
15439 \begin_layout Subsection
15441 \change_inserted 564990737 1671716212
15445 Risk and Safety Statements
15448 \begin_layout Standard
15450 \change_inserted 564990737 1671716212
15451 This module provides two insets,
15461 accessible via the menu
15466 nsert\SpecialChar menuseparator
15468 \begin_inset space ~
15473 and an environment to typeset numbers and phrases of chemical risk and safety statements.
15476 \begin_layout Subsection
15478 \change_inserted 564990737 1671716212
15482 \begin_layout Standard
15484 \change_inserted 564990737 1671716212
15485 This module uses the
15489 package to add environments useful for linguistics (numbered examples,
15493 You can obtain information about this module in
15498 elp\SpecialChar menuseparator
15504 \begin_inset space ~
15507 Manuals\SpecialChar menuseparator
15516 File\SpecialChar menuseparator
15517 Open Example\SpecialChar menuseparator
15518 Modules\SpecialChar menuseparator
15524 \begin_layout Section
15526 \change_inserted 564990737 1671788778
15530 \begin_layout Subsection
15532 \change_inserted 564990737 1671788778
15536 \begin_layout Standard
15538 \change_inserted 564990737 1671788778
15539 This module supports the Braille writing system.
15540 It requires the \SpecialChar LaTeX
15546 This and its documentation can be obtained from
15547 \begin_inset CommandInset href
15550 target "https://www.ctan.org/pkg/braille"
15556 You do not have to reconfigure your system after installing it.
15562 elp\SpecialChar menuseparator
15568 \begin_inset space ~
15571 Manuals\SpecialChar menuseparator
15580 File\SpecialChar menuseparator
15581 Open Example\SpecialChar menuseparator
15582 Modules\SpecialChar menuseparator
15588 \begin_layout Section
15590 \change_inserted 564990737 1671788778
15591 Annotation & Revision
15594 \begin_layout Subsection
15596 \change_inserted 564990737 1671788778
15600 \begin_layout Standard
15602 \change_inserted 564990737 1671788778
15603 This module provides “FiXme” (marginal) annotations for document revision purposes.
15604 A list of annotations can be produced by using the “List of FIXMEs” paragraph style.
15605 The annotations are customizable via the LaTeX preamble.
15606 See the FiXme documentation which can be obtained from
15607 \begin_inset CommandInset href
15610 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
15619 \begin_layout Paragraph
15621 \change_inserted 564990737 1671788778
15625 \begin_layout Standard
15627 \change_inserted 564990737 1671788778
15629 the notes are only displayed in “draft” mode (if the option “draft” has been inserted in
15631 Document\SpecialChar menuseparator
15632 Settings\SpecialChar menuseparator
15633 Document Class\SpecialChar menuseparator
15634 Class Options\SpecialChar menuseparator
15638 To display them always,
15647 Document\SpecialChar menuseparator
15648 Settings\SpecialChar menuseparator
15656 \begin_layout Subsection
15658 \change_inserted 564990737 1671788778
15662 \begin_layout Standard
15664 \change_inserted 564990737 1671788778
15665 This module provides various kinds of annotations for PDF output.
15668 Help\SpecialChar menuseparator
15669 Specific Manuals\SpecialChar menuseparator
15670 PDF comments and File\SpecialChar menuseparator
15671 Open Example\SpecialChar menuseparator
15672 Modules\SpecialChar menuseparator
15678 \begin_layout Subsection
15680 \change_inserted 564990737 1671788778
15686 \begin_layout Standard
15688 \change_inserted 564990737 1671788778
15689 This module provides fields and buttons for PDF forms.
15691 \begin_inset CommandInset href
15693 name "hyperref documentation"
15694 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
15702 Help\SpecialChar menuseparator
15703 Specific Manuals\SpecialChar menuseparator
15704 PDF forms and File\SpecialChar menuseparator
15705 Open Example\SpecialChar menuseparator
15706 Modules\SpecialChar menuseparator
15712 \begin_layout Subsection
15714 \change_inserted 564990737 1671788778
15720 \begin_layout Standard
15722 \change_inserted 564990737 1671788778
15723 This module defines an inset to typeset reading aids (ruby,
15724 furigana) to Chinese characters.
15725 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on the TeX engine) or a fallback definition.
15729 \begin_layout Subsection
15731 \change_inserted 564990737 1671788778
15737 \begin_layout Standard
15739 \change_inserted 564990737 1671788778
15740 This module provides custom insets to insert TODO items in your document.
15741 In order to generate a “List of TODOs,” the module provides a paragraph style.
15742 Inserting “final” in
15744 Document\SpecialChar menuseparator
15745 Settings\SpecialChar menuseparator
15746 Document Class\SpecialChar menuseparator
15747 Class Options\SpecialChar menuseparator
15750 ) suppresses the output of TODO notes.
15752 \begin_inset CommandInset href
15754 name "todonotes documentation"
15755 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
15763 \begin_layout Section
15765 \change_inserted 564990737 1671829045
15769 \begin_layout Subsection
15771 \change_inserted 564990737 1671829045
15772 APA Style with NatBib
15775 \begin_layout Standard
15777 \change_inserted 564990737 1671829045
15778 This module adds support for using natbib together with apacite (the bibliography style need not be apacite —
15779 it could be apacite,
15781 or any bibliography that works with both the natbib and apacite packages.)
15784 \begin_layout Section
15786 \change_inserted 564990737 1671829045
15790 \begin_layout Subsection
15792 \change_inserted 564990737 1671829045
15793 Fancy Colored Boxes
15796 \begin_layout Standard
15798 \change_inserted 564990737 1671829045
15799 This module adds ten custom insets that support colored boxes via the tcolorbox package.
15802 Help\SpecialChar menuseparator
15803 Specific Manuals\SpecialChar menuseparator
15809 File\SpecialChar menuseparator
15810 Open Example\SpecialChar menuseparator
15811 Modules\SpecialChar menuseparator
15815 \begin_inset CommandInset href
15817 name "tcolorbox documentation"
15818 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
15827 \begin_layout Subsection
15829 \change_inserted 564990737 1671829045
15833 \begin_layout Standard
15835 \change_inserted 564990737 1671829045
15836 This provides the custom insets
15854 to scale and rotate its content.
15857 \begin_layout Standard
15859 \change_inserted 564990737 1671829045
15864 is a simple way of reversing text without any other enhancement:
15867 \begin_layout Standard
15869 \change_inserted 564990737 1671829045
15870 \begin_inset Flex Reflectbox
15873 \begin_layout Plain Layout
15875 \change_inserted 564990737 1671829045
15876 Great Western Railway
15886 \begin_layout Standard
15888 \change_inserted 564990737 1671829045
15889 (You will need to use Ctrl-R to see any of these examples.)
15892 \begin_layout Standard
15894 \change_inserted 564990737 1671829045
15899 allows you to specify the dimensions of the text or image;
15900 permissible units are em,
15922 it scales by the width factor:
15925 \begin_layout Standard
15927 \change_inserted 564990737 1671829045
15928 \begin_inset Flex Resizebox
15931 \begin_layout Plain Layout
15933 \change_inserted 564990737 1671829045
15934 \begin_inset Argument 1
15937 \begin_layout Plain Layout
15939 \change_inserted 564990737 1671829045
15948 \begin_inset Argument 2
15951 \begin_layout Plain Layout
15953 \change_inserted 564990737 1671829045
15961 Great Western Railway
15971 \begin_layout Standard
15973 \change_inserted 564990737 1671829045
15978 allows you to rotate text around the reference point of the box.
15979 If you wish to rotate the box around a different origin,
15980 place the cursor inside the box and select Insert\SpecialChar menuseparator
16010 or meaningful combinations of these and the counterclockwise rotation angle is expressed in degrees.
16014 \begin_layout Standard
16016 \change_inserted 564990737 1671829045
16017 \begin_inset Flex Rotatebox
16020 \begin_layout Plain Layout
16022 \change_inserted 564990737 1671829045
16023 \begin_inset Argument 1
16026 \begin_layout Plain Layout
16028 \change_inserted 274215730 1672888693
16030 \change_inserted 564990737 1671829045
16039 \begin_inset Argument 2
16042 \begin_layout Plain Layout
16044 \change_inserted 564990737 1671829045
16052 Great Western Railway
16062 \begin_layout Standard
16064 \change_inserted 564990737 1671829045
16065 You can combine boxes as in:
16068 \begin_layout Standard
16070 \change_inserted 564990737 1671829045
16071 \begin_inset Flex Rotatebox
16074 \begin_layout Plain Layout
16076 \change_inserted 564990737 1671829045
16077 \begin_inset Argument 1
16080 \begin_layout Plain Layout
16082 \change_inserted 274215730 1672888702
16084 \change_inserted 564990737 1671829045
16093 \begin_inset Argument 2
16096 \begin_layout Plain Layout
16098 \change_inserted 564990737 1671829045
16107 \begin_inset Flex Resizebox
16110 \begin_layout Plain Layout
16112 \change_inserted 564990737 1671829045
16113 \begin_inset Argument 1
16116 \begin_layout Plain Layout
16118 \change_inserted 564990737 1671829045
16127 \begin_inset Argument 2
16130 \begin_layout Plain Layout
16132 \change_inserted 564990737 1671829045
16141 \begin_inset Flex Reflectbox
16144 \begin_layout Plain Layout
16146 \change_inserted 564990737 1671829045
16147 Great Western Railway
16171 \begin_layout Standard
16173 \change_inserted 564990737 1671829045
16179 select Insert\SpecialChar menuseparator
16180 V-Factor to add a vertical factor.
16181 If the vertical factor is omitted,
16182 the horizontal is used.
16183 Adding different horizontal and vertical values creates distortion as in
16186 \begin_layout Standard
16188 \change_inserted 564990737 1671829045
16191 \begin_inset Flex Scalebox
16194 \begin_layout Plain Layout
16196 \change_inserted 564990737 1671829045
16197 \begin_inset Argument 1
16200 \begin_layout Plain Layout
16202 \change_inserted 564990737 1671829045
16211 \begin_inset Argument 2
16214 \begin_layout Plain Layout
16216 \change_inserted 564990737 1671829045
16226 Great Western Railway
16236 \begin_layout Standard
16238 \change_inserted 564990737 1671829045
16239 A negative horizontal value reverses the text and a negative vertical value inverts it so that you get
16242 \begin_layout Standard
16244 \change_inserted 564990737 1671829045
16245 \begin_inset Flex Scalebox
16248 \begin_layout Plain Layout
16250 \change_inserted 564990737 1671829045
16251 \begin_inset Argument 1
16254 \begin_layout Plain Layout
16256 \change_inserted 564990737 1671829045
16265 \begin_inset Argument 2
16268 \begin_layout Plain Layout
16270 \change_inserted 564990737 1671829045
16278 Great Western Railway
16286 \begin_inset Flex Scalebox
16289 \begin_layout Plain Layout
16291 \change_inserted 564990737 1671829045
16292 \begin_inset Argument 1
16295 \begin_layout Plain Layout
16297 \change_inserted 564990737 1671829045
16306 \begin_inset Argument 2
16309 \begin_layout Plain Layout
16311 \change_inserted 564990737 1671829045
16319 Great Western Railway
16329 \begin_layout Subsection
16331 \change_inserted 564990737 1671884699
16335 \begin_layout Standard
16337 \change_inserted 564990737 1671884699
16338 This module defines Boxes with section header.
16339 It is mainly intended for the SciPoster Document class.
16343 \begin_layout Subsection
16345 \change_inserted 564990737 1671884699
16346 Variable-width Minipages
16349 \begin_layout Standard
16351 \change_inserted 564990737 1671884699
16355 \begin_inset space \thinspace{}
16362 Insert\SpecialChar menuseparator
16374 package provides a variable-width minipage,
16375 whose resulting width is the width of its contents (if this does not exceed the specified maximum width).
16376 The inset has two optional arguments which can be added by placing the cursor inside the minipage and entering
16378 Insert\SpecialChar menuseparator
16380 \begin_inset space \thinspace{}
16391 Insert\SpecialChar menuseparator
16393 \begin_inset space \thinspace{}
16407 File\SpecialChar menuseparator
16408 Open Example\SpecialChar menuseparator
16409 Variable-width Minipages
16415 \begin_layout Section
16417 \change_inserted 564990737 1671884699
16421 \begin_layout Subsection
16423 \change_inserted 564990737 1671884699
16424 Fix Computer Modern Fonts
16427 \begin_layout Standard
16429 \change_inserted 564990737 1671884699
16430 This module uses the
16434 package to improve the appearance of Computer Modern fonts and make them available with arbitrary sizes.
16436 \begin_inset CommandInset href
16438 name "fix-cm documentation"
16439 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
16448 \begin_layout Subsection
16450 \change_inserted 564990737 1671884699
16452 Kernel Fixes (Obsolete)
16455 \begin_layout Standard
16457 \change_inserted 564990737 1671884699
16458 This module loads the \SpecialChar LaTeX
16463 which contains some bug fixes for \SpecialChar LaTeX
16465 If you use this module your typeset document may look different when you process it,
16466 depending on the respective version of
16474 \begin_layout Paragraph
16476 \change_inserted 564990737 1671884699
16480 \begin_layout Standard
16482 \change_inserted 564990737 1671884699
16483 recent \SpecialChar LaTeX
16484 kernels (as of 2015/01/01) include the functionality of
16493 module is obsolete with newer \SpecialChar LaTeX
16498 \begin_layout Subsection
16500 \change_inserted 564990737 1671884699
16501 Minimalistic Insets
16504 \begin_layout Standard
16506 \change_inserted 564990737 1671884699
16507 This module redefines several insets (Index,
16509 URL) as being Minimalistic.
16512 \begin_layout Subsection
16514 \change_inserted 564990737 1671884699
16515 Title and Preamble Hacks
16518 \begin_layout Standard
16520 \change_inserted 564990737 1671884699
16521 This module provides two new paragraph styles:
16525 \begin_layout Enumerate
16527 \change_inserted 564990737 1671884699
16532 which puts whatever is entered into it into the preamble.
16535 to include preamble code in the body of a LyX document.
16539 \begin_layout Enumerate
16541 \change_inserted 564990737 1671884699
16546 which that will put its contents into the body of the LaTeX document,
16554 This is useful for making branches and notes in title-related material.
16556 if you put these in a Standard layout,
16557 this signals to LyX to output
16564 which may then come too early.)
16567 \begin_layout Section
16569 \change_inserted 564990737 1672081439
16573 \begin_layout Subsection
16575 \change_inserted 564990737 1672081439
16579 \begin_layout Standard
16581 \change_inserted 564990737 1672081439
16582 This module uses the
16586 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
16587 Use the Algorithm paragraph style to enter and indent the algorithm.
16589 \begin_inset CommandInset href
16591 name "algorithm2e documentation"
16592 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
16600 \begin_layout Subsection
16602 \change_inserted 564990737 1672081439
16603 Bilingual Captions AKA Multilingual Captions
16606 \begin_layout Standard
16608 \change_inserted 564990737 1672081439
16609 This module provides the paragraph style
16612 \begin_inset space ~
16617 with which to typeset multilingual captions.
16618 Within this paragraph style
16620 Insert\SpecialChar menuseparator
16623 allows you to enter the desired language using one of the babel names.
16626 File\SpecialChar menuseparator
16627 Open Example\SpecialChar menuseparator
16628 Multilingual Captions
16632 Help\SpecialChar menuseparator
16633 Specific Manuals\SpecialChar menuseparator
16634 Multilingual Captions
16636 further information on its use.
16639 \begin_layout Subsection
16641 \change_inserted 564990737 1672081439
16642 Number Figures by Section
16645 \begin_layout Standard
16647 \change_inserted 564990737 1672081439
16648 This module resets the figure number at section start and prepends the section number to the figure number,
16649 as in “Figure 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
16652 \begin_layout Subsection
16654 \change_inserted 564990737 1672081439
16655 Number Tables by Section
16658 \begin_layout Standard
16660 \change_inserted 564990737 1672081439
16661 This module resets the table number at section start and prepends the section number to the table number,
16662 as in “Table 2.1.” (By default book and report document classes number by Chapter and article document classes have a single sequence.)
16665 \begin_layout Section
16667 \change_inserted 564990737 1672081439
16671 \begin_layout Subsection
16673 \change_inserted 564990737 1672081439
16677 \begin_layout Standard
16679 \change_inserted 564990737 1672081439
16680 This module adds an endnote inset,
16681 in addition to footnotes.
16687 which has some limitations but works with older LaTeX distributions as well.
16690 Insert\SpecialChar menuseparator
16691 Custom Inset\SpecialChar menuseparator
16694 to insert an endnote and
16696 Insert\SpecialChar menuseparator
16697 List/Contents/References\SpecialChar menuseparator
16700 to insert the endnotes list where you want the endnotes to appear.
16703 Help\SpecialChar menuseparator
16704 Embedded\SpecialChar menuseparator
16705 Objects\SpecialChar menuseparator
16706 Notes\SpecialChar menuseparator
16712 \begin_layout Subsection
16714 \change_inserted 564990737 1672081439
16715 Endnotes (Extended)
16718 \begin_layout Standard
16720 \change_inserted 564990737 1672081439
16721 This module adds an endnote inset,
16722 in addition to footnotes.
16727 package which is more powerful and customizable than the
16732 but requires a fairly modern LaTeX distribution (with LaTeX3).
16735 Insert\SpecialChar menuseparator
16736 Custom Inset\SpecialChar menuseparator
16739 to insert an endnote and
16741 Insert\SpecialChar menuseparator
16742 List/Contents/References\SpecialChar menuseparator
16745 to insert the endnotes list where you want the endnotes to appear.
16748 Help\SpecialChar menuseparator
16749 Embedded\SpecialChar menuseparator
16750 Objects\SpecialChar menuseparator
16751 Notes\SpecialChar menuseparator
16757 \begin_layout Subsection
16759 \change_inserted 564990737 1672081439
16760 Footnotes as Endnotes (Basic)
16763 \begin_layout Standard
16765 \change_inserted 564990737 1672081439
16766 This module sets all footnotes as endnotes.
16772 which has some limitations but works with older LaTeX distributions as well.
16775 Insert\SpecialChar menuseparator
16776 List/Contents/References\SpecialChar menuseparator
16779 to insert the endnotes list where you want the endnotes to appear.
16782 Help\SpecialChar menuseparator
16783 Embedded\SpecialChar menuseparator
16784 Objects\SpecialChar menuseparator
16785 Notes\SpecialChar menuseparator
16791 \begin_layout Subsection
16793 \change_inserted 564990737 1672081439
16794 Footnotes as Endnotes (Extended)
16797 \begin_layout Standard
16799 \change_inserted 564990737 1672081439
16800 This module sets all footnotes as endnotes.
16805 package which is more powerful and customizable than then
16810 but requires a fairly modern LaTeX distribution (with LaTeX3).
16813 Insert\SpecialChar menuseparator
16814 List/Contents/References\SpecialChar menuseparator
16817 to insert the endnotes list where you want the endnotes to appear.
16820 Help\SpecialChar menuseparator
16821 Embedded\SpecialChar menuseparator
16822 Objects\SpecialChar menuseparator
16823 Notes\SpecialChar menuseparator
16829 \begin_layout Section
16831 \change_inserted 564990737 1672081439
16836 \begin_layout Subsection
16838 \change_inserted 564990737 1672081439
16842 \begin_layout Standard
16844 \change_inserted 564990737 1672081439
16845 This module provides support for the
16849 package to print chess games.
16852 File\SpecialChar menuseparator
16853 Open Example\SpecialChar menuseparator
16854 Articles\SpecialChar menuseparator
16857 where you will find
16866 \begin_inset CommandInset href
16868 name "chessboard documentation"
16869 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
16877 \begin_layout Subsection
16879 \change_inserted 564990737 1672081439
16880 Lilypond Music Notation
16883 \begin_layout Standard
16885 \change_inserted 564990737 1672081439
16886 This module provides an inset via
16891 nsert\SpecialChar menuseparator
16892 Custom Inset\SpecialChar menuseparator
16895 in which to enter code for the LilyPond music editor.
16896 It will then be processed in the output.
16899 Help\SpecialChar menuseparator
16900 Specific Manuals\SpecialChar menuseparator
16905 File\SpecialChar menuseparator
16906 Open Example\SpecialChar menuseparator
16907 Modules\SpecialChar menuseparator
16911 It cannot be used if the modules
16914 \begin_inset space \thinspace{}
16922 \begin_layout Section
16924 \change_inserted 564990737 1672138150
16928 \begin_layout Subsection
16930 \change_inserted 564990737 1672138150
16932 \begin_inset CommandInset label
16934 name "subsec:Customizable-Lists"
16941 \begin_layout Standard
16943 \change_inserted 564990737 1672138150
16944 This module uses the
16948 package to enable the customization of various list environments.
16951 \begin_layout Subsubsection
16953 \change_inserted 564990737 1672138150
16954 Custom Enumerate Lists
16957 \begin_layout Standard
16960 \change_inserted 564990737 1672138150
16961 The default numbering of numbered lists can be changed by adding an optional argument (menu
16966 nsert\SpecialChar menuseparator
16973 ) to the first item of each level in the list.
16974 There you add the command
16977 \begin_layout Standard
16979 \change_inserted 564990737 1672138150
16987 \begin_layout Standard
16989 \change_inserted 564990737 1672138150
16990 in \SpecialChar TeX
17000 \begin_layout Standard
17002 \change_inserted 564990737 1672138150
17007 is the first level counter of the enumeration.
17008 To change the numbering for the list sublevels,
17013 ” in the command by the small Roman numeral of the level (
17035 \begin_layout Standard
17037 \change_inserted 564990737 1672138150
17044 outputs the counter as a small Roman numeral.
17045 For capital Roman numerals replace
17057 in the command above.
17058 For Arabic numerals use
17066 \begin_inset Quotes eld
17070 \begin_inset Quotes erd
17073 items with capital or small Latin letters use
17089 \begin_layout Standard
17092 \change_inserted 564990737 1672138150
17093 \begin_inset Note Greyedout
17096 \begin_layout Plain Layout
17098 \change_inserted 564990737 1672138150
17104 You can only number 26
17105 \begin_inset space ~
17108 items with Latin letters,
17109 because this numbering is limited to single letters.
17117 \begin_layout Standard
17119 \change_inserted 564990737 1672138150
17120 Here is a list with custom numbering:
17123 \begin_layout Enumerate
17125 \change_inserted 564990737 1672138150
17126 \begin_inset Argument 1
17129 \begin_layout Plain Layout
17131 \change_inserted 564990737 1672138150
17135 \begin_layout Plain Layout
17137 \change_inserted 564990737 1672138150
17158 \begin_inset Separator latexpar
17165 \begin_layout Enumerate
17167 \change_inserted 564990737 1672138150
17168 \begin_inset Argument 1
17171 \begin_layout Plain Layout
17173 \change_inserted 564990737 1672138150
17177 \begin_layout Plain Layout
17179 \change_inserted 564990737 1672138150
17200 \begin_layout Enumerate
17202 \change_inserted 564990737 1672138150
17204 \begin_inset Separator latexpar
17211 \begin_layout Enumerate
17213 \change_inserted 564990737 1672138150
17214 \begin_inset Argument 1
17217 \begin_layout Plain Layout
17219 \change_inserted 564990737 1672138150
17223 \begin_layout Plain Layout
17225 \change_inserted 564990737 1672138150
17228 \change_deleted 274215730 1672889016
17232 \change_inserted 274215730 1672889016
17236 \change_inserted 564990737 1672138150
17252 \begin_inset Separator latexpar
17259 \begin_layout Enumerate
17261 \change_inserted 564990737 1672138150
17262 \begin_inset Argument 1
17265 \begin_layout Plain Layout
17267 \change_inserted 564990737 1672138150
17271 \begin_layout Plain Layout
17273 \change_inserted 564990737 1672138150
17297 \begin_layout Standard
17299 \change_inserted 564990737 1672138150
17300 For this list these commands were used:
17303 \begin_layout Standard
17306 \change_inserted 564990737 1672138150
17316 \begin_inset Newline newline
17324 \begin_inset Newline newline
17328 \change_deleted 274215730 1672889037
17332 \change_inserted 274215730 1672889037
17336 \change_inserted 564990737 1672138150
17340 \begin_inset Newline newline
17350 \begin_layout Standard
17352 \change_inserted 564990737 1672138150
17359 makes the label emphasized and
17360 \change_deleted 274215730 1672889045
17366 \change_inserted 274215730 1672889046
17370 \change_inserted 564990737 1672138150
17376 \begin_layout Standard
17378 \change_inserted 564990737 1672138150
17379 \begin_inset Note Greyedout
17382 \begin_layout Plain Layout
17384 \change_inserted 564990737 1672138150
17390 When you change the label of a list level,
17391 it will be used for all following lists until you change the definition.
17399 \begin_layout Standard
17401 \change_inserted 564990737 1672138150
17405 \begin_layout Plain Layout
17407 \change_inserted 564990737 1672138150
17425 \begin_layout Subsubsection
17427 \change_inserted 564990737 1672138150
17428 Numbered Paragraphs in Reports
17431 \begin_layout Enumerate
17433 \change_inserted 564990737 1672138213
17434 Official reports often include numbered paragraphs;
17435 you can achieve this with a variation on the approach outlined in the footnote
17436 \begin_inset space ~
17440 \begin_inset CommandInset ref
17442 reference "fn:If-you-really"
17455 in each command with
17462 \begin_layout Enumerate
17464 \change_inserted 564990737 1672138150
17465 These numbered paragraphs were generated by inserting the \SpecialChar TeX
17467 \begin_inset Separator latexpar
17474 \begin_layout Standard
17476 \change_inserted 564990737 1672138150
17490 \begin_layout Standard
17492 \change_inserted 564990737 1672138150
17493 before the start of the section;
17500 uses the \SpecialChar LaTeX
17501 section counter to generate the first part of the number.
17505 \begin_layout Enumerate
17507 \change_inserted 564990737 1672138150
17508 I have ignored the subsection heading in this example because,
17509 with paragraphs numbered in this way,
17510 subsections are less likely to be used.
17513 \begin_layout Subsubsection
17515 \change_inserted 564990737 1672138150
17516 Resumed Enumeration
17519 \begin_layout Standard
17521 \change_inserted 564990737 1672138150
17525 \begin_layout Plain Layout
17527 \change_inserted 564990737 1672138150
17543 \begin_layout Standard
17545 \change_inserted 564990737 1672138150
17546 Enumerations can be resumed after intermediate paragraphs:
17549 \begin_layout Enumerate
17551 \change_inserted 564990737 1672138150
17552 \begin_inset Argument 1
17555 \begin_layout Plain Layout
17557 \change_inserted 564990737 1672138150
17561 \begin_layout Plain Layout
17563 \change_inserted 564990737 1672138150
17580 \begin_inset Note Note
17583 \begin_layout Plain Layout
17585 \change_inserted 564990737 1672138150
17586 goes back to default numbering
17594 \begin_layout Enumerate
17596 \change_inserted 564990737 1672138150
17600 \begin_layout Standard
17602 \change_inserted 564990737 1672138150
17606 \begin_layout Enumerate-Resume
17608 \change_inserted 564990737 1672138150
17612 \begin_layout Standard
17614 \change_inserted 564990737 1672138150
17615 To resume an enumeration,
17621 Its numbering appears in blue within \SpecialChar LyX
17622 to indicate that it is a resumed list and that the numbering will not be correct in \SpecialChar LyX
17627 \begin_layout Standard
17629 \change_inserted 564990737 1672138150
17630 \begin_inset Note Greyedout
17633 \begin_layout Plain Layout
17635 \change_inserted 564990737 1672138150
17641 If there is no previous enumeration to resume,
17642 you will get a \SpecialChar LaTeX
17651 \begin_layout Standard
17653 \change_inserted 564990737 1672138150
17654 Perhaps you might want to resume the list with a different number from the next one.
17655 Or you want to start a new enumeration with a defined number.
17656 This is possible by adding an optional argument to the first list item of a normal enumeration.
17661 \begin_layout Standard
17663 \change_inserted 564990737 1672138150
17669 \begin_layout Standard
17671 \change_inserted 564990737 1672138150
17676 is the number with which you want to resume the list.
17680 \begin_layout Enumerate
17682 \change_inserted 564990737 1672138150
17686 \begin_layout Enumerate
17688 \change_inserted 564990737 1672138150
17692 \begin_layout Standard
17694 \change_inserted 564990737 1672138150
17695 Enumeration starting at a given value:
17698 \begin_layout Enumerate
17700 \change_inserted 564990737 1672138150
17701 \begin_inset Argument 1
17704 \begin_layout Plain Layout
17706 \change_inserted 564990737 1672138150
17710 \begin_layout Plain Layout
17712 \change_inserted 564990737 1672138150
17726 This enumeration starts at 4
17729 \begin_layout Subsubsection
17731 \change_inserted 564990737 1672138150
17733 \begin_inset Index idx
17738 \begin_layout Plain Layout
17740 \change_inserted 564990737 1672138150
17752 \begin_layout Standard
17754 \change_inserted 564990737 1672138150
17755 In some cases you might want less or more vertical space between the items of a list.
17756 For example if the default space is too much in your opinion in this case:
17759 \begin_layout Itemize
17761 \change_inserted 564990737 1672138150
17765 \begin_layout Itemize
17767 \change_inserted 564990737 1672138150
17768 with standard spacing
17771 \begin_layout Standard
17773 \change_inserted 564990737 1672138150
17774 You can decrease the space by adding an optional argument to the first item of the list.
17775 Add there the command
17779 to get no additional list space like in this example:
17782 \begin_layout Itemize
17784 \change_inserted 564990737 1672138150
17785 \begin_inset Argument 1
17788 \begin_layout Plain Layout
17790 \change_inserted 564990737 1672138150
17794 \begin_layout Plain Layout
17796 \change_inserted 564990737 1672138150
17813 \begin_layout Itemize
17815 \change_inserted 564990737 1672138150
17819 \begin_layout Itemize
17821 \change_inserted 564990737 1672138150
17825 \begin_layout Standard
17827 \change_inserted 564990737 1672138150
17828 To add space you can use several other commands provided by the
17833 \begin_inset Index idx
17838 \begin_layout Plain Layout
17840 \change_inserted 564990737 1672138150
17851 For more information see the
17852 \begin_inset CommandInset href
17854 name "enumitem documentation"
17855 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
17863 \begin_layout Standard
17865 \change_inserted 564990737 1672138150
17866 There are also many commands available to change the horizontal spacing and indentation.
17867 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
17868 \begin_inset space \thinspace{}
17871 cm so that the number is in the page margin:
17874 \begin_layout Enumerate
17876 \change_inserted 564990737 1672138150
17877 \begin_inset Argument 1
17880 \begin_layout Plain Layout
17882 \change_inserted 564990737 1672138150
17886 \begin_layout Plain Layout
17888 \change_inserted 564990737 1672138150
17908 \begin_layout Enumerate
17910 \change_inserted 564990737 1672138150
17911 with negative indentation
17914 \begin_layout Subsubsection
17916 \change_inserted 564990737 1672138150
17917 Further Customization
17918 \begin_inset Index idx
17923 \begin_layout Plain Layout
17925 \change_inserted 564990737 1672138150
17937 \begin_layout Standard
17939 \change_inserted 564990737 1672138150
17940 You can also change the style of description lists.
17944 \begin_layout Standard
17946 \change_inserted 564990737 1672138150
17952 \begin_layout Standard
17954 \change_inserted 564990737 1672138150
17955 changes the description label font,
17959 \begin_layout Standard
17961 \change_inserted 564990737 1672138150
17970 \begin_layout Standard
17972 \change_inserted 564990737 1672138150
17973 sets the list style.
17976 \begin_layout Standard
17978 \change_inserted 564990737 1672138150
17979 An example where the command
17982 \begin_layout Standard
17984 \change_inserted 564990737 1672138150
17993 \begin_layout Standard
17995 \change_inserted 564990737 1672138150
17999 \begin_layout Description
18001 \change_inserted 564990737 1672138150
18003 \begin_inset space ~
18008 \begin_inset Argument 1
18011 \begin_layout Plain Layout
18013 \change_inserted 564990737 1672138150
18017 \begin_layout Plain Layout
18019 \change_inserted 564990737 1672138150
18038 Ionizing radiation consists of particles or electromagnetic waves that are energetic enough to detach electrons from atoms or molecules,
18039 therefore ionizing them.
18042 \begin_layout Description
18044 \change_inserted 564990737 1672138150
18046 \begin_inset space ~
18050 In computer science,
18051 reference counting is a technique of storing the number of references,
18053 or handles to a resource such as an object,
18055 disk space or other resource.
18058 \begin_layout Standard
18060 \change_inserted 564990737 1672138150
18061 There are many more commands and features provided by the
18066 \begin_inset Index idx
18071 \begin_layout Plain Layout
18073 \change_inserted 564990737 1672138150
18084 For more information see the
18085 \begin_inset CommandInset href
18087 name "enumitem documentation"
18088 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
18096 \begin_layout Subsection
18098 \change_inserted 564990737 1672138150
18104 \begin_layout Standard
18106 \change_inserted 564990737 1672138150
18107 This module uses the package
18111 to provide nine new list environments.
18112 Itemized and enumerated lists can be typeset within paragraphs,
18113 as paragraphs and in a compact version.
18114 Most environments have optional arguments to format the labels.
18116 the \SpecialChar LaTeX
18117 list environments itemize and enumerate are extended to use a similar optional argument.
18118 For further details see
18120 File\SpecialChar menuseparator
18121 Open Example\SpecialChar menuseparator
18122 Modules\SpecialChar menuseparator
18123 Paragraph Lists (paralist)
18128 Help\SpecialChar menuseparator
18129 Specific Manuals\SpecialChar menuseparator
18133 \begin_inset CommandInset href
18135 name "paralist documentation"
18136 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
18144 \begin_layout Section
18146 \change_inserted 564990737 1672161542
18147 Literate Programming
18150 \begin_layout Subsection
18152 \change_inserted 564990737 1672161542
18156 \begin_layout Standard
18158 \change_inserted 564990737 1672161542
18159 This module allows the use of Noweb as a literate programming tool.
18160 The files and the documentation for Noweb can be obtained from
18161 \begin_inset CommandInset href
18164 target "https://www.ctan.org/pkg/noweb"
18170 Literate programming is described in section
18171 \begin_inset space ~
18175 \begin_inset CommandInset ref
18177 reference "sec:Literate-Programming"
18182 and there are three example files:
18185 File\SpecialChar menuseparator
18186 Open Example\SpecialChar menuseparator
18187 Modules\SpecialChar menuseparator
18193 File\SpecialChar menuseparator
18194 Open Example\SpecialChar menuseparator
18195 Modules\SpecialChar menuseparator
18200 File\SpecialChar menuseparator
18201 Open Example\SpecialChar menuseparator
18202 Modules\SpecialChar menuseparator
18203 Noweb2\SpecialChar LyX
18209 \begin_layout Subsection
18211 \change_inserted 564990737 1672161542
18215 \begin_layout Standard
18217 \change_inserted 564990737 1672161542
18218 This module uses the
18228 \begin_inset Flex Code
18231 \begin_layout Plain Layout
18233 \change_inserted 564990737 1672161542
18241 package in R for dynamic report generation has to be installed for this module to work:
18243 \begin_inset Flex Code
18246 \begin_layout Plain Layout
18248 \change_inserted 564990737 1672161542
18249 install.packages(“knitr”)
18260 \begin_layout Paragraph
18262 \change_inserted 564990737 1672161542
18266 \begin_layout Standard
18268 \change_inserted 564990737 1672161542
18269 it depends on R >= 2.14.1.
18271 \begin_inset Flex URL
18274 \begin_layout Plain Layout
18276 \change_inserted 564990737 1672161542
18278 http://yihui.name/knitr
18289 \begin_layout Standard
18291 \change_inserted 564990737 1672161542
18296 also has to be installed.
18297 It cannot be used if the modules
18300 \begin_inset space ~
18312 Help\SpecialChar menuseparator
18313 Specific Manuals\SpecialChar menuseparator
18319 File\SpecialChar menuseparator
18320 Open Example\SpecialChar menuseparator
18321 Modules\SpecialChar menuseparator
18325 \begin_inset space ~
18329 \begin_inset CommandInset ref
18331 reference "sec:Literate-Programming"
18336 for information about literate programming.
18339 \begin_layout Subsection
18341 \change_inserted 564990737 1672161542
18345 \begin_layout Standard
18347 \change_inserted 564990737 1672161542
18348 This module allows the use of the statistical language S/R as a literate programming tool.
18359 \begin_inset CommandInset href
18362 target "https://www.ctan.org/pkg/includernw"
18368 \begin_inset CommandInset href
18371 target "https://www.ctan.org/pkg/fancyvrb"
18376 are available from CTAN.
18377 It cannot be used if the module
18380 \begin_inset space ~
18388 Help\SpecialChar menuseparator
18389 Specific Manuals\SpecialChar menuseparator
18395 File\SpecialChar menuseparator
18396 Open Example\SpecialChar menuseparator
18397 Modules\SpecialChar menuseparator
18401 \begin_inset space ~
18405 \begin_inset CommandInset ref
18407 reference "sec:Literate-Programming"
18412 for information about literate programming.
18415 \begin_layout Section
18417 \change_inserted 564990737 1672224959
18421 \begin_layout Subsection
18423 \change_inserted 564990737 1672224959
18427 \begin_layout Standard
18429 \change_inserted 564990737 1672224959
18430 This modules defines theorem environments and the proof environment using the extended AMS machinery.
18431 Both numbered and unnumbered types are provided.
18433 the theorems are numbered consecutively throughout the document.
18434 This can be changed by loading one of the
18436 AMS Theorems (Numbered by \SpecialChar ldots
18440 It cannot be used if the modules
18446 Standard Theorems (Unnumbered)
18451 \begin_layout Subsection
18453 \change_inserted 564990737 1672224959
18454 AMS Theorems (Extended)
18457 \begin_layout Standard
18459 \change_inserted 564990737 1672224959
18460 This module defines some additional theorem environments for use with the
18464 package (which must be loaded).
18465 It includes Criterion,
18476 Case and Question in both numbered and unnumbered forms.
18479 \begin_layout Subsection
18481 \change_inserted 564990737 1672224959
18482 AMS Theorems (Extended,
18483 Numbered by Type within Chapters)
18486 \begin_layout Standard
18488 \change_inserted 564990737 1672224959
18489 This module defines some additional theorem environments for use with the
18491 AMS Theorems (Numbered by Type within Chapters)
18493 package (which must be loaded).
18494 It includes Criterion,
18503 Assumption and Case in both numbered and unnumbered forms.
18506 AMS Theorems (Extended)
18509 the different theorem types provided here each have a separate counter,
18510 restarted with each new chapter (e.g.,
18517 axiom 2.1\SpecialChar ldots
18519 as opposed to criterion 1,
18525 \begin_layout Subsection
18527 \change_inserted 564990737 1672224959
18528 AMS Theorems (Extended,
18532 \begin_layout Standard
18534 \change_inserted 564990737 1672224959
18535 This module defines some additional theorem environments for use with the
18537 AMS Theorems (Numbered by Type)
18539 package (which must be loaded).
18540 It includes Criterion,
18549 Assumption and Case in both numbered and unnumbered forms.
18552 AMS Theorems (Extended)
18555 the different theorem types provided here each have a separate counter (e.g.,
18563 as opposed to criterion 1,
18571 \begin_layout Subsection
18573 \change_inserted 564990737 1672224959
18574 AMS Theorems (Numbered by Type within Chapters)
18577 \begin_layout Standard
18579 \change_inserted 564990737 1672224959
18580 This module defines theorem environments and the proof environment using the extended AMS machinery.
18581 Both numbered and unnumbered types are provided.
18587 the different theorem types provided here each have a separate counter (e.g.,
18596 as opposed to theorem 1,
18602 The numbering restarts for each chapter:
18606 It cannot be used if the modules
18618 Standard Theorems (Numbered by Type)
18622 Standard Theorems (Unnumbered)
18627 \begin_layout Subsection
18629 \change_inserted 564990737 1672224959
18630 AMS Theorems (Numbered by Type)
18633 \begin_layout Standard
18635 \change_inserted 564990737 1672224959
18636 This module defines theorem environments and the proof environment using the extended AMS machinery.
18637 Both numbered and unnumbered types are provided.
18643 the different theorem types provided here each have a separate counter (e.g.,
18652 as opposed to theorem 1,
18658 The numbering’s scope is the whole document.
18659 For chapter- and section-wide numbering,
18660 use one of the ‘within Sections’/‘within Chapters’ modules,
18662 It cannot be used if the modules
18674 Standard Theorems (Numbered by Type)
18678 Standard Theorems (Unnumbered)
18683 \begin_layout Subsection
18685 \change_inserted 564990737 1672224959
18686 Number Equations by Section
18689 \begin_layout Standard
18691 \change_inserted 564990737 1672224959
18692 This module resets the equation number at section start and prepends the section number to the equation number,
18696 \begin_layout Subsection
18698 \change_inserted 564990737 1672224959
18702 \begin_layout Standard
18704 \change_inserted 564990737 1672224959
18705 This module defines some theorem environments for use with non-AMS classes.
18707 the theorems are numbered consecutively throughout the document.
18708 This can be changed by loading one of the
18710 Standard Theorems (Numbered by \SpecialChar ldots
18714 It cannot be used if the modules
18720 Standard Theorems (Unnumbered)
18726 \begin_layout Subsection
18728 \change_inserted 564990737 1672224959
18729 Standard Theorems (Nameable)
18732 \begin_layout Standard
18734 \change_inserted 564990737 1672224959
18735 This module facilitates the use of named theorems.
18736 The name of the theorem goes into the “Additional Theorem Text” argument.
18740 \begin_layout Subsection
18742 \change_inserted 564990737 1672224959
18743 Standard Theorems (Numbered by Chapter)
18746 \begin_layout Standard
18748 \change_inserted 564990737 1672224959
18749 This module numbers theorems and the like by chapter (i.e.,
18750 the counter is reset at each chapter start).
18751 Use this module only with document classes that provide a chapter environment.
18761 It cannot be used if the module
18763 Standard Theorems (Numbered by Section)
18768 \begin_layout Subsection
18770 \change_inserted 564990737 1672224959
18771 Standard Theorems (Numbered by Section)
18774 \begin_layout Standard
18776 \change_inserted 564990737 1672224959
18777 This module numbers theorems and the like by section (i.e.,
18778 the counter is reset at each section start).
18788 It cannot be used if the module
18790 Standard Theorems (Numbered by Chapter)
18795 \begin_layout Subsection
18797 \change_inserted 564990737 1672224959
18798 Standard Theorems (Numbered by Type within Chapters)
18801 \begin_layout Standard
18803 \change_inserted 564990737 1672224959
18804 This module defines some theorem environments for use with non-AMS classes.
18814 the different theorem types provided here each have a separate counter (e.g.,
18823 as opposed to theorem 1,
18829 The numbering is reset at each chapter start.
18832 AMS Theorems (Numbered by Type)
18836 Standard Theorems (Numbered by Type)
18839 It cannot be used if any of the modules
18851 Standard Theorems (Unnumbered)
18856 Standard Theorems (Numbered by Sections)
18860 Standard Theorems (Numbered by Type within Sections)
18865 \begin_layout Subsection
18867 \change_inserted 564990737 1672224959
18868 Standard Theorems (Numbered by Type within Sections)
18871 \begin_layout Standard
18873 \change_inserted 564990737 1672224959
18874 This module defines some theorem environments for use with non-AMS classes.
18884 the different theorem types provided here each have a separate counter (e.g.,
18893 as opposed to theorem 1,
18899 The numbering is reset at each section start.
18902 AMS Theorems (Numbered by Type)
18906 Standard Theorems (Numbered by Type)
18909 It cannot be used if any of the modules
18921 Standard Theorems (Unnumbered)
18926 Standard Theorems (Numbered by Chapters)
18930 Standard Theorems (Numbered by Type within Chapters)
18935 \begin_layout Subsection
18937 \change_inserted 564990737 1672224959
18938 Standard Theorems (Numbered by Type)
18941 \begin_layout Standard
18943 \change_inserted 564990737 1672224959
18944 This module defines some theorem environments for use with non-AMS classes.
18954 the different theorem types provided here each have a separate counter (e.g.,
18963 as opposed to theorem 1,
18969 The numbering’s scope is the whole document.
18970 For chapter- and section-wide numbering,
18971 use one of the “within Chapters”/“within Sections” modules,
18973 It cannot be used if any of the modules
18985 Standard Theorems (Unnumbered)
18989 AMS Theorems (Numbered by Type)
18994 \begin_layout Subsection
18996 \change_inserted 564990737 1672224959
18997 Standard Theorems (Unnumbered)
19000 \begin_layout Standard
19002 \change_inserted 564990737 1672224959
19003 This module defines only unnumbered theorem environments and the proof environment,
19004 using the extended AMS machinery.
19005 It cannot be used if either of the modules
19016 \begin_layout Subsection
19018 \change_inserted 564990737 1672224959
19022 \begin_layout Standard
19024 \change_inserted 564990737 1672224959
19025 This module provides a straightforward way to segregate subequations in LyX.
19028 Help\SpecialChar menuseparator
19029 Math\SpecialChar menuseparator
19036 \begin_layout Section
19038 \change_inserted 564990737 1672236008
19042 \begin_layout Subsection
19044 \change_inserted 564990737 1672236008
19045 Custom Header/Footer Text
19048 \begin_layout Standard
19050 \change_inserted 564990737 1672236008
19051 This module requires the
19054 \begin_inset space ~
19068 ocument\SpecialChar menuseparator
19073 ettings\SpecialChar menuseparator
19075 \begin_inset space ~
19080 dialog to be set to
19085 It adds six environments to document classes which support the
19092 \begin_layout Itemize
19094 \change_inserted 564990737 1672236008
19100 \begin_layout Itemize
19102 \change_inserted 564990737 1672236008
19108 \begin_layout Itemize
19110 \change_inserted 564990737 1672236008
19116 \begin_layout Itemize
19118 \change_inserted 564990737 1672236008
19124 \begin_layout Itemize
19126 \change_inserted 564990737 1672236008
19132 \begin_layout Itemize
19134 \change_inserted 564990737 1672236008
19140 \begin_layout Subsubsection
19142 \change_inserted 564990737 1672236008
19143 Fancy Headers and Footers
19146 \begin_layout Standard
19148 \change_inserted 564990737 1672236008
19149 The default page layout is rather plain;
19151 \begin_inset Flex Code
19154 \begin_layout Plain Layout
19156 \change_inserted 564990737 1672236008
19165 all you get is a centered page number at the bottom of the page.
19166 This document uses KOMA-script’s book class;
19167 so it appears to be a bit fancier.
19171 \begin_inset space ~
19185 ocument\SpecialChar menuseparator
19190 ettings\SpecialChar menuseparator
19194 \begin_inset Quotes eld
19198 \begin_inset Quotes erd
19202 you will find that the page header is divided into three fields,
19203 not surprisingly labeled
19204 \begin_inset Quotes eld
19208 \begin_inset Quotes erd
19213 \begin_inset Quotes eld
19217 \begin_inset Quotes erd
19222 \begin_inset Quotes eld
19226 \begin_inset Quotes erd
19230 The footer is also divided into these three fields.
19231 The \SpecialChar LaTeX
19232 commands to set these fields in the simplest manner are
19261 Suppose you wish to put your name in the upper left hand corner of each page.
19262 Simply insert the following command in the preamble:
19266 \begin_layout Standard
19268 \change_inserted 564990737 1672236008
19284 \begin_layout Standard
19286 \change_inserted 564990737 1672236008
19287 You will now see your name in the upper left.
19288 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,
19290 \begin_inset space \thinspace{}
19296 \begin_layout Standard
19298 \change_inserted 564990737 1672236008
19306 \begin_layout Standard
19308 \change_inserted 564990737 1672236008
19311 an easier way to make simple changes.
19317 ocument\SpecialChar menuseparator
19322 ettings\SpecialChar menuseparator
19323 Modules\SpecialChar menuseparator
19324 Page Layout\SpecialChar menuseparator
19325 Custom Header/Footer Text
19328 you will find you have six new environments corresponding to the six fields described above.
19331 \begin_layout Standard
19333 \change_inserted 564990737 1672236008
19334 Let's get really fancy:
19335 lets put the section number with the word
19336 \begin_inset Quotes eld
19340 \begin_inset Quotes erd
19344 \begin_inset space \thinspace{}
19348 \begin_inset space \space{}
19351 Section 3) in the upper left,
19352 the page number (e.
19353 \begin_inset space \thinspace{}
19357 \begin_inset space \space{}
19360 Page 4) in the upper right,
19361 your name in the lower left,
19362 and the date in the lower right.
19363 Use your newly enabled environments to add these entries:
19366 \begin_layout Standard
19368 \change_inserted 564990737 1672236008
19369 \begin_inset VSpace defskip
19375 \begin_layout Standard
19377 \change_inserted 564990737 1672236008
19381 \begin_inset space ~
19399 \begin_layout Standard
19401 \change_inserted 564990737 1672236008
19407 \begin_layout Standard
19409 \change_inserted 564990737 1672236008
19424 \begin_layout Standard
19426 \change_inserted 564990737 1672236008
19436 \begin_layout Standard
19438 \change_inserted 564990737 1672236008
19444 \begin_layout Standard
19446 \change_inserted 564990737 1672236008
19461 \begin_layout Standard
19463 \change_inserted 564990737 1672236008
19464 \begin_inset VSpace defskip
19470 \begin_layout Standard
19472 \change_inserted 564990737 1672236008
19473 Make sure you enter the commands
19492 as \SpecialChar TeX
19510 access \SpecialChar LaTeX
19511 ’s section and page counters,
19512 and so print out the current section and page numbers.
19519 simply prints out today’s date.
19522 \begin_layout Standard
19524 \change_inserted 564990737 1672236008
19525 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
19526 If you don't want one of the rules,
19527 set its thickness to 0.
19528 The header rule has a default thickness of 0.4pt,
19529 the footer rule is 0pt.
19530 For this you will need to use \SpecialChar TeX
19534 \begin_layout Standard
19536 \change_inserted 564990737 1672236008
19543 headrulewidth}{0.4pt}
19548 \begin_layout Standard
19550 \change_inserted 564990737 1672236008
19557 footrulewidth}{0.4pt}
19559 to set the thicknesses.
19562 \begin_layout Standard
19564 \change_inserted 564990737 1672236008
19565 You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
19570 thispagestyle{empty}
19577 thispagestyle{plain}
19584 thispagestyle{fancy}
19587 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
19590 title pages are marked as plain by default,
19591 while following pages are marked fancy when using the global fancy setting.
19595 \begin_layout Standard
19597 \change_inserted 564990737 1672236008
19598 If you want a header or footer to be on the outer side of a two sided document,
19599 you need to use something like:
19602 \begin_layout Standard
19604 \change_inserted 564990737 1672236008
19607 \begin_inset Flex Strong
19610 \begin_layout Plain Layout
19612 \change_inserted 564990737 1672236008
19628 \begin_layout Standard
19630 \change_inserted 564990737 1672236008
19633 \begin_inset Flex Strong
19636 \begin_layout Plain Layout
19638 \change_inserted 564990737 1672236008
19656 \begin_layout Standard
19658 \change_inserted 564990737 1672236008
19659 The first command clears all existing footers avoiding any conflicts with your new command.
19662 \begin_layout Standard
19664 \change_inserted 564990737 1672236008
19665 You can enter any of these commands,
19666 the simpler ones in any of your new environments,
19667 the more complex ones as \SpecialChar TeX
19669 at any point in your document and they will take effect on the next page.
19672 \begin_layout Standard
19674 \change_inserted 564990737 1672236008
19675 As a final example,
19676 it is possible to include an image in the header or footer.
19677 Suppose you want to put a company logo in the upper left hand corner.
19678 You might try something like
19681 \begin_layout Standard
19683 \change_inserted 564990737 1672236008
19692 includegraphics{logo.eps}}}
19695 \begin_layout Standard
19698 \change_inserted 564990737 1672236008
19699 (you may need to preface this with
19703 usepackage{graphics}
19705 if you don't include graphics elsewhere in your document).
19708 \begin_layout Standard
19710 \change_inserted 564990737 1672236008
19711 For more information on fancy headers,
19713 \begin_inset Flex Code
19716 \begin_layout Plain Layout
19718 \change_inserted 564990737 1672236008
19727 \begin_inset CommandInset href
19730 target "http://www.ctan.org/pkg/fancyhdr"
19739 \begin_layout Subsection
19741 \change_inserted 564990737 1672236008
19742 Landscape Document Parts
19745 \begin_layout Standard
19747 \change_inserted 564990737 1672236008
19748 This module outputs parts of the document in landscape mode using
19750 Insert\SpecialChar menuseparator
19751 Custom Insets\SpecialChar menuseparator
19756 Insert\SpecialChar menuseparator
19757 Custom Insets\SpecialChar menuseparator
19758 Landscape (Floating)
19763 \begin_layout Subsection
19765 \change_inserted 564990737 1672236008
19766 \begin_inset CommandInset label
19768 name "sec:Multiple-Columns"
19775 \begin_layout Standard
19777 \change_inserted 564990737 1672236008
19778 This module uses the
19783 \begin_inset Index idx
19788 \begin_layout Plain Layout
19790 \change_inserted 564990737 1672236008
19800 package and is independent of the option
19813 ocument\SpecialChar menuseparator
19818 ettings\SpecialChar menuseparator
19820 \begin_inset space ~
19826 If you want to have two columns for the whole document,
19827 you are recommended to use the
19836 For all other cases use this module.
19837 \change_deleted 564990737 1672236008
19838 Multiple Text Columns
19841 \begin_layout Standard
19843 \change_deleted 564990737 1672236008
19844 This feature is independent of the option
19846 Two-column document
19848 in the document settings under
19853 If you want to have 2
19854 \begin_inset space ~
19857 columns for the whole document,
19858 it is recommended to use the
19860 Two-column document
19863 For all other cases use this feature.
19866 \begin_layout Standard
19868 \change_deleted 564990737 1672236008
19869 To use multiple text columns in your document,
19870 you have to load the module
19876 Document\SpecialChar menuseparator
19877 Settings\SpecialChar menuseparator
19880 ) and must have the \SpecialChar LaTeX
19882 \begin_inset Flex Code
19885 \begin_layout Plain Layout
19896 \begin_layout Standard
19897 Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
19898 Within the different columns you can use everything,
19899 with the limitation that for floats you need to
19900 \change_deleted 564990737 1672236179
19901 use the float option
19904 \change_inserted 564990737 1672236179
19913 \begin_inset space ~
19923 dit\SpecialChar menuseparator
19929 \begin_inset space ~
19939 \begin_layout Subsubsection
19943 \begin_layout Standard
19944 If you want to have 2
19945 \begin_inset space ~
19948 columns in your text,
19949 insert a multicolumn inset via the menu
19951 Insert\SpecialChar menuseparator
19953 \begin_inset space ~
19956 Insets\SpecialChar menuseparator
19958 \begin_inset space ~
19963 where the columns should start.
19964 Write all text that should be printed in 2
19965 \begin_inset space ~
19968 columns into this inset.
19971 \begin_layout Standard
19972 Here is an example:
19975 \begin_layout Standard
19977 \begin_inset Flex Multiple Columns
19980 \begin_layout Plain Layout
19985 The Adventure of the Empty House
19988 \begin_inset Newline newline
19991 by Sir Arthur Conan Doyle
19994 \begin_layout Plain Layout
19997 It was in the spring of the year 1894 that all London was interested,
19998 and the fashionable world dismayed,
19999 by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
20000 The public has already learned those particulars of the crime which came out in the police investigation,
20001 but a good deal was suppressed upon that occasion,
20002 since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
20004 at the end of nearly ten years,
20005 am I allowed to supply those missing links which make up the whole of that remarkable chain.
20006 The crime was of interest in itself,
20007 but that interest was as nothing to me compared to the inconceivable sequel,
20008 which afforded me the greatest shock and surprise of any event in my adventurous life.
20010 after this long interval,
20011 I find myself thrilling as I think of it,
20012 and feeling once more that sudden flood of joy,
20014 and incredulity which utterly submerged my mind.
20015 Let me say to that public,
20016 which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
20017 that they are not to blame me if I have not shared my knowledge with them,
20018 for I should have considered it my first duty to do so,
20019 had I not been barred by a positive prohibition from his own lips,
20020 which was only withdrawn upon the third of last month.
20028 \begin_layout Standard
20029 To get 3 or more columns,
20030 set the cursor into the multicolumn inset and use the menu
20032 Insert\SpecialChar menuseparator
20034 \begin_inset space ~
20038 \begin_inset space ~
20044 The number of the desired columns is written into that inset (for 3
20045 \begin_inset space ~
20049 \begin_inset Quotes eld
20053 \begin_inset Quotes erd
20057 \begin_inset Newline newline
20060 Here is an example with 3
20061 \begin_inset space ~
20067 \begin_layout Standard
20068 \begin_inset Flex Multiple Columns
20071 \begin_layout Plain Layout
20074 \begin_inset Argument 1
20077 \begin_layout Plain Layout
20084 It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
20085 and that after his disappearance I never failed to read with care the various problems which came before the public.
20086 And I even attempted,
20088 for my own private satisfaction,
20089 to employ his methods in their solution,
20090 though with indifferent success.
20093 which appealed to me like this tragedy of Ronald Adair.
20094 As I read the evidence at the inquest,
20095 which led up to a verdict of willful murder against some person or persons unknown,
20096 I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
20097 There were points about this strange business which would,
20099 have specially appealed to him,
20100 and the efforts of the police would have been supplemented,
20101 or more probably anticipated,
20102 by the trained observation and the alert mind of the first criminal agent in Europe.
20104 as I drove upon my round,
20105 I turned over the case in my mind and found no explanation which appeared to me to be adequate.
20106 At the risk of telling a twice-told tale,
20107 I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
20115 \begin_layout Standard
20116 You can have up to 10
20117 \begin_inset space ~
20120 columns if you want to,
20121 but that might not be very pleasant for the readers of your document.
20124 \begin_layout Standard
20126 \change_deleted 564990737 1672236245
20127 \begin_inset Newpage newpage
20135 \begin_layout Subsubsection
20136 Columns inside Columns
20139 \begin_layout Standard
20140 You can also have columns inside columns:
20143 \begin_layout Standard
20144 \begin_inset Flex Multiple Columns
20147 \begin_layout Plain Layout
20150 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
20151 at that time governor of one of the Australian colonies.
20152 Adair's mother had returned from Australia to undergo the operation for cataract,
20155 and her daughter Hilda were living together at 427 Park Lane.
20158 \begin_layout Plain Layout
20159 \begin_inset Flex Multiple Columns
20162 \begin_layout Plain Layout
20165 The youth moved in the best society
20166 \begin_inset space ~
20170 so far as was known,
20171 no enemies and no particular vices.
20172 He had been engaged to Miss Edith Woodley,
20174 but the engagement had been broken off by mutual consent some months before,
20175 and there was no sign that it had left any very profound feeling behind it.
20176 For the rest {sic} the man's life moved in a narrow and conventional circle,
20177 for his habits were quiet and his nature unemotional.
20178 Yet it was upon this easy-going young aristocrat that death came,
20179 in most strange and unexpected form,
20180 between the hours of ten and eleven-twenty on the night of March 30,
20189 \begin_layout Plain Layout
20192 Ronald Adair was fond of cards
20193 \begin_inset space ~
20196 – playing continually,
20197 but never for such stakes as would hurt him.
20198 He was a member of the Baldwin,
20200 and the Bagatelle card clubs.
20202 after dinner on the day of his death,
20203 he had played a rubber of whist at the latter club.
20204 He had also played there in the afternoon.
20209 The evidence of those who had played with him
20210 \begin_inset space ~
20217 \begin_inset space ~
20220 – showed that the game was whist,
20221 and that there was a fairly equal fall of the cards.
20222 Adair might have lost five pounds,
20224 His fortune was a considerable one,
20225 and such a loss could not in any way affect him.
20226 He had played nearly every day at one club or other,
20227 but he was a cautious player,
20228 and usually rose a winner.
20229 It came out in evidence that,
20230 in partnership with Colonel Moran,
20231 he had actually won as much as four hundred and twenty pounds in a sitting,
20233 from Godfrey Milner and Lord Balmoral.
20234 So much for his recent history as it came out at the inquest.
20242 \begin_layout Subsubsection
20246 \begin_layout Standard
20247 The examples in this section show some more special features of multiple columns.
20250 \begin_layout Standard
20251 For more features of multiple columns,
20253 \begin_inset CommandInset href
20255 name "documentation"
20256 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
20261 of the \SpecialChar LaTeX
20263 \begin_inset Flex Code
20266 \begin_layout Plain Layout
20275 \begin_layout Paragraph
20279 \begin_layout Standard
20280 To add a preface text for multiple columns,
20281 set the cursor into the multicolumn inset and use the menu
20283 Insert\SpecialChar menuseparator
20287 Write your preface text into that inset.
20288 \begin_inset Newline newline
20291 This is an example with some preface text:
20294 \begin_layout Standard
20295 \begin_inset VSpace bigskip
20301 \begin_layout Standard
20302 \begin_inset Flex Multiple Columns
20305 \begin_layout Plain Layout
20306 \begin_inset Argument 2
20309 \begin_layout Plain Layout
20310 And the story continues and continues and continues and continues\SpecialChar ldots
20318 On the evening of the crime,
20319 he returned from the club exactly at ten.
20320 His mother and sister were out spending the evening with a relation.
20321 The servant deposed that she heard him enter the front room on the second floor,
20322 generally used as his sitting-room.
20323 She had lit a fire there,
20324 and as it smoked she had opened the window.
20325 No sound was heard from the room until eleven-twenty,
20326 the hour of the return of Lady Maynooth and her daughter.
20327 Desiring to say good-night,
20328 she attempted to enter her son's room.
20329 The door was locked on the inside,
20330 and no answer could be got to their cries and knocking.
20332 and the door forced.
20333 The unfortunate young man was found lying near the table.
20334 His head had been horribly mutilated by an expanding revolver bullet,
20335 but no weapon of any sort was to be found in the room.
20343 \begin_layout Standard
20344 You can also use a section heading as the preface if you use a section command as \SpecialChar TeX
20346 For example the command
20349 \begin_layout LyX-Code
20352 subsection{subsection title}
20355 \begin_layout Standard
20356 creates a subsection.
20357 In this example the preface is a subsubsection:
20360 \begin_layout Standard
20361 \begin_inset Flex Multiple Columns
20364 \begin_layout Plain Layout
20365 \begin_inset Argument 2
20368 \begin_layout Plain Layout
20372 \begin_layout Plain Layout
20381 This is a subsubsection heading as a preface
20385 \begin_layout Plain Layout
20399 A minute examination of the circumstances served only to make the case more complex.
20400 In the first place,
20401 no reason could be given why the young man should have fastened the door upon the inside.
20402 There was the possibility that the murderer had done this,
20403 and had afterwards escaped by the window.
20404 The drop was at least twenty feet,
20406 and a bed of crocuses in full bloom lay beneath.
20407 Neither the flowers nor the earth showed any sign of having been disturbed,
20408 nor were there any marks upon the narrow strip of grass which separated the house from the road.
20411 it was the young man himself who had fastened the door.
20412 But how did he come by his death?
20413 No one could have climbed up to the window without leaving traces.
20414 Suppose a man had fired through the window,
20415 he would indeed be a remarkable shot who could with a revolver inflict so deadly a wound.
20417 Park Lane is a frequented thoroughfare;
20418 there is a cab stand within a hundred yards of the house.
20419 No one had heard a shot.
20427 \begin_layout Standard
20428 If there is less vertical space than 6
20429 \begin_inset space ~
20432 text lines is left on the page at the beginning of the multiple columns,
20433 a page break will be inserted before the multiple columns.
20434 Depending on the number of lines of the preface text,
20435 you might want to change this space.
20436 This is done by setting the cursor into the mulitcolumn inset behind the preface (if there is any) and using the menu
20438 Insert\SpecialChar menuseparator
20440 \begin_inset space ~
20444 \begin_inset space ~
20448 \begin_inset space ~
20454 Insert into that inset the amount of space like e.
20455 \begin_inset space \thinspace{}
20459 \begin_inset space \space{}
20463 \begin_inset Quotes eld
20467 \begin_inset Quotes erd
20471 \begin_inset Newline newline
20474 In this example the space is set to 7
20475 \begin_inset space ~
20478 text lines by using
20479 \begin_inset Flex Code
20482 \begin_layout Plain Layout
20491 \begin_inset Flex Code
20494 \begin_layout Plain Layout
20502 needs to be inserted as \SpecialChar TeX
20506 \begin_layout Standard
20507 \begin_inset Flex Multiple Columns
20510 \begin_layout Plain Layout
20511 \begin_inset Argument 3
20514 \begin_layout Plain Layout
20519 \begin_layout Plain Layout
20535 On the evening of the crime,
20536 he returned from the club exactly at ten.
20537 His mother and sister were out spending the evening with a relation.
20538 The servant deposed that she heard him enter the front room on the second floor,
20539 generally used as his sitting-room.
20540 She had lit a fire there,
20541 and as it smoked she had opened the window.
20542 No sound was heard from the room until eleven-twenty,
20543 the hour of the return of Lady Maynooth and her daughter.
20544 Desiring to say good-night,
20545 she attempted to enter her son's room.
20546 The door was locked on the inside,
20547 and no answer could be got to their cries and knocking.
20549 and the door forced.
20550 The unfortunate young man was found lying near the table.
20551 His head had been horribly mutilated by an expanding revolver bullet,
20552 but no weapon of any sort was to be found in the room.
20560 \begin_layout Paragraph
20564 \begin_layout Standard
20565 The amount of space before and after multiple columns can be changed by changing the length
20566 \begin_inset Flex Code
20569 \begin_layout Plain Layout
20578 For example the command
20581 \begin_layout LyX-Code
20589 \begin_layout Standard
20590 in \SpecialChar TeX
20591 Code changes its value to 3
20592 \begin_inset space \thinspace{}
20596 The change must be made before the multiple columns' start.
20597 The predefined value is 13
20598 \begin_inset space \thinspace{}
20604 \begin_layout Standard
20606 \begin_inset Flex Code
20609 \begin_layout Plain Layout
20618 \begin_inset space \thinspace{}
20624 \begin_layout Standard
20628 \begin_layout Plain Layout
20634 multicolsep}{2.5cm}
20642 \begin_layout Standard
20643 \begin_inset Flex Multiple Columns
20646 \begin_layout Plain Layout
20649 All day I turned these facts over in my mind,
20650 endeavouring to hit upon some theory which could reconcile them all,
20651 and to find that line of least resistance which my poor friend had declared to be the starting-point of every investigation.
20652 I confess that I made little progress.
20653 In the evening I strolled across the Park,
20654 and found myself about six o'clock at the Oxford Street end of Park Lane.
20655 A group of loafers upon the pavements,
20656 all staring up at a particular window,
20657 directed me to the house which I had come to see.
20659 thin man with coloured glasses,
20660 whom I strongly suspected of being a plain-clothes detective,
20661 was pointing out some theory of his own,
20662 while the others crowded round to listen to what he said.
20663 I got as near him as I could,
20664 but his observations seemed to me to be absurd,
20665 so I withdrew again in some disgust.
20666 As I did so I struck against an elderly,
20668 who had been behind me,
20669 and I knocked down several books which he was carrying.
20677 \begin_layout Standard
20678 \begin_inset Note Greyedout
20681 \begin_layout Plain Layout
20687 The values you set with
20688 \begin_inset Flex Code
20691 \begin_layout Plain Layout
20699 will be used for all following multiple columns until you change them again.
20707 \begin_layout Standard
20711 \begin_layout Plain Layout
20723 \begin_inset Note Note
20726 \begin_layout Plain Layout
20727 go back to the default
20735 \begin_layout Standard
20737 \change_deleted 564990737 1672236355
20738 \begin_inset Newpage newpage
20746 \begin_layout Paragraph
20750 \begin_layout Standard
20751 A column break can be forced by inserting the command
20752 \begin_inset Flex Code
20755 \begin_layout Plain Layout
20763 as \SpecialChar TeX
20764 Code to that position in the text where the column should be broken.
20765 Note that this leads in most cases to whitespace in the text.
20766 \begin_inset Newline newline
20769 Here is an example:
20772 \begin_layout Standard
20773 \begin_inset Flex Multiple Columns
20776 \begin_layout Plain Layout
20779 \begin_inset Quotes eld
20782 You're surprised to see me,
20784 \begin_inset Quotes erd
20792 \begin_layout Plain Layout
20795 I acknowledged that I was.
20798 \begin_layout Plain Layout
20801 \begin_inset Quotes eld
20807 and when I chanced to see you go into this house,
20808 as I came hobbling after you,
20809 I thought to myself,
20810 I'll just step in and see that kind gentleman,
20811 and tell him that if I was a bit gruff in my manner there was not any harm meant,
20812 and that I am much obliged to him for picking up my books.
20813 \begin_inset Quotes erd
20819 \begin_layout Plain Layout
20822 \begin_inset Quotes eld
20825 You make too much of a trifle,
20826 \begin_inset Quotes erd
20831 \begin_inset Quotes eld
20834 May I ask how you knew who I was?
20835 \begin_inset Quotes erd
20838 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
20842 \begin_layout Plain Layout
20854 \begin_layout Plain Layout
20857 \begin_inset Quotes eld
20862 if it isn't too great a liberty,
20863 I am a neighbour of yours,
20864 for you'll find my little bookshop at the corner of Church Street,
20865 and very happy to see you,
20867 Maybe you collect yourself,
20872 \begin_inset space ~
20888 \begin_inset space ~
20893 With five volumes you could just fill that gap on that second shelf.
20897 \begin_inset Quotes erd
20908 \begin_layout Paragraph
20912 \begin_layout Standard
20913 The width of the columns is automatically calculated,
20914 but you can modify the space between the columns.
20915 This is done by changing the length
20916 \begin_inset Flex Code
20919 \begin_layout Plain Layout
20928 Its predefined value is 10
20929 \begin_inset space \thinspace{}
20933 Here is an example where
20934 \begin_inset Flex Code
20937 \begin_layout Plain Layout
20946 \begin_inset space \thinspace{}
20952 \begin_layout Standard
20956 \begin_layout Plain Layout
20970 \begin_layout Standard
20971 \begin_inset Flex Multiple Columns
20974 \begin_layout Plain Layout
20977 My observations of No.
20978 \begin_inset space \space{}
20981 427 Park Lane did little to clear up the problem in which I was interested.
20982 The house was separated from the street by a low wall and railing,
20983 the whole not more than five feet high.
20984 It was perfectly easy,
20986 for anyone to get into the garden,
20987 but the window was entirely inaccessible,
20988 since there was no water pipe or anything which could help the most active man to climb it.
20989 More puzzled than ever,
20990 I retraced my steps to Kensington.
20991 I had not been in my study five minutes when the maid entered to say that a person desired to see me.
20992 To my astonishment it was none other than my strange old book collector,
20994 wizened face peering out from a frame of white hair,
20995 and his precious volumes,
20996 a dozen of them at least,
20997 wedged under his right arm.
21005 \begin_layout Standard
21009 \begin_layout Plain Layout
21021 \begin_inset Note Note
21024 \begin_layout Plain Layout
21025 go back to the default
21033 \begin_layout Paragraph
21037 \begin_layout Standard
21038 Between the columns a rule with a width of the length
21039 \begin_inset Flex Code
21042 \begin_layout Plain Layout
21051 If this rule width is set to 0
21052 \begin_inset space \thinspace{}
21055 pt (this is the default),
21056 the rule is suppressed.
21057 In the following example the rule is 2
21058 \begin_inset space \thinspace{}
21064 \begin_layout Standard
21068 \begin_layout Plain Layout
21074 columnseprule}{2pt}
21082 \begin_layout Standard
21083 \begin_inset Flex Multiple Columns
21086 \begin_layout Plain Layout
21089 \begin_inset Quotes eld
21092 You're surprised to see me,
21094 \begin_inset Quotes erd
21102 \begin_layout Plain Layout
21105 I acknowledged that I was.
21108 \begin_layout Plain Layout
21111 \begin_inset Quotes eld
21117 and when I chanced to see you go into this house,
21118 as I came hobbling after you,
21119 I thought to myself,
21120 I'll just step in and see that kind gentleman,
21121 and tell him that if I was a bit gruff in my manner there was not any harm meant,
21122 and that I am much obliged to him for picking up my books.
21123 \begin_inset Quotes erd
21129 \begin_layout Plain Layout
21132 \begin_inset Quotes eld
21135 You make too much of a trifle,
21136 \begin_inset Quotes erd
21141 \begin_inset Quotes eld
21144 May I ask how you knew who I was?
21145 \begin_inset Quotes erd
21151 \begin_layout Plain Layout
21154 \begin_inset Quotes eld
21159 if it isn't too great a liberty,
21160 I am a neighbour of yours,
21161 for you'll find my little bookshop at the corner of Church Street,
21162 and very happy to see you,
21164 Maybe you collect yourself,
21169 \begin_inset space ~
21185 \begin_inset space ~
21190 With five volumes you could just fill that gap on that second shelf.
21194 \begin_inset Quotes erd
21205 \begin_layout Standard
21206 \begin_inset VSpace defskip
21212 \begin_layout Standard
21213 The rule can be colored by redefining the command
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21226 This is done by inserting the command
21229 \begin_layout LyX-Code
21234 columnseprulecolor}{
21239 \begin_layout Standard
21240 as \SpecialChar TeX
21241 Code before the multicolumn inset.
21243 \begin_inset Flex Code
21246 \begin_layout Plain Layout
21252 in this command by a color of your choice.
21253 You can use all pre- and self-defined colors.
21262 \begin_inset space ~
21267 for more information about pre- and self-defined colors.
21268 To go back to the default color insert the command
21271 \begin_layout LyX-Code
21276 columnseprulecolor}{
21281 \begin_layout Standard
21282 Here is the example with a cyan rule and 1
21283 \begin_inset space \thinspace{}
21286 cm column separation:
21289 \begin_layout Standard
21293 \begin_layout Plain Layout
21302 \begin_layout Plain Layout
21308 columnseprulecolor}{
21318 \begin_layout Standard
21319 \begin_inset Flex Multiple Columns
21322 \begin_layout Plain Layout
21325 \begin_inset Quotes eld
21328 You're surprised to see me,
21330 \begin_inset Quotes erd
21338 \begin_layout Plain Layout
21341 I acknowledged that I was.
21344 \begin_layout Plain Layout
21347 \begin_inset Quotes eld
21353 and when I chanced to see you go into this house,
21354 as I came hobbling after you,
21355 I thought to myself,
21356 I'll just step in and see that kind gentleman,
21357 and tell him that if I was a bit gruff in my manner there was not any harm meant,
21358 and that I am much obliged to him for picking up my books.
21359 \begin_inset Quotes erd
21365 \begin_layout Plain Layout
21368 \begin_inset Quotes eld
21371 You make too much of a trifle,
21372 \begin_inset Quotes erd
21377 \begin_inset Quotes eld
21380 May I ask how you knew who I was?
21381 \begin_inset Quotes erd
21387 \begin_layout Plain Layout
21390 \begin_inset Quotes eld
21395 if it isn't too great a liberty,
21396 I am a neighbour of yours,
21397 for you'll find my little bookshop at the corner of Church Street,
21398 and very happy to see you,
21400 Maybe you collect yourself,
21405 \begin_inset space ~
21421 \begin_inset space ~
21426 With five volumes you could just fill that gap on that second shelf.
21430 \begin_inset Quotes erd
21441 \begin_layout Standard
21445 \begin_layout Plain Layout
21451 columnseprule}{0pt}
21454 \begin_layout Plain Layout
21460 columnseprulecolor}{
21468 \begin_inset Note Note
21471 \begin_layout Plain Layout
21472 go back to the default
21480 \begin_layout Section
21482 \change_inserted 564990737 1671270380
21486 \begin_layout Subsection
21488 \change_inserted 564990737 1671270398
21490 \change_deleted 564990737 1671270396
21496 \begin_layout Standard
21499 as well as any other text processor uses by default rectangular paragraphs.
21500 For special cases like for example posters,
21501 invitation cards or poems you can modify the paragraph shape to one of your choice.
21503 \change_deleted 564990737 1672311802
21504 This can be done by using the \SpecialChar LaTeX
21506 \begin_inset Flex Code
21509 \begin_layout Plain Layout
21515 which is loaded by using in the document settings the module
21517 Custom paragraph shapes
21520 \change_inserted 564990737 1672311802
21521 This module uses the
21525 package to provide over a dozen paragraph shapes as well as commands to define custom shapes.
21531 \begin_layout Subsubsection
21535 \begin_layout Standard
21540 provides the following shapes:
21543 \begin_layout Standard
21544 \begin_inset Tabular
21545 <lyxtabular version="3" rows="13" columns="3">
21546 <features booktabs="true" islongtable="true" longtabularalignment="center">
21547 <column alignment="left" valignment="middle" width="16col%">
21548 <column alignment="left" valignment="middle" width="40col%">
21549 <column alignment="left" valignment="middle" width="35col%">
21550 <row endhead="true">
21551 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21554 \begin_layout Plain Layout
21563 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21566 \begin_layout Plain Layout
21575 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21578 \begin_layout Plain Layout
21588 <row interlinespace="default">
21589 <cell alignment="left" valignment="top" usebox="none">
21592 \begin_layout Plain Layout
21600 <cell alignment="left" valignment="top" usebox="none">
21603 \begin_layout Plain Layout
21606 Circle with circular hole (in the size of a CD/DVD)
21611 <cell alignment="left" valignment="top" usebox="none">
21614 \begin_layout Plain Layout
21618 take care there is not too much text
21624 <row interlinespace="default">
21625 <cell alignment="left" valignment="top" usebox="none">
21628 \begin_layout Plain Layout
21636 <cell alignment="left" valignment="top" usebox="none">
21639 \begin_layout Plain Layout
21647 <cell alignment="left" valignment="top" usebox="none">
21650 \begin_layout Plain Layout
21654 calculation might fail
21660 <row interlinespace="default">
21661 <cell alignment="left" valignment="top" usebox="none">
21664 \begin_layout Plain Layout
21672 <cell alignment="left" valignment="top" usebox="none">
21675 \begin_layout Plain Layout
21678 Rhomboid (symbolizing a
21679 \begin_inset Quotes eld
21683 \begin_inset Quotes erd
21691 <cell alignment="left" valignment="top" usebox="none">
21694 \begin_layout Plain Layout
21703 <row interlinespace="default">
21704 <cell alignment="left" valignment="top" usebox="none">
21707 \begin_layout Plain Layout
21715 <cell alignment="left" valignment="top" usebox="none">
21718 \begin_layout Plain Layout
21726 <cell alignment="left" valignment="top" usebox="none">
21729 \begin_layout Plain Layout
21738 <row interlinespace="default">
21739 <cell alignment="left" valignment="top" usebox="none">
21742 \begin_layout Plain Layout
21750 <cell alignment="left" valignment="top" usebox="none">
21753 \begin_layout Plain Layout
21761 <cell alignment="left" valignment="top" usebox="none">
21764 \begin_layout Plain Layout
21773 <row interlinespace="default">
21774 <cell alignment="left" valignment="top" usebox="none">
21777 \begin_layout Plain Layout
21785 <cell alignment="left" valignment="top" usebox="none">
21788 \begin_layout Plain Layout
21791 Nut for bolt (hexagon with circular hole)
21796 <cell alignment="left" valignment="top" usebox="none">
21799 \begin_layout Plain Layout
21808 <row interlinespace="default">
21809 <cell alignment="left" valignment="top" usebox="none">
21812 \begin_layout Plain Layout
21820 <cell alignment="left" valignment="top" usebox="none">
21823 \begin_layout Plain Layout
21831 <cell alignment="left" valignment="top" usebox="none">
21834 \begin_layout Plain Layout
21843 <row interlinespace="default">
21844 <cell alignment="left" valignment="top" usebox="none">
21847 \begin_layout Plain Layout
21855 <cell alignment="left" valignment="top" usebox="none">
21858 \begin_layout Plain Layout
21866 <cell alignment="left" valignment="top" usebox="none">
21869 \begin_layout Plain Layout
21878 <row interlinespace="default">
21879 <cell alignment="left" valignment="top" usebox="none">
21882 \begin_layout Plain Layout
21890 <cell alignment="left" valignment="top" usebox="none">
21893 \begin_layout Plain Layout
21901 <cell alignment="left" valignment="top" usebox="none">
21904 \begin_layout Plain Layout
21913 <row interlinespace="default">
21914 <cell alignment="left" valignment="top" usebox="none">
21917 \begin_layout Plain Layout
21925 <cell alignment="left" valignment="top" usebox="none">
21928 \begin_layout Plain Layout
21931 Normal/reversed rain drop
21936 <cell alignment="left" valignment="top" usebox="none">
21939 \begin_layout Plain Layout
21943 calculation might fail
21949 <row interlinespace="default">
21950 <cell alignment="left" valignment="top" usebox="none">
21953 \begin_layout Plain Layout
21962 <cell alignment="left" valignment="top" usebox="none">
21965 \begin_layout Plain Layout
21968 The \SpecialChar TeX
21974 <cell alignment="left" valignment="top" usebox="none">
21977 \begin_layout Plain Layout
21986 <row interlinespace="default">
21987 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
21990 \begin_layout Plain Layout
21994 \begin_inset Newline newline
22002 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22005 \begin_layout Plain Layout
22008 Triangles in different orientations
22013 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
22016 \begin_layout Plain Layout
22032 \begin_layout Standard
22033 To use a shape for your paragraph,
22034 simply select it in \SpecialChar LyX
22035 's pull-down box for environments in the toolbar.
22038 \begin_layout Standard
22039 \begin_inset Newpage newpage
22045 \begin_layout Standard
22046 Here is an example paragraph in the shape of a nut:
22049 \begin_layout Standard
22050 \begin_inset VSpace bigskip
22059 Lorem ipsum dolor sit amet,
22060 consetetur sadipscing elitr,
22061 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22063 At vero eos et accusam et justo duo dolores et ea rebum.
22064 Stet clita kasd gubergren,
22065 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22066 Lorem ipsum dolor sit amet,
22067 consetetur sadipscing elitr,
22068 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22072 \begin_layout Standard
22073 \begin_inset VSpace bigskip
22079 \begin_layout Standard
22080 \begin_inset Note Greyedout
22083 \begin_layout Plain Layout
22093 paragraphs cannot run over a page break.
22101 \begin_layout Standard
22102 \begin_inset VSpace bigskip
22108 \begin_layout Standard
22110 \begin_inset Flex Code
22113 \begin_layout Plain Layout
22119 takes care that the shape will always be preserved,
22120 no matter how much text is in the paragraph.
22121 Therefore the paragraph size changes with the amount of contained text.
22122 This can lead to paragraph sizes exceeding the page margins.
22123 To demonstrate the size scaling,
22124 here is the same example paragraph but with twice as much text:
22127 \begin_layout Standard
22128 \begin_inset Newpage newpage
22137 Lorem ipsum dolor sit amet,
22138 consetetur sadipscing elitr,
22139 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22141 At vero eos et accusam et justo duo dolores et ea rebum.
22142 Stet clita kasd gubergren,
22143 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22144 Lorem ipsum dolor sit amet,
22145 consetetur sadipscing elitr,
22146 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22148 Lorem ipsum dolor sit amet,
22149 consetetur sadipscing elitr,
22150 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22152 At vero eos et accusam et justo duo dolores et ea rebum.
22153 Stet clita kasd gubergren,
22154 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22155 Lorem ipsum dolor sit amet,
22156 consetetur sadipscing elitr,
22157 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22161 \begin_layout Standard
22162 \begin_inset VSpace bigskip
22168 \begin_layout Standard
22169 An exception is the shape
22174 It cannot be scaled because it must fit the size of a CD/DVD.
22175 Therefore the amount of text that fits into the shape is limited.
22176 \begin_inset Newline newline
22188 meaning that the calculation of their size can fail,
22189 depending on the amount of text.
22190 You will then get the \SpecialChar LaTeX
22192 \begin_inset Quotes eld
22195 Arithmetic overflow
22196 \begin_inset Quotes erd
22200 In this case one can try to remove or add some text;
22201 if nothing works one has to use another shape.
22204 \begin_layout Standard
22205 \begin_inset VSpace bigskip
22211 \begin_layout Standard
22212 For shapes with tips you will maybe see that \SpecialChar LaTeX
22213 's hyphenation routine fails for text in the tips.
22214 Therefore it is often necessary to add hyphenation points
22219 arg "specialchar-insert hyphenation"
22224 ) to the corresponding text parts.
22227 \begin_layout Standard
22228 \begin_inset VSpace bigskip
22234 \begin_layout Standard
22235 Shapepar paragraphs are either always centered or placed on the page so that their left border touches the left page margin.
22236 You can therefore not use the paragraph dialog to align such paragraphs.
22237 A solution is to put the paragraph into a minipage or parbox and align the box.
22238 The problem is hereby to find the right width for the box.
22239 Because if it is too wide and you center the box,
22240 the paragraph is not centered too because it sticks at the left side of the box.
22241 So you might have to play a bit with the width until it fits.
22242 Here are two heart-shaped paragraphs,
22243 the first one is not aligned,
22244 the second one is right-aligned:
22247 \begin_layout Standard
22248 \begin_inset Newpage newpage
22254 \begin_layout Heart
22258 Lo\SpecialChar softhyphen
22259 rem ipsum dolor sit amet,
22260 consetetur sadipscing elitr,
22261 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22263 At vero eos et accusam et justo duo dolores et ea rebum.
22264 Stet clita kasd gubergren,
22265 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22268 \begin_layout Standard
22269 \begin_inset VSpace bigskip
22275 \begin_layout Standard
22278 \begin_inset Box Frameless
22288 height_special "totalheight"
22293 backgroundcolor "none"
22296 \begin_layout Heart
22300 Lo\SpecialChar softhyphen
22301 rem ipsum dolor sit amet,
22302 consetetur sadipscing elitr,
22303 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22305 At vero eos et accusam et justo duo dolores et ea rebum.
22306 Stet clita kasd gubergren,
22307 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22315 \begin_layout Subsubsection
22319 \begin_layout Standard
22320 You can define any shape you want.
22321 Doing this manually is a lot of work because every coordinate must be specified.
22322 But there is a way to let the computer calculate the coordinates:
22325 \begin_layout Enumerate
22326 Install the program
22327 \begin_inset CommandInset href
22330 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
22338 \begin_layout Enumerate
22345 TeX/LaTeX\SpecialChar menuseparator
22346 Settings\SpecialChar menuseparator
22349 and select the font size you are using in your document.
22350 For example this document uses the size 12
22351 \begin_inset space \thinspace{}
22357 \begin_layout Enumerate
22361 \begin_layout Enumerate
22364 TeX/LaTeX\SpecialChar menuseparator
22367 to export the shape to coordinates.
22368 In the appearing dialog use either the outline of your shape for the coordinates or the path itself.
22372 \begin_layout Plain Layout
22373 For more information see
22374 \begin_inset CommandInset href
22376 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
22389 \begin_layout Standard
22390 The coordinates are written into a \SpecialChar TeX
22392 To use it for your \SpecialChar LyX
22396 \begin_layout Enumerate
22397 Place the cursor before the first character of your paragraph (or into a new empty one).
22400 \begin_layout Enumerate
22401 Open in \SpecialChar LyX
22404 Insert\SpecialChar menuseparator
22405 File\SpecialChar menuseparator
22407 \begin_inset space ~
22413 select the file and use
22422 \begin_layout Standard
22423 \begin_inset VSpace defskip
22429 \begin_layout Standard
22430 \begin_inset Note Greyedout
22433 \begin_layout Plain Layout
22439 The changed shape only applies to the current paragraph;
22440 everything is reset to normal for the next paragraph.
22441 Therefore the shape definition file must be input into every paragraph with the desired shape.
22449 \begin_layout Standard
22450 \begin_inset VSpace bigskip
22456 \begin_layout Standard
22457 Here is an example:
22460 \begin_layout Standard
22461 \begin_inset VSpace bigskip
22467 \begin_layout Standard
22468 \begin_inset CommandInset include
22470 filename "SpecialParagraphShape.tex"
22477 Lorem ipsum dolor sit amet,
22478 consetetur sadipscing elitr,
22479 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22481 At vero eos et accusam et justo duo dolores et ea rebum.
22482 Stet clita kasd gubergren,
22483 no sea takimata sanctus est Lorem ipsum dolor sit amet.
22484 Lorem ipsum dolor sit amet,
22485 consetetur sadipscing elitr,
22486 sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
22490 \begin_layout Standard
22491 \begin_inset VSpace bigskip
22497 \begin_layout Standard
22503 to draw complexer shapes in
22507 you can draw the shape in a program of your choice and import the resulting image to
22512 Then you only need to draw a line or spline along the outline of the image.
22515 \begin_layout Standard
22516 \begin_inset VSpace bigskip
22522 \begin_layout Standard
22525 Custom paragraph shapes
22527 also provides the two commands
22535 which can be used to define custom shapes coordinate by coordinate.
22539 \begin_layout Plain Layout
22540 These commands are internally used for all shapes described here.
22545 For information how these styles are used and about further customization possibilities,
22547 \begin_inset CommandInset href
22549 name "documentation"
22550 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
22556 \begin_inset Flex Code
22559 \begin_layout Plain Layout
22568 \begin_layout Subsection
22570 \change_inserted 564990737 1672311925
22574 \begin_layout Hanging
22576 \change_inserted 564990737 1672311925
22577 This module adds the
22583 one where all but the first line of the paragraph is indented.
22584 This may not appear in your \SpecialChar LyX
22585 document but will appear in the final output.
22588 \begin_layout Subsection
22590 \change_inserted 564990737 1672311925
22591 \begin_inset CommandInset label
22593 name "subsec:Initials"
22597 Initials (Drop Caps)
22600 \begin_layout Initial
22602 \change_inserted 564990737 1672311925
22603 \begin_inset Argument 2
22606 \begin_layout Plain Layout
22608 \change_inserted 564990737 1672311925
22617 \begin_inset Argument 3
22620 \begin_layout Plain Layout
22622 \change_inserted 564990737 1672311925
22630 module adds a drop capitals paragraph style
22634 for paragraph environments which you can use wherever you want to have drop capitals.
22635 You then have three more items in the
22642 \begin_layout Itemize
22644 \change_inserted 564990737 1672311925
22649 which creates an inset for the drop capital
22652 \begin_layout Itemize
22654 \change_inserted 564990737 1672311925
22659 which creates an inset for the rest of the word
22662 \begin_layout Itemize
22664 \change_inserted 564990737 1672311925
22669 which allow you configure the formatting of the drop capital.
22672 \begin_layout Standard
22674 \change_inserted 564990737 1672311925
22675 To customize the appearance of the style,
22678 Help\SpecialChar menuseparator
22679 Embedded Objects\SpecialChar menuseparator
22680 Objects Surrounded by Text\SpecialChar menuseparator
22686 \begin_layout Section
22688 \change_inserted 564990737 1672312011
22692 \begin_layout Subsection
22694 \change_inserted 564990737 1672312011
22695 Hyphenatable Text Markup
22698 \begin_layout Standard
22700 \change_inserted 564990737 1672312011
22701 This package defines text styles to highlight,
22704 underline and capitalize/small-cap text by means of the
22709 As opposed to the markup provided by the Text Properties dialog,
22710 words marked-up with
22716 \begin_inset CommandInset href
22718 name "soul documentation"
22719 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
22727 \begin_layout Subsection
22729 \change_inserted 564990737 1672312011
22733 \begin_layout Standard
22735 \change_inserted 564990737 1672312011
22736 This module defines some character styles for logical markup:
22740 \begin_inset Flex Noun
22743 \begin_layout Plain Layout
22745 \change_inserted 564990737 1672312011
22761 \begin_inset Flex Emph
22764 \begin_layout Plain Layout
22766 \change_inserted 564990737 1672312011
22780 \begin_inset Flex Strong
22783 \begin_layout Plain Layout
22785 \change_inserted 564990737 1672312011
22795 \begin_inset Flex Code
22798 \begin_layout Plain Layout
22800 \change_inserted 564990737 1672312011
22808 which are accessed via the
22813 dit\SpecialChar menuseparator
22815 \begin_inset space ~
22819 \begin_inset space ~
22831 \begin_layout Chapter
22833 \change_deleted 564990737 1671304317
22837 \change_inserted 564990737 1671304322
22839 \change_deleted 564990737 1671304331
22840 ies with Bib\SpecialChar TeX
22846 \begin_layout Standard
22847 The most basic information about how to use Bib\SpecialChar TeX
22852 with \SpecialChar LyX
22853 is contained in the section
22855 Bibliography databases
22862 The following subsections explain special bibliography features supported by \SpecialChar LyX
22866 \begin_layout Section
22867 Alternative Citation Styles
22870 \begin_layout Standard
22871 Standard Bib\SpecialChar TeX
22873 \begin_inset space \thinspace{}
22877 \begin_inset space \space{}
22881 \begin_inset Quotes eld
22885 \begin_inset Quotes erd
22888 ) to refer to a cited work.
22890 in many scientific disciplines,
22891 other citation styles are in use.
22892 The most common one is the author-year style (e.
22893 \begin_inset space \thinspace{}
22897 \begin_inset space \space{}
22901 \begin_inset Quotes eld
22905 \begin_inset Quotes erd
22910 supports three packages that provide this style,
22912 \begin_inset Flex Code
22915 \begin_layout Plain Layout
22923 \begin_inset Flex Code
22926 \begin_layout Plain Layout
22934 \begin_inset Flex Code
22937 \begin_layout Plain Layout
22944 Each of these packages has their pros and cons,
22945 which cannot be listed in detail.
22946 If you only want to have simple author-year (or author-numerical) style,
22947 or if you want to use one of the countless style files for
22948 \begin_inset Flex Code
22951 \begin_layout Plain Layout
22958 then the established
22959 \begin_inset Flex Code
22962 \begin_layout Plain Layout
22968 package is probably your choice.
22969 If you look for specific citation styles common in law studies,
22970 you might consider the
22971 \begin_inset Flex Code
22974 \begin_layout Plain Layout
22981 If you want to have full control over the formatting or look for advanced features such as ibidem,
22982 footnote citations,
22983 full title citations,
22984 advanced date formats (such as 400 BC) or full localization to other languages than English,
22985 you should definitely consider
22986 \begin_inset Flex Code
22989 \begin_layout Plain Layout
22996 which exceeds all other packages in terms of features,
22997 but is also quite heavy and more resource-hungry.
23000 \begin_layout Standard
23001 The handling of these packages in \SpecialChar LyX
23002 is basically the same.
23004 \begin_inset Flex Noun
23007 \begin_layout Plain Layout
23008 Document\SpecialChar menuseparator
23015 \begin_inset Flex Noun
23018 \begin_layout Plain Layout
23025 \begin_inset Flex Noun
23028 \begin_layout Plain Layout
23035 \begin_inset Flex Noun
23038 \begin_layout Plain Layout
23046 \begin_inset Flex Noun
23049 \begin_layout Plain Layout
23057 \begin_inset Flex Noun
23060 \begin_layout Plain Layout
23061 Biblatex (Natbib mode)
23068 \begin_inset Flex Noun
23071 \begin_layout Plain Layout
23078 \begin_inset Flex Noun
23081 \begin_layout Plain Layout
23088 \begin_inset space ~
23091 6.5.3 in the User's Guide for more information on these choices).
23092 With all these packages,
23093 you will get some extra features in the citation dialog and you can select the style of the reference (
23094 \begin_inset Quotes eld
23098 \begin_inset Quotes erd
23103 \begin_inset Quotes eld
23107 \begin_inset Quotes erd
23112 \begin_inset Quotes eld
23117 \begin_inset Quotes erd
23122 \begin_inset Quotes eld
23126 \begin_inset Quotes erd
23130 Note that either package needs specifically designed style files.
23131 They all ship their own,
23132 but there are lots of additional style files,
23133 and there is even an interactive style file builder
23137 \begin_layout Plain Layout
23139 \begin_inset Flex URL
23142 \begin_layout Plain Layout
23144 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
23155 \begin_inset Flex Code
23158 \begin_layout Plain Layout
23167 \begin_layout Section
23168 Subdivided Bibliographies
23171 \begin_layout Standard
23172 Sometimes you might need to divide your bibliography into several sections.
23173 If you are for instance a historian,
23174 the possibility to separate sources and scientific works is most likely a
23175 \begin_inset Quotes eld
23179 \begin_inset Quotes erd
23184 Bib\SpecialChar TeX
23185 itself does not allow you to do this.
23186 But with the help of some \SpecialChar LaTeX
23188 Bib\SpecialChar TeX
23189 can be extended to fit your needs.
23192 \begin_layout Standard
23194 provides native support for one of these packages,
23203 \begin_layout Plain Layout
23205 \begin_inset Flex URL
23208 \begin_layout Plain Layout
23210 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
23220 The advantage of this package (compared to other packages such as
23224 ) is that you don't need to define new citation commands.
23226 you need to prepare different bibliographic databases which include the entries for the different sections of the bibliography.
23228 If you want to divide your bibliography into the sections
23229 \begin_inset Quotes eld
23233 \begin_inset Quotes erd
23237 \begin_inset Quotes eld
23241 \begin_inset Quotes erd
23245 you first need to create two bibliographic databases,
23247 \begin_inset space \thinspace{}
23251 \begin_inset space \space{}
23255 \begin_inset Flex Code
23258 \begin_layout Plain Layout
23265 \begin_inset Flex Code
23268 \begin_layout Plain Layout
23278 \begin_layout Standard
23280 \begin_inset Flex Noun
23283 \begin_layout Plain Layout
23284 Document\SpecialChar menuseparator
23291 \begin_inset Flex Noun
23294 \begin_layout Plain Layout
23301 \begin_inset Flex Noun
23304 \begin_layout Plain Layout
23305 Subdivided bibliography
23311 Now you can insert multiple Bib\SpecialChar TeX
23313 one for each section of your bibliography.
23314 Returning to our example:
23315 Insert the Bib\SpecialChar TeX
23317 \begin_inset Flex Code
23320 \begin_layout Plain Layout
23326 and a second one for the database
23327 \begin_inset Flex Code
23330 \begin_layout Plain Layout
23337 You are free to use the same or different styles for each section.
23339 you can choose if the bibliography section should contain
23340 \begin_inset Quotes eld
23343 all cited references
23344 \begin_inset Quotes erd
23347 of the specified database(s) (which is the default),
23349 \begin_inset Quotes eld
23352 all uncited references
23353 \begin_inset Quotes erd
23357 \begin_inset Quotes eld
23361 \begin_inset Quotes erd
23365 This might be useful if you would like to separate your bibliography into three sections:
23367 \begin_inset Quotes eld
23371 \begin_inset Quotes erd
23376 \begin_inset Quotes eld
23380 \begin_inset Quotes erd
23385 \begin_inset Quotes eld
23389 \begin_inset Quotes erd
23393 The titles for the sections can be added as ordinary sections or subsections.
23395 \begin_inset Flex Code
23398 \begin_layout Plain Layout
23404 removes the bibliography title,
23405 you have to manually re-add that,
23406 too (as a chapter* or section*,
23410 \begin_layout Standard
23416 the procedure is a bit different.
23427 \begin_inset Flex Noun
23430 \begin_layout Plain Layout
23431 Subdivided bibliography
23436 option is disabled if you use
23446 provides its own means to generate subdivided bibliographies.
23447 You can either add keywords to bibliography entries via the
23448 \begin_inset Flex Code
23451 \begin_layout Plain Layout
23457 entry option and then filter bibliography sections by keyword (by adding
23458 \begin_inset Flex Code
23461 \begin_layout Plain Layout
23468 \begin_inset Flex Noun
23471 \begin_layout Plain Layout
23477 field of the dialog that opens if you left-click on the
23478 \begin_inset Flex Noun
23481 \begin_layout Plain Layout
23482 Biblatex Generated Bibliography
23488 or you can filter by entry types (such as
23497 \begin_inset space \thinspace{}
23502 \begin_inset Flex Code
23505 \begin_layout Plain Layout
23512 \begin_inset Flex Code
23515 \begin_layout Plain Layout
23522 \begin_inset Flex Noun
23525 \begin_layout Plain Layout
23532 or you can create so-called
23533 \begin_inset Quotes eld
23536 Bibliography Categories
23537 \begin_inset Quotes erd
23540 to which you can assign individual entries.
23541 Please refer to the Biblatex manual,
23544 Subdivided Bibliographies
23550 \begin_layout Section
23551 Multiple Bibliographies
23552 \begin_inset CommandInset label
23554 name "subsec:Multiple-Bibliographies"
23561 \begin_layout Standard
23562 Multiple bibliographies,
23564 \begin_inset space \thinspace{}
23568 \begin_inset space \space{}
23571 a bibliography for each part,
23574 subsection or child (sub-document) of the document,
23575 are also supported by \SpecialChar LyX
23577 In order to enable it,
23579 \begin_inset Flex Noun
23582 \begin_layout Plain Layout
23583 Document\SpecialChar menuseparator
23584 Settings\SpecialChar menuseparator
23590 and select the relevant unit (e.
23591 \begin_inset space \thinspace{}
23596 \begin_inset Quotes eld
23600 \begin_inset Quotes erd
23604 \begin_inset Flex Noun
23607 \begin_layout Plain Layout
23608 Multiple Bibliographies
23614 Then add a Bib(la)\SpecialChar TeX
23615 bibliography to each unit (e.
23616 \begin_inset space \thinspace{}
23620 section) of your document.
23622 a separate bibliography,
23623 containing only the references done in the current unit is generated.
23626 \begin_layout Standard
23627 If you use Bib\SpecialChar TeX
23630 \begin_inset Flex Code
23633 \begin_layout Plain Layout
23640 \begin_inset Flex Code
23643 \begin_layout Plain Layout
23649 package is used to create multiple bibliographies.
23650 The former package is used if you select
23651 \begin_inset Quotes eld
23655 \begin_inset Quotes erd
23663 \begin_inset Flex Noun
23666 \begin_layout Plain Layout
23667 Sectioned Bibliography
23673 In all other cases,
23675 \begin_inset Flex Code
23678 \begin_layout Plain Layout
23688 \begin_layout Plain Layout
23689 An alternative approach,
23690 if you are willing to use some
23691 \begin_inset Flex Noun
23694 \begin_layout Plain Layout
23702 \begin_inset space ~
23706 \begin_inset CommandInset ref
23708 reference "sec:Inserting-TeX-Code"
23715 \begin_inset Flex Code
23718 \begin_layout Plain Layout
23730 \begin_inset Flex Code
23733 \begin_layout Plain Layout
23741 encloses the specified units in
23742 \begin_inset Flex Code
23745 \begin_layout Plain Layout
23752 \begin_inset Flex Code
23755 \begin_layout Plain Layout
23764 \begin_inset Flex Code
23767 \begin_layout Plain Layout
23775 in order to create the units.
23776 Note that this approach has some limitations.
23778 every citation reference has to be inside some
23779 \begin_inset Flex Code
23782 \begin_layout Plain Layout
23789 So citations outside a defined unit (e.
23790 \begin_inset space \thinspace{}
23794 before the first section if you use
23795 \begin_inset Quotes eld
23799 \begin_inset Quotes erd
23803 \begin_inset Quotes eld
23807 \begin_inset Quotes erd
23811 You can also create your own units by entering
23812 \begin_inset Flex Code
23815 \begin_layout Plain Layout
23824 \begin_inset Flex Code
23827 \begin_layout Plain Layout
23835 as \SpecialChar TeX
23836 code (for instance to work around the mentioned limitation).
23840 \begin_inset Flex Code
23843 \begin_layout Plain Layout
23849 s cannot be nested.
23850 A second limitation is that
23851 \begin_inset Flex Code
23854 \begin_layout Plain Layout
23860 always processes all references of a bibliography database,
23861 even if they are not cited.
23862 This can result in odd labels (e.
23863 \begin_inset space \thinspace{}
23868 \begin_inset Quotes eld
23872 \begin_inset Quotes erd
23875 if two works of this author from 2014 are in the database,
23876 even if only one is cited).
23879 \begin_layout Standard
23886 \begin_inset Flex Code
23889 \begin_layout Plain Layout
23895 option is used instead.
23896 If you need specific units,
23897 you can start them with the \SpecialChar TeX
23899 \begin_inset Flex Code
23902 \begin_layout Plain Layout
23911 \begin_inset Flex Code
23914 \begin_layout Plain Layout
23924 If you also want to control the end of the unit,
23925 use the environment
23926 \begin_inset Flex Code
23929 \begin_layout Plain Layout
23939 \begin_inset Flex Code
23942 \begin_layout Plain Layout
23954 \begin_inset Flex Code
23957 \begin_layout Plain Layout
23963 s cannot be nested.
23964 In addition to the individual bibliography of the current unit,
23969 also provides an easy way to output all bibliographies,
23972 \begin_inset space \thinspace{}
23976 at the end of the document).
23978 \begin_inset Quotes eld
23981 all reference units
23982 \begin_inset Quotes erd
23985 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve this.
23986 Please refer to the
23990 manual for more information on this topic.
23993 \begin_layout Chapter
23995 \change_deleted 564990737 1671355654
23999 \change_inserted 564990737 1671355667
24001 \change_deleted 564990737 1671355661
24003 \change_inserted 564990737 1671355684
24005 \begin_inset CommandInset label
24007 name "chap:bullets"
24012 \change_deleted 564990737 1671355684
24014 \begin_inset CommandInset label
24025 \begin_layout Standard
24031 \begin_layout Section
24035 \begin_layout Standard
24037 provides 216 bullet shapes that can be accessed from a simple dialog.
24038 Using this dialog you can easily specify what bullet shape to use at each level of an itemized list.
24039 These settings are document-wide so you won't be able to specify different sets of bullets for different paragraphs.
24043 \begin_layout Plain Layout
24045 actually you can but you'll have to do it by hand.
24053 \begin_layout Section
24057 \begin_layout Standard
24058 Open the dialog by selecting the
24059 \begin_inset Flex Noun
24062 \begin_layout Plain Layout
24063 Document\SpecialChar menuseparator
24069 menu item and then select the
24070 \begin_inset Flex Noun
24073 \begin_layout Plain Layout
24082 \begin_layout Standard
24083 The dialog provides you with a table of bullet shapes.
24084 A column of buttons on the left of the table provides access to the six different panels of bullet shapes.
24085 The row of buttons across the top is used to select which bullet depth you are changing.
24087 \change_deleted 244031559 1603875981
24088 A text entry under the table shows the currently selected bullet shape's \SpecialChar LaTeX
24089 equivalent and this can be edited if desired.
24090 If you do modify the text you will also need to specify any needed packages in the \SpecialChar LaTeX
24096 \begin_layout Standard
24097 The six panels are divided up by the packages they require.
24098 The following table shows the mappings from button name to \SpecialChar LaTeX
24102 \begin_layout Standard
24104 \begin_inset Tabular
24105 <lyxtabular version="3" rows="7" columns="2">
24106 <features tabularvalignment="middle">
24107 <column alignment="center" valignment="top" width="0pt">
24108 <column alignment="center" valignment="top" width="0pt">
24110 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
24113 \begin_layout Plain Layout
24128 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
24131 \begin_layout Plain Layout
24148 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24151 \begin_layout Plain Layout
24166 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24169 \begin_layout Plain Layout
24178 base \SpecialChar LaTeX
24186 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24189 \begin_layout Plain Layout
24204 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24207 \begin_layout Plain Layout
24224 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24227 \begin_layout Plain Layout
24242 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24245 \begin_layout Plain Layout
24262 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24265 \begin_layout Plain Layout
24280 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24283 \begin_layout Plain Layout
24300 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
24303 \begin_layout Plain Layout
24318 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
24321 \begin_layout Plain Layout
24338 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
24341 \begin_layout Plain Layout
24356 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
24359 \begin_layout Plain Layout
24382 \begin_layout Standard
24384 doesn't stop you using bullets from packages you don't have.
24385 If you get errors from \SpecialChar LaTeX
24386 when you try to view or print the file,
24387 then it is likely you are missing a package.
24391 \begin_layout Plain Layout
24393 doesn't restrict your use since you may be editing locally and exporting elsewhere.
24401 \begin_layout Section
24405 \begin_layout Standard
24406 Select which bullet depth you want to change then select the bullet shape and size.
24407 Any changes will not be visible in \SpecialChar LyX
24409 but are visible when viewing the document.
24412 \begin_layout Standard
24413 You can reset a bullet shape to the default simply by clicking your right mouse button on the appropriate bullet depth button.
24417 \begin_layout Plain Layout
24419 \change_inserted 564990737 1672138075
24420 \begin_inset CommandInset label
24422 name "fn:If-you-really"
24432 want to have multiple sets of paragraphs with different sets of bullets in each,
24433 then you're going to have to get your hands dirty with \SpecialChar TeX
24435 The bullet selection dialog can help though because it provides you with the \SpecialChar LaTeX
24436 code for a wide range of bullet shapes.
24437 To make your own custom paragraphs you have the following options:
24440 \begin_layout Plain Layout
24444 \begin_layout Plain Layout
24460 \begin_layout Plain Layout
24464 \begin_layout Plain Layout
24486 \begin_layout Itemize
24487 Use the \SpecialChar LaTeX
24489 \begin_inset Flex Code
24492 \begin_layout Plain Layout
24500 to specify a new bullet shape for a given depth.
24501 You'll also need to save the current bullet shape so you can restore it again afterwards.
24502 In this itemized list the following \SpecialChar LaTeX
24503 code was used to change the bullet used for the first depth.
24507 \begin_layout LyX-Code
24517 \begin_layout LyX-Code
24534 \begin_layout Itemize
24535 Note that the itemize depth is specified in Roman numerals as part of the
24544 \begin_layout Itemize
24545 \begin_inset Argument item:1
24548 \begin_layout Plain Layout
24552 \begin_layout Plain Layout
24570 Specify each individual entry by starting each item with the bullet shape enclosed in a
24571 \begin_inset Quotes eld
24575 \begin_inset Quotes erd
24578 inset (available at
24580 Insert\SpecialChar menuseparator
24584 \begin_inset Flex Noun
24587 \begin_layout Plain Layout
24596 this item was started with
24597 \begin_inset Flex Code
24600 \begin_layout Plain Layout
24615 \begin_layout Plain Layout
24619 \begin_layout Plain Layout
24635 \begin_layout Plain Layout
24636 You'll also need to revert the labelitem back to its previous setting for the global bullet shape settings to remain in effect.
24637 The way used here was:
24640 \begin_layout LyX-Code
24655 \begin_layout Chapter
24659 \begin_layout Section
24660 Multipart Documents
24663 \begin_layout Subsection
24667 \begin_layout Standard
24668 When you are working on a large file with many sections,
24669 it is often convenient to break up the document into several files,
24670 or perhaps you have something where a table may change from time to time,
24671 but the preceding text does not.
24673 you should seriously consider using multipart documents.
24675 scientific papers often have five major sections:
24681 Each of these could be its own separate \SpecialChar LyX
24684 \begin_inset Quotes eld
24688 \begin_inset Quotes erd
24691 file which contains the title,
24696 plus the five included files.
24697 It is important to note that each of these files is a full \SpecialChar LyX
24698 file which can be formatted and printed on its own,
24699 as well as included in a master file.
24700 Each of these files must have the same document class,
24702 don't attempt to mix book classes with article classes.
24703 You may also include \SpecialChar LaTeX
24706 these files must not have their own preamble (i.
24707 \begin_inset space \thinspace{}
24711 \begin_inset space \space{}
24714 everything up to and including the
24715 \begin_inset Flex Code
24718 \begin_layout Plain Layout
24726 line as well as the
24727 \begin_inset Flex Code
24730 \begin_layout Plain Layout
24738 line must be deleted) or else errors will be generated when you try to make a DVI file.
24741 \begin_layout Standard
24743 allows you to include files quite easily with
24744 \begin_inset Flex Noun
24747 \begin_layout Plain Layout
24748 Insert\SpecialChar menuseparator
24750 \begin_inset space ~
24759 When you click on this selection a small box is inserted into the file at the current cursor location.
24760 Clicking on the box raises a dialog which allows you to select the file to be included,
24761 and the method of its inclusion.
24765 \begin_layout Standard
24766 The file selection box should by now be obvious.
24767 The three inclusion methods are
24768 \begin_inset Quotes eld
24772 \begin_inset Quotes erd
24777 \begin_inset Quotes eld
24781 \begin_inset Quotes erd
24786 \begin_inset Quotes eld
24790 \begin_inset Quotes erd
24795 \begin_inset Quotes eld
24799 \begin_inset Quotes erd
24803 \begin_inset Quotes eld
24807 \begin_inset Quotes erd
24810 are similar in many ways,
24811 but there are also some notable differences:
24814 \begin_layout Enumerate
24816 \begin_inset Quotes eld
24820 \begin_inset Quotes erd
24823 are typeset beginning on a new page,
24824 while files that are
24825 \begin_inset Quotes eld
24829 \begin_inset Quotes erd
24832 are typeset starting on the current page.
24835 \begin_layout Enumerate
24836 \begin_inset Quotes eld
24840 \begin_inset Quotes erd
24843 files cannot themselves
24844 \begin_inset Quotes eld
24848 \begin_inset Quotes erd
24852 \begin_inset Quotes eld
24856 \begin_inset Quotes erd
24861 \begin_inset Quotes eld
24865 \begin_inset Quotes erd
24870 infinite sub-inputting is possible.
24873 \begin_layout Enumerate
24874 \begin_inset Quotes eld
24878 \begin_inset Quotes erd
24881 allow for the output of only selected
24882 \begin_inset Quotes eld
24886 \begin_inset Quotes erd
24890 while maintaining the actual counters (pagination etc.) and references (please refer to the section
24893 \begin_inset space ~
24901 \begin_inset space ~
24906 manual for details).
24909 \begin_layout Standard
24912 \begin_inset Quotes eld
24916 \begin_inset Quotes erd
24919 is the preferred method for chapters that are outsourced to child documents,
24921 \begin_inset Quotes eld
24925 \begin_inset Quotes erd
24928 is more suitable for arbitrary file inheritance.
24931 \begin_layout Standard
24933 \begin_inset Quotes eld
24937 \begin_inset Quotes erd
24940 included file allows you to include a file typeset exactly as it appears in the file,
24942 \begin_inset space \thinspace{}
24946 \begin_inset space \space{}
24950 \begin_inset Flex Code
24953 \begin_layout Plain Layout
24960 with the characters set in a fixed-width typewriter font.
24962 spaces in this file are invisible,
24963 though two consecutive spaces are conserved,
24964 unlike \SpecialChar LyX
24965 's normal treatment of spaces.
24968 \begin_inset Flex Noun
24971 \begin_layout Plain Layout
24973 \begin_inset space ~
24977 \begin_inset space ~
24981 \begin_inset space ~
24989 checkbox typesets a mark to unambiguously define the presence of a space.
24993 \begin_layout Standard
24995 the master file is converted into a full \SpecialChar LaTeX
24996 file before typesetting,
24997 while the included files are converted to \SpecialChar LaTeX
24998 files that do not have all the preamble information.
25001 \begin_layout Subsection
25002 Cross-References Between Files
25005 \begin_layout Standard
25006 \begin_inset Box Shadowbox
25016 height_special "totalheight"
25021 backgroundcolor "none"
25024 \begin_layout Plain Layout
25025 This section is somewhat out of date.
25026 Need to describe default master documents and how children are opened when the master is.
25035 \begin_layout Standard
25036 It is possible to set up cross-references between the different files.
25038 open all the files in question:
25039 let's call them A and B in a two file example,
25040 where B is included in A.
25041 Let's say you insert a label in A,
25042 then want to reference it in B.
25043 Open the cross-reference dialog whilst in document B,
25044 and you can select the
25045 \begin_inset Quotes eld
25049 \begin_inset Quotes erd
25055 \begin_layout Subsection
25056 Bibliography Lists in all Subdocuments
25059 \begin_layout Standard
25060 If you work with child documents,
25061 you might want to have only one main bibliography at the end,
25062 but still be able to have a selected bibliography for the child if you output it on its own.
25063 Here is how to achieve this.
25066 \begin_layout Standard
25067 For the main document,
25068 you just insert a bibliography inset at the place where the main bibliography has to appear (within the master file or within a child).
25069 If the bibliography inset is in the master file,
25070 the references will be inherited by all children,
25071 so they are available in the citation dialog within each child.
25074 \begin_layout Standard
25075 For child-specific bibliographies,
25076 insert bibliography insets within the child documents,
25077 at the place where the bibliography should appear when the child is compiled separately.
25079 the trick is to insert them into a branch (
25081 Insert\SpecialChar menuseparator
25082 Branch\SpecialChar menuseparator
25083 Insert New Branch...
25087 \begin_inset space \thinspace{}
25092 \begin_inset Quotes eld
25096 \begin_inset Quotes erd
25100 Within the children,
25101 activate the branch (
25103 Document\SpecialChar menuseparator
25104 Settings...\SpecialChar menuseparator
25109 deactivate the branch (
25111 Document\SpecialChar menuseparator
25112 Settings...\SpecialChar menuseparator
25116 Now the child's bibliography will be ignored by the master,
25117 but considered by the child.
25120 \begin_layout Standard
25121 If you need multiple bibliographies (e.
25122 \begin_inset space \thinspace{}
25126 one per child in the
25131 please refer to sec.
25132 \begin_inset space ~
25136 \begin_inset CommandInset ref
25138 reference "subsec:Multiple-Bibliographies"
25146 \begin_layout Section
25151 \begin_layout Standard
25152 Users sometimes need to be able to
25153 \begin_inset Quotes eld
25157 \begin_inset Quotes erd
25161 file together with all the images (and other files) on which it depends,
25162 either for sending to a publisher or for sharing with a co-author.
25164 includes a Python script (
25165 \begin_inset Flex Code
25168 \begin_layout Plain Layout
25174 ) that automates this process.
25176 you must have either the
25177 \begin_inset Flex Code
25180 \begin_layout Plain Layout
25187 \begin_inset Flex Code
25190 \begin_layout Plain Layout
25196 python modules installed on your system.
25198 the script prefers the
25199 \begin_inset Flex Code
25202 \begin_layout Plain Layout
25209 \begin_inset Flex Code
25212 \begin_layout Plain Layout
25218 format on Unix-like systems and the
25219 \begin_inset Flex Code
25222 \begin_layout Plain Layout
25231 \begin_layout Standard
25233 's configuration process will set the script up to export a `\SpecialChar LyX
25235 and this format will then be available under
25236 \begin_inset Flex Code
25239 \begin_layout Plain Layout
25240 File\SpecialChar menuseparator
25249 \begin_layout Standard
25250 Independently of the platform,
25251 the generation of a particular archive format can be forced by adding either the
25252 \begin_inset Flex Code
25255 \begin_layout Plain Layout
25262 \begin_inset Flex Code
25265 \begin_layout Plain Layout
25272 \begin_inset Flex Code
25275 \begin_layout Plain Layout
25282 \begin_inset Flex Code
25285 \begin_layout Plain Layout
25291 format) switch to the
25292 \begin_inset Flex Code
25295 \begin_layout Plain Layout
25297 \SpecialChar menuseparator
25305 \begin_inset Flex Code
25308 \begin_layout Plain Layout
25309 Tools\SpecialChar menuseparator
25310 Preferences\SpecialChar menuseparator
25311 File Handling\SpecialChar menuseparator
25318 (Make sure you add the switch after the script name,
25322 \begin_layout Section
25323 Fancy Headers and Footers
25326 \begin_layout Standard
25327 The default page layout is rather plain;
25329 \begin_inset Flex Code
25332 \begin_layout Plain Layout
25339 all you get is a centered page number at the bottom of the page.
25340 This document uses KOMA-script's book class,
25341 so it appears to be a bit fancier.
25342 But to really put on a show,
25343 you need to set the document page style to
25344 \begin_inset Quotes eld
25348 \begin_inset Quotes erd
25352 as mentioned in the
25357 This section describes the \SpecialChar LaTeX
25358 code you need to insert in your \SpecialChar LaTeX
25359 preamble in order to get the desired effects.
25362 \begin_layout Standard
25363 For more information on fancy headers,
25365 \begin_inset Flex Code
25368 \begin_layout Plain Layout
25374 package documentation.
25376 \begin_inset Flex URL
25379 \begin_layout Plain Layout
25381 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
25389 \begin_layout Standard
25390 The page header is divided into three fields,
25391 not surprisingly labeled
25392 \begin_inset Quotes eld
25396 \begin_inset Quotes erd
25401 \begin_inset Quotes eld
25405 \begin_inset Quotes erd
25410 \begin_inset Quotes eld
25414 \begin_inset Quotes erd
25418 The footer is also divided into these three fields.
25419 The \SpecialChar LaTeX
25420 commands to set these fields in the simplest manner are
25421 \begin_inset Flex Code
25424 \begin_layout Plain Layout
25434 \begin_inset Flex Code
25437 \begin_layout Plain Layout
25447 \begin_inset Flex Code
25450 \begin_layout Plain Layout
25460 \begin_inset Flex Code
25463 \begin_layout Plain Layout
25473 Suppose you wish to put your name in the upper left hand corner of each page.
25474 Simply insert the following command in the preamble:
25478 \begin_layout Standard
25487 \begin_layout Standard
25488 You will now see your name in the upper left.
25489 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,
25491 \begin_inset space \thinspace{}
25497 \begin_layout Standard
25505 \begin_layout Standard
25506 Let's get really fancy:
25507 lets put the section number with the word
25508 \begin_inset Quotes eld
25512 \begin_inset Quotes erd
25516 \begin_inset space \thinspace{}
25520 \begin_inset space \space{}
25523 Section 3) in the upper left,
25524 the page number (e.
25525 \begin_inset space \thinspace{}
25529 \begin_inset space \space{}
25532 Page 4) in the upper right,
25533 your name in the lower left,
25534 and the date in the lower right.
25535 The following commands should now appear in the preamble:
25538 \begin_layout Standard
25548 \begin_layout Standard
25556 \begin_layout Standard
25566 \begin_layout Standard
25575 \begin_layout Standard
25583 \begin_layout Standard
25593 \begin_layout Standard
25595 \begin_inset Flex Code
25598 \begin_layout Plain Layout
25607 \begin_inset Flex Code
25610 \begin_layout Plain Layout
25618 access \SpecialChar LaTeX
25619 's section and page counters,
25620 and so print out the current section and page number.
25622 \begin_inset Flex Code
25625 \begin_layout Plain Layout
25633 simply prints out today's date.
25636 \begin_layout Standard
25637 The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
25638 If you don't want one of the rules,
25639 set its thickness to 0.
25640 The header rule has a default thickness of 0.4pt,
25641 the footer rule is 0pt.
25647 \begin_inset Flex Code
25650 \begin_layout Plain Layout
25655 headrulewidth}{0.4pt}
25661 \begin_inset Flex Code
25664 \begin_layout Plain Layout
25669 footrulewidth}{0.4pt}
25674 to set the thicknesses.
25677 \begin_layout Standard
25678 You can switch the header/footer settings on and off for individual pages using commands like
25679 \begin_inset Flex Code
25682 \begin_layout Plain Layout
25685 thispagestyle{empty}
25692 \begin_inset Flex Code
25695 \begin_layout Plain Layout
25698 thispagestyle{plain}
25705 \begin_inset Flex Code
25708 \begin_layout Plain Layout
25711 thispagestyle{fancy}
25717 Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
25720 title pages are marked as plain by default,
25721 while following pages are marked fancy when using the global fancy setting.
25724 \begin_layout Standard
25725 As a final example,
25726 it is possible to include an image in the header or footer.
25727 Suppose you want to put a company logo in the upper lefthand corner.
25728 You might try something like
25731 \begin_layout Standard
25740 includegraphics{logo.eps}}}
25743 \begin_layout Standard
25745 (you may need to preface this with
25746 \begin_inset Flex Code
25749 \begin_layout Plain Layout
25752 usepackage{graphics}
25757 if you don't include graphics elsewhere in your document).
25760 \begin_layout Chapter
25762 and the World Wide Web
25765 \begin_layout Standard
25767 has long supported the export of documents to various web-friendly formats,
25769 Before version 2.0,
25771 HTML export was always accomplished by the use of external converters.
25775 \begin_layout Plain Layout
25776 For details on the use of external converters with \SpecialChar LyX
25782 section of the Customization manual.
25787 These fall into two large groups:
25788 there are converters that use \SpecialChar LaTeX
25789 as an intermediate format,
25791 \begin_inset Flex Code
25794 \begin_layout Plain Layout
25802 \begin_inset Flex Code
25805 \begin_layout Plain Layout
25813 \begin_inset Flex Code
25816 \begin_layout Plain Layout
25823 relying upon \SpecialChar LyX
25824 to produce the \SpecialChar LaTeX
25826 and there is a converter that works directly on \SpecialChar LyX
25829 \begin_inset Flex Code
25832 \begin_layout Plain Layout
25840 All of these have different advantages and disadvantages.
25844 \begin_layout Standard
25845 The \SpecialChar LaTeX
25846 -based converters have the advantage that,
25848 they know everything about the exported document that \SpecialChar LaTeX
25850 Such converters do not care,
25852 if a certain block of code was produced by \SpecialChar LyX
25853 or was Evil Red Text.
25854 These converters know about
25855 \begin_inset Flex Code
25858 \begin_layout Plain Layout
25867 and can often make use of the
25868 \begin_inset Flex Code
25871 \begin_layout Plain Layout
25877 files generated by Bib\SpecialChar TeX
25881 is a very hard language to parse—
25882 it is sometimes said that only \SpecialChar TeX
25883 itself understands \SpecialChar TeX
25885 and \SpecialChar LaTeX
25886 -based converters will often choke on what seem to be quite simple constructs;
25887 complex ones can throw them completely,
25888 and as of this writing,
25894 manual will not export with
25895 \begin_inset Flex Code
25898 \begin_layout Plain Layout
25905 though the others will.
25906 The other issue concerns how math is handled.
25907 These converters typically convert the formulae into little pictures that are then linked from the HTML document.
25908 Since these are actually generated by \SpecialChar LaTeX
25911 But they do not scale well,
25912 and just getting them to look as if they are actually meant to be in your document—
25913 so that the font sizes seem to be roughly the same—
25914 can be a challenge.
25917 \begin_layout Standard
25919 \begin_inset Flex Code
25922 \begin_layout Plain Layout
25930 \begin_inset CommandInset href
25932 name "http://pinchito.es/elyxer/"
25933 target "http://pinchito.es/elyxer/"
25938 ) solves some of these problems.
25940 the formulae it produces scale perfectly,
25941 since it renders math using a combination of HTML and CSS rather than converting the formulae to images.
25942 But even moderately complex formula are rendered less well than with
25943 \begin_inset Flex Code
25946 \begin_layout Plain Layout
25953 this reflects the limitations of HTML.
25957 \begin_layout Plain Layout
25960 \begin_inset Flex Code
25963 \begin_layout Plain Layout
25970 can also use jsMath and MathJax for equations,
25971 but this setting is only available globally and requires one to have access to a server that runs the backend.
25976 More importantly (as of version 1.1.1,
25979 \begin_inset Flex Code
25982 \begin_layout Plain Layout
25989 has limited support for math macros and no support for user-defined paragraph or character styles.
25990 These limitations make
25991 \begin_inset Flex Code
25994 \begin_layout Plain Layout
26001 unsuitable for many of the documents \SpecialChar LyX
26005 these problems could be solved,
26006 but the \SpecialChar LyX
26007 developers have decided to follow a different path and have made \SpecialChar LyX
26008 itself capable of writing XHTML,
26009 just as it is capable of writing \SpecialChar LaTeX
26015 \begin_layout Standard
26016 As of this writing,
26017 XHTML output remains under development and should probably be regarded as
26018 \begin_inset Quotes eld
26022 \begin_inset Quotes erd
26029 \begin_layout Plain Layout
26031 \begin_inset Flex Code
26034 \begin_layout Plain Layout
26035 development/HTML/HTML.notes
26041 which can be found in the \SpecialChar LyX
26043 \begin_inset CommandInset href
26045 name "accessed online"
26046 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
26052 usually contains up-to-date information about the state of XHTML output.
26053 See also the list of XHTML bugs on
26054 \begin_inset CommandInset href
26056 name "the bug tracker"
26057 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"
26068 the developers have chosen this approach because it has several potential advantages over the other two.
26071 \begin_layout Standard
26072 These advantages are primarily due to the fact that the XHTML output routines,
26073 since they are part of \SpecialChar LyX
26075 know everything \SpecialChar LyX
26076 knows about the document being exported.
26080 \begin_layout Plain Layout
26081 Another advantage is that,
26082 since these routines are internal to \SpecialChar LyX
26084 they are immune to changes in \SpecialChar LyX
26086 or to changes in the semantics of existing insets.
26091 So they know about the table of contents (as displayed in the outline),
26092 about the counters associated with different paragraph styles,
26093 and about user-defined styles.
26094 The XHTML output routines know what \SpecialChar LyX
26095 knows about internationalization,
26097 so they will output
26098 \begin_inset Quotes eld
26102 \begin_inset Quotes erd
26106 \begin_inset Quotes eld
26114 \begin_inset Quotes erd
26118 depending upon the language in effect at the time.
26122 \begin_layout Standard
26124 the output routines know what \SpecialChar LyX
26125 knows about document layout,
26127 about how the document is to be rendered on screen.
26128 We use this information when we output the document as XHTML.
26135 generates CSS style information corresponding to the layout information it uses to render the document on screen:
26136 if section headings are supposed to be sans-serif and bold as seen in \SpecialChar LyX
26138 then (by default) they will be sans-serif and bold when viewed in a web browser,
26140 And this is true not just for pre-defined styles,
26143 including user-defined styles.
26145 the XHTML output routines make no distinction between user-defined paragraph and
26146 \change_deleted 244031559 1603876931
26148 \change_inserted 244031559 1603876940
26151 styles and \SpecialChar LyX
26152 's own pre-defined styles:
26154 everything \SpecialChar LyX
26155 knows about the styles is contained in the layout files.
26156 And much the same is true as regards pre-defined textual insets,
26158 and various custom insets.
26162 \begin_layout Standard
26163 The result is that XHTML output can be customized and extended in exactly the same way \SpecialChar LaTeX
26164 output can be customized and extended:
26165 through layout files and modules.
26166 See chapter five of the
26170 manual for the details.
26173 \begin_layout Standard
26174 The remainder of this chapter contains more detailed information on XHTML output,
26176 and ways to work around those limitations.
26179 \begin_layout Section
26180 Math Output in XHTML
26183 \begin_layout Standard
26185 offers four choices for how math is rendered.
26186 These have various advantages and disadvantages:
26189 \begin_layout Itemize
26191 \begin_inset Newline newline
26194 MathML is a dialect of XML designed specifically for mathematics on the web,
26195 and it typically renders very well in browsers that support it.
26196 The disadvantage is that not all browsers support MathML,
26197 and support is not complete even in the Gecko-based browsers,
26199 \begin_inset Newline newline
26202 If \SpecialChar LyX
26203 is unable to render a formula as MathML—
26205 if the formula uses the
26206 \begin_inset Flex Code
26209 \begin_layout Plain Layout
26216 then it will instead output the formula as an image.
26220 \begin_layout Itemize
26222 \begin_inset Newline newline
26225 As mentioned above,
26227 \begin_inset Flex Code
26230 \begin_layout Plain Layout
26236 outputs math as HTML,
26241 \begin_layout Plain Layout
26243 has borrowed some of the CSS for its HTML output from
26244 \begin_inset Flex Code
26247 \begin_layout Plain Layout
26258 For simple formulae,
26259 this can work quite well,
26260 though with more complicated formulae it tends to break down.
26262 this method has the advantage that it is very widely supported and so it may be appropriate for documents that contain only a little,
26263 fairly simple math.
26264 \begin_inset Newline newline
26267 If Lyx is unable to render a formula as HTML—
26269 if the formula uses the
26270 \begin_inset Flex Code
26273 \begin_layout Plain Layout
26280 then it will instead output the formula as an image.
26284 \begin_layout Itemize
26286 \begin_inset Newline newline
26290 \begin_inset Flex Code
26293 \begin_layout Plain Layout
26301 will output formulae as images,
26302 the very same images,
26304 that are used for instant preview.
26308 \begin_layout Plain Layout
26309 Instant preview does
26313 have to be on for images to be output,
26319 The advantage to this method is that the images are simply generated by \SpecialChar LaTeX
26321 so they are very accurate.
26323 as mentioned earlier,
26324 is that these are bitmapped images,
26325 so they do not scale terribly well,
26326 and one cannot copy them,
26328 \begin_inset Newline newline
26331 The size of the images can be controlled by setting the
26332 \begin_inset Quotes eld
26335 Math Images Scaling
26336 \begin_inset Quotes erd
26340 \begin_inset Flex Noun
26343 \begin_layout Plain Layout
26344 Document\SpecialChar menuseparator
26345 Settings\SpecialChar menuseparator
26355 \begin_layout Plain Layout
26356 For those who want to know,
26357 this controls the resolution of the image in dots per inch and is based upon a default of 75 dpi.
26363 \begin_inset Newline newline
26366 If \SpecialChar LyX
26367 for some reason fails to create an image for a formula (e.g.,
26368 if a required \SpecialChar LaTeX
26369 package is not installed),
26370 then it will fall back to outputing the raw \SpecialChar LaTeX
26374 \begin_layout Itemize
26377 \begin_inset Newline newline
26382 will happily output math as \SpecialChar LaTeX
26384 As well as being the output of last resort,
26385 this method can be used with such tools as
26386 \begin_inset CommandInset href
26389 target "http://www.math.union.edu/~dpvc/jsMath/"
26395 which uses JavaScript to render \SpecialChar LaTeX
26396 embedded in HTML documents.
26398 wraps the \SpecialChar LaTeX
26400 \begin_inset Flex Code
26403 \begin_layout Plain Layout
26409 (for inline formulas) or
26410 \begin_inset Flex Code
26413 \begin_layout Plain Layout
26419 (for displayed formulas) with
26420 \begin_inset Flex Code
26423 \begin_layout Plain Layout
26430 as is required for jsMath.
26433 \begin_layout Standard
26434 One of these output methods must be selected under
26435 \begin_inset Flex Noun
26438 \begin_layout Plain Layout
26439 Document\SpecialChar menuseparator
26440 Settings\SpecialChar menuseparator
26450 This is a document-wide setting,
26454 \begin_layout Standard
26457 will offer the user the option to select an alternate output method for a particular inset,
26459 one that isn't being rendered very well by MathML.
26463 \begin_layout Plain Layout
26465 since \SpecialChar LyX
26466 falls back to images if the inset contains ERT,
26467 then one can force output as an image by putting some harmless ERT into the math,
26470 \begin_inset Formula $a=b\relax$
26481 \begin_layout Section
26482 Bibliography and Citations
26485 \begin_layout Standard
26486 XHTML output fully supports bibliographies and citations.
26490 \begin_layout Standard
26491 Citation labels are generated by the same machinery that generates \SpecialChar LyX
26492 's on-screen labels,
26493 so the labels will look in the output much as they do in \SpecialChar LyX
26496 If you are using numerical citations,
26497 then \SpecialChar LyX
26498 will output numerical labels,
26499 such as [1] or [17],
26500 rather than simply showing the citation key in square brackets,
26501 as it does on-screen.
26502 If you are using author-year citations,
26503 then \SpecialChar LyX
26504 will add lowercase letters to the years,
26505 just as Bib\SpecialChar TeX
26507 if it finds more than one citation for a given author-year combination.
26508 The labels will be printed with the bibliography entries.
26509 Note that there is,
26511 no way to customize the appearance of the labels,
26513 to choose between square brackets and parentheses.
26516 \begin_layout Standard
26517 Bibliography output is handled by the same machinery that handles the presentation of reference information in the citation dialog,
26518 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.
26519 The formatting can be customized in your layout file or,
26526 manual for the details.
26529 \begin_layout Standard
26530 The main defect at present is that cross-referenced information is printed with every entry with which it is associated.
26531 So you can see things like this:
26534 \begin_layout Quote
26537 \begin_inset Quotes eld
26540 Context and Logical Form
26541 \begin_inset Quotes erd
26547 Language in Context:
26551 Oxford University Press,
26557 \begin_layout Quote
26560 \begin_inset Quotes eld
26563 Semantics in Context
26564 \begin_inset Quotes erd
26570 Language in Context:
26574 Oxford University Press,
26580 \begin_layout Standard
26581 This should be fixed before long.
26584 \begin_layout Standard
26585 There is no support at present for sectioned bibliographies.
26586 If you have multiple bibliographies,
26587 then \SpecialChar LyX
26588 will print the same bibliography over and over.
26591 \begin_layout Section
26595 \begin_layout Standard
26597 will happily export indexes as XHTML,
26598 but with certain limitations at the moment.
26601 \begin_layout Standard
26602 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
26610 \begin_layout Plain Layout
26611 The main issue here is that \SpecialChar LyX
26612 itself does not really handle these.
26613 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
26619 We'll describe how they are handled using the subsection headings from that section.
26622 \begin_layout Itemize
26623 Grouping Index Entries (aka,
26626 makes an effort to support these,
26627 but the entries must be separated by
26628 \begin_inset Quotes eld
26633 \begin_inset Quotes erd
26638 there must be spaces around the exclamation point.
26639 This is because it is otherwise too difficult to check for escaped exclamation points,
26644 \begin_layout Itemize
26646 There is no support at all for page ranges,
26647 since these make no sense with XHMTL.
26649 you will just get two index entries,
26653 \begin_layout Itemize
26655 There is no support for cross-referencing.
26656 If \SpecialChar LyX
26657 finds an entry containing the
26658 \begin_inset Quotes eld
26661 |see\SpecialChar ldots
26663 \begin_inset Quotes erd
26667 it is just dropped,
26668 and the rest is treated as an ordinary index entry.
26671 \begin_layout Itemize
26674 does support attempts to fix the sorting order.
26675 It will take what is before the first `@' it finds and use that for sorting,
26676 taking what follows the first `@' to be the actual entry.
26679 does not check for escaped `@',
26680 so do not try to index email addresses.
26683 \begin_layout Itemize
26684 Index Entry Layout:
26685 You can format entries by using the text style dialog,
26686 or by using any other method available within \SpecialChar LyX
26688 There is no support for constructs like:
26690 \begin_inset Quotes eld
26694 \begin_inset Quotes erd
26699 if \SpecialChar LyX
26700 finds a pipe symbol,
26703 it will delete it and everything that follows it.
26706 \begin_layout Itemize
26708 There is no support for multiple indexes.
26710 all index entries will be printed as one large index.
26711 To avoid our printing several versions of the index,
26712 we print only the main index,
26713 so make sure you have one.
26716 \begin_layout Section
26717 Nomenclature and Glossary
26720 \begin_layout Standard
26721 There is at present no support for glossaries.
26722 Adding it would be fairly trivial,
26726 \begin_layout Chapter
26728 \change_inserted 1075283030 1616534180
26732 \begin_layout Standard
26734 \change_inserted 1075283030 1616534386
26737 can generate documents in the DocBook XML vocabulary.
26738 With versions 2.3 and before,
26739 only select templates could be used to generate DocBook documents (only version 4).
26740 Starting with \SpecialChar LyX
26742 most \SpecialChar LyX
26743 layouts can generate valid DocBook documents (only version 5).
26744 This feature is built into \SpecialChar LyX
26745 and does not require the use of external tools.
26748 \begin_layout Standard
26750 \change_inserted 1075283030 1616534437
26751 The result is that the DocBook output can be customized and extended in exactly the same way \SpecialChar LaTeX
26752 output can be customized and extended:
26753 through layout files and modules.
26754 See chapter five of the
26758 manual for the details.
26761 \begin_layout Standard
26763 \change_inserted 1075283030 1616534475
26764 Most \SpecialChar LyX
26765 features are supported with DocBook,
26769 \begin_layout Itemize
26771 \change_inserted 1075283030 1616534741
26772 Math output is performed mostly in MathML (the major exception being constructions not supported by \SpecialChar LyX
26776 All formulae are also available in raw \SpecialChar TeX
26777 in the DocBook output for further processing.
26780 \begin_layout Itemize
26782 \change_inserted 1075283030 1616534852
26783 Bibliographies and citations are implemented,
26784 including with an external BibTeX file.
26785 Bibliography entries are not prerendered when the detailed information are available,
26786 but rather output with the standard DocBook constructs.
26787 The external DocBook processor is expected to handle the rendering of entries.
26790 \begin_layout Itemize
26792 \change_inserted 1075283030 1616534863
26793 Indexes are supported,
26794 including multiple indices.
26801 and cross-references (
26806 with the exception of the same symbols escaped.
26815 ) are not supported.
26816 There is no support for escaping of index entries.
26819 \begin_layout Itemize
26821 \change_inserted 1075283030 1616534884
26822 Glossaries are implemented.
26825 \begin_layout Standard
26827 \change_inserted 1075283030 1616534894
26828 Two major parameters can be set at the document level.
26831 \begin_layout Itemize
26833 \change_inserted 1075283030 1616534948
26836 can generate tables either as HTML (default value) or CALS,
26837 depending on the user's requirements.
26838 Most DocBook processors accept both formats.
26841 \begin_layout Itemize
26843 \change_inserted 1075283030 1616535006
26846 MathML is included within its own name space,
26848 The implication is that there must be an indication of the tags belonging to the MathML standard.
26849 Three choices are offered:
26854 \begin_layout Itemize
26856 \change_inserted 1075283030 1616535044
26858 the MathML name space is defined for each formula (using the
26862 attribute on each formula)
26865 \begin_layout Itemize
26867 \change_inserted 1075283030 1616535090
26873 the MathML name space is defined at the document level (using the
26877 attribute on the root element).
26878 Each MathML is prefixed with
26889 \begin_layout Itemize
26891 \change_inserted 1075283030 1616620405
26907 \begin_layout Standard
26909 \change_inserted 1075283030 1616620470
26910 This option is especially useful if you want \SpecialChar LyX
26911 to match your personal style or to work with buggy software that only accepts one prefix for MathML.
26917 \begin_layout Chapter
26918 The \SpecialChar LyX
26922 \begin_layout Section
26926 \begin_layout Standard
26927 The `\SpecialChar LyX
26928 server' allows other programs to talk to \SpecialChar LyX
26930 invoke \SpecialChar LyX
26932 and retrieve information about the \SpecialChar LyX
26934 This is only intended for advanced users,
26935 but they should find it useful.
26936 It is by writing to the \SpecialChar LyX
26939 that bibliography managers,
26942 \begin_inset Quotes eld
26946 \begin_inset Quotes erd
26949 citations to \SpecialChar LyX
26953 \begin_layout Section
26954 Starting the \SpecialChar LyX
26956 \begin_inset CommandInset label
26958 name "sec:Starting-the-Server"
26965 \begin_layout Standard
26966 The \SpecialChar LyX
26967 server works through the use of a pair of named pipes.
26968 These are usually located in
26969 \begin_inset Flex Code
26972 \begin_layout Plain Layout
26979 (except on Windows,
26984 named pipes are special objects located in
26985 \begin_inset Flex Code
26988 \begin_layout Plain Layout
27000 ) and have the names
27001 \begin_inset Quotes eld
27005 \begin_inset Flex Code
27008 \begin_layout Plain Layout
27015 \begin_inset Quotes erd
27019 \begin_inset Quotes eld
27023 \begin_inset Flex Code
27026 \begin_layout Plain Layout
27033 \begin_inset Quotes erd
27037 External programs write into
27038 \begin_inset Flex Code
27041 \begin_layout Plain Layout
27047 and read back data from
27048 \begin_inset Flex Code
27051 \begin_layout Plain Layout
27058 The stem of the pipe names can be defined in the
27059 \begin_inset Flex Noun
27062 \begin_layout Plain Layout
27063 Tools\SpecialChar menuseparator
27071 \begin_inset Flex Code
27074 \begin_layout Plain Layout
27075 "/home/myhome/lyxpipe"
27082 \begin_inset Flex Code
27085 \begin_layout Plain Layout
27099 on Windows (where any working path instead of lyxpipe can be used,
27101 \begin_inset Flex Code
27104 \begin_layout Plain Layout
27127 configure this manually in order for the server to start.
27130 \begin_layout Standard
27133 \begin_inset Flex Code
27136 \begin_layout Plain Layout
27143 \begin_inset Flex Code
27146 \begin_layout Plain Layout
27152 ' to create the pipes.
27153 If one of the pipes already exists,
27155 will assume that another \SpecialChar LyX
27156 process is already running and will not start the server.
27157 On POSIX (Unix like) systems,
27158 if for some other reason,
27160 \begin_inset Quotes eld
27164 \begin_inset Quotes erd
27167 pipe is left in existence when \SpecialChar LyX
27169 then \SpecialChar LyX
27170 will try to delete it.
27171 If this fails for some reason,
27172 you will need to delete the pipes manually and then restart \SpecialChar LyX
27175 pipes are deleted by the OS on program termination or crash,
27177 \begin_inset Quotes eld
27181 \begin_inset Quotes erd
27184 pipes should not be possible.
27187 \begin_layout Standard
27188 To have several \SpecialChar LyX
27189 processes with servers at the same time,
27190 you have to use different configurations,
27191 perhaps by using separate user directories,
27193 \begin_inset Flex Code
27196 \begin_layout Plain Layout
27206 \begin_layout Standard
27207 If you are developing a client program,
27208 you might find it useful to enable debugging information from the \SpecialChar LyX
27210 Do this by starting \SpecialChar LyX
27212 \begin_inset Flex Code
27215 \begin_layout Plain Layout
27224 \begin_layout Standard
27225 You can find a complete example client written in C++ in the source distribution as
27226 \begin_inset Flex Code
27229 \begin_layout Plain Layout
27230 development/lyxserver/server_monitor.cpp
27238 \begin_layout Standard
27239 Another useful tool is the command-line based client found in
27240 \begin_inset Flex Code
27243 \begin_layout Plain Layout
27244 src/client/lyxclient
27252 \begin_layout Section
27253 Normal communication
27256 \begin_layout Standard
27257 To issue a \SpecialChar LyX
27259 the client writes a line of ASCII text into the input pipe.
27260 This line has the following format:
27263 \begin_layout Quote
27277 \begin_layout Description
27278 clientname is a name that the client can choose arbitrarily.
27279 Its only use is that \SpecialChar LyX
27280 will echo it if it sends an answer—
27281 so a client can dispatch results from different requesters.
27284 \begin_layout Description
27285 function is the function you want \SpecialChar LyX
27287 It is the same as the commands you'd use in the minibuffer.
27290 \begin_layout Description
27291 argument is an optional argument which is meaningful only to some functions (for instance,
27293 \begin_inset Quotes eld
27297 \begin_inset Quotes erd
27300 LFUN will insert the argument as text at the cursor position).
27303 \begin_layout Standard
27304 The answer from \SpecialChar LyX
27305 will arrive in the output pipe and be of the form
27308 \begin_layout Quote
27322 \begin_layout Standard
27331 are just echoed from the command request,
27336 is more or less useful information filled according to how the command execution worked out.
27339 \begin_inset Quotes eld
27343 \begin_inset Quotes erd
27347 will return information about the internal state of \SpecialChar LyX
27349 while other will return an empty data-response.
27350 This means that the command execution went fine.
27353 \begin_layout Standard
27355 the response from \SpecialChar LyX
27356 will have this form
27359 \begin_layout Quote
27373 \begin_layout Standard
27378 should contain an explanation of why the command failed.
27381 \begin_layout Standard
27385 \begin_layout LyX-Code
27386 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
27387 \begin_inset Newline newline
27390 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
27391 \begin_inset Newline newline
27394 read a <~/.lyxpipe.out
27395 \begin_inset Newline newline
27401 \begin_layout Subsection
27402 AppleScript (Mac OS X)
27405 \begin_layout Standard
27406 Since \SpecialChar LyX
27409 supports basic interactions with AppleScript for normal communication through the command run.
27410 This command takes a direct argument (the
27414 to perform) and an optional argument.
27415 It either returns the output of the function or triggers an error with the error message and code.
27418 \begin_layout Standard
27422 \begin_layout LyX-Code
27423 tell application "\SpecialChar LyX
27427 \begin_layout LyX-Code
27431 \begin_layout LyX-Code
27432 -- Stores the current file name into f
27435 \begin_layout LyX-Code
27436 set f to (run "server-get-filename" with argument "")
27439 \begin_layout LyX-Code
27440 on error the error_message number the error_number
27443 \begin_layout LyX-Code
27444 display dialog "Error:
27445 " & the error_number & ".
27449 \begin_layout LyX-Code
27450 & the error_message buttons {"OK"} default button 1
27453 \begin_layout LyX-Code
27457 \begin_layout LyX-Code
27461 \begin_layout Section
27465 \begin_layout Standard
27467 can notify clients of events going on asynchronously.
27468 Currently it will only do this if the user binds a key sequence with the function
27469 \begin_inset Quotes eld
27473 \begin_inset Quotes erd
27477 The format of the string \SpecialChar LyX
27478 sends is as follows:
27481 \begin_layout Quote
27482 \begin_inset Flex Code
27485 \begin_layout Plain Layout
27496 \begin_layout Standard
27501 is the printed representation of the key sequence that was actually typed by the user.
27504 \begin_layout Standard
27505 This mechanism can be used to extend \SpecialChar LyX
27506 's command set and implement macros.
27507 Bind some key sequence to
27508 \begin_inset Quotes eld
27512 \begin_inset Quotes erd
27516 Then start a client that listens on the output pipe,
27517 dispatches the command according to the sequence,
27518 and starts a function that may use \SpecialChar LyX
27519 calls and \SpecialChar LyX
27520 requests to issue a command or a series of commands to \SpecialChar LyX
27524 \begin_layout Section
27525 The simple \SpecialChar LyX
27529 \begin_layout Standard
27531 implements a simple protocol that can be used for session management.
27532 All messages are of the form
27535 \begin_layout Quote
27545 \begin_layout Standard
27551 \begin_inset Quotes eld
27555 \begin_inset Quotes erd
27559 \begin_inset Quotes eld
27563 \begin_inset Quotes erd
27568 \begin_inset Quotes eld
27572 \begin_inset Quotes erd
27575 is received from a client,
27577 will report back to inform the client that it's listening to it's messages,
27579 \begin_inset Quotes eld
27583 \begin_inset Quotes erd
27586 sent from \SpecialChar LyX
27587 will inform clients that \SpecialChar LyX
27591 \begin_layout Section
27592 Reverse DVI/PDF search
27595 \begin_layout Standard
27596 Some DVI/PDF viewers
27600 \begin_layout Plain Layout
27601 The following viewers offer the reverse PDF search feature:
27602 Okular on KDE/Linux,
27604 Skim on Mac OSX and SumatraPDF on Windows.
27613 facility (also called
27618 This means that you can tell \SpecialChar LyX
27619 to put the cursor to a specific line in the document by clicking at the respective position in the DVI/PDF output.
27621 the viewer must be able to communicate with \SpecialChar LyX
27623 This is done via the \SpecialChar LyX
27624 server either by using the named pipe (
27629 or the UNIX domain socket (
27633 ) that \SpecialChar LyX
27634 creates in its temporary directory (this is the way the
27635 \begin_inset Flex Code
27638 \begin_layout Plain Layout
27644 program communicates with \SpecialChar LyX
27647 you need a helper script that mediates between the viewer and \SpecialChar LyX
27650 the viewer can communicate with \SpecialChar LyX
27652 This depends on the selected viewer and on your operating system.
27653 The same applies to the way viewers need to be configured and the way the reverse search is actually performed.
27655 we will thus describe how to setup reverse search for specific viewers.
27656 Before we turn to this,
27658 we will explain what needs to be done generally to enable reverse search in the DVI/PDF output.
27661 \begin_layout Subsection
27663 \begin_inset CommandInset label
27665 name "subsec:rev-search"
27672 \begin_layout Standard
27673 In most cases \SpecialChar LyX
27674 will do the work for you by pressing the following button in the toolbar:
27678 arg "buffer-toggle-output-sync"
27683 you can also enable the feature by checking
27685 Synchronize with Output
27688 \begin_inset Flex Noun
27691 \begin_layout Plain Layout
27692 Document\SpecialChar menuseparator
27693 Settings\SpecialChar menuseparator
27700 In such a case \SpecialChar LyX
27701 will automatically insert the necessary Sync\SpecialChar TeX
27702 macro (for PDF) or load the srcltx package (for DVI) respectively.
27703 This option can be easily reached also on
27704 \begin_inset Flex Code
27707 \begin_layout Plain Layout
27716 \begin_layout Standard
27717 If you need a different setting,
27718 you can select or input a custom macro from the drop down box just below
27719 \begin_inset Flex Noun
27722 \begin_layout Plain Layout
27723 Document\SpecialChar menuseparator
27724 Settings\SpecialChar menuseparator
27725 Output\SpecialChar menuseparator
27726 Synchronize with Output
27734 \begin_layout Standard
27735 Note that the method
27736 \begin_inset Flex Code
27739 \begin_layout Plain Layout
27747 enables gzip compression.
27748 If your viewer does not support it,
27749 you should instead use
27750 \begin_inset Flex Code
27753 \begin_layout Plain Layout
27764 \begin_layout Standard
27765 Please also note that including the
27766 \begin_inset Flex Code
27769 \begin_layout Plain Layout
27776 \begin_inset Flex Code
27779 \begin_layout Plain Layout
27785 sometimes has an undesired impact on the typesetting.
27787 you should switch output synchronization off for the final typesetting if you use the
27788 \begin_inset Flex Code
27791 \begin_layout Plain Layout
27798 \begin_inset Flex Code
27801 \begin_layout Plain Layout
27811 \begin_layout Standard
27812 In case you need some more special settings that are not covered by the automatic settings,
27813 read the next section about how to set up output synchronization manually.
27814 If the automatic setup suits your needs,
27815 you can readily jump to section
27816 \begin_inset space ~
27820 \begin_inset CommandInset ref
27822 reference "subsec:configuring-viewers"
27828 where the necessary configuration steps in your viewer – needed both with the automatic and the manual setup – are described.
27831 \begin_layout Subsection
27835 \begin_layout Standard
27837 provides several different methods for reverse search.
27838 Some are built-in in the
27839 \begin_inset Flex Code
27842 \begin_layout Plain Layout
27849 some are provided by external packages.
27850 Your choice depends on whether your \SpecialChar LaTeX
27851 distribution already provides a given method (the built-in methods are rather new) and whether your viewer can cope with it.
27852 The available methods are described in the following.
27855 \begin_layout Subsubsection*
27856 Built-in DVI-search via src-specials (DVI only)
27859 \begin_layout Standard
27860 This method provides the DVI file with the necessary information for reverse search.
27861 It is available in \SpecialChar LaTeX
27862 since quite some time (any somewhat recent \SpecialChar LaTeX
27863 distribution should include it),
27864 and it works reliably.
27867 \begin_inset Flex Noun
27870 \begin_layout Plain Layout
27881 \begin_inset Flex Noun
27884 \begin_layout Plain Layout
27895 \begin_inset Flex Noun
27898 \begin_layout Plain Layout
27899 Preferences\SpecialChar menuseparator
27900 File Handling\SpecialChar menuseparator
27907 \begin_inset Flex Code
27910 \begin_layout Plain Layout
27911 latex -src-specials $$i
27917 If this doesn't work,
27918 check if your \SpecialChar TeX
27919 engine needs different options (the syntax might differ in some distributions).
27922 \begin_layout Subsubsection*
27923 External Packages (PDFSync and scrltx)
27926 \begin_layout Standard
27935 provide reverse search facility for PDF output (via pdflatex) and DVI output,
27937 In order to enable it,
27938 load the packages in the \SpecialChar LyX
27943 \begin_layout Itemize
27944 \begin_inset Flex Code
27947 \begin_layout Plain Layout
27950 usepackage{pdfsync}
27955 for reverse PDF search,
27958 \begin_layout Itemize
27959 \begin_inset Flex Code
27962 \begin_layout Plain Layout
27965 usepackage[active]{srcltx}
27970 for reverse DVI search.
27973 \begin_layout Standard
27974 If you want to be able to perform both DVI and PDF reverse searches,
27975 you can also insert in the preamble the following lines
27978 \begin_layout LyX-Code
27982 \begin_inset Newline newline
27988 \begin_inset Newline newline
27993 usepackage{pdfsync}
27994 \begin_inset Newline newline
28000 \begin_inset Newline newline
28005 usepackage[active]{srcltx}
28006 \begin_inset Newline newline
28014 \begin_layout Standard
28016 you can preview the file as either DVI or PDF (pdflatex) and the right package will be used.
28019 \begin_layout Standard
28020 Note that PDFSync might affect the output layout of your document.
28021 It is therefore advised to disable PDFsync for final documents.
28024 \begin_layout Subsubsection*
28025 Built-in reverse search via Sync\SpecialChar TeX
28029 \begin_layout Standard
28031 \begin_inset Flex Code
28034 \begin_layout Plain Layout
28040 have built-in support for both PDF and DVI reverse search.
28043 Sync\SpecialChar TeX
28046 facility is basically the result of the integration of the PDFSync package to the pdftex program and its merge with the
28051 You need at least \SpecialChar TeX
28052 Live 2008 or a recent Mik\SpecialChar TeX
28053 distribution in order to use it.
28057 \begin_layout Plain Layout
28059 Mik\SpecialChar TeX
28060 does not understand/obey the command \SpecialChar LyX
28061 inserts into the preamble when you check the "Enable Forward/Reverse Search" button in the toolbar and does not generate the necessary info.
28064 \begin_layout Plain Layout
28065 The generation of the required info can be forced by changing the converter "\SpecialChar LaTeX
28066 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e.,
28067 by adding the -synctex=1 switch).
28072 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
28074 SumatraPDF on Windows;
28075 see the next section for details) already provide Sync\SpecialChar TeX
28079 \begin_layout Standard
28080 To enable Sync\SpecialChar TeX
28083 \begin_inset Flex Noun
28086 \begin_layout Plain Layout
28097 \begin_inset Flex Noun
28100 \begin_layout Plain Layout
28105 (plain) -> DraftDVI
28111 \begin_inset Flex Noun
28114 \begin_layout Plain Layout
28115 Preferences\SpecialChar menuseparator
28116 File Handling\SpecialChar menuseparator
28123 \begin_inset Flex Code
28126 \begin_layout Plain Layout
28127 latex -synctex=1 $$i
28133 and for PDF output,
28135 \begin_inset Flex Noun
28138 \begin_layout Plain Layout
28143 (pdflatex) -> PDF (pdflatex)
28149 \begin_inset Flex Code
28152 \begin_layout Plain Layout
28153 pdflatex -synctex=1 $$i
28159 Should your viewer not be considered in the following description,
28160 or in case of missing success,
28161 please check the documentation of your viewer whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
28166 \begin_layout Plain Layout
28167 Note that the option
28168 \begin_inset Flex Code
28171 \begin_layout Plain Layout
28177 option enables gzip compression.
28178 If your viewer does not support it,
28179 you should instead use
28180 \begin_inset Flex Code
28183 \begin_layout Plain Layout
28197 \begin_layout Subsection
28198 Configuring and using specific viewers
28199 \begin_inset CommandInset label
28201 name "subsec:configuring-viewers"
28208 \begin_layout Subsubsection*
28209 Xdvi (all platforms)
28212 \begin_layout Standard
28214 \begin_inset Flex Code
28217 \begin_layout Plain Layout
28224 you don't need to do anything else for performing a reverse DVI search,
28225 as \SpecialChar LyX
28226 already provides the necessary hooks for automatically using the
28227 \begin_inset Flex Code
28230 \begin_layout Plain Layout
28237 Just setup your document as described above (reverse search is triggered by Ctrl-click or Alt-click on Mac OSX,
28241 \begin_layout Standard
28243 if for whatever reason you want to use the named pipe instead of the socket for communicating with \SpecialChar LyX
28245 simply change the DVI viewer in
28246 \begin_inset Flex Noun
28249 \begin_layout Plain Layout
28250 Preferences\SpecialChar menuseparator
28251 File Handling\SpecialChar menuseparator
28261 \begin_layout Plain Layout
28262 On Mac OSX you have to use
28263 \begin_inset Flex Code
28266 \begin_layout Plain Layout
28267 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
28278 \begin_inset Flex Code
28281 \begin_layout Plain Layout
28282 xdvi -editor "lyxeditor.sh %f %l"
28289 \begin_inset Flex Code
28292 \begin_layout Plain Layout
28298 is a suitable script.
28300 a minimal shell script is the following one:
28303 \begin_layout LyX-Code
28305 \begin_inset Newline newline
28308 LYXPIPE="/path/to/lyxpipe"
28309 \begin_inset Newline newline
28312 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
28313 \begin_inset Newline newline
28316 echo "$COMMAND" > "${LYXPIPE}".in || exit
28317 \begin_inset Newline newline
28320 read TMP < "${LYXPIPE}".out || exit
28323 \begin_layout Standard
28325 \begin_inset Flex Code
28328 \begin_layout Plain Layout
28334 is the LyXServer pipe path specified in
28335 \begin_inset Flex Noun
28338 \begin_layout Plain Layout
28339 Preferences\SpecialChar menuseparator
28349 \begin_layout Plain Layout
28351 \begin_inset Flex Code
28354 \begin_layout Plain Layout
28360 folder of a source distribution you can find a
28361 \begin_inset Flex Code
28364 \begin_layout Plain Layout
28370 script which is able to locate the
28374 based on your preferences.
28382 \begin_layout Subsubsection*
28386 \begin_layout Standard
28388 \begin_inset Flex Code
28391 \begin_layout Plain Layout
28392 /Applications/MacDviX_Folder/calleditor.script
28398 add the following lines:
28401 \begin_layout LyX-Code
28402 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
28403 \begin_inset Newline newline
28409 \begin_layout Standard
28410 Modify the lines accordingly if you install \SpecialChar LyX
28411 somewhere else than in the Applications folder.
28414 \begin_layout Standard
28415 Reverse search is triggered by Alt-click (OPTION-click).
28418 \begin_layout Subsubsection*
28422 \begin_layout Standard
28424 \begin_inset Flex Code
28427 \begin_layout Plain Layout
28428 open -a Skim.app $$i
28433 to the viewer setting in
28434 \begin_inset Flex Noun
28437 \begin_layout Plain Layout
28438 Preferences\SpecialChar menuseparator
28439 File Handling\SpecialChar menuseparator
28440 File formats\SpecialChar menuseparator
28448 \begin_inset Flex Noun
28451 \begin_layout Plain Layout
28452 Skim\SpecialChar menuseparator
28453 Preferences\SpecialChar menuseparator
28460 \begin_inset Flex Noun
28463 \begin_layout Plain Layout
28469 preset and enter command
28470 \begin_inset Flex Noun
28473 \begin_layout Plain Layout
28474 /Applications/\SpecialChar LyX
28475 .app/Contents/MacOS/lyxeditor
28483 \begin_layout Standard
28484 Reverse search is triggered by COMMAND-SHIFT-click
28487 \begin_layout Subsubsection*
28491 \begin_layout Standard
28492 Reverse search with evince does not work out of the box,
28493 but it can be achieved by means of some third party helper scripts.
28495 \begin_inset CommandInset href
28497 target "https://wiki.lyx.org/LyX/SyncTeX"
28505 \begin_layout Subsubsection*
28509 \begin_layout Standard
28511 \begin_inset Flex Noun
28514 \begin_layout Plain Layout
28515 Settings\SpecialChar menuseparator
28516 Configure Okular\SpecialChar menuseparator
28523 \begin_inset Quotes erd
28527 This inserts the appropriate command (
28528 \begin_inset Flex Code
28531 \begin_layout Plain Layout
28540 \begin_layout Standard
28541 Reverse search is triggered by SHIFT-click.
28543 \change_inserted -712698321 1578211026
28544 Note that this only works if Okular is in
28545 \begin_inset Quotes eld
28549 \begin_inset Quotes erd
28553 \begin_inset space \thinspace{}
28557 the hand symbol is clicked).
28562 \begin_layout Subsubsection*
28566 \begin_layout Standard
28567 Qpdfview supports Sync\SpecialChar TeX
28568 since version 0.3.5.
28570 \begin_inset Flex Noun
28573 \begin_layout Plain Layout
28574 Edit\SpecialChar menuseparator
28575 Settings\SpecialChar menuseparator
28582 click on the input field of the
28583 \begin_inset Quotes eld
28587 \begin_inset Quotes erd
28590 item and add the command
28591 \begin_inset Flex Code
28594 \begin_layout Plain Layout
28603 \begin_layout Standard
28604 Reverse search is triggered by double-click or,
28605 in more recent versions,
28609 \begin_layout Subsubsection*
28613 \begin_layout Standard
28616 \begin_inset Flex Noun
28619 \begin_layout Plain Layout
28620 View\SpecialChar menuseparator
28626 menu and select the
28627 \begin_inset Quotes eld
28631 \begin_inset Quotes erd
28636 \begin_inset Quotes eld
28639 New\SpecialChar ldots
28641 \begin_inset Quotes erd
28645 in the window that opens,
28647 \begin_inset Quotes eld
28652 \begin_inset Quotes erd
28655 (or any other name you like) in the
28656 \begin_inset Quotes eld
28660 \begin_inset Quotes erd
28664 Now click on the button labeled
28665 \begin_inset Quotes eld
28670 \begin_inset Quotes erd
28673 to open a file dialog and navigate to the directory containing the batch file
28674 \begin_inset Flex Code
28677 \begin_layout Plain Layout
28685 \begin_inset Flex Code
28688 \begin_layout Plain Layout
28694 and then specify the program arguments as
28695 \begin_inset Flex Code
28698 \begin_layout Plain Layout
28706 \begin_inset Flex Code
28709 \begin_layout Plain Layout
28715 wrapper is used for communicating with \SpecialChar LyX
28723 \begin_layout LyX-Code
28725 \begin_inset Newline newline
28728 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
28737 \begin_inset Newline newline
28751 \begin_layout Standard
28752 Make sure that the \SpecialChar LyX
28753 Server pipe path you specified in \SpecialChar LyX
28755 \begin_inset Flex Code
28758 \begin_layout Plain Layout
28773 otherwise change the
28774 \begin_inset Flex Code
28777 \begin_layout Plain Layout
28783 wrapper accordingly.
28786 \begin_layout Standard
28788 reverse search is triggered by double-click.
28791 \begin_layout Subsubsection*
28792 SumatraPDF (Windows)
28795 \begin_layout Standard
28796 In order to use SumatraPDF for inverse search,
28798 \begin_inset Flex Code
28801 \begin_layout Plain Layout
28802 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
28807 in the viewer setting in
28808 \begin_inset Flex Noun
28811 \begin_layout Plain Layout
28812 Preferences\SpecialChar menuseparator
28813 File Handling\SpecialChar menuseparator
28814 File formats\SpecialChar menuseparator
28822 \begin_inset Flex Code
28825 \begin_layout Plain Layout
28831 is the previous wrapper.
28832 If SumatraPDF.exe is not in your command PATH,
28833 use its full file name.
28836 \begin_layout Standard
28837 Reverse search is triggered by double-click.
28840 \begin_layout Subsubsection*
28844 \begin_layout Standard
28846 make sure that yap is your default DVI viewer in the Windows environment,
28849 \begin_inset Flex Noun
28852 \begin_layout Plain Layout
28853 View\SpecialChar menuseparator
28859 menu and select the
28860 \begin_inset Quotes eld
28864 \begin_inset Quotes erd
28869 \begin_inset Quotes eld
28872 New\SpecialChar ldots
28874 \begin_inset Quotes erd
28878 in the window that opens,
28880 \begin_inset Quotes eld
28885 \begin_inset Quotes erd
28888 (or any other name you like) in the
28889 \begin_inset Quotes eld
28893 \begin_inset Quotes erd
28897 Now click on the button labeled
28898 \begin_inset Quotes eld
28903 \begin_inset Quotes erd
28906 to open a file dialog and navigate to the directory containing the
28907 \begin_inset Flex Code
28910 \begin_layout Plain Layout
28916 program (which is installed by default on Cygwin along with the \SpecialChar LyX
28919 \begin_inset Flex Code
28922 \begin_layout Plain Layout
28928 and then specify the program arguments as
28929 \begin_inset Flex Code
28932 \begin_layout Plain Layout
28940 you will be using the
28944 for communicating with \SpecialChar LyX
28947 for whatever reason,
28948 you want to use the
28954 \begin_inset Flex Code
28957 \begin_layout Plain Layout
28963 option and be sure to specify the \SpecialChar LyX
28964 Server pipe path in the \SpecialChar LyX
28968 \begin_layout Standard
28970 reverse search is triggered by double-click.
28973 \begin_layout Subsubsection*
28974 SumatraPDF (Cygwin)
28977 \begin_layout Standard
28978 In order to use SumatraPDF for inverse search,
28980 \begin_inset Flex Code
28983 \begin_layout Plain Layout
28984 SumatraPDF -inverse-search "lyxeditor -g %f %l"
28989 in the viewer setting in
28990 \begin_inset Flex Noun
28993 \begin_layout Plain Layout
28994 Preferences\SpecialChar menuseparator
28995 File Handling\SpecialChar menuseparator
28996 File formats\SpecialChar menuseparator
29003 If SumatraPDF.exe is not in your command PATH,
29004 use its full posix path.
29006 \begin_inset Flex Code
29009 \begin_layout Plain Layout
29015 enables communication via the
29022 \begin_inset Flex Code
29025 \begin_layout Plain Layout
29031 option if you want to use the
29036 and be sure to specify the \SpecialChar LyX
29037 Server pipe path in the \SpecialChar LyX
29041 \begin_layout Standard
29042 Reverse search is triggered by double-click.
29045 \begin_layout Section
29049 \begin_layout Standard
29051 as the name implies,
29053 \begin_inset Quotes eld
29057 \begin_inset Quotes erd
29061 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
29063 If forward search is set up (as described in what follows),
29064 you can put the cursor anywhere in your \SpecialChar LyX
29067 \begin_inset Flex Noun
29070 \begin_layout Plain Layout
29071 Navigate\SpecialChar menuseparator
29078 \begin_inset Flex Noun
29081 \begin_layout Plain Layout
29087 in the context menu via right mouse click),
29088 and then the viewer will jump to that position as well.
29091 that your viewer supports this function.
29094 \begin_layout Standard
29095 To make forward search possible,
29096 you first need to provide the generated output PDF/DVI file with additional information about the \SpecialChar TeX
29098 This can be done via the methods described in the section
29099 \begin_inset CommandInset ref
29101 reference "subsec:rev-search"
29109 \begin_layout Standard
29111 you need to configure \SpecialChar LyX
29112 for using your viewers in
29113 \begin_inset Flex Noun
29116 \begin_layout Plain Layout
29117 Tools\SpecialChar menuseparator
29118 Preferences\SpecialChar menuseparator
29119 Output\SpecialChar menuseparator
29126 We provide a range of tested configurations for some viewers,
29127 which you can select from the drop down list.
29128 If none of these configurations suits you,
29129 you have to find out and enter a suitable configuration yourself.
29130 The definition syntax uses the following placeholders:
29133 \begin_layout Itemize
29135 \begin_inset Flex Code
29138 \begin_layout Plain Layout
29148 \begin_layout Itemize
29150 \begin_inset Flex Code
29153 \begin_layout Plain Layout
29160 name of the (temporary) exported .tex file (without path)
29163 \begin_layout Itemize
29165 \begin_inset Flex Code
29168 \begin_layout Plain Layout
29175 name of the (temporary) exported .tex file (including path)
29178 \begin_layout Itemize
29180 \begin_inset Flex Code
29183 \begin_layout Plain Layout
29190 name of the exported output file (either dvi or pdf,
29191 depending on which one exists in the temporary directory)
29194 \begin_layout Standard
29195 Note that only some of the viewers provide full and usable forward search functionality out of the box,
29202 \begin_layout Plain Layout
29203 You might want to set
29204 \begin_inset Flex Code
29207 \begin_layout Plain Layout
29214 \begin_inset Flex Noun
29217 \begin_layout Plain Layout
29218 Tools\SpecialChar menuseparator
29219 Preferences\SpecialChar menuseparator
29220 File Handling\SpecialChar menuseparator
29222 \begin_inset space ~
29241 \begin_layout Plain Layout
29242 SumatraPDF can also use DDE commands through the external program CMCDDE —
29244 \begin_inset CommandInset href
29246 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
29262 \begin_layout Plain Layout
29263 Forward search with evince can be achieved by means of third party helper scripts.
29265 \begin_inset CommandInset href
29267 target "https://wiki.lyx.org/LyX/SyncTeX"
29278 require some extra tools in order to use forward search.
29279 While many of the widespread PDF viewers (most notably Adobe Reader) do not support forward search at all,
29280 some other viewers – e.
29281 \begin_inset space \thinspace{}
29285 xpdf – allow at least to reload the document and jump to a specific page of the file,
29286 so you can at least navigate
29287 \begin_inset Quotes eld
29291 \begin_inset Quotes erd
29295 This latter functionality is provided by an external call of synctex (see the predefined example configurations).
29299 \begin_layout Standard
29300 Forward search works both with DVI and PDF output.
29302 simply checks which preview format you have used before (i.
29303 \begin_inset space \thinspace{}
29307 which format is already there in the temporary directory) and chooses the appropriate configuration for the respective format.
29308 \change_deleted 564990737 1672743015
29312 \begin_layout Standard
29314 \change_deleted 564990737 1672743015
29315 Special Document Classes
29318 \begin_layout Standard
29320 \change_deleted 564990737 1669742044
29324 \begin_layout Standard
29326 \change_deleted 564990737 1669742044
29332 \begin_layout Standard
29334 \change_deleted 564990737 1669742044
29338 \begin_layout Standard
29340 \change_deleted 564990737 1669742044
29341 This section describes how \SpecialChar LyX
29342 can be used to write articles for submission to the scientific journal
29344 Astronomy and Astrophysics
29347 \begin_inset Flex URL
29350 \begin_layout Plain Layout
29352 https://www.aanda.org/
29357 ) using Version 5.01 of the document class
29362 This package can be downloaded from the ftp site
29365 \begin_layout Standard
29367 \change_deleted 564990737 1669742044
29368 \begin_inset VSpace medskip
29374 \begin_layout Standard
29377 \change_deleted 564990737 1669742044
29378 \begin_inset Flex URL
29381 \begin_layout Plain Layout
29383 ftp://ftp.edpsciences.org/pub/aa/readme.html
29391 \begin_layout Standard
29393 \change_deleted 564990737 1669742044
29394 \begin_inset VSpace medskip
29400 \begin_layout Standard
29402 \change_deleted 564990737 1669742044
29403 A manual comes together with that package,
29404 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.
29408 \begin_layout Standard
29410 \change_deleted 564990737 1669742044
29411 Please note that the publisher of the journal was changed from Springer to EDP Sciences starting January 1,
29413 That change involved also some slight changes to the style files,
29414 namely the removal of the thesaurus command.
29415 The \SpecialChar LyX
29416 class aa supports the newest version of these style files,
29418 If you have an older version installed,
29421 the old (version 4) layout has been kept as
29426 Please refer to the comments in
29429 Dir/layouts/aapaper.layout
29434 \begin_layout Standard
29436 \change_deleted 564990737 1669742044
29440 \begin_layout Standard
29442 \change_deleted 564990737 1669742044
29443 It is recommended you start from the example template distributed with \SpecialChar LyX
29445 If you are not using a template,
29446 note the following settings:
29449 \begin_layout Itemize
29451 \change_deleted 564990737 1669742044
29458 Document\SpecialChar menuseparator
29462 that one was obvious).
29465 \begin_layout Itemize
29467 \change_deleted 564990737 1669742044
29468 Don't change the option
29471 \begin_inset space ~
29482 The whole layout is done by the macros,
29483 you shouldn't change anything.
29486 \begin_layout Standard
29488 \change_deleted 564990737 1669742044
29492 \begin_layout Standard
29494 \change_deleted 564990737 1669742044
29495 First thing to enter is the header information.
29496 It consists of seven entries,
29497 of which some are optional.
29501 \begin_layout Itemize
29503 \change_deleted 564990737 1669742044
29512 \begin_layout Itemize
29514 \change_deleted 564990737 1669742044
29523 \begin_layout Itemize
29525 \change_deleted 564990737 1669742044
29534 \begin_layout Itemize
29536 \change_deleted 564990737 1669742044
29545 \begin_layout Itemize
29547 \change_deleted 564990737 1669742044
29553 [optional] if more than one author:
29554 whom to contact for offprint requests.
29557 \begin_layout Itemize
29559 \change_deleted 564990737 1669742044
29565 [optional] mail address for contacts.
29568 \begin_layout Itemize
29570 \change_deleted 564990737 1669742044
29577 Suggested format is
29584 \begin_layout Standard
29586 \change_deleted 564990737 1669742044
29587 There is no need to issue the
29594 this is done automatically by \SpecialChar LyX
29595 when the header is finished.
29596 Although the order of the single header entries doesn't matter it is advised to keep the above sequence,
29597 just to get the best optics and meets the layout of the real document.
29600 \begin_layout Standard
29602 \change_deleted 564990737 1669742044
29603 If you want to place footnotes in the header block,
29605 \begin_inset space \thinspace{}
29609 \begin_inset space \space{}
29612 to state your present address,
29613 just use the standard footnote via the menu
29615 Insert\SpecialChar menuseparator
29620 will automagically use the term
29629 \begin_layout Standard
29631 \change_deleted 564990737 1669742044
29634 Edit\SpecialChar menuseparator
29638 you'll find two insets which are relevant for the titling:
29641 \begin_layout Itemize
29643 \change_deleted 564990737 1669742044
29650 to mark corresponding author\SpecialChar breakableslash
29652 The institutes are numbered sequentially as they appear in the
29657 so you have to put a marker to each author.
29660 \begin_layout Itemize
29662 \change_deleted 564990737 1669742044
29667 to supply an email address for fast contact.
29670 \begin_layout Standard
29672 \change_deleted 564990737 1669742044
29673 In addition to these topics,
29674 the macros use one additional \SpecialChar LaTeX
29675 command that has no counterpart in \SpecialChar LyX
29679 \begin_layout Itemize
29681 \change_deleted 564990737 1669742044
29688 to separate different names for more than one author and institute,
29692 \begin_layout Standard
29694 \change_deleted 564990737 1669742044
29695 The appropriate command has to be entered in \SpecialChar LyX
29696 and marked as \SpecialChar LaTeX
29702 \begin_layout Standard
29704 \change_deleted 564990737 1669742044
29708 \begin_layout Standard
29710 \change_deleted 564990737 1669742044
29711 The abstract should immediately follow the header block.
29712 With version 5 the abstract environment was changed to a command,
29713 and there is now a restriction to only one paragraph.
29715 it should contain an entry with the keywords.
29716 This is done via the paragraph style
29721 Refer to the example paper.
29724 \begin_layout Standard
29726 \change_deleted 564990737 1669742044
29727 Supported environments
29730 \begin_layout Standard
29732 \change_deleted 564990737 1669742044
29733 The A&A paper layout supports the following environments for structuring your text:
29736 \begin_layout Itemize
29738 \change_deleted 564990737 1669742044
29744 \begin_layout Itemize
29746 \change_deleted 564990737 1669742044
29752 \begin_layout Itemize
29754 \change_deleted 564990737 1669742044
29760 \begin_layout Itemize
29762 \change_deleted 564990737 1669742044
29768 \begin_layout Itemize
29770 \change_deleted 564990737 1669742044
29776 \begin_layout Itemize
29778 \change_deleted 564990737 1669742044
29784 \begin_layout Itemize
29786 \change_deleted 564990737 1669742044
29792 \begin_layout Itemize
29794 \change_deleted 564990737 1669742044
29800 \begin_layout Itemize
29802 \change_deleted 564990737 1669742044
29808 \begin_layout Itemize
29810 \change_deleted 564990737 1669742044
29816 \begin_layout Itemize
29818 \change_deleted 564990737 1669742044
29824 \begin_layout Itemize
29826 \change_deleted 564990737 1669742044
29833 \begin_layout Standard
29835 \change_deleted 564990737 1669742044
29836 Commands not supported by \SpecialChar LyX
29840 \begin_layout Standard
29842 \change_deleted 564990737 1669742044
29843 Some commands are not yet supported by the
29847 layout for \SpecialChar LyX
29849 Some have already been mentioned.
29850 For the sake of completeness,
29851 they are listed all together here:
29854 \begin_layout Itemize
29856 \change_deleted 564990737 1669742044
29864 \begin_layout Itemize
29866 \change_deleted 564990737 1669742044
29874 \begin_layout Itemize
29876 \change_deleted 564990737 1669742044
29884 \begin_layout Itemize
29886 \change_deleted 564990737 1669742044
29894 \begin_layout Standard
29896 \change_deleted 564990737 1669742044
29897 If you want to use any of these commands,
29898 you have to enter them yourself.
29901 Do not forget to mark them as \SpecialChar LaTeX
29905 \begin_layout Standard
29907 \change_deleted 564990737 1669742044
29908 Figure and Table Floats
29911 \begin_layout Standard
29913 \change_deleted 564990737 1669742044
29915 provides support for the necessary float environments
29926 therefore we won't tell much about it here.
29930 \begin_inset space ~
29936 Just remember that tables should be left-aligned.
29938 select the table and change the alignment in
29940 Edit\SpecialChar menuseparator
29942 \begin_inset space ~
29948 \begin_layout Standard
29950 \change_deleted 564990737 1669742044
29951 There is only one special thing:
29952 the figures with caption besides the figure.
29953 To create such a figure,
29954 you have to do the following:
29957 \begin_layout Enumerate
29959 \change_deleted 564990737 1669742044
29960 Create a wide figure float:
29963 Insert\SpecialChar menuseparator
29964 Float\SpecialChar menuseparator
29968 then right click in the figure and select
29971 \begin_inset space ~
29979 \begin_layout Enumerate
29981 \change_deleted 564990737 1669742044
29982 Enter your caption text.
29985 \begin_layout Enumerate
29987 \change_deleted 564990737 1669742044
29992 to move the cursor above the caption.
29995 \begin_layout Enumerate
29997 \change_deleted 564990737 1669742044
30001 \begin_layout Enumerate
30003 \change_deleted 564990737 1669742044
30004 Position the cursor behind the figure and insert a horizontal fill:
30007 Insert\SpecialChar menuseparator
30009 \begin_inset space ~
30012 Character\SpecialChar menuseparator
30014 \begin_inset space ~
30022 \begin_layout Enumerate
30024 \change_deleted 564990737 1669742044
30025 Switch to \SpecialChar LaTeX
30030 \begin_inset space ~
30038 \begin_layout Enumerate
30040 \change_deleted 564990737 1669742044
30050 Do not close the brace!
30053 \begin_layout Enumerate
30055 \change_deleted 564990737 1669742044
30056 Position the cursor behind the caption text,
30057 switch to \SpecialChar LaTeX
30058 mode and insert the closing brace:
30062 \begin_inset space ~
30074 \begin_layout Standard
30076 \change_deleted 564990737 1669742044
30078 refer to the figures in the example paper.
30081 \begin_layout Standard
30083 \change_deleted 564990737 1669742044
30087 \begin_layout Standard
30089 \change_deleted 564990737 1669742044
30091 the paper has to be formated in a special double-spacing layout.
30093 you have to give the option
30097 to the document class.
30098 This must be done using the custom class options field in the
30100 Document\SpecialChar menuseparator
30104 Just enter the string
30111 \begin_layout Standard
30113 \change_deleted 564990737 1669742044
30117 \begin_layout Standard
30119 \change_deleted 564990737 1669742044
30124 directory contains an example paper written with \SpecialChar LyX
30126 It is the example paper from the original macro package,
30127 translated to \SpecialChar LyX
30129 Use it for inspiration,
30130 and compare the original \SpecialChar LaTeX
30131 code with \SpecialChar LyX
30135 \begin_layout Standard
30137 \change_deleted 564990737 1671097429
30141 \begin_layout Standard
30143 \change_deleted 564990737 1671097429
30148 can be used to type letters according to German conventions.
30149 A template file is included in
30151 .../lyx/share/templates
30153 for you to use as a starting point.
30156 \begin_layout Standard
30158 \change_deleted 564990737 1671097429
30162 \begin_layout Standard
30164 \change_deleted 564990737 1671097429
30165 See the \SpecialChar LyX
30171 It contains all infos you need.
30174 \begin_layout Standard
30176 \change_deleted 564990737 1669755802
30180 \begin_layout Standard
30182 \change_deleted 564990737 1669755802
30185 Panayotis Papasotiriou
30188 \begin_layout Standard
30190 \change_deleted 564990737 1669755802
30194 \begin_layout Standard
30196 \change_deleted 564990737 1669755802
30197 The ijmpc package is a set of macros that facilitates electronic manuscript submission to the
30199 International Journal of Modern Physics C
30203 the ijmpd package is for creating manuscripts to be submitted to the
30205 International Journal of Modern Physics D
30208 Both journals are published by World Scientific.
30209 The corresponding document classes are named
30220 together with instructions for the authors,
30221 can be downloaded from the sites
30222 \begin_inset Flex URL
30225 \begin_layout Plain Layout
30227 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
30233 \begin_inset Flex URL
30236 \begin_layout Plain Layout
30238 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
30244 Both packages are modified versions of the standard
30245 \begin_inset Quotes eld
30249 \begin_inset Quotes erd
30253 and they are almost (but not exactly) identical.
30254 Most of their features are supported by \SpecialChar LyX
30256 I have used \SpecialChar LyX
30257 successfully to write articles submitted to both journals without any problem.
30260 \begin_layout Standard
30262 \change_deleted 564990737 1669755802
30266 \begin_layout Standard
30268 \change_deleted 564990737 1669755802
30270 the easiest way to write a paper is to start with a template.
30273 File\SpecialChar menuseparator
30290 This will give an (almost) empty document that includes the most common fields found in a manuscript.
30291 Simply overwrite the existing text (including the brackets,
30297 You should keep in mind the following remarks.
30300 \begin_layout Enumerate
30302 \change_deleted 564990737 1669755802
30304 won't let you change the font size and the page style of the document,
30305 because such modifications are not allowed by both packages.
30308 \begin_layout Enumerate
30310 \change_deleted 564990737 1669755802
30311 The language of the document should not be changed.
30312 Before previewing your paper,
30313 be sure that the babel package is not used.
30318 arg "dialog-show document"
30323 \SpecialChar menuseparator
30328 \begin_inset Quotes eld
30332 \begin_inset Quotes erd
30342 \begin_layout Enumerate
30344 \change_deleted 564990737 1669755802
30346 \begin_inset Quotes eld
30350 \begin_inset Quotes erd
30353 style must be used to define keywords.
30356 \begin_layout Enumerate
30358 \change_deleted 564990737 1669755802
30359 The ijmpc package provides a style named
30360 \begin_inset Quotes eld
30363 Classification Codes
30364 \begin_inset Quotes erd
30368 which can be used to define classification codes,
30369 such as PACS numbers.
30370 Note that this facility is not supported by the ijmpd package.
30373 \begin_layout Enumerate
30375 \change_deleted 564990737 1669755802
30376 Several new environments are available:
30378 \begin_inset Quotes eld
30382 \begin_inset Quotes erd
30387 \begin_inset Quotes eld
30391 \begin_inset Quotes erd
30396 \begin_inset Quotes eld
30400 \begin_inset Quotes erd
30405 \begin_inset Quotes eld
30409 \begin_inset Quotes erd
30414 \begin_inset Quotes eld
30418 \begin_inset Quotes erd
30423 \begin_inset Quotes eld
30427 \begin_inset Quotes erd
30432 \begin_inset Quotes eld
30436 \begin_inset Quotes erd
30441 \begin_inset Quotes eld
30445 \begin_inset Quotes erd
30450 \begin_inset Quotes eld
30454 \begin_inset Quotes erd
30459 \begin_inset Quotes eld
30463 \begin_inset Quotes erd
30468 \begin_inset Quotes eld
30472 \begin_inset Quotes erd
30477 \begin_inset Quotes eld
30481 \begin_inset Quotes erd
30486 \begin_inset Quotes eld
30490 \begin_inset Quotes erd
30495 \begin_inset Quotes eld
30499 \begin_inset Quotes erd
30503 Their use is more or less obvious.
30505 supports all these environments;
30506 it will use the proper label,
30508 and numbering scheme for each of them.
30511 \begin_layout Enumerate
30513 \change_deleted 564990737 1669755802
30514 Both packages use basic citations;
30515 the natbib package should not be used.
30516 In \SpecialChar LyX
30518 citation references are shown as usual;
30520 citations are shown as superscripts.
30521 If you want to use a citation as normal text,
30528 \begin_inset space \thinspace{}
30532 \begin_inset space \space{}
30536 \begin_inset Quotes eld
30540 \begin_inset space \space{}
30550 \begin_inset Quotes erd
30556 \begin_layout Enumerate
30558 \change_deleted 564990737 1669755802
30560 \begin_inset Quotes eld
30564 \begin_inset Quotes erd
30567 section in both packages.
30568 To put acknowledgments,
30570 \begin_inset Quotes eld
30574 \begin_inset Quotes erd
30580 \begin_layout Enumerate
30582 \change_deleted 564990737 1669755802
30583 Appendices may be added to the paper,
30588 the Acknowledgments and
30594 provides a special environment,
30596 \begin_inset Quotes eld
30600 \begin_inset Quotes erd
30603 which marks the beginning of the appendices.
30604 This environment should be left blank;
30605 it just sends a \SpecialChar LaTeX
30607 but nothing is really printed.
30608 In \SpecialChar LyX
30611 \begin_inset Quotes eld
30615 \begin_inset Quotes erd
30618 is printed with blue letters,
30619 as a signal that all sections after that point are appendices.
30620 To write an appendix,
30622 \begin_inset Quotes eld
30626 \begin_inset Quotes erd
30631 will number each appendix with capital letters,
30632 as required by both journals.
30634 \begin_inset Quotes eld
30638 \begin_inset Quotes erd
30645 be present before the first appendix;
30647 all appendices will be numbered as normal sections in the output.
30650 \begin_layout Enumerate
30652 \change_deleted 564990737 1669755802
30653 The ijmpc and the ijmpd packages use the
30657 command to implement table captions.
30659 a table created by \SpecialChar LyX
30660 is printed correctly,
30661 but its caption is ignored.
30663 you can use some \SpecialChar TeX
30664 code to overcome this problem,
30665 so that captions are printed as expected.
30667 create a float table as usual,
30668 remove the caption,
30669 and replace it with the \SpecialChar TeX
30681 you must also the \SpecialChar TeX
30686 immediately after the tabular material.
30687 Study the example table included in the template files to see how this trick is implemented.
30689 If you need table captions,
30690 you should implement the whole table float in a
30695 then include this file to the \SpecialChar LyX
30698 Insert\SpecialChar menuseparator
30699 File\SpecialChar menuseparator
30701 \begin_inset space ~
30707 Details on how to create a table float can be found in the files
30716 included in the corresponding packages.
30719 \begin_layout Standard
30721 \change_deleted 564990737 1669755802
30722 Preparing a paper for submission
30725 \begin_layout Standard
30727 \change_deleted 564990737 1669755802
30728 Before you submit your paper you must export the \SpecialChar LyX
30729 document as a \SpecialChar LaTeX
30732 File\SpecialChar menuseparator
30733 Export\SpecialChar menuseparator
30741 \begin_layout Plain Layout
30742 Actually you have the choice between \SpecialChar LaTeX
30743 (plain) and pdflatex.
30744 If you intend to use pdflatex to prepare the paper,
30745 you should use the pdflatex option so that included graphics are converted to PDF format,
30746 ready for use by pdflatex.
30752 then make the following changes to the resulting
30759 \begin_layout Enumerate
30761 \change_deleted 564990737 1669755802
30762 Remove the comment lines before the
30771 \begin_layout Enumerate
30773 \change_deleted 564990737 1669755802
30774 Remove everything between (and including) the
30787 except for any commands you specifically put into the \SpecialChar LaTeX
30791 \begin_layout Standard
30793 \change_deleted 564990737 1672743015
30798 file should be saved and processed through \SpecialChar LaTeX
30799 as many times as necessary.
30800 You may also want to check the resulting
30807 \begin_layout Standard
30809 \change_deleted 564990737 1669801478
30813 \begin_layout Standard
30815 \change_deleted 564990737 1669801478
30821 \begin_layout Standard
30823 \change_deleted 564990737 1669801478
30827 \begin_layout Standard
30829 \change_deleted 564990737 1669801478
30830 The iopart package provides a document class to create electronic manuscript submission to the journals published by the Institute of Physics.
30831 Instructions for the authors how to create a paper using the iopart class can be downloaded together with the iopart package from the site
30832 \begin_inset Flex URL
30835 \begin_layout Plain Layout
30837 ftp://ftp.iop.org/pub/journals/latex2e
30845 \begin_layout Standard
30847 \change_deleted 564990737 1669801478
30851 \begin_layout Standard
30853 \change_deleted 564990737 1669801478
30854 The easiest way to write a paper is to start with the template
30858 that is available via
30860 File\SpecialChar menuseparator
30863 The template explains how to use the special text environments.
30864 Here are the most important advices:
30867 \begin_layout Itemize
30869 \change_deleted 564990737 1669801478
30870 To be able to compile your document to a PDF,
30873 ensure that the no AMS packages are loaded in
30875 Document\SpecialChar menuseparator
30876 Settings\SpecialChar menuseparator
30882 \begin_layout Itemize
30884 \change_deleted 564990737 1669801478
30887 The title environment defines the kind of your paper.
30888 So use one of the following environments for the title:
30892 \begin_layout Itemize
30894 \change_deleted 564990737 1669801478
30903 \begin_layout Itemize
30905 \change_deleted 564990737 1669801478
30914 \begin_layout Itemize
30916 \change_deleted 564990737 1669801478
30922 for a Topical review
30925 \begin_layout Itemize
30927 \change_deleted 564990737 1669801478
30936 \begin_layout Itemize
30938 \change_deleted 564990737 1669801478
30947 \begin_layout Itemize
30949 \change_deleted 564990737 1669801478
30955 for a Paper (same as Title)
30958 \begin_layout Itemize
30960 \change_deleted 564990737 1669801478
30966 for a Preliminary communication
30969 \begin_layout Itemize
30971 \change_deleted 564990737 1669801478
30977 for a Rapid communication
30980 \begin_layout Itemize
30982 \change_deleted 564990737 1669801478
30988 for a Letter to the editor
30992 \begin_layout Itemize
30994 \change_deleted 564990737 1669801478
30997 All title environments except of
31001 can have an optional short title.
31004 \begin_layout Itemize
31006 \change_deleted 564990737 1669801478
31007 There is a general title environment
31011 which is not directly supported by \SpecialChar LyX
31013 This can be used as \SpecialChar TeX
31014 code when your document doesn't fit into one of the other title types.
31017 \begin_layout Standard
31019 \change_deleted 564990737 1672743015
31020 For more informations like hints for special table and formula formatting,
31021 look at the IOP author guidelines.
31024 \begin_layout Standard
31026 \change_deleted 564990737 1670317155
31030 \begin_layout Standard
31032 \change_deleted 564990737 1670317155
31035 Panayotis Papasotiriou
31038 \begin_layout Standard
31040 \change_deleted 564990737 1670317155
31044 \begin_layout Standard
31046 \change_deleted 564990737 1670317155
31047 The Kluwer package is a set of macros produced by Kluwer Academic Publishers that facilitates electronic manuscript submission to the journals they publish.
31048 Most known of them (at least in my domain of interest) are
31050 Astrophysics and Space Science
31057 but there are many others (see a complete list at
31058 \begin_inset Flex URL
31061 \begin_layout Plain Layout
31063 http://www.wkap.nl/jrnllist.htm/JRNLHOME
31069 The Kluwer package may be downloaded from the site
31070 \begin_inset Flex URL
31073 \begin_layout Plain Layout
31075 http://www.wkap.nl/kaphtml.htm/STYLEFILES
31081 A complete user guide is contained in that package (but it can also be downloaded separately).
31084 \begin_layout Standard
31086 \change_deleted 564990737 1670317155
31088 supports many features of the package but not everything.
31090 the \SpecialChar TeX
31091 code needed is reduced to some
31092 \begin_inset Quotes eld
31096 \begin_inset Quotes erd
31099 commands of the package (see
31100 \begin_inset space ~
31104 \begin_inset CommandInset ref
31106 reference "subsec:kluwer_peculiarities"
31112 I have recently used \SpecialChar LyX
31113 to write an article submitted to the
31115 Astrophysics and Space Science
31117 without any problem.
31120 \begin_layout Standard
31122 \change_deleted 564990737 1670317155
31126 \begin_layout Standard
31128 \change_deleted 564990737 1670317155
31129 The easiest way to write a paper is to start with the Kluwer template file.
31132 File\SpecialChar menuseparator
31145 This will give an (almost) empty document that includes the most common fields found in a manuscript and a short description of their use.
31146 As in most templates,
31147 simply overwrite the existing text (including the brackets,
31152 ) with the correct information.
31155 \begin_layout Standard
31157 \change_deleted 564990737 1670317155
31158 Preparing a paper for submission
31161 \begin_layout Standard
31163 \change_deleted 564990737 1670317155
31164 As in the AAS\SpecialChar TeX
31166 before you submit your paper to a journal you must
31167 \begin_inset Quotes eld
31171 \begin_inset Quotes erd
31177 \begin_layout Enumerate
31179 \change_deleted 564990737 1670317155
31180 Export your paper as a \SpecialChar LaTeX
31185 File\SpecialChar menuseparator
31186 Export\SpecialChar menuseparator
31194 \begin_layout Enumerate
31196 \change_deleted 564990737 1670317155
31201 file with a text editor and make the following changes
31205 \begin_layout Enumerate
31207 \change_deleted 564990737 1670317155
31208 remove the comment lines before the
31217 \begin_layout Enumerate
31219 \change_deleted 564990737 1670317155
31220 remove everything between (and including) the
31233 except for any commands you specifically put into the \SpecialChar LaTeX
31237 \begin_layout Standard
31239 \change_deleted 564990737 1670317155
31248 \begin_layout Enumerate
31250 \change_deleted 564990737 1670317155
31255 file through \SpecialChar LaTeX
31256 as many times as necessary (usually up to three).
31259 \begin_layout Enumerate
31261 \change_deleted 564990737 1670317155
31268 \begin_inset space \thinspace{}
31272 \begin_inset space \space{}
31280 and check if everything is OK (it should,
31281 if you didn't make any mistake).
31284 \begin_layout Standard
31286 \change_deleted 564990737 1670317155
31287 \begin_inset Quotes eld
31291 \begin_inset Quotes erd
31294 of the Kluwer package
31295 \begin_inset CommandInset label
31297 name "subsec:kluwer_peculiarities"
31304 \begin_layout Standard
31306 \change_deleted 564990737 1670317155
31307 The Kluwer package has the following
31308 \begin_inset Quotes eld
31312 \begin_inset Quotes erd
31318 \begin_layout Enumerate
31320 \change_deleted 564990737 1670317155
31321 It is possible to write multiple articles in the same \SpecialChar LaTeX
31326 \begin_layout Plain Layout
31327 I can't imagine any good reason to do this.
31333 Each article must be included in the environment
31334 \begin_inset Quotes eld
31338 \begin_inset Quotes erd
31343 this environment cannot be omitted,
31344 even if you write just one article.
31346 each article starts with the command
31354 ends with the command
31361 Although this can be implemented in \SpecialChar LyX
31363 I didn't included it,
31364 since it looks ugly and can confuse the novice user.
31366 you need to enter them directly and mark them as \SpecialChar LaTeX
31367 code (the well-known
31368 \begin_inset Quotes eld
31373 \begin_inset Quotes erd
31379 \begin_layout Enumerate
31381 \change_deleted 564990737 1670317155
31382 Information given at the beginning of the article (i.
31383 \begin_inset space \thinspace{}
31387 \begin_inset space \space{}
31396 abstract and keywords) must be included in an environment called
31397 \begin_inset Quotes eld
31401 \begin_inset Quotes erd
31405 This is not implemented in \SpecialChar LyX
31407 so you must enter title,
31409 \begin_inset space ~
31412 between two \SpecialChar TeX
31428 \begin_layout Enumerate
31430 \change_deleted 564990737 1670317155
31431 According to the user manual,
31432 the label of each bibliography item must be written as
31455 \begin_layout Standard
31457 \change_deleted 564990737 1670317155
31462 template takes care of all these
31463 \begin_inset Quotes eld
31467 \begin_inset Quotes erd
31471 If you start a new paper using this template you don't need to do anything special.
31475 \begin_layout Enumerate
31477 \change_deleted 564990737 1670317155
31478 don't delete the \SpecialChar TeX
31479 code included in the template,
31483 \begin_layout Enumerate
31485 \change_deleted 564990737 1670317155
31486 copy the example bibliography item included in the template and modify it as necessary to enter new bibliography items.
31489 \begin_layout Standard
31491 \change_deleted 564990737 1671097446
31495 \begin_layout Standard
31497 \change_deleted 564990737 1671097446
31502 provides an alternative to the standard
31507 It provides similar functionality,
31508 but you might prefer this layout with sans serif sections,
31513 \begin_layout Standard
31515 \change_deleted 564990737 1671097446
31516 Springer Journals (
31523 \begin_layout Standard
31525 \change_deleted 564990737 1671097446
31531 \begin_layout Standard
31533 \change_deleted 564990737 1671097446
31537 \begin_layout Standard
31539 \change_deleted 564990737 1671097446
31540 These are the layout files for some of the journal formats used by Springer Verlag and listed on
31541 \begin_inset Flex URL
31544 \begin_layout Plain Layout
31546 http://www.springer.de/author/tex/help-journals.html
31552 where you should also go to fetch the class files (yes,
31553 these are \SpecialChar LaTeX2e
31555 It is a modular system:
31556 the things common to all journals are implemented in
31561 which journal-specific layout files (such as,
31563 \begin_inset space \thinspace{}
31567 \begin_inset space \space{}
31574 for Journal of Geodesy) can include.
31577 \begin_layout Standard
31579 \change_deleted 564990737 1671097446
31580 This means that implementing support for any other Springer journal on this list is as simple as writing your own
31588 file following the outline given in
31596 \begin_layout Standard
31598 \change_deleted 564990737 1671097446
31599 It is reasonably well tested only for the Journal of Geodesy.
31608 come with the standard \SpecialChar LyX
31610 Install the relevant class file (downloaded from Springer) in a proper directory,
31611 reconfigure \SpecialChar LaTeX
31612 (in the te\SpecialChar TeX
31618 as root if necessary —
31619 doesn't \SpecialChar LyX
31620 take care of this?),
31621 reconfigure \SpecialChar LyX
31622 and it should work.
31625 \begin_layout Standard
31627 \change_deleted 564990737 1671097446
31631 \begin_layout Standard
31633 \change_deleted 564990737 1671097446
31634 A large number of theorem-like styles —
31649 \begin_layout Standard
31651 \change_deleted 564990737 1671097446
31657 Running_\SpecialChar LaTeX
31668 See the Springer class file documentation for details.
31671 \begin_layout Standard
31673 \change_deleted 564990737 1671097446
31677 \begin_layout Itemize
31679 \change_deleted 564990737 1671097446
31693 \begin_layout Itemize
31695 \change_deleted 564990737 1671097446
31698 Probability Theory and Related Fields
31706 Jean-Marc Lasgouttes
31709 \begin_layout Standard
31711 \change_deleted 564990737 1671097446
31716 \begin_layout Standard
31718 \change_deleted 564990737 1671097446
31722 \begin_layout Standard
31724 \change_deleted 564990737 1671097446
31725 These files are partly based on the older
31730 which was again based on a tinkered-with version of an old \SpecialChar LaTeX
31731 2.09 style file from Springer.
31739 Jean-Marc Lasgouttes helped out big in making me find my way around the \SpecialChar LyX
31740 layout file mechanism.
31743 \begin_layout Standard
31745 \change_deleted 564990737 1671097446
31749 \begin_layout Standard
31751 \change_deleted 564990737 1671097446
31753 But probably less than in the old hacked-\SpecialChar LaTeX
31761 \begin_layout Chapter
31763 Features needing Extra Software
31766 \begin_layout Section
31767 Checking \SpecialChar TeX
31771 \begin_layout Standard
31777 \begin_layout Subsection
31781 \begin_layout Standard
31790 \begin_layout Plain Layout
31795 is not yet available when you are using the \SpecialChar LaTeX
31796 distribution MiK\SpecialChar TeX
31811 \begin_inset space ~
31822 \begin_inset Newline newline
31826 \begin_inset CommandInset href
31828 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
31836 \begin_layout Standard
31839 Chk\SpecialChar TeX
31842 package is a program that was written by
31843 \begin_inset Flex Noun
31846 \begin_layout Plain Layout
31848 \begin_inset space ~
31856 in frustration because some constructs in \SpecialChar LaTeX
31857 are sometimes non-intuitive,
31858 and easy to forget.
31859 The program runs over your \SpecialChar LaTeX
31861 checks the integrity of the file,
31862 and flags some common errors.
31863 In other technical words,
31868 for \SpecialChar LaTeX
31872 \begin_layout Standard
31874 what is a syntax checker doing in \SpecialChar LyX
31875 which is supposed to produce correct \SpecialChar LaTeX
31877 The answer is simple:
31882 not only checks the
31891 checks for type-errors,
31894 Chk\SpecialChar TeX
31897 catches some common
31902 in addition to the syntactical ones.
31906 Chk\SpecialChar TeX
31909 is capable of detecting several common errors,
31913 \begin_layout Itemize
31914 Ellipsis detection:
31915 \begin_inset Newline newline
31918 Use \SpecialChar ldots
31922 \begin_layout Itemize
31923 No space in front of/after parenthesis:
31924 \begin_inset Newline newline
31930 \begin_layout Itemize
31931 Enforcement of normal space after common abbreviations:
31932 \begin_inset Newline newline
31936 \begin_inset space \thinspace{}
31940 \begin_inset space \space{}
31943 is too wide spacing.
31946 \begin_layout Itemize
31947 Enforcement of end-of-sentence space when the last sentence ends with a capital letter:
31948 \begin_inset Newline newline
31952 And this is wrong spacing.
31955 \begin_layout Itemize
31956 Space in front of labels and similar commands:
31957 \begin_inset Newline newline
31960 The label should stick right up to the text to avoid falling to a wrong page.
31962 \begin_inset CommandInset label
31972 \begin_layout Plain Layout
31973 This footnote is in danger of falling off to a wrong page
31978 The label is separated too much.
31981 \begin_layout Itemize
31982 Space in front of references,
31983 instead of hard spaces:
31984 \begin_inset Newline newline
31987 If you have bad luck,
31988 the text will break right between the referenced text and reference number,
31991 \begin_inset CommandInset ref
31993 reference "sec:chktex"
32001 \begin_layout Itemize
32003 \begin_inset Quotes eld
32007 \begin_inset Quotes erd
32011 \begin_inset Formula $\times$
32015 \begin_inset Newline newline
32018 2x2 looks cheap compared to
32019 \begin_inset Formula $2\times2$
32025 \begin_layout Standard
32026 and more \SpecialChar ldots
32027 It is an invaluable tool when you are
32028 \begin_inset Quotes eld
32032 \begin_inset Quotes erd
32035 your document before printing,
32036 and you should run it right after the obligatory spelling check,
32037 and before you go fine tuning the typesetting.
32040 \begin_layout Subsection
32044 \begin_layout Standard
32045 If you have the program installed,
32046 usage is as simple as choosing
32048 Tools\SpecialChar menuseparator
32050 \begin_inset space ~
32056 This will make \SpecialChar LyX
32057 generate a \SpecialChar LaTeX
32058 file of your document,
32061 Chk\SpecialChar TeX
32065 and then make \SpecialChar LyX
32067 \begin_inset Quotes eld
32071 \begin_inset Quotes erd
32074 with the warnings from
32076 Chk\SpecialChar TeX
32081 The warnings will be placed close to the point of the mistake,
32082 and you can quickly find them by using the
32084 Navigate\SpecialChar menuseparator
32088 or the shortcut key
32097 Open the error boxes by clicking on them with the mouse,
32098 or use the shortcut key
32107 or the corresponding
32116 Read the warning and correct the mistake,
32117 if it is a mistake.
32118 If you have trouble understanding what the warning is about,
32119 you can safely ignore it.
32120 Remember that there is a hidden layer between the document on screen and the technical details in invoking
32122 Chk\SpecialChar TeX
32126 and this gap can make some warnings seem arcane or just plain silly.
32129 \begin_layout Standard
32130 This document is an excellent testing bed for the feature,
32131 and it should provide quite a few warnings for you to fiddle with.
32132 Since computers are only so smart,
32133 expect most of the warnings to be false alarms,
32137 \begin_layout Subsection
32138 How to fine tune it
32141 \begin_layout Standard
32145 Chk\SpecialChar TeX
32148 makes more noise than suits your mood.
32149 Then you can choose not to use it,
32150 wait until your mood changes,
32151 or try to customize
32153 Chk\SpecialChar TeX
32156 to get better along with you.
32159 \begin_layout Standard
32162 Chk\SpecialChar TeX
32169 very configurable and extensible,
32170 you should not expect to solve all problems with
32172 Chk\SpecialChar TeX
32175 in \SpecialChar LyX
32177 Since \SpecialChar LyX
32178 has to generate a somewhat special \SpecialChar LaTeX
32179 file to be able to match the line numbers from the
32181 Chk\SpecialChar TeX
32188 \begin_layout Plain Layout
32189 You can inspect the specific output from
32195 Document\SpecialChar menuseparator
32198 \begin_inset space ~
32212 to the internal document structure,
32213 some of the warnings will not appear correctly.
32214 There are two things you can do about this:
32217 \begin_layout Itemize
32220 Chk\SpecialChar TeX
32223 invocation command line in
32224 \begin_inset Flex Noun
32227 \begin_layout Plain Layout
32228 Tools\SpecialChar menuseparator
32229 Preferences\SpecialChar menuseparator
32230 Output\SpecialChar menuseparator
32231 LaTeX\SpecialChar menuseparator
32240 Chk\SpecialChar TeX
32243 installation configuration file (usually with the file
32248 See below to learn what warnings can be enabled and disabled on the command line.
32251 \begin_layout Itemize
32252 Export your document as a raw \SpecialChar LaTeX
32255 File\SpecialChar menuseparator
32256 Export\SpecialChar menuseparator
32265 Invoked in this way,
32266 it can be a hassle to find the corresponding place in the document inside \SpecialChar LyX
32268 but with a little patience,
32269 you should be able to do it.
32272 \begin_layout Standard
32273 Here follows the warning messages that can be enabled and disabled in
32282 to disable a warning,
32287 to enable a warning.
32288 The emphasized entries are disabled by default,
32289 because the default is "
32291 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
32296 \begin_layout Standard
32297 Notice that you should only use the options that enable and disable warnings,
32298 because \SpecialChar LyX
32299 relies on some of the other command line parameters to be set in a specific way to have a chance to communicate with
32306 \begin_layout Enumerate
32310 Command terminated with space.
32313 \begin_layout Enumerate
32316 Non-breaking space (
32317 \begin_inset Quotes eld
32325 \begin_inset Quotes erd
32328 ) should have been used.
32331 \begin_layout Enumerate
32335 You should enclose the previous parenthesis with
32336 \begin_inset Quotes eld
32344 \begin_inset Quotes erd
32350 \begin_layout Enumerate
32353 Italic correction (
32354 \begin_inset Quotes eld
32364 \begin_inset Quotes erd
32367 ) found in non-italic buffer.
32370 \begin_layout Enumerate
32373 Italic correction (
32374 \begin_inset Quotes eld
32384 \begin_inset Quotes erd
32387 ) found more than once.
32390 \begin_layout Enumerate
32394 No italic correction (
32395 \begin_inset Quotes eld
32405 \begin_inset Quotes erd
32411 \begin_layout Enumerate
32415 \begin_inset Quotes eld
32423 \begin_inset Quotes erd
32427 \begin_inset Quotes eld
32435 \begin_inset Quotes erd
32441 \begin_layout Enumerate
32444 Wrong length of dash may have been used.
32447 \begin_layout Enumerate
32451 \begin_inset Quotes eld
32459 \begin_inset Quotes erd
32464 \begin_inset Quotes eld
32472 \begin_inset Quotes erd
32478 \begin_layout Enumerate
32482 \begin_inset Quotes eld
32490 \begin_inset Quotes erd
32496 \begin_layout Enumerate
32500 \begin_inset Quotes eld
32508 \begin_inset Quotes erd
32511 to achieve an ellipsis.
32514 \begin_layout Enumerate
32517 Inter-word spacing (
32518 \begin_inset Quotes eld
32528 \begin_inset Quotes eld
32531 ) should perhaps be used.
32534 \begin_layout Enumerate
32537 Inter-sentence spacing (
32538 \begin_inset Quotes eld
32548 \begin_inset Quotes erd
32551 ) should perhaps be used.
32554 \begin_layout Enumerate
32557 Could not find argument for command.
32560 \begin_layout Enumerate
32564 \begin_inset Quotes eld
32572 \begin_inset Quotes erd
32578 \begin_layout Enumerate
32581 Math mode still on at end of \SpecialChar LaTeX
32585 \begin_layout Enumerate
32589 \begin_inset Quotes eld
32597 \begin_inset Quotes erd
32600 doesn't match the number of
32601 \begin_inset Quotes eld
32609 \begin_inset Quotes erd
32615 \begin_layout Enumerate
32618 You should use either
32621 \begin_inset Quotes eld
32629 \begin_inset Quotes erd
32634 as an alternative to
32635 \begin_inset Quotes eld
32643 \begin_inset Quotes erd
32649 \begin_layout Enumerate
32656 " (ASCII 39) instead of "
32663 \begin_layout Enumerate
32666 User-specified pattern found.
32669 \begin_layout Enumerate
32672 This command might not be intended.
32675 \begin_layout Enumerate
32682 \begin_layout Enumerate
32700 \begin_layout Enumerate
32703 Delete this space to maintain correct page references.
32706 \begin_layout Enumerate
32710 You might wish to put this between a pair of
32711 \begin_inset Quotes eld
32719 \begin_inset Quotes erd
32725 \begin_layout Enumerate
32728 You ought to remove spaces in front of punctuation.
32731 \begin_layout Enumerate
32734 Could not execute \SpecialChar LaTeX
32738 \begin_layout Enumerate
32747 in front of small punctuation.
32750 \begin_layout Enumerate
32758 may look prettier here.
32761 \begin_layout Enumerate
32765 Multiple spaces detected in output.
32768 \begin_layout Enumerate
32771 This text may be ignored.
32774 \begin_layout Enumerate
32780 \begin_inset Quotes eld
32785 to begin quotation,
32793 \begin_layout Enumerate
32804 \begin_inset Quotes eld
32812 \begin_layout Enumerate
32818 \begin_layout Enumerate
32821 You should perhaps use
32822 \begin_inset Quotes eld
32830 \begin_inset Quotes erd
32836 \begin_layout Enumerate
32839 You should put a space in front of/after parenthesis.
32842 \begin_layout Enumerate
32845 You should avoid spaces in front of/after parenthesis.
32848 \begin_layout Enumerate
32852 You should not use punctuation in front of/after quotes.
32855 \begin_layout Enumerate
32858 Double space found.
32861 \begin_layout Enumerate
32864 You should put punctuation outside inner/inside display math mode.
32867 \begin_layout Enumerate
32870 You ought to not use primitive \SpecialChar TeX
32871 in \SpecialChar LaTeX
32875 \begin_layout Enumerate
32878 You should remove spaces in front of
32879 \begin_inset Quotes eld
32887 \begin_inset Quotes erd
32893 \begin_layout Enumerate
32896 \begin_inset Quotes eld
32904 \begin_inset Quotes erd
32907 is normally not followed by
32908 \begin_inset Quotes eld
32916 \begin_inset Quotes erd
32922 \begin_layout Standard
32923 In later versions of \SpecialChar LyX
32925 we hope to provide a more complete interface to this tool (and it's smaller cousin
32929 ) to exploit the full power of it.
32930 But it's not exactly useless as it is now:
32931 go try it on one of your existing documents of a certain length and be surprised.
32934 \begin_layout Section
32935 Version Control in \SpecialChar LyX
32939 \begin_layout Standard
32942 Lars Gullik Bjønnes
32949 \begin_layout Subsection
32953 \begin_layout Standard
32955 supports some of the most basic RCS/CVS/SVN/GIT commands.
32956 If you need something a bit more sophisticated you will have to do that manually in a terminal.
32959 \begin_layout Standard
32960 Also note that CVS support is not as good as subversion support,
32961 so we advise using SVN instead.
32962 A good place to start learning Subversion is the SVN Book
32966 \begin_layout Plain Layout
32967 \begin_inset CommandInset href
32969 target "http://svnbook.red-bean.com/"
32980 In the case of RCS you should read
32981 \begin_inset Quotes eld
32985 \begin_inset Quotes erd
32994 This file describes all the basic features of RCS.
32995 You should especially notice the comment about a RCS directory,
32996 and the notion of a master RCS file (the file ending in
33003 \begin_layout Standard
33004 Before you begin to use the version control features in \SpecialChar LyX
33006 you should be familiar with RCS/CVS/SVN/GIT usage.
33007 The implementation in \SpecialChar LyX
33008 assumes a recent version of the GNU RCS or CVS/SVN package —
33009 no guarantees are made for older versions.
33010 Most of the log messages are not currently displayed after operations —
33011 you can check them in the Messages pane if you are unsure.
33012 Regular users of version control will appreciate the VC toolbar,
33013 which can be enabled via
33015 View\SpecialChar menuseparator
33016 Toolbars\SpecialChar menuseparator
33018 \begin_inset space ~
33026 \begin_layout Standard
33027 For introducing your own external commands consult
33028 \begin_inset Flex Code
33031 \begin_layout Plain Layout
33045 \begin_layout Standard
33046 It is strongly recommended to store documents in uncompressed format if using version control (uncheck
33048 Document\SpecialChar menuseparator
33052 Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
33053 Compressed LyX documents are binary files,
33054 which cannot be merged by version control systems.
33057 \begin_layout Subsection
33058 RCS commands in \SpecialChar LyX
33062 \begin_layout Standard
33063 The following sections describe the RCS commands supported by \SpecialChar LyX
33065 You can find them in the
33067 File\SpecialChar menuseparator
33069 \begin_inset space ~
33076 was tested against RCS 5.7/5.8.
33079 \begin_layout Subsubsection
33085 \begin_layout Standard
33086 If your document is not under revision control,
33087 this is the only item shown in the menu.
33088 And if it is under revision control,
33093 item is not visible.
33097 \begin_layout Standard
33098 This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
33099 You are asked interactively to supply an initial description of the document.
33100 The document is now set in Read-Only mode and you have to
33103 \begin_inset space ~
33107 \begin_inset space ~
33111 \begin_inset space ~
33117 before making any changes to it.
33118 A document under revision control has a
33119 \begin_inset Quotes eld
33122 [RCS:<version> <locker>]
33123 \begin_inset Quotes erd
33126 item tagged to the filename in the minibuffer.
33129 \begin_layout Standard
33130 RCS command that is run:
33133 \begin_layout LyX-Code
33136 ci -q -u -i -t-"<initial description>" <file-name>
33139 \begin_layout Standard
33144 to understand the switches.
33148 \begin_layout Subsubsection
33154 \begin_layout Standard
33155 When you are finished editing a file,
33156 you check in your changes.
33158 you are asked for a description of the changes.
33159 This is stored in the history log.
33160 The version number is bumped,
33161 your changes are applied to the master RCS file,
33162 the document is unlocked and set to Read-Only mode.
33165 \begin_layout Itemize
33169 ci -q -u -m"<description>" <file-name>
33172 \begin_layout Subsubsection
33178 \begin_layout Standard
33179 By doing this you lock the document so that only you can edit it.
33180 This will also make the document Read-Write only for you.
33181 You will usually continue editing for a while and when you are finished you check in your changes.
33182 The status line is changed to reflect that you have locked the file.
33185 \begin_layout Itemize
33189 co -q -l <file-name>
33192 \begin_layout Subsubsection
33195 Revert To Repository Version
33198 \begin_layout Standard
33199 This will discard all changes made to the document since the last check in.
33200 You get a warning before changes are discarded.
33203 \begin_layout Itemize
33207 co -f -u<version> <file-name>
33210 \begin_layout Subsubsection
33216 \begin_layout Standard
33217 This will create a copy of the current document.
33218 Since RCS does not support copy operations natively,
33219 the version history is not preserved,
33220 and the copy is added as a new file.
33221 It requires a clean document without any changes since the last checkin.
33222 You are asked for a file name and a description of the copy operation.
33223 After that the copy is created,
33224 both locally and in the repository.
33225 If the parent directories of the copied and original document differ,
33226 all relative paths of included files of the copy are adjusted (like in
33228 File\SpecialChar menuseparator
33234 the copy is loaded instead of the original document.
33237 \begin_layout Labeling
33238 \labelwidthstring 00.00.0000
33240 \begin_inset space ~
33245 \begin_inset space ~
33249 \begin_inset Newline newline
33253 \begin_inset Flex Code
33256 \begin_layout Plain Layout
33259 \begin_inset Quotes qld
33263 \begin_inset Quotes qld
33272 \begin_inset Flex Code
33275 \begin_layout Plain Layout
33278 \begin_inset Quotes qld
33282 \begin_inset Quotes qld
33291 \begin_inset Newline newline
33295 \begin_inset Flex Code
33298 \begin_layout Plain Layout
33302 \begin_inset Quotes qld
33306 \begin_inset Quotes qld
33317 \begin_layout Subsubsection
33323 \begin_layout Standard
33324 This makes as if the last check in never happened.
33325 No changes are made to the document loaded into \SpecialChar LyX
33327 but the last version is removed from the master RCS file.
33330 \begin_layout Itemize
33334 rcs -o<version> <file-name>
33337 \begin_layout Subsubsection
33343 \begin_layout Standard
33344 This shows the complete history of the RCS document.
33349 is shown in a browser.
33357 \begin_layout Subsubsection
33361 \begin_layout Standard
33363 supports RCS version number,
33365 date and time of last commit.
33366 All those are extracted from
33368 rlog -r <file-name>
33372 \begin_inset CommandInset ref
33374 reference "subsec:VCS-Revision-Information"
33382 \begin_layout Subsection
33383 CVS commands in \SpecialChar LyX
33387 \begin_layout Standard
33388 A subset of CVS operations is supported by \SpecialChar LyX
33390 You can find the commands in the
33392 File\SpecialChar menuseparator
33394 \begin_inset space ~
33400 The version control system SVN is more powerful,
33401 so please use it instead of CVS if possible.
33404 \begin_layout Subsubsection
33410 \begin_layout Standard
33411 If you start from scratch with CVS you have to create your repository and checkout the working copy with external tools.
33412 If you're using a client-server setup you may need to login before doing the first repository checkout.
33415 \begin_layout Standard
33416 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.
33417 Standard CVS repositories don't operate with a file locking mechanism.
33418 This may be surprising,
33419 but conflicts only occur if people disagree on the proper content of the same part of a document.
33421 if co-workers are used to communicate regularly,
33422 these conflicts occur rarely.
33423 If they don't communicate they have a fundamental problem anyway.
33424 Nevertheless some people like to work with so called
33425 \begin_inset Quotes eld
33429 \begin_inset Quotes erd
33433 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.
33434 When the changes are checked in the working copy returns to readonly state.
33435 With \SpecialChar LyX
33436 one has to edit the
33437 \begin_inset Flex Code
33440 \begin_layout Plain Layout
33446 file and add the line
33447 \begin_inset Flex Code
33450 \begin_layout Plain Layout
33456 to work with reserved checkouts.
33457 The benefit is the possibility to see who is using a writable copy of some document.
33458 It's not guaranteed only one user makes a copy writable.
33461 \begin_layout Standard
33463 tries to guess if you're using reserved or non-reserved checkouts.
33464 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.
33465 When a reserved checkout is detected you have to use
33466 \begin_inset Flex Noun
33469 \begin_layout Plain Layout
33475 to make your working copy writable if it's readonly.
33477 \begin_inset Flex Noun
33480 \begin_layout Plain Layout
33486 operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
33489 \begin_layout Standard
33490 More information about CVS can be found here
33491 \begin_inset Flex URL
33494 \begin_layout Plain Layout
33496 http://www.nongnu.org/cvs
33502 \begin_inset Flex URL
33505 \begin_layout Plain Layout
33507 http://ximbiot.com/cvs
33515 \begin_layout Standard
33520 to understand the sub-commands and the switches mentioned below.
33523 \begin_layout Subsubsection
33529 \begin_layout Standard
33530 If your document is not under revision control,
33531 this is the only item shown in the menu.
33532 And if it is under revision control,
33537 item is not visible.
33541 \begin_layout Standard
33542 This command registers in CVS your document
33543 \begin_inset Flex Strong
33546 \begin_layout Plain Layout
33554 in the case you have already the documents directory under CVS control (in particular
33559 This means you have to create or checkout the archive by yourself using external tools.
33560 (In case you forget that step \SpecialChar LyX
33561 registers the document with RCS.)
33564 \begin_layout Standard
33565 Then you are asked interactively to supply an initial description of the document.
33566 Don't forget that registered file is not yet checked in.
33569 \begin_layout Standard
33570 CVS command that is run:
33573 cvs -q add -m"<entered message>" "<file-name>"
33576 \begin_layout Standard
33581 above and for all other CVS commands is an abbreviation for
33582 \begin_inset Quotes eld
33585 change the current working directory to file location and use the file name without path component as argument
33586 \begin_inset Quotes erd
33592 \begin_layout Subsubsection
33598 \begin_layout Standard
33599 When you are finished editing a file,
33600 you commit your changes.
33601 When you do this and you had changed the document,
33602 you are asked for a description of the changes.
33603 After that changes are written to the repository.
33604 In case you didn't change the document and a reserved checkout is detected the reservation made on
33605 \begin_inset Flex Noun
33608 \begin_layout Plain Layout
33617 \begin_layout Labeling
33618 \labelwidthstring 00.00.0000
33620 \begin_inset space ~
33625 \begin_inset space ~
33629 \begin_inset Newline newline
33633 \begin_inset Flex Code
33636 \begin_layout Plain Layout
33639 -q commit -m"<description>" "<file-name>"
33645 \begin_inset Newline newline
33649 \begin_inset Flex Code
33652 \begin_layout Plain Layout
33663 \begin_layout Subsubsection
33669 \begin_layout Standard
33670 When you are sharing a repository with others,
33671 you may have to incorporate their changes into your working copy.
33674 \begin_layout Standard
33678 cvs -q update "<file-name>"
33681 \begin_layout Standard
33682 If a readonly checkout is detected the working copy is made writable and reserved.
33685 \begin_layout Standard
33689 cvs -q edit "<file-name>"
33692 \begin_layout Subsubsection
33695 Revert To Repository Version
33698 \begin_layout Standard
33699 This will discard all changes made to the document since the last check in.
33700 You get a warning before changes are discarded.
33701 Firstly the file is deleted,
33702 secondly CVS update command is run.
33705 \begin_layout Standard
33709 cvs -q update "<file-name>"
33712 \begin_layout Standard
33713 If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
33716 \begin_layout Standard
33720 cvs -q unedit "<file-name>"
33723 \begin_layout Subsubsection
33729 \begin_layout Standard
33730 This will create a copy of the current document.
33731 Since CVS does not support copy operations natively,
33732 the version history is not preserved,
33733 and the copy is added as a new file.
33734 It requires a clean document without any changes since the last checkin.
33735 You are asked for a file name and a description of the copy operation.
33736 After that the copy is created,
33737 both locally and in the repository.
33738 If the parent directories of the copied and original document differ,
33739 all relative paths of included files of the copy are adjusted (like in
33741 File\SpecialChar menuseparator
33747 the copy is loaded instead of the original document.
33750 \begin_layout Labeling
33751 \labelwidthstring 00.00.0000
33753 \begin_inset space ~
33758 \begin_inset space ~
33762 \begin_inset Newline newline
33766 \begin_inset Flex Code
33769 \begin_layout Plain Layout
33776 \begin_inset Flex Code
33779 \begin_layout Plain Layout
33786 \begin_inset Newline newline
33790 \begin_inset Flex Code
33793 \begin_layout Plain Layout
33794 cvs -q add "<new-file-name>"
33802 \begin_layout Subsubsection
33808 \begin_layout Standard
33809 This will rename the current document.
33810 Since CVS does not support rename operations natively,
33811 the version history is not preserved,
33812 the renamed document is added as a new file,
33813 and the original document is deleted.
33814 It requires a clean document without any changes since the last checkin.
33815 You are asked for a file name and a description of the rename operation.
33816 After that the document is renamed,
33817 both locally and in the repository.
33818 If the parent directories of the new and old file names differ,
33819 all relative paths of included files are adjusted (like in
33821 File\SpecialChar menuseparator
33827 the document is reloaded using the new name.
33830 \begin_layout Labeling
33831 \labelwidthstring 00.00.0000
33833 \begin_inset space ~
33838 \begin_inset space ~
33842 \begin_inset Newline newline
33846 \begin_inset Flex Code
33849 \begin_layout Plain Layout
33856 \begin_inset Flex Code
33859 \begin_layout Plain Layout
33866 \begin_inset Newline newline
33870 \begin_inset Flex Code
33873 \begin_layout Plain Layout
33874 cvs -q add "<new-file-name>"
33880 \begin_inset Newline newline
33884 \begin_inset Flex Code
33887 \begin_layout Plain Layout
33888 cvs -q remove "<file-name>"
33896 \begin_layout Subsubsection
33897 Update of the local directory checkout from repository
33900 \begin_layout Standard
33901 Once your documents gets more complex,
33902 containing sub-documents and pictures,
33904 \begin_inset Flex Code
33907 \begin_layout Plain Layout
33913 files and so on using version control becomes more complicated.
33915 supports updating the whole tree in which resides the document.
33916 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.
33917 You have to organize the files structure so that all external files are in the same directory or subdirectories of the document.
33918 It's good practice anyway to store multipart documents in an extra directory.
33921 \begin_layout Standard
33923 \begin_inset Flex Code
33926 \begin_layout Plain Layout
33927 Update local directory from repository
33932 command updates the whole directory.
33933 If local changes are detected user is warned before update starts.
33934 In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
33935 You have to review and correct the result of the merge.
33936 You'll find the conflicts enclosed in pairs of
33937 \begin_inset Flex Code
33940 \begin_layout Plain Layout
33947 \begin_inset Flex Code
33950 \begin_layout Plain Layout
33957 \begin_inset Flex Code
33960 \begin_layout Plain Layout
33967 The first part is your version as before the update operation with the document name prepended.
33968 The second one is the repository version with the version number after the sequence of
33969 \begin_inset Flex Code
33972 \begin_layout Plain Layout
33981 \begin_layout Labeling
33982 \labelwidthstring 00.00.0000
33984 \begin_inset space ~
33989 \begin_inset space ~
33993 \begin_inset Newline newline
33997 \begin_inset Flex Code
34000 \begin_layout Plain Layout
34009 (Ask if changes are detected.)
34010 \begin_inset Newline newline
34014 \begin_inset Flex Code
34017 \begin_layout Plain Layout
34029 \begin_layout Standard
34031 \begin_inset Flex Code
34034 \begin_layout Plain Layout
34040 stands for the path to the document.
34043 \begin_layout Subsubsection
34049 \begin_layout Standard
34050 This shows the complete history of the CVS document.
34053 cvs log "<file-name>"
34055 is shown in a browser.
34058 \begin_layout Subsubsection
34062 \begin_layout Standard
34064 supports CVS version number,
34066 date and time of last commit.
34067 All those are extracted from
34069 cvs log -r <file-name>
34073 \begin_inset CommandInset ref
34075 reference "subsec:VCS-Revision-Information"
34083 \begin_layout Subsection
34084 SVN commands in \SpecialChar LyX
34088 \begin_layout Standard
34089 SVN is now partially supported by \SpecialChar LyX
34091 You can find the commands in the
34093 File\SpecialChar menuseparator
34095 \begin_inset space ~
34101 Please note that if you use password protected access to repository via ssh,
34102 you will be asked in terminal window.
34104 was tested against SVN 1.5,
34110 \begin_layout Plain Layout
34111 Most of the commands will work with 1.4 too,
34113 \begin_inset CommandInset ref
34115 reference "subsec:SVN-Repo-Update"
34121 There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
34129 \begin_layout Subsubsection
34135 \begin_layout Standard
34136 If your document is not under revision control,
34137 this is the only item shown in the menu.
34138 And if it is under revision control,
34143 item is not visible.
34146 \begin_layout Standard
34147 This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
34152 This means you have to checkout the archive by yourself.
34155 \begin_layout Standard
34156 Then you are asked interactively to supply an initial description of the document.
34157 Don't forget that registered file is not yet commited.
34160 \begin_layout Standard
34161 SVN command that is run:
34165 \begin_inset Quotes qld
34169 \begin_inset Quotes qld
34175 \begin_layout Standard
34180 to understand the switches.
34183 \begin_layout Subsubsection
34189 \begin_layout Standard
34190 When you are finished editing a file,
34191 you commit your changes.
34193 you are asked for a description of the changes.
34194 After that changes are commited.
34197 \begin_layout Standard
34202 \begin_layout Plain Layout
34203 In case locking is not enabled.
34205 \begin_inset CommandInset ref
34207 reference "subsec:SVN-File-Locking"
34219 svn commit -q -m"<description>" <file-name>
34222 \begin_layout Subsubsection
34228 \begin_layout Standard
34229 Updates the changes of this file from the repository.
34230 Be sure you understand SVN merging and conflicts resolving before using this function,
34231 because all conflicts has to be resolved manually by you!
34234 \begin_layout Standard
34239 \begin_layout Plain Layout
34247 svn update --non-interactive
34248 \begin_inset Quotes qld
34252 \begin_inset Quotes qld
34258 \begin_layout Subsubsection
34261 Revert To Repository Version
34264 \begin_layout Standard
34265 This will discard all changes made to the document since the last check in.
34266 You get a warning before changes are discarded.
34269 \begin_layout Standard
34274 \begin_inset Quotes qld
34278 \begin_inset Quotes qld
34284 \begin_layout Subsubsection
34290 \begin_layout Standard
34291 This will create a copy of the current document including the version history.
34292 It requires a clean document without any changes since the last checkin.
34293 You are asked for a file name and a description of the copy operation.
34294 After that the copy is created,
34295 both locally and in the repository.
34296 If the parent directories of the copied and original document differ,
34297 all relative paths of included files of the copy are adjusted (like in
34299 File\SpecialChar menuseparator
34305 the copy is loaded instead of the original document.
34308 \begin_layout Labeling
34309 \labelwidthstring 00.00.0000
34311 \begin_inset space ~
34316 \begin_inset space ~
34320 \begin_inset Newline newline
34324 \begin_inset Flex Code
34327 \begin_layout Plain Layout
34331 \begin_inset Quotes qld
34335 \begin_inset Quotes qld
34339 \begin_inset Quotes qld
34343 \begin_inset Quotes qld
34352 \begin_inset Newline newline
34356 \begin_inset Flex Code
34359 \begin_layout Plain Layout
34368 \begin_layout Subsubsection
34374 \begin_layout Standard
34375 This will rename the current document including the version history.
34376 It requires a clean document without any changes since the last checkin.
34377 You are asked for a file name and a description of the rename operation.
34378 After that the document is renamed,
34379 both locally and in the repository.
34380 If the parent directories of the new and old file names differ,
34381 all relative paths of included files are adjusted (like in
34383 File\SpecialChar menuseparator
34389 the document is reloaded using the new name.
34392 \begin_layout Labeling
34393 \labelwidthstring 00.00.0000
34395 \begin_inset space ~
34400 \begin_inset space ~
34404 \begin_inset Newline newline
34408 \begin_inset Flex Code
34411 \begin_layout Plain Layout
34415 \begin_inset Quotes qld
34419 \begin_inset Quotes qld
34423 \begin_inset Quotes qld
34427 \begin_inset Quotes qld
34436 \begin_inset Newline newline
34440 \begin_inset Flex Code
34443 \begin_layout Plain Layout
34452 \begin_layout Subsubsection
34453 \begin_inset CommandInset label
34455 name "subsec:SVN-Repo-Update"
34459 Update of the local directory checkout from repository
34463 \begin_layout Plain Layout
34464 Note that this command will work only with subversion
34465 \begin_inset Formula $\geqq1.5$
34476 \begin_layout Standard
34477 All the commands above have one shortcoming – they deal with the current document only.
34478 Once your document contains pictures,
34480 \begin_inset Flex Code
34483 \begin_layout Plain Layout
34489 files and so on administration becomes more complicated.
34491 now supports updating the whole tree in which resides the document
34495 \begin_layout Plain Layout
34496 One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
34503 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.
34507 \begin_layout Standard
34508 \begin_inset Flex Code
34511 \begin_layout Plain Layout
34512 Update local directory from repository
34517 command updates the whole directory and in case of merge conflicts local version of the files are left,
34518 so no unintended data loss occurs.
34519 If local changes are detected user is warned before update starts.
34522 \begin_layout Labeling
34523 \labelwidthstring 00.00.0000
34525 \begin_inset space ~
34530 \begin_inset space ~
34534 \begin_inset Newline newline
34538 \begin_inset Flex Code
34541 \begin_layout Plain Layout
34547 (Ask if changes are detected.)
34548 \begin_inset Newline newline
34552 \begin_inset Flex Code
34555 \begin_layout Plain Layout
34556 svn update --accept mine-full $path
34564 \begin_layout Standard
34566 \begin_inset Flex Code
34569 \begin_layout Plain Layout
34575 stands for the path to the document.
34578 \begin_layout Subsubsection
34584 \begin_layout Standard
34585 This shows the complete history of the SVN document.
34589 \begin_inset Quotes qld
34593 \begin_inset Quotes qld
34598 is shown in a browser.
34601 \begin_layout Subsubsection
34603 \begin_inset CommandInset label
34605 name "subsec:SVN-File-Locking"
34612 \begin_layout Standard
34613 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.
34614 When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
34615 which guarantees that only one user is allowed to edit file at the given time.
34618 \begin_layout Standard
34619 SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
34621 \begin_inset CommandInset ref
34623 reference "subsec:Automatical-Locking-Property"
34629 \begin_inset Flex Code
34632 \begin_layout Plain Layout
34642 \begin_layout Plain Layout
34643 \begin_inset Flex URL
34646 \begin_layout Plain Layout
34648 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
34659 If this property is detected for a given document \SpecialChar LyX
34660 starts to use SVN locks for document editing automatically and the whole check-in/out mechanism switches to the same regimen as for RCS.
34661 This in particular means there are two different modes of file use in \SpecialChar LyX
34665 \begin_layout Itemize
34667 The loaded file is in the read-only mode.
34668 For editing on needs to check-out.
34673 consists of updating from the repository and gaining write lock.
34674 If the lock is not possible to obtain,
34675 we remain in unlocked state.
34678 \begin_layout Itemize
34680 The loaded file is in the
34681 \begin_inset Quotes els
34685 \begin_inset Quotes ers
34689 No other user is allowed to edit the file.
34694 consists of commiting changes and releasing write-lock.
34695 If no changes have been made to the document,
34696 no commit will be produced
34700 \begin_layout Plain Layout
34701 Don't be puzzled by the fact that you will be asked for commit message anyway.
34706 and only the write-lock will be released.
34709 \begin_layout Standard
34713 \begin_layout Labeling
34714 \labelwidthstring 00.00.0000
34718 svn commit -q -m"<description>" "<file-name>"
34719 \begin_inset Newline newline
34722 svn unlock "<file-name>"
34725 \begin_layout Labeling
34726 \labelwidthstring 00.00.0000
34730 svn update "<file-name>"
34731 \begin_inset Newline newline
34734 svn lock "<file-name>"
34737 \begin_layout Subsubsection
34740 \begin_inset CommandInset label
34742 name "subsec:Automatical-Locking-Property"
34748 Automatic Locking Property
34751 \begin_layout Standard
34752 The above mentioned automatic setting of write permissions of the .lyx file can be set through
34754 File\SpecialChar menuseparator
34756 \begin_inset space ~
34759 Control\SpecialChar menuseparator
34760 Use Locking Property
34763 This command is active only when the file is not locked on the svn server (i.e.
34764 you need to check-out before proceeding).
34767 \begin_layout Labeling
34768 \labelwidthstring 00.00.0000
34770 \begin_inset space ~
34776 \begin_layout Labeling
34777 \labelwidthstring 00.00.0000
34781 svn propset svn:needs-lock ON "<file-name>"
34784 \begin_layout Labeling
34785 \labelwidthstring 00.00.0000
34789 svn propdel svn:needs-lock "<file-name>"
34792 \begin_layout Subsubsection
34793 \begin_inset CommandInset label
34795 name "subsec:VCS-Revision-Information"
34799 Revision Information in Documents
34802 \begin_layout Standard
34803 There are more possibilities how to activate revision information in our document.
34806 \begin_layout Itemize
34812 \begin_layout Itemize
34813 tree revision information (
34814 \begin_inset Flex Code
34817 \begin_layout Plain Layout
34824 The result is the output of the
34825 \begin_inset Flex Code
34828 \begin_layout Plain Layout
34835 the following table gives you an idea,
34836 how to read the results.
34839 \begin_layout Standard
34841 \begin_inset Tabular
34842 <lyxtabular version="3" rows="6" columns="2">
34843 <features tabularvalignment="middle">
34844 <column alignment="left" valignment="top">
34845 <column alignment="left" valignment="top">
34847 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
34850 \begin_layout Plain Layout
34858 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
34861 \begin_layout Plain Layout
34871 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
34874 \begin_layout Plain Layout
34880 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34883 \begin_layout Plain Layout
34884 mixed revision working copy
34891 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
34894 \begin_layout Plain Layout
34900 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34903 \begin_layout Plain Layout
34904 modified working copy
34911 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
34914 \begin_layout Plain Layout
34920 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34923 \begin_layout Plain Layout
34924 switched working copy
34931 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
34934 \begin_layout Plain Layout
34940 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34943 \begin_layout Plain Layout
34944 partial working copy,
34945 from a sparse checkout
34952 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
34955 \begin_layout Plain Layout
34961 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
34964 \begin_layout Plain Layout
34967 switched working copy
34980 \begin_layout Itemize
34981 file revision information.
34982 The result comes from parsing the output of
34983 \begin_inset Flex Code
34986 \begin_layout Plain Layout
34988 \begin_inset space ~
34992 \begin_inset space ~
34996 \begin_inset space ~
35005 Supported flags are:
35009 \begin_layout Itemize
35010 version number of the last commit (
35011 \begin_inset Flex Code
35014 \begin_layout Plain Layout
35023 \begin_layout Itemize
35024 author of the last commit (
35025 \begin_inset Flex Code
35028 \begin_layout Plain Layout
35037 \begin_layout Itemize
35038 date of the last commit (
35039 \begin_inset Flex Code
35042 \begin_layout Plain Layout
35051 \begin_layout Itemize
35052 time of the last commit (
35053 \begin_inset Flex Code
35056 \begin_layout Plain Layout
35066 \begin_layout Standard
35067 You can obtain this info via InsetInfo (
35068 \change_inserted 5863208 1564400022
35069 Insert\SpecialChar menuseparator
35070 Field\SpecialChar menuseparator
35071 Version Control Revision
35072 \change_deleted 5863208 1564399852
35075 \begin_inset Flex Code
35078 \begin_layout Plain Layout
35079 info-insert buffer vcs-date
35087 The information will be available only when you have the file stored under svn managment (i.e.
35089 \begin_inset Flex Code
35092 \begin_layout Plain Layout
35098 directory is available with your document).
35102 \begin_layout Itemize
35105 possibility is to use svn keywords
35109 \begin_layout Plain Layout
35110 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
35116 In short – you set file keywords property (e.g.
35119 svn propset svn:keywords 'Rev' file.lyx
35121 ) and then paste keyword \SpecialChar TeX
35126 \begin_layout Plain Layout
35127 This is an easy way how to ensure that \SpecialChar LyX
35128 won't break the line in the middle of keyword tag.
35133 tag in your document (e.g.
35135 \begin_inset Flex Code
35138 \begin_layout Plain Layout
35145 This way svn client will automatically substitute revision number (e.g.
35147 \begin_inset Flex Code
35150 \begin_layout Plain Layout
35157 ) after each update and commit.
35158 There are more problems with this approach.
35160 the '$' character is used in \SpecialChar TeX
35161 world for math equations,
35162 so any occurence of math formula
35163 \begin_inset Formula $Rev$
35167 \begin_inset Formula $Rev:59$
35170 in your \SpecialChar LyX
35172 Similarly for other keywords like Id,
35176 Secondly svn output is dependent on your locales,
35177 so its very easy that svn would produce some problematic strings once Date is used.
35178 Thirdly you get the whole 'Rev:
35179 59' string in your document instead of the plain number.
35180 Until subversion implements user's custom keywords it will be hard to use this approach reliably or let \SpecialChar LyX
35181 to support it directly.
35184 \begin_layout Subsection
35185 SVN and Windows Environment
35188 \begin_layout Quote
35189 My inclination is to say that if the user cannot figure out the command line operations on their own fairly quickly,
35190 they would be well advised to use TortoiseSVN.
35197 \begin_layout Subsubsection
35201 \begin_layout Standard
35202 In addition to installing \SpecialChar LyX
35204 and having access to a Subversion repository,
35205 the user will need to install the Subversion client program.
35206 A Windows installer for the client program is available from
35207 \begin_inset CommandInset href
35210 target "http://www.collab.net/nonav/downloads/subversion/"
35216 The user may also want to install
35217 \begin_inset CommandInset href
35220 target "http://tortoisesvn.tigris.org/"
35226 which integrates Subversion operations into the context (rightclick) menu of Windows Explorer.
35227 Operations done outside \SpecialChar LyX
35228 will typically be more convenient using the Explorer context menu.
35229 Note that TortoiseSVN is not a replacement for the client program,
35230 which is what \SpecialChar LyX
35234 \begin_layout Subsubsection
35235 Bringing a document under Subversion control
35238 \begin_layout Standard
35239 Before a \SpecialChar LyX
35240 document can be brought under version control in Subversion,
35241 its parent directory needs to be under version control.
35242 If the document is being added to a project already in the repository,
35243 this is accomplished by checking the project out to the directory where the new document will be placed.
35244 If the project itself is not yet under version control (for instance,
35245 if this document starts a new project),
35246 the directory must be imported into the repository.
35247 This is done outside \SpecialChar LyX
35249 Both import and checkout are easily accomplished from the Explorer context menu using TortoiseSVN,
35250 or alternatively can be done using the command line client at a DOS prompt.
35251 The procedure for importing the project using TortoiseSVN is described below,
35252 assuming an existing repository and a new project being started in
35259 For information on using the Subversion client program,
35267 \begin_layout Enumerate
35274 in Windows Explorer,
35278 TortoiseSVN\SpecialChar menuseparator
35283 adjust the URL for the repository,
35287 \begin_layout Enumerate
35288 Right click the level of the repository under which you want to place the new project folder (typically the top level) and click
35292 Supply a name for the project folder and click OK.
35293 Add a message for the log file if desired,
35294 then click OK again.
35295 The new project folder should appear in the repository.
35297 click OK again to exit the repository browser.
35300 \begin_layout Enumerate
35301 Once again right click
35308 this time selecting SVN Checkout\SpecialChar ldots
35309 Select the URL of the project folder you just created in the repository,
35310 and set the checkout directory to
35318 You will be warned about a non-empty folder;
35319 click OK to proceed.
35320 You should now have a
35331 \begin_layout Enumerate
35332 Create or open your document in \SpecialChar LyX
35335 File\SpecialChar menuseparator
35337 \begin_inset space ~
35340 Control\SpecialChar menuseparator
35344 Add a log message and click OK to commit the document to version control.
35347 \begin_layout Standard
35348 From this point onward,
35349 you should have full functionality in the
35351 File\SpecialChar menuseparator
35353 \begin_inset space ~
35359 You also have the option of checking the document in and out,
35360 viewing its history,
35362 using the TortoiseSVN context menu in Windows Explorer or the Subversion client program from a command prompt.
35365 \begin_layout Subsubsection
35366 SSH tunnel used with SVN under Windows
35369 \begin_layout Standard
35370 Compared with Linux setting up an svn client to communicate over ssh under Windows is a rather troublesome task.
35371 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,
35372 also be prepared for a great deal of frustration\SpecialChar ldots
35376 \begin_layout Enumerate
35377 Get an svn client for windows,
35378 as described in the previous sections.
35379 When it is a fresh install run some svn command (e.g.
35381 \begin_inset Flex Code
35384 \begin_layout Plain Layout
35390 ) to create config files,
35391 which you will need to change later on.
35394 \begin_layout Enumerate
35395 Choose an ssh client for Windows.
35396 There are several possibilities,
35397 we will use the one from Putty tools
35401 \begin_layout Plain Layout
35402 \begin_inset Flex URL
35405 \begin_layout Plain Layout
35407 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
35418 You will need to set the connection up so that the client doesn't ask for any password from you.
35419 To keep things easy we will use only keys without any additional password protection etc.
35423 \begin_layout Enumerate
35425 \begin_inset Flex Code
35428 \begin_layout Plain Layout
35435 Save your private .ppk key file and put the public one on the server side.
35436 If the SVN server runs on Linux,
35437 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
35438 \begin_inset Quotes eld
35443 Public key for pasting into OpenSSH authorized_keys file
35446 \begin_inset Quotes erd
35449 edit field into the server's
35450 \begin_inset Flex Code
35453 \begin_layout Plain Layout
35454 ~/.ssh/authorized_keys
35460 \begin_inset Flex Code
35463 \begin_layout Plain Layout
35472 \begin_layout Enumerate
35474 \begin_inset Flex Code
35477 \begin_layout Plain Layout
35484 In the SVN config file
35488 \begin_layout Plain Layout
35489 Exact path depends on Windows version,
35490 usually somewhere around
35491 \begin_inset Flex Code
35494 \begin_layout Plain Layout
35497 Documents and Settings
35511 \begin_inset Flex Code
35514 \begin_layout Plain Layout
35534 \begin_inset Flex Code
35537 \begin_layout Plain Layout
35538 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
35547 \begin_layout Plain Layout
35548 It will usually take a lot of time to get exact command right and it depends on many things.
35549 For example do not have some remote server saved as a default session in Putty etc.
35551 try to connect via plink without SVN first.
35560 \begin_layout Enumerate
35561 Checkout the SVN archive,
35563 \begin_inset space \thinspace{}
35567 \begin_inset Newline newline
35571 \begin_inset Flex Code
35574 \begin_layout Plain Layout
35575 svn co svn+ssh://user@server/repository_path
35583 \begin_layout Subsubsection
35584 End-of-Line Conversions
35587 \begin_layout Standard
35588 When the collaborators are mixing Linux and Windows environments,
35590 will use different line endings inside the .lyx files.
35591 This is not a problem as far as \SpecialChar LyX
35592 functionality is concerned,
35593 but the commit diffs will be huge and merge-conflicts prone.
35594 Fortunately SVN itself knows
35598 \begin_layout Plain Layout
35599 \begin_inset Flex URL
35602 \begin_layout Plain Layout
35604 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
35614 how to deal with CR/LF problems when switching .lyx files to the
35615 \begin_inset Flex Code
35618 \begin_layout Plain Layout
35628 \begin_layout Plain Layout
35631 \begin_inset Flex Code
35634 \begin_layout Plain Layout
35635 svn propset svn:eol-style native FILE_NAME
35648 \begin_layout Subsection
35649 GIT commands in \SpecialChar LyX
35653 \begin_layout Standard
35654 A minimal subset of GIT commands is now supported by \SpecialChar LyX
35656 You can find the commands in the
35658 File\SpecialChar menuseparator
35660 \begin_inset space ~
35666 Please note that if you use password protected access to repository via ssh,
35667 you will be asked in terminal window.
35669 was tested against GIT 1.7.
35673 \begin_layout Plain Layout
35674 Windows users please note that you need to ensure that git is on the path.
35675 This can be set from within \SpecialChar LyX
35678 Tools\SpecialChar menuseparator
35679 Preferences\SpecialChar menuseparator
35680 Paths\SpecialChar menuseparator
35691 \begin_layout Standard
35692 One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
35693 With traditional version control systems there is one central server which hosts the repository.
35694 Users commit their changes to the server,
35695 and get updates made by other users from it.
35697 users commit to a local repository.
35698 The local repository can be synchronized with one or more remote repositories using the
35699 \begin_inset Flex Code
35702 \begin_layout Plain Layout
35709 \begin_inset Flex Code
35712 \begin_layout Plain Layout
35720 does not interact in any way with remote GIT repositories.
35721 It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
35722 If you use remote GIT repositories you need to do the
35723 \begin_inset Flex Code
35726 \begin_layout Plain Layout
35733 \begin_inset Flex Code
35736 \begin_layout Plain Layout
35742 operations with your favourite GIT client.
35745 \begin_layout Subsubsection
35751 \begin_layout Standard
35752 If your document is not under revision control,
35753 this is the only item shown in the menu.
35754 And if it is under revision control,
35759 item is not visible.
35762 \begin_layout Standard
35763 This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
35768 This means you have to checkout the archive by yourself.
35771 \begin_layout Standard
35772 Then you are asked interactively to supply an initial description of the document.
35773 Don't forget that registered file is not yet committed.
35776 \begin_layout Standard
35777 GIT command that is run:
35781 \begin_inset Quotes qld
35785 \begin_inset Quotes qld
35791 \begin_layout Standard
35796 to understand the switches.
35799 \begin_layout Subsubsection
35805 \begin_layout Standard
35806 When you are finished editing a file,
35807 you commit your changes.
35809 you are asked for a description of the changes.
35810 After that changes are committed.
35813 \begin_layout Standard
35817 git commit -q -m"<description>" <file-name>
35820 \begin_layout Subsubsection
35823 Revert To Repository Version
35826 \begin_layout Standard
35827 This will discard all changes made to the document since the last check in.
35828 You get a warning before changes are discarded.
35831 \begin_layout Standard
35836 \begin_inset Quotes qld
35840 \begin_inset Quotes qld
35846 \begin_layout Subsubsection
35852 \begin_layout Standard
35853 This will rename the current document including the version history.
35854 It requires a clean document without any changes since the last checkin.
35855 You are asked for a file name and a description of the rename operation.
35856 After that the document is renamed,
35857 both locally and in the repository.
35858 If the parent directories of the new and old file names differ,
35859 all relative paths of included files are adjusted (like in
35861 File\SpecialChar menuseparator
35867 the document is reloaded using the new name.
35870 \begin_layout Labeling
35871 \labelwidthstring 00.00.0000
35873 \begin_inset space ~
35878 \begin_inset space ~
35882 \begin_inset Newline newline
35886 \begin_inset Flex Code
35889 \begin_layout Plain Layout
35893 \begin_inset Quotes qld
35897 \begin_inset Quotes qld
35901 \begin_inset Quotes qld
35905 \begin_inset Quotes qld
35914 \begin_inset Newline newline
35918 \begin_inset Flex Code
35921 \begin_layout Plain Layout
35930 \begin_layout Subsubsection
35936 \begin_layout Standard
35937 This shows the complete history of the GIT document.
35941 \begin_inset Quotes qld
35945 \begin_inset Quotes qld
35950 is shown in a browser.
35953 \begin_layout Subsubsection
35957 \begin_layout Standard
35959 supports GIT hash number of the last commit to the file,
35961 \change_inserted 1119979965 1564297456
35962 its abbreviated form,
35966 date and time of last commit.
35967 All those are extracted from
35969 git log -n 1 --pretty=format:%H%n
35970 \change_inserted 1119979965 1564297427
35976 Tree version information is obtained via
35978 git describe --abbrev --dirty --long
35982 \begin_inset CommandInset ref
35984 reference "subsec:VCS-Revision-Information"
35992 \begin_layout Subsection
35996 \begin_layout Standard
35997 With the recent addition of the
35998 \begin_inset Flex Code
36001 \begin_layout Plain Layout
36007 function \SpecialChar LyX
36008 power users are allowed to create their own commands for revision control.
36011 \begin_layout Standard
36012 As an example you can see how two TortoiseSVN commands could be integrated directly:
36015 \begin_layout Description
36018 \begin_inset Flex Code
36021 \begin_layout Plain Layout
36022 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
36030 \begin_layout Description
36033 \begin_inset Flex Code
36036 \begin_layout Plain Layout
36037 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
36045 \begin_layout Subsection
36046 Version control and Document comparison
36049 \begin_layout Standard
36050 One of the typical uses of version control is to inspect the changes between revisions,
36051 usually by creating
36052 \begin_inset Flex Code
36055 \begin_layout Plain Layout
36062 While this is useful for plain text files,
36063 it is much less useful in the case of \SpecialChar LyX
36065 which have more a complicated structure.
36066 Hence we provide binding to the Document comparison feature.
36067 There are two ways of calling this feature – either by direct call of
36068 \begin_inset Flex Code
36071 \begin_layout Plain Layout
36078 function (for details see \SpecialChar LyX
36079 functions manual) or by the toolbar icon
36093 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 '
36094 \begin_inset Flex Noun
36097 \begin_layout Plain Layout
36103 ' revisions back means comparison of the edited file with last commited revision).
36107 \begin_layout Standard
36108 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,
36109 numbers always point to the last number in RCS revision number,
36112 We don't currently support GIT addressing of revisions,
36113 one can just compare edited document with its revision X steps backs,
36114 where X is addressed as
36115 \begin_inset Flex Code
36118 \begin_layout Plain Layout
36127 \begin_layout Section
36129 \change_inserted 564990737 1672161575
36130 \begin_inset CommandInset label
36132 name "sec:Literate-Programming"
36138 Literate Programming
36141 \begin_layout Standard
36146 (kayvan@sylvan.com)
36151 original documentation written by
36153 Edmar Wienskoski Jr.
36156 (edmar-w-jr@technologist.com)
36159 \begin_layout Subsection
36163 \begin_layout Standard
36164 The main purpose of this documentation is to show you how to use \SpecialChar LyX
36165 for literate programming,
36166 where it is assumed that you are familiar with this programming technique,
36168 \begin_inset Quotes eld
36172 \begin_inset Quotes erd
36176 \begin_inset Quotes eld
36180 \begin_inset Quotes erd
36184 If that is not the case,
36185 please follow the web links provided in the following sections.
36186 There is a lot of good documentation out there covering old development history to the latest tools tips.
36189 \begin_layout Standard
36190 It is also assumed that you are familiar with \SpecialChar LyX
36191 itself to a point that you are comfortable changing your \SpecialChar LyX
36193 and X resources file.
36194 If that is not the case please refer to other \SpecialChar LyX
36195 documentation to cover your specific needs.
36198 \begin_layout Subsection
36199 Literate Programming
36202 \begin_layout Standard
36203 From the Literate Programming FAQ:
36207 \begin_layout Quotation
36208 Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
36210 literate programs should be enjoyable reading,
36213 I couldn't resist!) In general,
36214 literate programs combine source and documentation in a single file.
36215 Literate programming tools then parse the file to produce either readable documentation or compilable source.
36216 The WEB style of literate programming was created by D.
36217 \begin_inset space \thinspace{}
36221 Knuth during the development of his \SpecialChar TeX
36222 typesetting software.
36226 \begin_layout Standard
36227 Another excerpt says:
36230 \begin_layout Quotation
36233 How is literate programming different from verbose commenting?
36236 \begin_layout Quotation
36237 There are three distinguishing characteristics.
36238 In order of importance,
36244 \begin_layout Itemize
36245 flexible order of elaboration
36248 \begin_layout Itemize
36249 automatic support for browsing
36252 \begin_layout Itemize
36253 typeset documentation,
36254 especially diagrams and mathematics
36258 \begin_layout Standard
36259 Now that I sparked your curiosity,
36260 take a look in the references.
36263 \begin_layout Subsubsection
36267 \begin_layout Standard
36268 The complete Literate Programming FAQ can be found at:
36271 \begin_layout Quote
36272 Literate Programming FAQ
36273 \begin_inset Flex URL
36276 \begin_layout Plain Layout
36278 http://www.literateprogramming.com/lpfaq.pdf
36286 \begin_layout Standard
36287 The FAQ lists 23 (twenty three!) different literate programming tools.
36288 Where some are specialized or
36289 \begin_inset Quotes eld
36293 \begin_inset Quotes erd
36296 for particular programming languages,
36297 while other have general scope.
36302 for my own use for several reasons:
36305 \begin_layout Itemize
36306 It can generate the documentation either in \SpecialChar LaTeX
36310 \begin_layout Itemize
36311 It has a open architecture,
36313 \begin_inset space \thinspace{}
36317 \begin_inset space \space{}
36320 it is easy to plug in new filters
36324 \begin_layout Plain Layout
36329 are programs that read a given data stream and output a manipulated data stream.
36331 a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
36337 and to perform special processing that you may need.
36341 \begin_layout Itemize
36342 There is a good selection of filters available already (the HTML is one of them).
36345 \begin_layout Itemize
36349 \begin_layout Standard
36350 The Noweb web page can be found at:
36354 \begin_layout Quote
36356 \begin_inset Flex URL
36359 \begin_layout Plain Layout
36361 https://www.cs.tufts.edu/~nr/noweb/
36369 \begin_layout Standard
36370 Starting from there you can reach many other interesting links and even some literate program examples.
36373 \begin_layout Subsection
36375 and Literate Programming with Noweb
36378 \begin_layout Standard
36379 The \SpecialChar LyX
36380 support for Literate Programming is provided by using the generic \SpecialChar LyX
36381 converters mechanism.
36382 This support is provided in a
36383 \begin_inset Quotes eld
36387 \begin_inset Quotes erd
36392 \begin_inset space \thinspace{}
36396 \begin_inset space \space{}
36399 you will be able to use this new \SpecialChar LyX
36400 feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
36404 \begin_layout Subsubsection
36405 Generating documents and code (weaving and tangling)
36408 \begin_layout Paragraph
36409 Using the noweb module
36412 \begin_layout Standard
36413 If you have installed Noweb and \SpecialChar LyX
36415 whenever you open a new document,
36416 after you have chosen its document class,
36419 Document\SpecialChar menuseparator
36423 \begin_inset Quotes eld
36427 \begin_inset Quotes erd
36431 If Noweb is correctly installed,
36432 when you click on the
36433 \begin_inset Quotes eld
36437 \begin_inset Quotes erd
36442 \begin_inset Quotes eld
36446 \begin_inset Quotes erd
36449 module in the available list and you can add it to your document.
36452 \begin_layout Paragraph
36456 \begin_layout Standard
36458 enables you to write code with a custom inset named
36459 \begin_inset Flex Noun
36462 \begin_layout Plain Layout
36469 Noweb delimits chunks like this:
36472 \begin_layout LyX-Code
36476 \begin_layout LyX-Code
36480 \begin_layout LyX-Code
36484 \begin_layout LyX-Code
36488 \begin_layout LyX-Code
36492 \begin_layout Standard
36493 The problem is that whatever is written in between the << and the
36497 must be taken literally,
36499 \begin_inset space \thinspace{}
36503 \begin_inset space \space{}
36507 should be prevented from making any special interpretation of what has been written.
36508 This is also handled by
36509 \begin_inset Flex Noun
36512 \begin_layout Plain Layout
36519 that works like a normal text inset but has a free spacing capability.
36522 \begin_layout Standard
36524 you can also use the
36525 \begin_inset Quotes eld
36529 \begin_inset Quotes erd
36532 construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
36535 \begin_layout LyX-Code
36539 \begin_layout LyX-Code
36540 def some_function(args):
36543 \begin_layout LyX-Code
36544 "This is the doc string for this function."
36547 \begin_layout LyX-Code
36553 \begin_layout LyX-Code
36554 @ %def some_function
36557 \begin_layout Standard
36558 For an example of this usage and the resulting cross-reference output,
36559 look at the Literate python program in
36561 LIBDIR/examples/listerrors.lyx
36563 which should make this all clear.
36566 \begin_layout Paragraph
36567 Generating the documentation
36570 \begin_layout Standard
36571 At this point you already have a new document file with a proper document class,
36572 and with some code and text on it.
36574 The answer is simple,
36577 View\SpecialChar menuseparator
36582 Just like you would do for a plain document.
36583 No special procedure is required.
36586 \begin_layout Standard
36587 To help orientate you,
36588 I will now explain what happens inside \SpecialChar LyX
36592 \begin_layout Enumerate
36595 Update\SpecialChar menuseparator
36598 menu option is chosen,
36599 a \SpecialChar LaTeX
36605 \begin_layout Standard
36606 If the document is of any literate class the generated file will be named with an extension name defined by the
36607 \begin_inset Quotes eld
36611 \begin_inset Quotes erd
36614 format (defined in the Preferences panel),
36615 otherwise the file will have the usual
36623 \begin_layout Enumerate
36624 Note that the only difference so far is in the name of the file,
36625 no special processing is required by \SpecialChar LyX
36627 Given that you formatted the code using the
36628 \begin_inset Flex Noun
36631 \begin_layout Plain Layout
36639 takes care of the business.
36642 \begin_layout Enumerate
36643 If the document is of any literate class \SpecialChar LyX
36644 will then use the internal \SpecialChar LyX
36645 to Noweb converter,
36646 followed by the Noweb to \SpecialChar LaTeX
36651 \begin_layout Plain Layout
36652 The converters are defined in the
36654 Tools\SpecialChar menuseparator
36659 \begin_inset Quotes eld
36663 \begin_inset Quotes erd
36675 manual for general information about converters.
36680 to generate the \SpecialChar LaTeX
36685 \begin_layout Standard
36686 Otherwise it will just skip this step.
36690 \begin_layout Enumerate
36693 is invoked and the regular post processing continues as in a plain document.
36696 \begin_layout Standard
36697 Independence from a particular
36698 \begin_inset Quotes eld
36702 \begin_inset Quotes erd
36705 is easily achieved by changing the commands that are run by the various converters.
36708 \begin_layout Paragraph
36709 Generating the code
36712 \begin_layout Standard
36713 When the build menu option is chosen or the corresponding button in the toolbar is pressed,
36714 a \SpecialChar LaTeX
36715 file is generated just like step 1 above.
36723 This converter needs to be defined by the user and is not installed by default,
36724 though the Program format is.
36725 This converter (like any other converter) will have two parts:
36728 \begin_layout Enumerate
36729 The converter program itself.
36730 This program performs the conversion from the one format to the other (in this case,
36731 from the Noweb format to the Program pseudo-format).
36734 \begin_layout Enumerate
36735 The error log parser.
36736 This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
36738 This makes it possible for \SpecialChar LyX
36739 to place error boxes in the right places in the file buffer.
36742 \begin_layout Standard
36745 \begin_inset Quotes eld
36749 \begin_inset Quotes erd
36756 \begin_layout LyX-Code
36764 \begin_layout Standard
36765 This basically means that \SpecialChar LyX
36767 \begin_inset Quotes eld
36771 \begin_inset Quotes erd
36774 (a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
36775 temp directory) and the directory path of the original \SpecialChar LyX
36780 \begin_layout Standard
36781 This is an implementation of
36782 \begin_inset Quotes eld
36786 \begin_inset Quotes erd
36789 that you can place in a directory on your path:
36792 \begin_layout LyX-Code
36798 \begin_layout LyX-Code
36804 \begin_layout LyX-Code
36807 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
36810 \begin_layout Standard
36811 The next part of the converter setting is the
36812 \begin_inset Quotes eld
36816 \begin_inset Quotes erd
36819 which is to be set to
36822 \begin_layout LyX-Code
36825 parselog=$$s/scripts/listerrors
36828 \begin_layout Standard
36829 This will run any errors that are generated by the
36830 \begin_inset Quotes eld
36834 \begin_inset Quotes erd
36837 process through the
36838 \begin_inset Quotes eld
36842 \begin_inset Quotes erd
36848 \begin_layout Standard
36849 The build will normally take place in \SpecialChar LyX
36850 's temporary directory,
36851 so the files produced by the conversion will be in that directory.
36853 will copy out what it regards as the `main' file,
36858 conversion may produce several files,
36859 and so most of these would then be deleted when \SpecialChar LyX
36861 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.
36864 \begin_layout Paragraph
36865 Build instructions in the document
36868 \begin_layout Standard
36869 The last piece of the integration between \SpecialChar LyX
36871 \begin_inset Quotes eld
36875 \begin_inset Quotes erd
36880 the instructions for building your program should be embedded in a chunk of its own.
36882 \begin_inset Quotes eld
36886 \begin_inset Quotes erd
36889 above uses the notangle command to look for this chunk (called
36890 \begin_inset Quotes eld
36894 \begin_inset Quotes erd
36897 ) and runs its contents through
36898 \begin_inset Quotes eld
36902 \begin_inset Quotes erd
36908 \begin_layout Standard
36910 such a chunk would look something like this:
36913 \begin_layout LyX-Code
36917 \begin_layout LyX-Code
36919 \begin_inset Newline newline
36922 if [ -z "${NOWEB_SOURCE}" ]
36923 \begin_inset Newline newline
36929 \begin_layout LyX-Code
36930 NOWEB_SOURCE=myfile.nw
36931 \begin_inset Newline newline
36935 \begin_inset Newline newline
36939 code to extract files ...
36940 use NOWEB_OUTPUT_DIR here ...]
36941 \begin_inset Newline newline
36945 code to compile files ...]
36946 \begin_inset Newline newline
36952 \begin_layout Standard
36954 \change_deleted 564990737 1672161716
36957 LIBDIR/examples/listerrors.lyx
36961 LIBDIR/examples/Literate.lyx
36962 \change_inserted 564990737 1672161716
36966 File\SpecialChar menuseparator
36967 Open Example\SpecialChar menuseparator
36968 Modules\SpecialChar menuseparator
36974 \change_deleted 564990737 1672161729
36978 \begin_inset Quotes eld
36982 \begin_inset Quotes erd
36985 program for some illustrations of how all of these pieces go together or in
36986 \change_deleted 564990737 1672161756
36989 LIBDIR/examples/noweb2lyx.lyx
36990 \change_inserted 564990737 1672161756
36994 File\SpecialChar menuseparator
36995 Open Example\SpecialChar menuseparator
36996 Modules\SpecialChar menuseparator
36997 Noweb2\SpecialChar LyX
37008 \change_deleted 564990737 1672161767
37011 files show off the language-indepence of the \SpecialChar LyX
37012 literate programming support since they are written in Python
37013 \change_deleted 564990737 1672161782
37017 and Perl respectively.
37020 \begin_layout Subsubsection
37021 Configuring \SpecialChar LyX
37025 \begin_layout Standard
37026 All the Literate Programming support is configured by the
37028 Tools\SpecialChar menuseparator
37032 \begin_inset Quotes eld
37036 \begin_inset Quotes erd
37040 The important parts are:
37043 \begin_layout Description
37045 \begin_inset space ~
37049 \begin_inset Quotes eld
37053 \begin_inset Quotes erd
37057 \begin_inset space ~
37060 format Set up via the File Formats tab,
37061 this is where the Noweb-specific pieces are set up.
37071 the file extension is set to
37076 This tells \SpecialChar LyX
37077 to create a file with a
37081 extension in the first step of the conversion process.
37084 \begin_layout Description
37086 \begin_inset space ~
37094 \begin_inset space ~
37097 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).
37100 \begin_layout Description
37110 This converter performs the
37111 \begin_inset Quotes eld
37115 \begin_inset Quotes erd
37118 of the literate document.
37121 \begin_inset Quotes eld
37126 noweave -delay -index $$i > $$o
37129 \begin_inset Quotes erd
37135 \begin_layout Description
37145 \begin_inset Quotes eld
37149 \begin_inset Quotes erd
37154 the Converter is set to
37155 \begin_inset Quotes eld
37163 \begin_inset Quotes erd
37168 \begin_inset Newline newline
37172 \begin_inset Quotes eld
37177 parselog=$$s/scripts/listerrors
37180 \begin_inset Quotes erd
37186 \begin_layout Subsubsection
37190 \begin_layout Standard
37191 There is also a new function implemented in the \SpecialChar LyX
37194 \begin_inset Quotes eld
37197 server-goto-file-row" function,
37198 to be used with ddd/gdb or other debugger.
37202 \begin_layout Standard
37203 When debugging code with ddd/gdb,
37204 it is possible to invoke a text editor at the current execution position with a single key stroke.
37205 The default ddd configuration for that is shift-ctrl-V.
37206 It happens that you can define the editor command line invocation in ddd by accessing the
37208 Edit\SpecialChar menuseparator
37209 Preferences\SpecialChar menuseparator
37212 dialog and changing the "Edit Sources" entry.
37215 \begin_layout Standard
37216 I take advantage of the newly created \SpecialChar LyX
37217 server function and this ddd feature,
37219 \begin_inset Quotes eld
37223 \begin_inset Quotes erd
37229 \begin_layout LyX-Code
37230 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
37233 \begin_layout Standard
37235 whenever you are using ddd and find a point in the program that you want to edit,
37236 you just press shift-ctrl-V (in the ddd window),
37237 and ddd will forward this information to \SpecialChar LyX
37238 through the \SpecialChar LyX
37239 server and then the \SpecialChar LyX
37240 window will show the same file with the cursor at the same position ddd was pointing to.
37241 No more guessing or long scrolling to locate a point in the program back from debugging !
37244 \begin_layout Standard
37245 Note however that you must enable the \SpecialChar LyX
37246 server to get this feature working (it is disabled by default).
37248 \begin_inset space ~
37252 \begin_inset CommandInset ref
37254 reference "sec:Starting-the-Server"
37259 explains how to do that.
37262 \begin_layout Subsubsection
37266 \begin_layout Standard
37267 There are six new buttons that can be added to your \SpecialChar LyX
37269 Four of these buttons are short cuts to layout styles:
37292 one for the custom inset
37297 The last one is a short cut to the
37298 \begin_inset Quotes eld
37302 \begin_inset Quotes erd
37309 \begin_layout Standard
37311 has a range of buttons that are available for tool bar customization.
37312 In my toolbar I like to combine the six short cuts above with two more:
37317 \SpecialChar menuseparator
37322 \SpecialChar menuseparator
37329 Document\SpecialChar menuseparator
37330 View\SpecialChar menuseparator
37334 Here is how it looks like:
37337 \begin_layout LyX-Code
37341 \begin_layout LyX-Code
37345 \begin_layout LyX-Code
37346 Icon "layout Standard"
37349 \begin_layout LyX-Code
37350 Icon "layout Section"
37353 \begin_layout LyX-Code
37354 Icon "layout \SpecialChar LaTeX
37358 \begin_layout LyX-Code
37359 Icon "layout \SpecialChar LyX
37363 \begin_layout LyX-Code
37364 Icon "flex.insert Chunk"
37367 \begin_layout LyX-Code
37371 \begin_layout LyX-Code
37375 \begin_layout LyX-Code
37376 Icon "buffer-typeset"
37379 \begin_layout LyX-Code
37380 Icon "build-program"
37383 \begin_layout LyX-Code
37387 \begin_layout LyX-Code
37391 \begin_layout LyX-Code
37395 \begin_layout LyX-Code
37399 \begin_layout LyX-Code
37403 \begin_layout Subsubsection
37404 Colors customization
37407 \begin_layout Standard
37408 There are a number of colors in \SpecialChar LyX
37409 that can be customized in
37414 One of the things that bothers people is the \SpecialChar LaTeX
37416 The default color is red,
37417 since the chunks uses \SpecialChar LaTeX
37419 and there is a lot of chunks in literate documents,
37420 you may get tired of seeing everything in red.
37421 You can change it by going to the tabs
37431 \begin_layout Standard
37432 The next thing is the visible presence of the newline character in the screen.
37433 You can choose the color of this particular character and make it blend in the background.
37434 I recommend you choosing a color that is close to the background but not equal,
37435 that way you still can see it is there,
37436 but it is not bothering you anymore.
37439 \begin_layout Subsection
37444 \begin_layout Standard
37454 \change_inserted 564990737 1672161863
37457 Help\SpecialChar menuseparator
37458 Specific Manuals\SpecialChar menuseparator
37464 \change_deleted 564990737 1671643409
37470 \change_inserted 564990737 1672161856
37473 File\SpecialChar menuseparator
37474 Open Example\SpecialChar menuseparator
37475 Modules\SpecialChar menuseparator
37481 \change_deleted 564990737 1671643461
37482 the Sweave manual (menu
37484 Help\SpecialChar menuseparator
37488 \change_inserted 564990737 1672161856
37491 Help\SpecialChar menuseparator
37492 Specific Manuals\SpecialChar menuseparator
37494 \change_deleted 564990737 1672161921
37499 \change_inserted 564990737 1672161917
37502 File\SpecialChar menuseparator
37503 Open Example\SpecialChar menuseparator
37504 Modules\SpecialChar menuseparator
37508 \change_deleted 564990737 1672742969
37512 \begin_layout Standard
37514 \change_deleted 564990737 1671355343
37518 \begin_layout Standard
37520 \change_deleted 564990737 1671355343
37521 You can do everything with \SpecialChar LyX
37522 that you can do with \SpecialChar LaTeX
37526 cannot support every \SpecialChar LaTeX
37528 But you can always use \SpecialChar TeX
37530 This chapter shows you some more special things you might want to use.
37531 For other special things you can do with figures,
37538 \begin_inset space ~