]> git.lyx.org Git - features.git/blob - lib/doc/Extended.lyx
Some initial updates to the Extended Features manual.
[features.git] / lib / doc / Extended.lyx
1 #LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
2 \lyxformat 341
3 \begin_document
4 \begin_header
5 \textclass scrbook
6 \begin_preamble
7 % DO NOT ALTER THIS PREAMBLE!!!
8 %
9 % This preamble is designed to ensure that the manual prints
10 % out as advertised. If you mess with this preamble,
11 % parts of the manual may not print out as expected.  If you
12 % have problems LaTeXing this file, please contact 
13 % the documentation team
14 % email: lyx-docs@lists.lyx.org
15
16 % if pdflatex is used
17 \usepackage{ifpdf}
18 \ifpdf
19
20  % set fonts for nicer pdf view
21  \IfFileExists{lmodern.sty}
22   {\usepackage{lmodern}}{}
23
24 \fi % end if pdflatex is used
25
26 % the pages of the TOC are numbered roman
27 % and a PDF-bookmark for the TOC is added
28 \pagenumbering{roman}
29 \let\myTOC\tableofcontents
30 \renewcommand{\tableofcontents}{%
31  \pdfbookmark[1]{\contentsname}{}
32  \myTOC
33  \cleardoublepage
34  \pagenumbering{arabic}}
35
36 % redefine the \LyX macro for PDF bookmarks
37 \def\LyX{\texorpdfstring{%
38   L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
39   {LyX }}
40
41 % used for multi-column text
42 \usepackage{multicol}
43
44 % extra space for tables
45 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
46 \end_preamble
47 \options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
48 \begin_modules
49 logicalmkup
50 theorems-ams
51 theorems-ams-extended
52 \end_modules
53 \language english
54 \inputencoding latin1
55 \font_roman default
56 \font_sans default
57 \font_typewriter default
58 \font_default_family default
59 \font_sc false
60 \font_osf false
61 \font_sf_scale 100
62 \font_tt_scale 100
63
64 \graphics default
65 \paperfontsize 12
66 \spacing single
67 \use_hyperref true
68 \pdf_title "LyX's Extended manual"
69 \pdf_author "LyX Team"
70 \pdf_subject "LyX's extended documentation"
71 \pdf_keywords "LyX, Documentation, Extended"
72 \pdf_bookmarks true
73 \pdf_bookmarksnumbered true
74 \pdf_bookmarksopen false
75 \pdf_bookmarksopenlevel 1
76 \pdf_breaklinks false
77 \pdf_pdfborder false
78 \pdf_colorlinks true
79 \pdf_backref false
80 \pdf_pagebackref false
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,  pdfpagelayout=OneColumn, pdfnewwindow=true,  pdfstartview=XYZ, plainpages=false, pdfpagelabels"
83 \papersize default
84 \use_geometry false
85 \use_amsmath 0
86 \use_esint 0
87 \cite_engine basic
88 \use_bibtopic false
89 \paperorientation portrait
90 \secnumdepth 3
91 \tocdepth 3
92 \paragraph_separation indent
93 \defskip medskip
94 \quotes_language english
95 \papercolumns 1
96 \papersides 2
97 \paperpagestyle headings
98 \tracking_changes false
99 \output_changes false
100 \author "" 
101 \author "" 
102 \end_header
103
104 \begin_body
105
106 \begin_layout Title
107 Extended LyX Features
108 \end_layout
109
110 \begin_layout Author
111 by the LyX Team
112 \begin_inset Foot
113 status collapsed
114
115 \begin_layout Plain Layout
116 \noindent
117 Principal maintainer of this file is
118 \noun on
119  Richard Heck
120 \noun default
121 .
122  If you have comments or error corrections, please send them to the LyX
123  Documentation mailing list, 
124 \begin_inset Flex CharStyle:Code
125 status collapsed
126
127 \begin_layout Plain Layout
128 \noindent
129 <lyx-docs@lists.lyx.org>
130 \end_layout
131
132 \end_inset
133
134 .
135 \end_layout
136
137 \end_inset
138
139  
140 \end_layout
141
142 \begin_layout Standard
143 \begin_inset CommandInset toc
144 LatexCommand tableofcontents
145
146 \end_inset
147
148
149 \end_layout
150
151 \begin_layout Chapter
152 Introduction
153 \end_layout
154
155 \begin_layout Standard
156 The 
157 \emph on
158 Extended LyX Features
159 \emph default
160  manual, which you are now reading, is essentially Part II of the 
161 \emph on
162 User's Guide\SpecialChar \@.
163
164 \emph default
165  The reason for separating this document out is simple: the 
166 \emph on
167 User's Guide
168 \emph default
169  is already huge, and it contains all of the basic features one needs to
170  know in order to prepare most documents.
171  However, the LyX Team has a long-term goal of making LyX extensible through
172  various configuration files and external packages.
173  That means that if you want to support the Fizzwizzle LaTeX package, you
174  can create a layout file (or module) for it without having to alter LyX
175  itself.
176  We've already had contributions of several new features this way.
177  This is the place where all of that gets documented.
178 \end_layout
179
180 \begin_layout Standard
181 This manual also documents some special features, like fax support, version
182  control, and SGML support, which require additional software to work properly.
183  Lastly, there's a chapter of LaTeX tools and tips, things you can use to
184  spruce up your documents by directly using the powerful features of LaTeX.
185  After all, LyX 
186 \emph on
187 is
188 \emph default
189  only WYSIWYM and will only ever interface to some, not all, LaTeX features.
190 \end_layout
191
192 \begin_layout Standard
193 If you haven't read the 
194 \emph on
195 Introduction
196 \emph default
197  yet, you are definitely in the wrong manual.
198  The 
199 \emph on
200 Introduction
201 \emph default
202  is the first place to go, since it will direct you to the correct manual,
203  and it also describes the notation and format of all of the manuals.
204  You should also be thoroughly familiar with the 
205 \emph on
206 User's Guide
207 \emph default
208  and all of the basic features of LyX.
209  
210 \end_layout
211
212 \begin_layout Standard
213 In this document, many sections are independent articles contributed by
214  an individual and are noted as such.
215  This person is generally whoever wrote the layout file for the new document
216  class or LaTeX package, or implemented the feature.
217  If there is no mention of an author to a chapter [or chapter sections],
218  that means it was written by the LyX Documentation Team.
219 \end_layout
220
221 \begin_layout Standard
222 Since all the topics in this manual depend heavily on LyX's interaction
223  with LaTeX, this first chapter covers the inner workings of LyX and how
224  to direct LyX to generate exactly the LaTeX code you want.
225  It is obviously for more seasoned LyX users.
226 \end_layout
227
228 \begin_layout Chapter
229 LyX and LaTeX
230 \end_layout
231
232 \begin_layout Section
233 How LyX Uses LaTeX
234 \end_layout
235
236 \begin_layout Standard
237 This chapter is for both TeX-nicians and the LaTeX-curious.
238  In it, we'll explain how LyX and LaTeX work together to produce printable
239  output.
240  This is the only place in any of the manuals where we assume you know something
241  about LaTeX.
242 \end_layout
243
244 \begin_layout Standard
245 At one time, LyX was called a 
246 \begin_inset Quotes eld
247 \end_inset
248
249 WYSIWYM frontend to LaTeX,
250 \begin_inset Quotes erd
251 \end_inset
252
253  but that's no longer true.
254  There are frontends to LaTeX out there.
255  They are basically editors with the ability to run LaTeX and mark any errors
256  in the file you're editing.
257  Although LyX 
258 \emph on
259 is
260 \emph default
261  an editor, and it 
262 \emph on
263 does
264 \emph default
265  run LaTeX, and it also marks errors in the file, it also does much, much
266  more.
267  Thanks to the WYSIWYM concept, you don't need to know LaTeX to use LyX
268  effectively.
269  LyX has also added a few extensions to LaTeX.
270  Try the following sometime: select 
271 \family sans
272 Export\SpecialChar \menuseparator
273 LaTeX
274 \family default
275  from the 
276 \family sans
277 \bar under
278 F
279 \bar default
280 ile
281 \family default
282  menu (or 
283 \family sans
284 View\SpecialChar \menuseparator
285 Source
286 \family default
287 ), then look at the preamble of the resulting 
288 \family typewriter
289 .tex
290 \family default
291  file.
292  You'll notice a variety of new macros defined specifically by LyX.
293  These macros are defined automatically, according to the features you use
294  in the document.
295 \end_layout
296
297 \begin_layout Standard
298 There are several commands that automatically invoke LaTeX.
299  They are:
300 \end_layout
301
302 \begin_layout Itemize
303
304 \family sans
305 \bar under
306 V
307 \bar default
308 iew\SpecialChar \menuseparator
309 View
310 \begin_inset space ~
311 \end_inset
312
313
314 \emph on
315 Format
316 \end_layout
317
318 \begin_layout Itemize
319
320 \family sans
321 \bar under
322 V
323 \bar default
324 iew\SpecialChar \menuseparator
325
326 \bar under
327 U
328 \bar default
329 pdate\SpecialChar \menuseparator
330
331 \emph on
332 Format
333 \end_layout
334
335 \begin_layout Itemize
336
337 \family sans
338 \bar under
339 F
340 \bar default
341 ile
342 \bar under
343 \SpecialChar \menuseparator
344 P
345 \bar default
346 rint
347 \end_layout
348
349 \begin_layout Itemize
350
351 \family sans
352 \bar under
353 F
354 \bar default
355 ile
356 \bar under
357 \SpecialChar \menuseparator
358 F
359 \bar default
360 ax
361 \end_layout
362
363 \begin_layout Standard
364 They will only invoke LaTeX if the file has changed since the last time
365  LaTeX was run.
366  
367 \end_layout
368
369 \begin_layout Standard
370 When it runs LaTeX on the file you're editing, LyX performs these steps:
371 \end_layout
372
373 \begin_layout Enumerate
374 Convert the document to LaTeX and save to a file with the extension 
375 \family typewriter
376 .tex
377 \family default
378  in place of 
379 \family typewriter
380 .lyx
381 \family default
382 .
383 \end_layout
384
385 \begin_layout Enumerate
386 Run LaTeX on the 
387 \family typewriter
388 .tex
389 \family default
390  file (maybe several times), and run any other commands (such as bibtex
391  or makeindex) needed to compile the LaTeX file.
392 \end_layout
393
394 \begin_layout Enumerate
395 If there are any errors, show the error log.
396 \end_layout
397
398 \begin_layout Standard
399 If you've run LaTeX using 
400 \family sans
401 View
402 \begin_inset space ~
403 \end_inset
404
405 DVI
406 \family default
407 , LyX then runs a dvi viewer to display DVI-file.
408  If you've used 
409 \family sans
410 View
411 \begin_inset space ~
412 \end_inset
413
414 PostScript
415 \family default
416 , LyX performs further steps:
417 \end_layout
418
419 \begin_layout Itemize
420 Run 
421 \family typewriter
422 dvips
423 \family default
424  to convert the DVI file to PostScript®.
425 \end_layout
426
427 \begin_layout Itemize
428 Run a Postscript viewer, such as 
429 \family typewriter
430 ghostview
431 \family default
432 , to display the PostScript® file.
433 \end_layout
434
435 \begin_layout Standard
436 LyX does similar things when viewing, or exporting, other formats.
437 \end_layout
438
439 \begin_layout Section
440 Translating LaTeX files into LyX
441 \end_layout
442
443 \begin_layout Standard
444 You can import a LaTeX file into LyX by using the 
445 \family sans
446 \bar under
447 F
448 \bar default
449 ile\SpecialChar \menuseparator
450
451 \bar under
452 I
453 \bar default
454 mport\SpecialChar \menuseparator
455
456 \bar under
457 L
458 \bar default
459 aTeX
460 \family default
461  command in LyX.
462  This will call a program named 
463 \family typewriter
464 tex2lyx
465 \family default
466 ---which will create a file 
467 \family typewriter
468 foo.lyx
469 \family default
470  from the file 
471 \family typewriter
472 foo.tex
473 \family default
474 ---and then LyX will attempt to open that file.
475 \end_layout
476
477 \begin_layout Standard
478
479 \family typewriter
480 tex2lyx
481 \family default
482  will translate most legal LaTeX, but not everything.
483  It will put things it doesn't understand into ERT, so after translating
484  a file with 
485 \family typewriter
486 tex2lyx
487 \family default
488 , you can look for ERT and hand-edit it to look right.
489 \end_layout
490
491 \begin_layout Section
492 \begin_inset CommandInset label
493 LatexCommand label
494 name "sec:Inserting-TeX-Code"
495
496 \end_inset
497
498 Inserting TeX Code into LyX Documents 
499 \end_layout
500
501 \begin_layout Standard
502 This is a rather important point: You can always insert TeX code into any
503  LyX document.
504  LyX cannot, and will never be able to, display every possible LaTeX construct.
505  If ever you need to insert LaTeX commands into your LyX document, you can
506  use the TeX Code box, which you can insert into your document with 
507 \family sans
508 Insert\SpecialChar \menuseparator
509 TeX Code
510 \family default
511 .
512 \end_layout
513
514 \begin_layout Standard
515 Here's an example of inserting LaTeX commands in a LyX document.
516  The code looks like this:
517 \end_layout
518
519 \begin_layout LyX-Code
520
521 \backslash
522 begin{tabular}{ll}
523 \begin_inset Newline newline
524 \end_inset
525
526
527 \backslash
528 begin{minipage}{5cm}
529 \begin_inset Newline newline
530 \end_inset
531
532 This is an example for a minipage environment.
533  You 
534 \begin_inset Newline newline
535 \end_inset
536
537 can put nearly everything in it, even (non-floating) 
538 \begin_inset Newline newline
539 \end_inset
540
541 figures and tables.
542  
543 \begin_inset Newline newline
544 \end_inset
545
546
547 \backslash
548 end{minipage}
549 \begin_inset Newline newline
550 \end_inset
551
552 &
553 \begin_inset Newline newline
554 \end_inset
555
556
557 \backslash
558 begin{minipage}{5cm}
559 \begin_inset Newline newline
560 \end_inset
561
562
563 \backslash
564 begin{verbatim}
565 \begin_inset Newline newline
566 \end_inset
567
568
569 \backslash
570 begin{minipage}{5cm}
571 \begin_inset Newline newline
572 \end_inset
573
574 This ...
575  
576 \begin_inset Newline newline
577 \end_inset
578
579
580 \backslash
581 end{minipage}
582 \begin_inset Newline newline
583 \end_inset
584
585
586 \backslash
587 end{verbatim}
588 \begin_inset Newline newline
589 \end_inset
590
591
592 \backslash
593 end{minipage}
594 \begin_inset Newline newline
595 \end_inset
596
597
598 \backslash
599 end{tabular}
600 \end_layout
601
602 \begin_layout LyX-Code
603
604 \end_layout
605
606 \begin_layout Standard
607 The TeX Code box containing this text is directly after this paragraph.
608  Those of you reading the manual in LyX will only see the ERT inset.
609  Those reading a printed version of the manuals will see the actual results:
610 \end_layout
611
612 \begin_layout Standard
613 \begin_inset ERT
614 status collapsed
615
616 \begin_layout Plain Layout
617
618
619 \backslash
620 begin{tabular}{ll}
621 \end_layout
622
623 \begin_layout Plain Layout
624
625
626 \backslash
627 begin{minipage}{5cm}
628 \end_layout
629
630 \begin_layout Plain Layout
631
632 This is an example for a minipage environment.
633  You can put nearly everything in it, even (non-floating) figures and tables.
634  
635 \end_layout
636
637 \begin_layout Plain Layout
638
639
640 \backslash
641 end{minipage}
642 \end_layout
643
644 \begin_layout Plain Layout
645
646 &
647 \end_layout
648
649 \begin_layout Plain Layout
650
651
652 \backslash
653 begin{minipage}{5cm}
654 \end_layout
655
656 \begin_layout Plain Layout
657
658
659 \backslash
660 begin{verbatim}
661 \end_layout
662
663 \begin_layout Plain Layout
664
665
666 \backslash
667 begin{minipage}{5cm}
668 \end_layout
669
670 \begin_layout Plain Layout
671
672 This ...
673  
674 \end_layout
675
676 \begin_layout Plain Layout
677
678
679 \backslash
680 end{minipage}
681 \end_layout
682
683 \begin_layout Plain Layout
684
685
686 \backslash
687 end{verbatim}
688 \end_layout
689
690 \begin_layout Plain Layout
691
692
693 \backslash
694 end{minipage}
695 \end_layout
696
697 \begin_layout Plain Layout
698
699
700 \backslash
701 end{tabular}
702 \end_layout
703
704 \end_inset
705
706
707 \end_layout
708
709 \begin_layout Standard
710 In addition to using ERT, you can also create a separate file containing
711  some complex LaTeX structure and then use 
712 \family sans
713 Insert\SpecialChar \menuseparator
714 Child
715 \begin_inset space ~
716 \end_inset
717
718 Document
719 \family default
720  to include your file (you should select the type 
721 \family sans
722 Input
723 \family default
724 ).
725  We recommend that you only do this if you have a 
726 \family typewriter
727 .tex
728 \family default
729  file which you 
730 \emph on
731 know
732 \emph default
733  works already.
734  Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
735 .
736 \end_layout
737
738 \begin_layout Standard
739 There are a few last points to emphasize:
740 \end_layout
741
742 \begin_layout Itemize
743 Inside of LyX, LaTeX code appears 
744 \emph on
745 in red
746 \end_layout
747
748 \begin_layout Itemize
749 LyX 
750 \emph on
751 does not
752 \emph default
753  check if your LaTeX code is correct.
754 \end_layout
755
756 \begin_layout Itemize
757 Beware reinventing the wheel.
758 \end_layout
759
760 \begin_layout Standard
761 On that last point, LyX does have quite a few features tucked into it, and
762  more are coming.
763  Be sure to check the manuals to make sure that LyX doesn't have such-and-such
764  feature before you decide you have to do it by hand.
765  Moreover, there are numerous LaTeX packages out there to do all sorts of
766  things, from labels to envelopes to fancy multipage tables.
767  Check out 
768 \begin_inset CommandInset href
769 LatexCommand href
770 name "CTAN"
771 target "http://www.ctan.org/"
772
773 \end_inset
774
775  for details.
776 \end_layout
777
778 \begin_layout Standard
779 If you do need to do some wild and fancy things within your document, be
780  sure to check out a good LaTeX book for assistance.
781  There are a number of them listed in the bibliography of the 
782 \emph on
783 User's Guide
784 \emph default
785 .
786 \end_layout
787
788 \begin_layout Section
789 LyX and the LaTeX Preamble
790 \end_layout
791
792 \begin_layout Subsection
793 About the LaTeX Preamble
794 \end_layout
795
796 \begin_layout Standard
797 If you already know LaTeX, there is no need to explain here what the preamble
798  is good for.
799  If you don't, the following will give you some ideas---we recommend again
800  that you consult a LaTeX book for further information.
801  In any case, you should read the points below, because they explain what
802  you can do and what you don't need to do in the LaTeX preamble of a LyX
803  document.
804 \end_layout
805
806 \begin_layout Standard
807 The LaTeX preamble comes at the very beginning of a document, 
808 \emph on
809 before
810 \emph default
811  the text.
812  It serves to:
813 \end_layout
814
815 \begin_layout Itemize
816 declare the document class.
817  LyX already does this for you.
818 \end_layout
819
820 \begin_deeper
821 \begin_layout Standard
822 If you're a seasoned LaTeX-nician, and you have some custom document class
823  you want to use, check out the 
824 \emph on
825 Customization Manual
826 \emph default
827  for information on how to make LyX interface to it.
828  Be sure to submit your efforts to the LyX Team for inclusion in future
829  versions!
830 \end_layout
831
832 \end_deeper
833 \begin_layout Itemize
834 declare the usage of packages.
835  LaTeX packages provide special commands, which are only available within
836  a document when the package has been declared in the preamble.
837  For example, the package 
838 \family typewriter
839 indentfirst
840 \family default
841  forces all paragraphs to be indented.
842  There are other packages for labels, envelopes, margins, etc.
843  
844 \end_layout
845
846 \begin_layout Itemize
847 set counters, variables, lengths and widths.
848  There are several LaTeX counters and variables which 
849 \emph on
850 must
851 \emph default
852  be set globally from within the preamble in order to have the desired effect.
853  (There are variables which you can set and reset inside the document, too.)
854  Margins are a good example of something which must be set in the preamble.
855  Another example is the label format for lists.
856  You can actually set these just about anywhere, but it's best to do it
857  just once, inside the preamble.
858 \end_layout
859
860 \begin_layout Itemize
861 declare user defined commands [with 
862 \family typewriter
863
864 \backslash
865 newcommand
866 \family default
867  or 
868 \family typewriter
869
870 \backslash
871 renewcommand
872 \family default
873 ], mostly abbreviations for LaTeX commands which appear very often inside
874  a document.
875  Although the preamble is a good place to declare such commands, they 
876 \emph on
877 can
878 \emph default
879  be declared anywhere else (before they are used for the first time, of
880  course\SpecialChar \ldots{}
881 ).
882  This can be useful if there is a lot of raw LaTeX code in your document,
883  which normally should not be the case.
884 \end_layout
885
886 \begin_layout Standard
887 LyX adds its own set of definitions to the preamble of the 
888 \family typewriter
889 .tex
890 \family default
891  file it produces.
892  This makes LaTeX files generated by LyX portable.
893 \end_layout
894
895 \begin_layout Subsection
896 Changing the Preamble
897 \end_layout
898
899 \begin_layout Standard
900 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
901  can't change them without patching LyX itself.
902  You can, however, add your own stuff to the preamble by selecting 
903 \family sans
904 \bar under
905 L
906 \bar default
907 aTeX
908 \begin_inset space ~
909 \end_inset
910
911
912 \bar under
913 P
914 \bar default
915 reamble
916 \family default
917  in the 
918 \family sans
919 \bar under
920 D
921 \bar default
922 ocument
923 \family default
924 \SpecialChar \menuseparator
925
926 \family sans
927 \bar under
928 S
929 \bar default
930 ettings
931 \family default
932  dialog.
933  LyX adds anything in the 
934 \family sans
935 Preamble
936 \family default
937  dialog to its own built-in preamble.
938  Before adding your own declarations in the preamble, you should make sure
939  that LyX doesn't already support what you want to do (remember what we
940  said about reinventing the wheel?).
941  Also, 
942 \emph on
943 make sure your preamble code is correct
944 \emph default
945 .
946  LyX doesn't check it.
947 \end_layout
948
949 \begin_layout Subsection
950 Examples
951 \end_layout
952
953 \begin_layout Standard
954 Here are some examples of what you can add to a preamble, and what they
955  do:
956 \end_layout
957
958 \begin_layout Subsubsection
959 Example #1: Offsets
960 \end_layout
961
962 \begin_layout Standard
963 There are two variables under LaTeX that control page position: 
964 \family typewriter
965
966 \backslash
967 hoffset
968 \family default
969  and 
970 \family typewriter
971
972 \backslash
973 voffset
974 \family default
975 .
976  Their names should be self-explanatory.
977  These variables are useful if you think for a moment about computer labels.
978  Sometimes, the size of a print medium and the area of the medium that you
979  can actually print on aren't the same.
980  This is where 
981 \family typewriter
982
983 \backslash
984 hoffset
985 \family default
986  and 
987 \family typewriter
988
989 \backslash
990 voffset
991 \family default
992  come in.
993 \end_layout
994
995 \begin_layout Standard
996 The default values for 
997 \family typewriter
998
999 \backslash
1000 hoffset
1001 \family default
1002  and 
1003 \family typewriter
1004
1005 \backslash
1006 voffset
1007 \family default
1008  are both 0 pt., i.e., the page isn't shifted.
1009 \end_layout
1010
1011 \begin_layout Standard
1012 Unfortunately, some DVI drivers always seem to shift the page.
1013  We have no idea why, or why the sysadmin hasn't fixed such behavior.
1014  If you're using LyX on a system that you don't personally maintain, and
1015  your sysadmin is a doofus, 
1016 \family typewriter
1017
1018 \backslash
1019 hoffset
1020 \family default
1021  and 
1022 \family typewriter
1023
1024 \backslash
1025 voffset
1026 \family default
1027  can save the day.
1028  Suppose you're left and top margins are always 0.5 inches too big.
1029  You can add this to the preamble:
1030 \end_layout
1031
1032 \begin_layout LyX-Code
1033
1034 \backslash
1035 setlength{
1036 \backslash
1037 hoffset}{-0.5 in}
1038 \end_layout
1039
1040 \begin_layout LyX-Code
1041
1042 \backslash
1043 setlength{
1044 \backslash
1045 voffset}{-0.5 in}
1046 \end_layout
1047
1048 \begin_layout Standard
1049 and your margins should now be correct.
1050 \end_layout
1051
1052 \begin_layout Subsubsection
1053 Example #2: Labels
1054 \end_layout
1055
1056 \begin_layout Standard
1057 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1058  There's a rather nice package, available at your nearest CTAN archive,
1059  for printing sheets of labels: 
1060 \family typewriter
1061 labels.sty
1062 \family default
1063 .
1064  Now, your system may not have this package installed by default.
1065  We leave that up to you to check.
1066  You'll also want to read the documentation for it; we're not going to do
1067  that for you.
1068  Since this is an example, however, we'll give you an example of how you
1069  use this package.
1070 \end_layout
1071
1072 \begin_layout Standard
1073 First, make sure you're using the 
1074 \family sans
1075 article
1076 \family default
1077  document class.
1078  Next, you need to put the following in your preamble:
1079 \end_layout
1080
1081 \begin_layout LyX-Code
1082
1083 \backslash
1084 usepackage{labels}
1085 \end_layout
1086
1087 \begin_layout LyX-Code
1088
1089 \backslash
1090 LabelCols=3
1091 \end_layout
1092
1093 \begin_layout LyX-Code
1094
1095 \backslash
1096 LabelRows=7
1097 \end_layout
1098
1099 \begin_layout LyX-Code
1100
1101 \backslash
1102 LeftBorder=8mm
1103 \end_layout
1104
1105 \begin_layout LyX-Code
1106
1107 \backslash
1108 RightBorder=8mm
1109 \end_layout
1110
1111 \begin_layout LyX-Code
1112
1113 \backslash
1114 TopBorder=9mm
1115 \end_layout
1116
1117 \begin_layout LyX-Code
1118
1119 \backslash
1120 BottomBorder=2mm
1121 \end_layout
1122
1123 \begin_layout Standard
1124 This sets things up for Avery® label sheets, stock #5360.
1125  You're now ready to print labels, but you'll need to insert LaTeX code,
1126  placing the commands 
1127 \family typewriter
1128
1129 \backslash
1130 begin{labels}
1131 \family default
1132  and 
1133 \family typewriter
1134
1135 \backslash
1136 end{labels}
1137 \family default
1138  around each label text.
1139  This and other special features of 
1140 \family typewriter
1141 labels.sty
1142 \family default
1143  are explained in its documentation.
1144 \end_layout
1145
1146 \begin_layout Standard
1147 Someday, someone may write a LyX layout file to support this package directly.
1148  Maybe that someone is you.
1149 \end_layout
1150
1151 \begin_layout Subsubsection
1152 Example #3: Paragraph Indentation
1153 \end_layout
1154
1155 \begin_layout Standard
1156 Americans are trained to indent the first line of 
1157 \emph on
1158 every
1159 \emph default
1160  paragraph.
1161  As with all of their other weird quirks, most Americans will whine and
1162  moan until they can have their way and indent the first line of all paragraphs.
1163  (Yes, we're joking.
1164  Aren't we?)
1165 \end_layout
1166
1167 \begin_layout Standard
1168 Of course, this behavior isn't standard typography.
1169  In books, you typically only indent the first line of a paragraph 
1170 \emph on
1171 if
1172 \emph default
1173  it follows another one.
1174  The idea behind indenting the first line of a paragraph is to distinguish
1175  neighboring paragraphs from one another.
1176  If there is no previous paragraph, for example, it follows a figure, or
1177  is the first paragraph in a section, then there is no special indentation.
1178  
1179 \end_layout
1180
1181 \begin_layout Standard
1182 If you're a typical American, though, you don't care about such esoteric
1183  things; you want your indentation! Add this to the preamble:
1184 \end_layout
1185
1186 \begin_layout LyX-Code
1187
1188 \backslash
1189 usepackage{indentfirst}
1190 \end_layout
1191
1192 \begin_layout Standard
1193 If your TeX distribution isn't a braindead one, you'll have this package,
1194  and all of your paragraphs will get the indentation you think they deserve.
1195 \end_layout
1196
1197 \begin_layout Subsubsection
1198 Example #4: This Document
1199 \end_layout
1200
1201 \begin_layout Standard
1202 You can also check out the preamble of this document to get an idea of some
1203  of the advanced things you can do.
1204  Also, there are more examples and an assortment of LaTeX 
1205 \begin_inset Quotes eld
1206 \end_inset
1207
1208 dirty tricks
1209 \begin_inset Quotes erd
1210 \end_inset
1211
1212  given in Chapter
1213 \begin_inset space ~
1214 \end_inset
1215
1216
1217 \begin_inset CommandInset ref
1218 LatexCommand ref
1219 reference "cha:secrets"
1220
1221 \end_inset
1222
1223 .
1224  
1225 \end_layout
1226
1227 \begin_layout Section
1228 LyX and LaTeX Errors
1229 \end_layout
1230
1231 \begin_layout Standard
1232 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1233  going.
1234  It then uses the log-file from the LaTeX run to do a post-mortem.
1235  LyX will then display a dialog listing the errors, and clicking on any
1236  one of them will take you to the position in your LyX file where the error
1237  occurred.
1238 \end_layout
1239
1240 \begin_layout Standard
1241 Some folks also like to look at the log file directly, accessible from 
1242 \family sans
1243 \bar under
1244 D
1245 \bar default
1246 ocument\SpecialChar \menuseparator
1247
1248 \bar under
1249 L
1250 \bar default
1251 aTeX
1252 \begin_inset space ~
1253 \end_inset
1254
1255 Log
1256 \begin_inset space ~
1257 \end_inset
1258
1259 File
1260 \family default
1261 .
1262  There are some fairly common error messages and warnings.
1263  We'll cover those here.
1264  You should look at a good LaTeX book for a complete listing.
1265 \end_layout
1266
1267 \begin_layout Itemize
1268 \begin_inset Quotes eld
1269 \end_inset
1270
1271
1272 \family typewriter
1273 LaTeX Warning:
1274 \family default
1275
1276 \begin_inset Quotes eld
1277 \end_inset
1278
1279
1280 \end_layout
1281
1282 \begin_deeper
1283 \begin_layout Standard
1284 Anything beginning with these word is a warning message for the purpose
1285  of 
1286 \begin_inset Quotes eld
1287 \end_inset
1288
1289 debugging
1290 \begin_inset Quotes erd
1291 \end_inset
1292
1293  the LaTeX code itself.
1294  You'll get messages like this if you added or changed cross-references
1295  or bibliography entries, in which case, LaTeX is trying to tell you that
1296  you need to make another run.
1297 \end_layout
1298
1299 \begin_layout Standard
1300 You can by-and-large ignore these.
1301 \end_layout
1302
1303 \end_deeper
1304 \begin_layout Itemize
1305 \begin_inset Quotes eld
1306 \end_inset
1307
1308
1309 \family typewriter
1310 LaTeX Font Warning:
1311 \family default
1312
1313 \begin_inset Quotes erd
1314 \end_inset
1315
1316
1317 \end_layout
1318
1319 \begin_deeper
1320 \begin_layout Standard
1321 Another warning message, this time about fonts which LaTeX couldn't find.
1322  The rest of the message will often say something about a replacement font
1323  that LaTeX used.
1324 \end_layout
1325
1326 \begin_layout Standard
1327 You can safely ignore these.
1328 \end_layout
1329
1330 \end_deeper
1331 \begin_layout Itemize
1332 \begin_inset Quotes eld
1333 \end_inset
1334
1335
1336 \family typewriter
1337 Overfull 
1338 \backslash
1339 hbox
1340 \family default
1341
1342 \begin_inset Quotes erd
1343 \end_inset
1344
1345
1346 \end_layout
1347
1348 \begin_deeper
1349 \begin_layout Standard
1350 LaTeX absolutely 
1351 \emph on
1352 loves
1353 \emph default
1354  to spew these out.
1355  They are warning you about lines that were too long and run past the right
1356  margin.
1357  Almost always, this is unnoticeable in the final output.
1358  Or, only one or two characters extend past the margin.
1359  LaTeX seems to generate at least one of these messages for just about any
1360  document you write.
1361 \end_layout
1362
1363 \begin_layout Standard
1364 You can ignore these stupid messages.
1365  Your eyes will tell you if there's a problem with something that's too
1366  wide; just look at the output.
1367 \end_layout
1368
1369 \end_deeper
1370 \begin_layout Itemize
1371 \begin_inset Quotes eld
1372 \end_inset
1373
1374
1375 \family typewriter
1376 Underfull 
1377 \backslash
1378 hbox
1379 \family default
1380
1381 \begin_inset Quotes erd
1382 \end_inset
1383
1384
1385 \end_layout
1386
1387 \begin_deeper
1388 \begin_layout Standard
1389 Not quite as common as its cousin.
1390  LaTeX seems to like to print lines that are a bit too wide as opposed to
1391  ones that are a bit too narrow.
1392  We have no idea why.
1393 \end_layout
1394
1395 \begin_layout Standard
1396 You can ignore these, too.
1397 \end_layout
1398
1399 \end_deeper
1400 \begin_layout Itemize
1401 \begin_inset Quotes eld
1402 \end_inset
1403
1404
1405 \family typewriter
1406 Overfull 
1407 \backslash
1408 vbox
1409 \family default
1410
1411 \begin_inset Quotes erd
1412 \end_inset
1413
1414  and 
1415 \begin_inset Quotes eld
1416 \end_inset
1417
1418
1419 \family typewriter
1420 Underfull 
1421 \backslash
1422 vbox
1423 \family default
1424
1425 \begin_inset Quotes erd
1426 \end_inset
1427
1428
1429 \end_layout
1430
1431 \begin_deeper
1432 \begin_layout Standard
1433 Warnings about troubles breaking the page.
1434  Once again, just look at the output.
1435  Your eyes will tell you where something has gone wrong.
1436 \end_layout
1437
1438 \end_deeper
1439 \begin_layout Itemize
1440 \begin_inset Quotes eld
1441 \end_inset
1442
1443  
1444 \family typewriter
1445 LaTeX Error: File 
1446 \begin_inset Quotes els
1447 \end_inset
1448
1449 Xxxx
1450 \begin_inset Quotes ers
1451 \end_inset
1452
1453  not found
1454 \family default
1455
1456 \begin_inset Quotes erd
1457 \end_inset
1458
1459  
1460 \end_layout
1461
1462 \begin_deeper
1463 \begin_layout Standard
1464 The file 
1465 \begin_inset Quotes eld
1466 \end_inset
1467
1468 Xxxx
1469 \begin_inset Quotes erd
1470 \end_inset
1471
1472  isn't installed on this system.
1473  This usually appears because some package your document needs isn't installed.
1474  If you didn't touch the preamble or didn't use the 
1475 \family typewriter
1476
1477 \backslash
1478 usepackage{}
1479 \family default
1480  command, then one of the packages LyX tried to load is missing.
1481  Use 
1482 \family sans
1483 \bar under
1484 H
1485 \bar default
1486 elp\SpecialChar \menuseparator
1487 L
1488 \bar under
1489 a
1490 \bar default
1491 TeX Configuration
1492 \family default
1493  to get a list of packages that LyX knows about.
1494  This file is updated whenever you reconfigure LyX (using 
1495 \family sans
1496 \bar under
1497 T
1498 \bar default
1499 ools
1500 \bar under
1501 \SpecialChar \menuseparator
1502 R
1503 \bar default
1504 econfigure
1505 \family default
1506 ) and tells you which packages have been detected and what they do.
1507 \end_layout
1508
1509 \begin_layout Standard
1510 If you 
1511 \emph on
1512 did
1513 \emph default
1514  use the 
1515 \family typewriter
1516
1517 \backslash
1518 usepackage{}
1519 \family default
1520  command and the package in question isn't installed, then you'll need to
1521  install it yourself.
1522 \end_layout
1523
1524 \end_deeper
1525 \begin_layout Itemize
1526 \begin_inset Quotes eld
1527 \end_inset
1528
1529
1530 \family typewriter
1531 LaTeX Error: Unknown option
1532 \family default
1533
1534 \begin_inset Quotes erd
1535 \end_inset
1536
1537
1538 \end_layout
1539
1540 \begin_deeper
1541 \begin_layout Standard
1542 Error messages beginning with this are trying to tell you that you specified
1543  a bad or undefined option to a package.
1544  Check the package's documentation.
1545 \end_layout
1546
1547 \end_deeper
1548 \begin_layout Itemize
1549 \begin_inset Quotes eld
1550 \end_inset
1551
1552
1553 \family typewriter
1554 Undefined control sequence
1555 \family default
1556
1557 \begin_inset Quotes erd
1558 \end_inset
1559
1560
1561 \end_layout
1562
1563 \begin_deeper
1564 \begin_layout Standard
1565 If you've inserted LaTeX code into your document, but made a typo, you'll
1566  get one of these.
1567  You may have forgotten to load a package.
1568  In any case, this error message usually means that you used an undefined
1569  command.
1570  
1571 \end_layout
1572
1573 \end_deeper
1574 \begin_layout Standard
1575 There are other error and warning messages.
1576  Some are self-explanatory.
1577  These are usually LaTeX messages.
1578  Others are downright cryptic.
1579  These are actually TeX error messages, and we really have 
1580 \emph on
1581 no clue
1582 \emph default
1583  what they mean or how to decipher them.
1584 \end_layout
1585
1586 \begin_layout Standard
1587 There's a general sequence you should follow if you get error messages:
1588 \end_layout
1589
1590 \begin_layout Enumerate
1591 Look at the LaTeX code you inserted for typos.
1592 \end_layout
1593
1594 \begin_layout Enumerate
1595 If there are no typos, check that you used the command(s) correctly.
1596 \end_layout
1597
1598 \begin_layout Enumerate
1599 If you get a bunch of error boxes piled up at the very top of the document,
1600  it means that there are errors in the preamble.
1601  Start debugging your preamble.
1602 \end_layout
1603
1604 \begin_layout Enumerate
1605 If you didn't add anything to the preamble and didn't add any LaTeX code
1606  to the document, the first suspect is your LaTeX distribution itself.
1607  Check for missing packages and install them.
1608 \end_layout
1609
1610 \begin_layout Enumerate
1611 Okay, so there are no missing packages.
1612  Did you use any of the fine-tuning options in LyX? Specifically, did you
1613  
1614 \emph on
1615 misuse
1616 \emph default
1617  any of them, like trying to manually insert lots of 
1618 \family sans
1619 Protected
1620 \begin_inset space ~
1621 \end_inset
1622
1623 Blank
1624 \family default
1625 s, 
1626 \family sans
1627 Linebreak
1628 \family default
1629 s, or 
1630 \family sans
1631 Pagebreak
1632 \family default
1633 s? Did you try to kludge something together with these instead of using
1634  the appropriate paragraph environment?
1635 \end_layout
1636
1637 \begin_layout Enumerate
1638 All right, you didn't use any of the fine-tuning options, you played by
1639  the rules.
1640  Did you try to pull a fancy maneuver? Did you do something funky inside
1641  a table or an equation, like inserting a graphic into a table cell?
1642 \end_layout
1643
1644 \begin_layout Enumerate
1645 Do you have long sections of text where LaTeX cannot find a place to break
1646  a line? By default, LaTeX is rather strict about how much extra inter-word
1647  spacing it will add in order to break a line.
1648  Preferably, you should rework the paragraph to avoid the problem.
1649  If this isn't an option, you can wrap your text in 
1650 \family typewriter
1651
1652 \backslash
1653 sloppypar
1654 \family default
1655  to make LaTeX's line breaking more, well, sloppy.
1656 \end_layout
1657
1658 \begin_layout Enumerate
1659 Did you go overboard with the nesting? LyX (currently) doesn't check to
1660  make sure you're in the limits for nesting environments.
1661  If you nested a bunch of environments to the 
1662 \begin_inset Formula $17^{\mathrm{th}}$
1663 \end_inset
1664
1665  level, that's the problem.
1666 \end_layout
1667
1668 \begin_layout Enumerate
1669 Okay, you didn't get any error messages, but your output looks whacked.
1670  If you have a table or figure that's too wide or long for the page, you
1671  need to:
1672 \end_layout
1673
1674 \begin_deeper
1675 \begin_layout Enumerate
1676 rescale the figure so it fits.
1677 \end_layout
1678
1679 \begin_layout Enumerate
1680 trim down the table so it fits.
1681 \end_layout
1682
1683 \begin_layout Standard
1684 If something else is wrong with the output, and you didn't try to pull anything
1685  fancy or kludge the fine-tuning options, we're not sure what's wrong.
1686 \end_layout
1687
1688 \end_deeper
1689 \begin_layout Standard
1690 If all this doesn't help --- well, then 
1691 \emph on
1692 perhaps
1693 \emph default
1694  you might have found a bug in LyX\SpecialChar \ldots{}
1695 .
1696 \end_layout
1697
1698 \begin_layout Chapter
1699 Supplemental Tools
1700 \end_layout
1701
1702 \begin_layout Section
1703 Customizing Bibliographies with BibTeX
1704 \end_layout
1705
1706 \begin_layout Standard
1707 The basics how to use BibTeX are explained in section 
1708 \emph on
1709 Bibliography databases (BibTeX)
1710 \emph default
1711  of the 
1712 \emph on
1713 User's Guide
1714 \emph default
1715 .
1716  The following subsections explain special bibliography features supported
1717  by LyX.
1718 \end_layout
1719
1720 \begin_layout Subsection
1721 Alternative Citation Styles
1722 \end_layout
1723
1724 \begin_layout Standard
1725 Standard BibTeX uses numbers (e.g., 
1726 \begin_inset Quotes eld
1727 \end_inset
1728
1729 [12]
1730 \begin_inset Quotes erd
1731 \end_inset
1732
1733 ) to refer to a cited work.
1734  However, in many scientific disciplines, other citation styles are in use.
1735  The most common one is the author-year style (e.g., 
1736 \begin_inset Quotes eld
1737 \end_inset
1738
1739 Knuth 1984a
1740 \begin_inset Quotes erd
1741 \end_inset
1742
1743 ).
1744  LyX supports two packages that provide this style, 
1745 \family typewriter
1746 natbib
1747 \family default
1748  and 
1749 \family typewriter
1750 jurabib
1751 \family default
1752 .
1753  Both packages have their own pros and cons, which cannot be listed in detail.
1754  If you only want to have simple author-year (or author-numerical) style
1755  or if you want to use one of the countless style files for natbib, than
1756  the established 
1757 \family typewriter
1758 natbib
1759 \family default
1760  package is probably your choice.
1761  If you need special features like short title references, ibidem etc., you
1762  might consider the fairly new 
1763 \family typewriter
1764 jurabib
1765 \family default
1766  package.
1767 \end_layout
1768
1769 \begin_layout Standard
1770 The handling of both packages in LyX is basically the same.
1771  Go to 
1772 \family sans
1773 Document\SpecialChar \menuseparator
1774 Settings
1775 \family default
1776  and select under 
1777 \family sans
1778 Bibliography
1779 \family default
1780  the option 
1781 \family sans
1782 Natbib
1783 \family default
1784  or 
1785 \family sans
1786 Jurabib
1787 \family default
1788 .
1789  With both packages, you will get some extra features in the citation dialog
1790  and you can select the style of the reference (
1791 \begin_inset Quotes eld
1792 \end_inset
1793
1794 Knuth 1984
1795 \begin_inset Quotes erd
1796 \end_inset
1797
1798
1799 \begin_inset Quotes eld
1800 \end_inset
1801
1802 Knuth (1984)
1803 \begin_inset Quotes erd
1804 \end_inset
1805
1806
1807 \begin_inset Quotes eld
1808 \end_inset
1809
1810 Knuth, 1984
1811 \begin_inset Quotes erd
1812 \end_inset
1813
1814
1815 \begin_inset Quotes eld
1816 \end_inset
1817
1818 1984
1819 \begin_inset Quotes erd
1820 \end_inset
1821
1822  etc.).
1823  Note that both packages need specifically designed style files (they both
1824  ship their own, while there are lots of additional style files and even
1825  an interactive style file builder
1826 \begin_inset Foot
1827 status collapsed
1828
1829 \begin_layout Plain Layout
1830 See 
1831 \begin_inset Flex URL
1832 status open
1833
1834 \begin_layout Plain Layout
1835
1836 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
1837 \end_layout
1838
1839 \end_inset
1840
1841
1842 \end_layout
1843
1844 \end_inset
1845
1846  for 
1847 \family typewriter
1848 natbib
1849 \family default
1850  available).
1851 \end_layout
1852
1853 \begin_layout Subsection
1854 Sectioned Bibliographies
1855 \end_layout
1856
1857 \begin_layout Standard
1858 Sometimes you might need to divide your bibliography into several sections.
1859  If you are for instance a historian, the possibility to separate sources
1860  and scientific works is most likely a 
1861 \begin_inset Quotes eld
1862 \end_inset
1863
1864 must have
1865 \begin_inset Quotes erd
1866 \end_inset
1867
1868 .
1869  Unfortunately, BibTeX itself does not allow you to do this.
1870  But with the help of some LaTeX packages, BibTeX can be extended to fit
1871  your needs.
1872 \end_layout
1873
1874 \begin_layout Standard
1875 LyX provides native support for one of these packages, 
1876 \family typewriter
1877 bibtopic
1878 \family default
1879 .
1880 \begin_inset Foot
1881 status collapsed
1882
1883 \begin_layout Plain Layout
1884 Available from 
1885 \begin_inset Flex URL
1886 status open
1887
1888 \begin_layout Plain Layout
1889
1890 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
1891 \end_layout
1892
1893 \end_inset
1894
1895
1896 \end_layout
1897
1898 \end_inset
1899
1900  The advantage of this package (compared to other packages like 
1901 \family typewriter
1902 multibib
1903 \family default
1904 ) is that you don't need to define new citation commands.
1905  Instead, you need to prepare different bibliographic databases which include
1906  the entries for the different sections of the bibliography.
1907  For example: If you want to divide your bibliography into the sections
1908  
1909 \begin_inset Quotes eld
1910 \end_inset
1911
1912 Sources
1913 \begin_inset Quotes erd
1914 \end_inset
1915
1916  and 
1917 \begin_inset Quotes eld
1918 \end_inset
1919
1920 Scientific works
1921 \begin_inset Quotes erd
1922 \end_inset
1923
1924 , you first need to create two bibliographic databases, e.
1925 \begin_inset space \thinspace{}
1926 \end_inset
1927
1928 g.
1929 \begin_inset space \space{}
1930 \end_inset
1931
1932
1933 \family typewriter
1934 sources.bib
1935 \family default
1936  and 
1937 \family typewriter
1938 scientific.bib
1939 \family default
1940 .
1941  
1942 \end_layout
1943
1944 \begin_layout Standard
1945 Go in LyX to 
1946 \family sans
1947 Document\SpecialChar \menuseparator
1948 Settings
1949 \family default
1950  and check under 
1951 \family sans
1952 Bibliography
1953 \family default
1954  the option 
1955 \family sans
1956 Sectioned
1957 \begin_inset space ~
1958 \end_inset
1959
1960 bibliography
1961 \family default
1962 .
1963  Now you can insert multiple BibTeX bibliographies, one for each section
1964  of your bibliography.
1965  Returning to our example: Insert the BibTeX bibliography 
1966 \family typewriter
1967 sources.bib
1968 \family default
1969  and a second one for the database 
1970 \family typewriter
1971 scientific.bib
1972 \family default
1973 .
1974  You are free to use the same or different styles for each section.
1975  Additionally, you can chose if the bibliography section should contain
1976  
1977 \begin_inset Quotes eld
1978 \end_inset
1979
1980 all cited references
1981 \begin_inset Quotes erd
1982 \end_inset
1983
1984  of the specified database(s) (which is the default), 
1985 \begin_inset Quotes eld
1986 \end_inset
1987
1988 all uncited references
1989 \begin_inset Quotes erd
1990 \end_inset
1991
1992  or even 
1993 \begin_inset Quotes eld
1994 \end_inset
1995
1996 all references
1997 \begin_inset Quotes erd
1998 \end_inset
1999
2000 .
2001  This might be useful if you would like to separate your bibliography into
2002  three sections: 
2003 \begin_inset Quotes eld
2004 \end_inset
2005
2006 Cited sources
2007 \begin_inset Quotes erd
2008 \end_inset
2009
2010
2011 \begin_inset Quotes eld
2012 \end_inset
2013
2014 Uncited sources
2015 \begin_inset Quotes erd
2016 \end_inset
2017
2018 , and 
2019 \begin_inset Quotes eld
2020 \end_inset
2021
2022 Scientific works
2023 \begin_inset Quotes erd
2024 \end_inset
2025
2026 .
2027  The titles for the sections can be added as ordinary sections or subsections.
2028  Since 
2029 \family typewriter
2030 bibtopic
2031 \family default
2032  removes the bibliography title, you have manually re-add that, too (as
2033  a chapter* or section*, for instance).
2034 \end_layout
2035
2036 \begin_layout Subsection
2037 Multiple Bibliographies
2038 \end_layout
2039
2040 \begin_layout Standard
2041 Multiple bibliographies, e.
2042 \begin_inset space \thinspace{}
2043 \end_inset
2044
2045 g.
2046 \begin_inset space \space{}
2047 \end_inset
2048
2049 a bibliography for each section or chapter of the document, are not supported
2050  by BibTeX itself.
2051  But the 
2052 \family typewriter
2053 bibtopic
2054 \family default
2055  package, which is used for the creation of sectioned bibliographies in
2056  LyX (see the previous section), provides an easy way to solve this task,
2057  if you are willing to use some TeX Code (see section
2058 \begin_inset space ~
2059 \end_inset
2060
2061
2062 \begin_inset CommandInset ref
2063 LatexCommand ref
2064 reference "sec:Inserting-TeX-Code"
2065
2066 \end_inset
2067
2068 ).
2069 \begin_inset Foot
2070 status collapsed
2071
2072 \begin_layout Plain Layout
2073 An alternative approach is to use the 
2074 \family typewriter
2075 chapterbib
2076 \family default
2077  or 
2078 \family typewriter
2079 bibunits
2080 \family default
2081  package, respectively.
2082 \end_layout
2083
2084 \end_inset
2085
2086
2087 \end_layout
2088
2089 \begin_layout Standard
2090 First go to 
2091 \family sans
2092 Document\SpecialChar \menuseparator
2093 Settings
2094 \family default
2095  and under 
2096 \family sans
2097 Bibliography
2098 \family default
2099  check 
2100 \family sans
2101 Sectioned
2102 \begin_inset space ~
2103 \end_inset
2104
2105 bibliography
2106 \family default
2107 .
2108  In the document, you have to enclose the sections, which shall contain
2109  their own bibliography (including the BibTeX bibliography itself), between
2110  
2111 \family typewriter
2112
2113 \backslash
2114 begin{btUnit}
2115 \family default
2116  and 
2117 \family typewriter
2118
2119 \backslash
2120 end{btUnit}
2121 \family default
2122  (those commands have to be inserted as ERT).
2123  The bibliography will contain all references which have been cited in the
2124  current btUnit.
2125  
2126 \series bold
2127 Note:
2128 \series default
2129  If you are using this approach, then 
2130 \emph on
2131 every
2132 \emph default
2133  citation reference has to be inside some btUnit.
2134  Also, the btUnits cannot be nested.
2135 \end_layout
2136
2137 \begin_layout Standard
2138
2139 \end_layout
2140
2141 \begin_layout Section
2142 Multipart Documents
2143 \end_layout
2144
2145 \begin_layout Subsection
2146 General Operation
2147 \end_layout
2148
2149 \begin_layout Standard
2150 When you are working on a large file with many sections, it is often convenient
2151  to break up the document into several files, or perhaps you have something
2152  where a table may change from time to time, but the preceding text does
2153  not.
2154  In these cases, you should seriously consider using multipart documents.
2155  For example, scientific papers often have five major sections: the introduction
2156 , observations, results, discussion, and conclusion.
2157  Each of these could be its own separate LyX file, with one 
2158 \begin_inset Quotes eld
2159 \end_inset
2160
2161 master
2162 \begin_inset Quotes erd
2163 \end_inset
2164
2165  file which contains the title, authors, abstract, references, etc., plus
2166  the five included files.
2167  It is important to note that each of these files is a full LyX file which
2168  can be formatted and printed on its own, as well as included in a master
2169  file.
2170  Each of these files must have the same document class, however--- don't
2171  attempt to mix book classes with article classes.
2172  You may also include LaTeX files; however, these files must not have their
2173  own preamble 
2174 \emph on
2175 (i.e.
2176
2177 \emph default
2178  everything up to and including the 
2179 \family typewriter
2180
2181 \backslash
2182 begin{document}
2183 \family default
2184  line as well as the 
2185 \family typewriter
2186
2187 \backslash
2188 end{document}
2189 \family default
2190  line must be deleted) or else errors will be generated when you try to
2191  make a DVI file.
2192 \end_layout
2193
2194 \begin_layout Standard
2195 LyX allows you to include files quite easily with 
2196 \family sans
2197 Insert\SpecialChar \menuseparator
2198 ChiId
2199 \begin_inset space ~
2200 \end_inset
2201
2202 Document
2203 \family default
2204 .
2205  When you click on this selection a small box is inserted into the file
2206  at the current cursor location.
2207  Clicking on the box raises a dialog which allows you to select the file
2208  to be included, and the method of its inclusion.
2209  
2210 \end_layout
2211
2212 \begin_layout Standard
2213 The file selection box should by now be obvious.
2214  The three inclusion methods are 
2215 \begin_inset Quotes eld
2216 \end_inset
2217
2218 include
2219 \begin_inset Quotes erd
2220 \end_inset
2221
2222
2223 \begin_inset Quotes eld
2224 \end_inset
2225
2226 input
2227 \begin_inset Quotes erd
2228 \end_inset
2229
2230 , and 
2231 \begin_inset Quotes eld
2232 \end_inset
2233
2234 verbatim
2235 \begin_inset Quotes erd
2236 \end_inset
2237
2238 .
2239  The difference between 
2240 \begin_inset Quotes eld
2241 \end_inset
2242
2243 include
2244 \begin_inset Quotes erd
2245 \end_inset
2246
2247  and 
2248 \begin_inset Quotes eld
2249 \end_inset
2250
2251 input
2252 \begin_inset Quotes erd
2253 \end_inset
2254
2255  is really only meaningful to LaTeXperts, but the practical difference is
2256  that files which are 
2257 \begin_inset Quotes eld
2258 \end_inset
2259
2260 included
2261 \begin_inset Quotes erd
2262 \end_inset
2263
2264  are typeset beginning on a new page, while files which are 
2265 \begin_inset Quotes eld
2266 \end_inset
2267
2268 inputted
2269 \begin_inset Quotes erd
2270 \end_inset
2271
2272  are typeset starting on the current page.
2273  Perhaps the labeling in LyX will be changed someday to reflect this.
2274 \end_layout
2275
2276 \begin_layout Standard
2277 Generally, the master file is converted into a full LaTeX file before typesettin
2278 g, while the included files are converted to LaTeX files which do not have
2279  all the preamble information.
2280  Checking the 
2281 \family sans
2282 Don't
2283 \family default
2284
2285 \begin_inset space ~
2286 \end_inset
2287
2288
2289 \family sans
2290 typeset
2291 \family default
2292  button prevents this conversion.
2293 \end_layout
2294
2295 \begin_layout Standard
2296
2297 \begin_inset Quotes eld
2298 \end_inset
2299
2300 verbatim
2301 \begin_inset Quotes erd
2302 \end_inset
2303
2304  included file allows you to include a file typeset exactly as it appears
2305  in the file, i.e.
2306 \begin_inset space ~
2307 \end_inset
2308
2309 verbatim mode, with the characters set in a fixed-width typewriter font.
2310  Normally, spaces in this file are invisible, though two consecutive spaces
2311  are conserved, unlike LyX's normal treatment of spaces.
2312  However, setting the 
2313 \family sans
2314 Mark
2315 \begin_inset space ~
2316 \end_inset
2317
2318 spaces
2319 \begin_inset space ~
2320 \end_inset
2321
2322 in
2323 \begin_inset space ~
2324 \end_inset
2325
2326 output
2327 \family default
2328  checkbox typesets a mark to unambiguously define the presence of a space.
2329  
2330 \end_layout
2331
2332 \begin_layout Subsection
2333 Cross-References Between Files
2334 \end_layout
2335
2336 \begin_layout Standard
2337 It is possible to set up cross-references between the different files.
2338  First, open all the files in question: let's call them A and B in a two
2339  file example, where B is included in A.
2340  Let's say you insert a label in A, then want to reference it in B.
2341  Open the cross-reference dialog in whilst in document B, and you can select
2342  the 
2343 \begin_inset Quotes eld
2344 \end_inset
2345
2346 buffer
2347 \begin_inset Quotes erd
2348 \end_inset
2349
2350  to use.
2351 \end_layout
2352
2353 \begin_layout Subsection
2354 Bibliography Lists in all Subdocuments
2355 \end_layout
2356
2357 \begin_layout Standard
2358 Copy the bibliography list with all entries to all subdocuments and transform
2359  them to a comment.
2360  This way LyX will find the 
2361 \family typewriter
2362 .bib
2363 \family default
2364 -files and you can easily insert references without making the bibliography
2365  list visible.
2366 \end_layout
2367
2368 \begin_layout Standard
2369 As the bibliography list is in a comment, LaTeX won't use use it and the
2370  references will look like this [?] instead of [1].
2371  A solution is to use the LaTeX-package 
2372 \family typewriter
2373 comment
2374 \family default
2375  that will only include comments by processing the files separately.
2376  To do this, add in the LaTeX preamble of every subdocument the following:
2377 \end_layout
2378
2379 \begin_layout LyX-Code
2380
2381 \backslash
2382 usepackage{comment}
2383 \end_layout
2384
2385 \begin_layout LyX-Code
2386
2387 \backslash
2388 includecomment{comment}
2389 \end_layout
2390
2391 \begin_layout Standard
2392 See also 
2393 \begin_inset Flex URL
2394 status collapsed
2395
2396 \begin_layout Plain Layout
2397
2398 http://wiki.lyx.org/FAQ/Unsorted#toc31
2399 \end_layout
2400
2401 \end_inset
2402
2403 .
2404 \end_layout
2405
2406 \begin_layout Section
2407 Fancy Headers and Footers
2408 \end_layout
2409
2410 \begin_layout Standard
2411 The default page layout is rather plain; for an article document class,
2412  all you get is a centered page number at the bottom of the page.
2413  This document is the book class, so it appears to be a bit fancier, but
2414  to really put on a show, you need to set the document page style to 
2415 \begin_inset Quotes eld
2416 \end_inset
2417
2418 fancy
2419 \begin_inset Quotes erd
2420 \end_inset
2421
2422 , as mentioned in the 
2423 \family sans
2424 User
2425 \begin_inset space ~
2426 \end_inset
2427
2428 Guide
2429 \family default
2430 .
2431  This section describes the LaTeX codes you need to insert in your LaTeX
2432  preamble or the text in order to get the desired effects.
2433 \end_layout
2434
2435 \begin_layout Standard
2436 The page header is divided into three fields, not surprisingly labeled 
2437 \begin_inset Quotes eld
2438 \end_inset
2439
2440 left
2441 \begin_inset Quotes erd
2442 \end_inset
2443
2444
2445 \begin_inset Quotes eld
2446 \end_inset
2447
2448 center
2449 \begin_inset Quotes erd
2450 \end_inset
2451
2452 , and 
2453 \begin_inset Quotes eld
2454 \end_inset
2455
2456 right
2457 \begin_inset Quotes erd
2458 \end_inset
2459
2460 .
2461  The footer is also divided into these three fields.
2462  The LaTeX commands to set these fields in the simplest manner are 
2463 \family typewriter
2464
2465 \backslash
2466 lhead
2467 \family default
2468
2469 \family typewriter
2470
2471 \backslash
2472 chead
2473 \family default
2474
2475 \family typewriter
2476
2477 \backslash
2478 rhead
2479 \family default
2480
2481 \family typewriter
2482
2483 \backslash
2484 lfoot
2485 \family default
2486 , etc.
2487  Suppose you wish to put your name in the upper left hand corner of each
2488  page.
2489  Simply insert the following command in the preamble: 
2490 \end_layout
2491
2492 \begin_layout Standard
2493
2494 \family typewriter
2495
2496 \backslash
2497 lhead{John Q.
2498  DocWriter}
2499 \end_layout
2500
2501 \begin_layout Standard
2502 You will now see your name in the upper left.
2503  If a field has a default entry that you would like to get rid of (often
2504  the page number appears in the central footer, simply include a command
2505  with a blank argument, e.
2506 \begin_inset space \thinspace{}
2507 \end_inset
2508
2509 g.
2510 \end_layout
2511
2512 \begin_layout Standard
2513
2514 \family typewriter
2515
2516 \backslash
2517 cfoot{}
2518 \end_layout
2519
2520 \begin_layout Standard
2521 Let's get really fancy: lets put the section number with the word 
2522 \begin_inset Quotes eld
2523 \end_inset
2524
2525 Section
2526 \begin_inset Quotes erd
2527 \end_inset
2528
2529  (e.
2530 \begin_inset space \thinspace{}
2531 \end_inset
2532
2533 g.
2534 \begin_inset space ~
2535 \end_inset
2536
2537 Section 3) in the upper left, the page number (e.
2538 \begin_inset space \thinspace{}
2539 \end_inset
2540
2541 g.
2542 \begin_inset space ~
2543 \end_inset
2544
2545 Page 4) in the upper right, your name in the lower left, and the date in
2546  the lower right.
2547  The following commands should now appear in the preamble:
2548 \end_layout
2549
2550 \begin_layout Standard
2551
2552 \family typewriter
2553
2554 \backslash
2555 lhead{Section 
2556 \backslash
2557 thesection}
2558 \end_layout
2559
2560 \begin_layout Standard
2561
2562 \family typewriter
2563
2564 \backslash
2565 chead{}
2566 \end_layout
2567
2568 \begin_layout Standard
2569
2570 \family typewriter
2571
2572 \backslash
2573 rhead{Page 
2574 \backslash
2575 thepage}
2576 \end_layout
2577
2578 \begin_layout Standard
2579
2580 \family typewriter
2581
2582 \backslash
2583 lfoot{John Q.
2584  DocWriter}
2585 \end_layout
2586
2587 \begin_layout Standard
2588
2589 \family typewriter
2590
2591 \backslash
2592 cfoot{}
2593 \end_layout
2594
2595 \begin_layout Standard
2596
2597 \family typewriter
2598
2599 \backslash
2600 rfoot{
2601 \backslash
2602 today}
2603 \end_layout
2604
2605 \begin_layout Standard
2606 The codes 
2607 \family typewriter
2608
2609 \backslash
2610 thesection
2611 \family default
2612  and 
2613 \family typewriter
2614
2615 \backslash
2616 thepage
2617 \family default
2618  access LaTeX's section and page counters, and so print out the current
2619  section and page numbers.
2620  
2621 \family typewriter
2622
2623 \backslash
2624 today
2625 \family default
2626  simply prints out today's date.
2627 \end_layout
2628
2629 \begin_layout Standard
2630 The thicknesses of the horizontal rules drawn beneath the header and above
2631  the footer can also be modified.
2632  If you don't want one of the headers, set its thickness to 0.
2633  The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
2634  Use the commands, e.
2635 \begin_inset space \thinspace{}
2636 \end_inset
2637
2638 g.
2639  
2640 \family typewriter
2641
2642 \backslash
2643 renewcommand{
2644 \backslash
2645 headrulewidth}{0.4pt}
2646 \family default
2647  and 
2648 \family typewriter
2649
2650 \backslash
2651 renewcommand{
2652 \backslash
2653 footrulewidth}{0.4pt}
2654 \family default
2655  to set the thicknesses.
2656 \end_layout
2657
2658 \begin_layout Standard
2659 You can switch the header/footer settings on and off for individual pages
2660  using commands like 
2661 \family typewriter
2662
2663 \backslash
2664 thispagestyle{empty}
2665 \family default
2666
2667 \family typewriter
2668
2669 \backslash
2670 thispagestyle{plain}
2671 \family default
2672 , and 
2673 \family typewriter
2674
2675 \backslash
2676 thispagestyle{fancy}
2677 \family default
2678 .
2679  Simply insert them in the text on the page you want changed and mark them
2680  as TeX code.
2681  In fact, title pages are marked as plain by default, while following pages
2682  are marked fancy when using the global fancy setting.
2683 \end_layout
2684
2685 \begin_layout Standard
2686 There are more complex commands which will let you insert things in the
2687  upper left on odd numbered pages, etc., but I will refer you to the 
2688 \family typewriter
2689 fancyhdr
2690 \family default
2691  package documentation for more descriptions.
2692  For example, if you have a teTeX installation, look for 
2693 \family typewriter
2694 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
2695 fancyhdr.dvi
2696 \family default
2697 .
2698 \end_layout
2699
2700 \begin_layout Standard
2701 As a final example, it is possible to include an Encapsulated PostScript
2702  file in the header or footer.
2703  Suppose you want to put a company logo in the upper lefthand corner.
2704  You might try something like
2705 \end_layout
2706
2707 \begin_layout Standard
2708
2709 \family typewriter
2710
2711 \backslash
2712 lhead{
2713 \backslash
2714 resizebox{1in}{!}{
2715 \backslash
2716 includegraphics{logo.eps}}}
2717 \end_layout
2718
2719 \begin_layout Standard
2720 \noindent
2721 (you may need to preface this with 
2722 \family typewriter
2723
2724 \backslash
2725 usepackage{graphics}
2726 \family default
2727  if you don't include EPS files elsewhere in your document).
2728 \end_layout
2729
2730 \begin_layout Section
2731 Itemize Bullet Selection
2732 \begin_inset CommandInset label
2733 LatexCommand label
2734 name "sec:bullet"
2735
2736 \end_inset
2737
2738
2739 \end_layout
2740
2741 \begin_layout Standard
2742 by
2743 \noun on
2744  Allan Rae
2745 \end_layout
2746
2747 \begin_layout Subsection
2748 Introduction
2749 \end_layout
2750
2751 \begin_layout Standard
2752 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
2753  Using this dialog you can easily specify what bullet shape to use at each
2754  level of an itemized list.
2755  These settings are document-wide so you won't be able to specify different
2756  sets of bullets for different paragraphs
2757 \begin_inset Foot
2758 status collapsed
2759
2760 \begin_layout Plain Layout
2761 Well, actually you can but you'll have to do it by hand.
2762 \end_layout
2763
2764 \end_inset
2765
2766 .
2767 \end_layout
2768
2769 \begin_layout Subsection
2770 How it looks
2771 \end_layout
2772
2773 \begin_layout Standard
2774 Open the dialog by selecting the 
2775 \family sans
2776 \bar under
2777 D
2778 \bar default
2779 ocument\SpecialChar \menuseparator
2780
2781 \bar under
2782 S
2783 \bar default
2784 ettings
2785 \family default
2786  menu item and then select the 
2787 \family sans
2788 \bar under
2789 B
2790 \bar default
2791 ullets
2792 \family default
2793  tab.
2794 \end_layout
2795
2796 \begin_layout Standard
2797 The dialog provides you with a table of bullet shapes.
2798  A column of buttons on the left of the table provides access to the six
2799  different panels of bullet shapes.
2800  The row of buttons across the top is used to select which bullet depth
2801  you are changing.
2802  A text entry under the table shows the currently selected bullet shape's
2803  LaTeX equivalent and this can be edited if desired.
2804  If you do modify the text you will also need to specify any needed packages
2805  in the LaTeX preamble.
2806 \end_layout
2807
2808 \begin_layout Standard
2809 The six panels are divided up by the packages they require.
2810  The following table shows the mappings from button name to LaTeX packages.
2811 \end_layout
2812
2813 \begin_layout Standard
2814 \align center
2815 \begin_inset Tabular
2816 <lyxtabular version="3" rows="7" columns="2">
2817 <features>
2818 <column alignment="center" valignment="top" width="0pt">
2819 <column alignment="center" valignment="top" width="0pt">
2820 <row>
2821 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2822 \begin_inset Text
2823
2824 \begin_layout Plain Layout
2825
2826 \family roman
2827 \series medium
2828 \shape up
2829 \size normal
2830 \emph off
2831 \bar no
2832 \noun off
2833 \color none
2834 Button
2835 \end_layout
2836
2837 \end_inset
2838 </cell>
2839 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
2840 \begin_inset Text
2841
2842 \begin_layout Plain Layout
2843
2844 \family roman
2845 \series medium
2846 \shape up
2847 \size normal
2848 \emph off
2849 \bar no
2850 \noun off
2851 \color none
2852 Packages Required
2853 \end_layout
2854
2855 \end_inset
2856 </cell>
2857 </row>
2858 <row>
2859 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2860 \begin_inset Text
2861
2862 \begin_layout Plain Layout
2863
2864 \family sans
2865 \series medium
2866 \shape up
2867 \size normal
2868 \emph off
2869 \bar no
2870 \noun off
2871 \color none
2872 Standard
2873 \end_layout
2874
2875 \end_inset
2876 </cell>
2877 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2878 \begin_inset Text
2879
2880 \begin_layout Plain Layout
2881
2882 \series medium
2883 \shape up
2884 \size normal
2885 \emph off
2886 \bar no
2887 \noun off
2888 \color none
2889 base LaTeX
2890 \end_layout
2891
2892 \end_inset
2893 </cell>
2894 </row>
2895 <row>
2896 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2897 \begin_inset Text
2898
2899 \begin_layout Plain Layout
2900
2901 \family sans
2902 \series medium
2903 \shape up
2904 \size normal
2905 \emph off
2906 \bar no
2907 \noun off
2908 \color none
2909 Maths
2910 \end_layout
2911
2912 \end_inset
2913 </cell>
2914 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2915 \begin_inset Text
2916
2917 \begin_layout Plain Layout
2918
2919 \family typewriter
2920 \series medium
2921 \shape up
2922 \size normal
2923 \emph off
2924 \bar no
2925 \noun off
2926 \color none
2927 amssymb.sty
2928 \end_layout
2929
2930 \end_inset
2931 </cell>
2932 </row>
2933 <row>
2934 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2935 \begin_inset Text
2936
2937 \begin_layout Plain Layout
2938
2939 \family sans
2940 \series medium
2941 \shape up
2942 \size normal
2943 \emph off
2944 \bar no
2945 \noun off
2946 \color none
2947 Ding1
2948 \end_layout
2949
2950 \end_inset
2951 </cell>
2952 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2953 \begin_inset Text
2954
2955 \begin_layout Plain Layout
2956
2957 \family typewriter
2958 \series medium
2959 \shape up
2960 \size normal
2961 \emph off
2962 \bar no
2963 \noun off
2964 \color none
2965 pifont.sty
2966 \end_layout
2967
2968 \end_inset
2969 </cell>
2970 </row>
2971 <row>
2972 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2973 \begin_inset Text
2974
2975 \begin_layout Plain Layout
2976
2977 \family sans
2978 \series medium
2979 \shape up
2980 \size normal
2981 \emph off
2982 \bar no
2983 \noun off
2984 \color none
2985 Ding2
2986 \end_layout
2987
2988 \end_inset
2989 </cell>
2990 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2991 \begin_inset Text
2992
2993 \begin_layout Plain Layout
2994
2995 \family typewriter
2996 \series medium
2997 \shape up
2998 \size normal
2999 \emph off
3000 \bar no
3001 \noun off
3002 \color none
3003 pifont.sty
3004 \end_layout
3005
3006 \end_inset
3007 </cell>
3008 </row>
3009 <row>
3010 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3011 \begin_inset Text
3012
3013 \begin_layout Plain Layout
3014
3015 \family sans
3016 \series medium
3017 \shape up
3018 \size normal
3019 \emph off
3020 \bar no
3021 \noun off
3022 \color none
3023 Ding3
3024 \end_layout
3025
3026 \end_inset
3027 </cell>
3028 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3029 \begin_inset Text
3030
3031 \begin_layout Plain Layout
3032
3033 \family typewriter
3034 \series medium
3035 \shape up
3036 \size normal
3037 \emph off
3038 \bar no
3039 \noun off
3040 \color none
3041 pifont.sty
3042 \end_layout
3043
3044 \end_inset
3045 </cell>
3046 </row>
3047 <row>
3048 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3049 \begin_inset Text
3050
3051 \begin_layout Plain Layout
3052
3053 \family sans
3054 \series medium
3055 \shape up
3056 \size normal
3057 \emph off
3058 \bar no
3059 \noun off
3060 \color none
3061 Ding4
3062 \end_layout
3063
3064 \end_inset
3065 </cell>
3066 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3067 \begin_inset Text
3068
3069 \begin_layout Plain Layout
3070
3071 \family typewriter
3072 \series medium
3073 \shape up
3074 \size normal
3075 \emph off
3076 \bar no
3077 \noun off
3078 \color none
3079 pifont.sty
3080 \end_layout
3081
3082 \end_inset
3083 </cell>
3084 </row>
3085 </lyxtabular>
3086
3087 \end_inset
3088
3089
3090 \end_layout
3091
3092 \begin_layout Standard
3093 LyX doesn't stop you using bullets from packages you don't have.
3094  If you get errors from LaTeX when you try to view or print the file then
3095  its likely you are missing a package.
3096  LyX doesn't restrict your use since you may be editing locally and exporting
3097  elsewhere.
3098 \end_layout
3099
3100 \begin_layout Subsection
3101 How to use it
3102 \end_layout
3103
3104 \begin_layout Standard
3105 Select which bullet depth you want to change then select the bullet shape
3106  and size.
3107  Any changes will not be visible in LyX, but are visible when viewing the
3108  document using xdvi or ghostview.
3109 \end_layout
3110
3111 \begin_layout Standard
3112 You can reset a bullet shape to the default simply by clicking your right
3113  mouse button on the appropriate bullet depth button.
3114 \end_layout
3115
3116 \begin_layout Standard
3117 If you 
3118 \emph on
3119 really
3120 \emph default
3121  want to have multiple sets of paragraphs with different sets of bullets
3122  in each then you're going to have to get your hands dirty.
3123  The itemize bullet selection dialog can help though because it provides
3124  you with the LaTeX code for a wide range of bullet shapes.
3125  To make your own custom paragraphs you have the following options:
3126 \end_layout
3127
3128 \begin_layout Standard
3129 \begin_inset ERT
3130 status open
3131
3132 \begin_layout Plain Layout
3133
3134
3135 \backslash
3136 let
3137 \backslash
3138 savelabelitemi=
3139 \backslash
3140 labelitemi
3141 \end_layout
3142
3143 \end_inset
3144
3145
3146 \end_layout
3147
3148 \begin_layout Standard
3149 \begin_inset ERT
3150 status open
3151
3152 \begin_layout Plain Layout
3153
3154
3155 \backslash
3156 renewcommand
3157 \backslash
3158 labelitemi[0]{
3159 \backslash
3160 small
3161 \backslash
3162 (
3163 \backslash
3164 sharp
3165 \backslash
3166 )}
3167 \end_layout
3168
3169 \end_inset
3170
3171
3172 \end_layout
3173
3174 \begin_layout Itemize
3175 Use the LaTeX command 
3176 \family typewriter
3177
3178 \backslash
3179 renewcommand{}{}
3180 \family default
3181  to specify a new bullet shape for a given depth.
3182  You'll also need to save the current bullet shape so you can restore it
3183  again afterwards.
3184  In this itemized list the following LaTeX code was used to change the bullet
3185  used for the first depth.
3186 \begin_inset Newline newline
3187 \end_inset
3188
3189
3190 \family typewriter
3191
3192 \backslash
3193 let
3194 \backslash
3195 savelabelitemi=
3196 \backslash
3197 labelitemi
3198 \family default
3199  
3200 \family typewriter
3201
3202 \begin_inset Newline newline
3203 \end_inset
3204
3205
3206 \backslash
3207 renewcommand
3208 \backslash
3209 labelitemi[0]{
3210 \backslash
3211 small
3212 \backslash
3213 (
3214 \backslash
3215 sharp
3216 \backslash
3217 )}
3218 \begin_inset Newline newline
3219 \end_inset
3220
3221
3222 \family default
3223 Note that the itemize depth is specified in Roman numerals as part of the
3224  
3225 \family typewriter
3226
3227 \backslash
3228 labelitem
3229 \family default
3230  command.
3231 \end_layout
3232
3233 \begin_layout Itemize
3234 \begin_inset ERT
3235 status open
3236
3237 \begin_layout Plain Layout
3238
3239 [
3240 \backslash
3241 (
3242 \backslash
3243 star
3244 \backslash
3245 )]
3246 \end_layout
3247
3248 \end_inset
3249
3250  Specify each individual entry by starting each item with the bullet shape
3251  enclosed in square brackets and set as TeX.
3252  For example, this item was started with 
3253 \family typewriter
3254 [
3255 \backslash
3256 (
3257 \backslash
3258 star
3259 \backslash
3260 )]
3261 \family default
3262 .
3263 \end_layout
3264
3265 \begin_layout Standard
3266 \begin_inset ERT
3267 status open
3268
3269 \begin_layout Plain Layout
3270
3271
3272 \backslash
3273 renewcommand
3274 \backslash
3275 labelitemi[0]{
3276 \backslash
3277 savelabelitemi}
3278 \end_layout
3279
3280 \end_inset
3281
3282
3283 \end_layout
3284
3285 \begin_layout Standard
3286 You'll also need to revert the labelitem back to its previous setting for
3287  the global bullet shape settings to remain in effect.
3288  The way used here was:
3289 \begin_inset Newline newline
3290 \end_inset
3291
3292
3293 \family typewriter
3294
3295 \backslash
3296 renewcommand
3297 \backslash
3298 labelitemi[0]{
3299 \backslash
3300 savelabelitemi}
3301 \end_layout
3302
3303 \begin_layout Chapter
3304 Special Document Classes
3305 \end_layout
3306
3307 \begin_layout Section
3308 AMS LaTeX
3309 \end_layout
3310
3311 \begin_layout Standard
3312 by 
3313 \noun on
3314 David Johnson; updated by Richard Heck
3315 \end_layout
3316
3317 \begin_layout Standard
3318 \begin_inset VSpace bigskip
3319 \end_inset
3320
3321
3322 \end_layout
3323
3324 \begin_layout Standard
3325 \noindent
3326 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
3327  papers to be submitted to American Mathematical Society publications.
3328  The layouts are not tailored to a specific journal, but easily can be.
3329  You should refer to the AMS documentation for specific instructions for
3330  each journal (usually it will entail only changing a single line in the
3331  TeX output).
3332  That documentation is available on the Web at 
3333 \begin_inset Flex URL
3334 status open
3335
3336 \begin_layout Plain Layout
3337
3338 http://www.ams.org
3339 \end_layout
3340
3341 \end_inset
3342
3343  or by ftp at 
3344 \begin_inset Flex URL
3345 status open
3346
3347 \begin_layout Plain Layout
3348
3349 ftp://ftp.ams.org/pub/tex/amslatex/
3350 \end_layout
3351
3352 \end_inset
3353
3354 .
3355  These layouts are appropriate, and useful, for any mathematical writing.
3356  
3357 \end_layout
3358
3359 \begin_layout Standard
3360 There are two basic AMS LaTeX layouts: 
3361 \end_layout
3362
3363 \begin_layout Itemize
3364 amsart: The standard AMS article format.
3365 \end_layout
3366
3367 \begin_layout Itemize
3368 amsbook: the standard AMS book (really, monograph) format.
3369  
3370 \end_layout
3371
3372 \begin_layout Standard
3373 The layouts themselves contain only the minimum necessary to use the AMS
3374  classes.
3375  They do not, in particular, contain any of the `theorem' environments used
3376  for setting theorems, lemmas, and the like.
3377  These are contained, instead, in the 
3378 \begin_inset Flex CharStyle:Code
3379 status collapsed
3380
3381 \begin_layout Plain Layout
3382 Theorems (AMS)
3383 \end_layout
3384
3385 \end_inset
3386
3387  module, which is loaded by default when when you select one of the AMS
3388  classes.
3389  (It can also be used with other classes and can be removed, if you would
3390  rather use something else.) Less commonly used environments are in the 
3391 \begin_inset Flex CharStyle:Code
3392 status collapsed
3393
3394 \begin_layout Plain Layout
3395 Theorems (AMS-Extended)
3396 \end_layout
3397
3398 \end_inset
3399
3400  module, which must be loaded manually.
3401 \end_layout
3402
3403 \begin_layout Standard
3404 By default, theorems and the like are numbered consecutively throughout
3405  the document, but this may be modified by loading the module 
3406 \begin_inset Flex CharStyle:Code
3407 status collapsed
3408
3409 \begin_layout Plain Layout
3410 Theorems (Order by Section)
3411 \end_layout
3412
3413 \end_inset
3414
3415  or, if you are using 
3416 \begin_inset Flex CharStyle:Code
3417 status collapsed
3418
3419 \begin_layout Plain Layout
3420 book (AMS)
3421 \end_layout
3422
3423 \end_inset
3424
3425 , the module 
3426 \begin_inset Flex CharStyle:Code
3427 status collapsed
3428
3429 \begin_layout Plain Layout
3430 Theorems (Order by Chapter)
3431 \end_layout
3432
3433 \end_inset
3434
3435 .
3436  These will number the results as 
3437 \begin_inset Formula $n.m$
3438 \end_inset
3439
3440 , where the first number refers to the section (or chapter) and the second
3441  refers to the total number of results so far in that section (or chapter).
3442  Many environments are also available unnumbered.
3443  These are indicated by an asterisk at the end.
3444  If you happen to want 
3445 \emph on
3446 only
3447 \emph default
3448  unnumbered results, the the module 
3449 \begin_inset Flex CharStyle:Code
3450 status collapsed
3451
3452 \begin_layout Plain Layout
3453 Theorems (Starred)
3454 \end_layout
3455
3456 \end_inset
3457
3458  provides that option.
3459 \end_layout
3460
3461 \begin_layout Standard
3462 Note that these modules do not 
3463 \emph on
3464 have
3465 \emph default
3466  to be used with the AMS classes.
3467  It is perfectly possible to use the 
3468 \begin_inset Flex CharStyle:Code
3469 status collapsed
3470
3471 \begin_layout Plain Layout
3472 Theorems (AMS)
3473 \end_layout
3474
3475 \end_inset
3476
3477  module, and the others mentioned, with other classes, such as 
3478 \begin_inset Flex CharStyle:Code
3479 status collapsed
3480
3481 \begin_layout Plain Layout
3482 article
3483 \end_layout
3484
3485 \end_inset
3486
3487
3488 \begin_inset Flex CharStyle:Code
3489 status collapsed
3490
3491 \begin_layout Plain Layout
3492 report
3493 \end_layout
3494
3495 \end_inset
3496
3497
3498 \begin_inset Flex CharStyle:Code
3499 status collapsed
3500
3501 \begin_layout Plain Layout
3502 book (KOMA-script)
3503 \end_layout
3504
3505 \end_inset
3506
3507 , and so forth.
3508 \end_layout
3509
3510 \begin_layout Subsection
3511 What these layouts provide
3512 \end_layout
3513
3514 \begin_layout Standard
3515 There is a long list of included environments provided by these layouts.
3516  In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
3517  variety of `theorem' environments.
3518  However, the AMS recommends the environments that are available in LyX.
3519  
3520 \end_layout
3521
3522 \begin_layout Standard
3523 The following environments---as well as the standard environments, such
3524  as 
3525 \begin_inset Flex CharStyle:Noun
3526 status collapsed
3527
3528 \begin_layout Plain Layout
3529 section
3530 \end_layout
3531
3532 \end_inset
3533
3534
3535 \begin_inset Flex CharStyle:Noun
3536 status collapsed
3537
3538 \begin_layout Plain Layout
3539 bibliography
3540 \end_layout
3541
3542 \end_inset
3543
3544
3545 \begin_inset Flex CharStyle:Noun
3546 status collapsed
3547
3548 \begin_layout Plain Layout
3549 title
3550 \end_layout
3551
3552 \end_inset
3553
3554
3555 \begin_inset Flex CharStyle:Noun
3556 status collapsed
3557
3558 \begin_layout Plain Layout
3559 author
3560 \end_layout
3561
3562 \end_inset
3563
3564 , and 
3565 \begin_inset Flex CharStyle:Noun
3566 status collapsed
3567
3568 \begin_layout Plain Layout
3569 date
3570 \end_layout
3571
3572 \end_inset
3573
3574 ---are provided by 
3575 \begin_inset Flex CharStyle:Code
3576 status collapsed
3577
3578 \begin_layout Plain Layout
3579 article (AMS)
3580 \end_layout
3581
3582 \end_inset
3583
3584  and 
3585 \begin_inset Flex CharStyle:Code
3586 status collapsed
3587
3588 \begin_layout Plain Layout
3589 book (AMS)
3590 \end_layout
3591
3592 \end_inset
3593
3594 :
3595 \end_layout
3596
3597 \begin_layout Description
3598 Address This should be the author's permanent address.
3599 \end_layout
3600
3601 \begin_layout Description
3602 Current
3603 \begin_inset space ~
3604 \end_inset
3605
3606 Address This should be the author's temporary address at the time of submission,
3607  if different from the Address.
3608 \end_layout
3609
3610 \begin_layout Description
3611 Email Author's e-mail address
3612 \end_layout
3613
3614 \begin_layout Description
3615 URL Author's Web address, if desired.
3616 \end_layout
3617
3618 \begin_layout Description
3619 Keywords Key words or phrases used to identify specific topics discussed
3620  in the paper.
3621 \end_layout
3622
3623 \begin_layout Description
3624 Subjectclass These refer to the AMS Subject Classifications, published and
3625  described in 
3626 \emph on
3627 Mathematical Reviews
3628 \emph default
3629 .
3630  These are also available online at the AMS cites listed above.
3631 \end_layout
3632
3633 \begin_layout Description
3634 Thanks
3635 \end_layout
3636
3637 \begin_layout Description
3638 Dedicatory
3639 \end_layout
3640
3641 \begin_layout Description
3642 Translator
3643 \end_layout
3644
3645 \begin_layout Standard
3646 The following environments are provided by both the 
3647 \begin_inset Flex CharStyle:Code
3648 status collapsed
3649
3650 \begin_layout Plain Layout
3651 Theorems
3652 \end_layout
3653
3654 \end_inset
3655
3656  and 
3657 \begin_inset Flex CharStyle:Code
3658 status collapsed
3659
3660 \begin_layout Plain Layout
3661 Theorems (AMS)
3662 \end_layout
3663
3664 \end_inset
3665
3666  modules, in the latter case in both starred (unnumbered) and unstarred
3667  (numbered) versions.
3668  These same environments are provided only in the starred versions by the
3669  
3670 \begin_inset Flex CharStyle:Code
3671 status collapsed
3672
3673 \begin_layout Plain Layout
3674 Theorems (Starred)
3675 \end_layout
3676
3677 \end_inset
3678
3679  module:
3680 \end_layout
3681
3682 \begin_layout Theorem
3683 This is typically used for the statements of major results.
3684  
3685 \end_layout
3686
3687 \begin_layout Corollary*
3688 This is used for statements which follow fairly directly from previous statement
3689 s.
3690  Again, these can be major results.
3691  
3692 \end_layout
3693
3694 \begin_layout Lemma
3695 These are smaller results needed to prove other statements.
3696 \end_layout
3697
3698 \begin_layout Proposition
3699 These are less major results which (hopefully) add to the general theory
3700  being discussed.
3701 \end_layout
3702
3703 \begin_layout Conjecture
3704 These are statements provided without justification, which the author does
3705  not know how to prove, but which seem to be true (to the author, at least).
3706 \end_layout
3707
3708 \begin_layout Definition*
3709 Guess what this is for.
3710  The font is different for this environment than for the previous ones.
3711  
3712 \end_layout
3713
3714 \begin_layout Example*
3715 Used for examples illustrating proven results.
3716 \end_layout
3717
3718 \begin_layout Problem
3719 It's not really known what this is for.
3720  You should figure it out.
3721 \end_layout
3722
3723 \begin_layout Exercise*
3724 Write a description for this one.
3725 \end_layout
3726
3727 \begin_layout Remark
3728 This environment is also a type of theorem, usually a lesser sort of observation.
3729 \end_layout
3730
3731 \begin_layout Claim*
3732 Often used in the course of giving a proof of a larger result.
3733 \end_layout
3734
3735 \begin_layout Case
3736 Generally, these are used to break up long arguments, using specific instances
3737  of some condition.
3738  
3739 \end_layout
3740
3741 \begin_layout Case
3742 The numbering scheme for cases is on its own, not together with other numbered
3743  statements.
3744  
3745 \end_layout
3746
3747 \begin_layout Proof
3748 At the end of this environment , a QED symbol (usually a square, but it
3749  can vary with different styles) is placed.
3750  If you want to have other environments within this one---for example, Case
3751  environments---and have the QED symbol appear only after them, then the
3752  other environments need to be nested within the proof environment.
3753  See section 
3754 \emph on
3755 Nesting Environments
3756 \emph default
3757  of the 
3758 \emph on
3759 User's Guide
3760 \emph default
3761  for information on nesting.
3762 \end_layout
3763
3764 \begin_layout Standard
3765 And these are provided by 
3766 \begin_inset Flex CharStyle:Code
3767 status collapsed
3768
3769 \begin_layout Plain Layout
3770 Theorems (AMS-Extended)
3771 \end_layout
3772
3773 \end_inset
3774
3775 :
3776 \end_layout
3777
3778 \begin_layout Criterion*
3779 A required condition.
3780 \end_layout
3781
3782 \begin_layout Algorithm*
3783 A general procedure to be used.
3784 \end_layout
3785
3786 \begin_layout Axiom*
3787 This is a property or statement taken as true within the system being discussed.
3788 \end_layout
3789
3790 \begin_layout Condition*
3791 Sometimes used to state a condition assumed within the present context of
3792  discussion.
3793 \end_layout
3794
3795 \begin_layout Note*
3796 Similar to a Remark.
3797 \end_layout
3798
3799 \begin_layout Notation*
3800 Used for the explanation of, yes, notation.
3801 \end_layout
3802
3803 \begin_layout Summary
3804 Do we really need to tell you? 
3805 \end_layout
3806
3807 \begin_layout Acknowledgement*
3808 Acknowledgement.
3809 \end_layout
3810
3811 \begin_layout Conclusion*
3812 Sometimes used at the end of a long train of argument.
3813 \end_layout
3814
3815 \begin_layout Fact
3816 Used in a way similar to Proposition, though perhaps lower on the scale.
3817 \end_layout
3818
3819 \begin_layout Standard
3820 In addition, the AMS classes automatically provide the AMS LaTeX and AMS
3821  fonts packages.
3822  They need to be available on your system in order to use these environments.
3823 \end_layout
3824
3825 \begin_layout Section
3826 Dinbrief
3827 \end_layout
3828
3829 \begin_layout Standard
3830 The document class 
3831 \family sans
3832 dinbrief
3833 \family default
3834  can be used to type letters according to German conventions.
3835  A template file is included in 
3836 \family typewriter
3837 .../lyx/share/templates
3838 \family default
3839  for you to use as a starting point.
3840 \end_layout
3841
3842 \begin_layout Section
3843 Paper
3844 \end_layout
3845
3846 \begin_layout Standard
3847 The document class 
3848 \family sans
3849 paper
3850 \family default
3851  provides an alternative to the standard 
3852 \family sans
3853 article
3854 \family default
3855  class.
3856  It provides similar functionality, but you might prefer this layout with
3857  sans serif sections, headings, and more.
3858 \end_layout
3859
3860 \begin_layout Section
3861 A&A Paper
3862 \end_layout
3863
3864 \begin_layout Standard
3865 by 
3866 \noun on
3867 Peter Sütterlin
3868 \end_layout
3869
3870 \begin_layout Subsection
3871 Introduction
3872 \end_layout
3873
3874 \begin_layout Standard
3875 This section describes how LyX can be used to write articles for submission
3876  to the scientific journal 
3877 \emph on
3878 Astronomy and Astrophysics
3879 \emph default
3880  (www.edpsciences.fr/aa/ 
3881 \begin_inset Flex URL
3882 status collapsed
3883
3884 \begin_layout Plain Layout
3885
3886 http://www.edpsciences.fr/aa/
3887 \end_layout
3888
3889 \end_inset
3890
3891 ) using Version 5.01 of the document class 
3892 \family typewriter
3893 aa.cls
3894 \family default
3895 .
3896  This package can be downloaded from the ftp site
3897 \end_layout
3898
3899 \begin_layout Standard
3900 \begin_inset VSpace medskip
3901 \end_inset
3902
3903
3904 \end_layout
3905
3906 \begin_layout Standard
3907 \align center
3908 \begin_inset Flex URL
3909 status collapsed
3910
3911 \begin_layout Plain Layout
3912
3913 ftp://ftp.edpsciences.org/pub/aa/readme.html
3914 \end_layout
3915
3916 \end_inset
3917
3918
3919 \end_layout
3920
3921 \begin_layout Standard
3922 \begin_inset VSpace medskip
3923 \end_inset
3924
3925
3926 \end_layout
3927
3928 \begin_layout Standard
3929 A manual comes together with that package, and this text is not meant to
3930  replace the original manual but merely a short guide how to realize the
3931  correct form of your paper.
3932  
3933 \end_layout
3934
3935 \begin_layout Standard
3936 Please note that the publisher of the journal was changed from Springer
3937  to EDP Sciences starting January 1, 2001.
3938  That change implicated also some slight changes of the style files, namely
3939  the removal of the thesaurus command.
3940  The LyX class aa supports the newest version of these style files, V 5.01.
3941  If you have an older version installed, please upgrade.
3942  For compatibility, the old (version 4) layout has been kept as 
3943 \family sans
3944 article (A&A V4)
3945 \family default
3946 .
3947  Please refer to the comments in 
3948 \family typewriter
3949 LyXDir/layouts/aapaper.layout
3950 \family default
3951 .
3952 \end_layout
3953
3954 \begin_layout Subsection
3955 Getting started
3956 \end_layout
3957
3958 \begin_layout Standard
3959 It is recommended you start from the example template distributed with LyX.
3960  If you are not using a template, note the following settings:
3961 \end_layout
3962
3963 \begin_layout Itemize
3964 Select 
3965 \family sans
3966 article (A&A)
3967 \family default
3968  in the 
3969 \family sans
3970 \bar under
3971 D
3972 \bar default
3973 ocument\SpecialChar \menuseparator
3974
3975 \bar under
3976 S
3977 \bar default
3978 ettings
3979 \family default
3980  dialog (OK, that one was obvious).
3981 \end_layout
3982
3983 \begin_layout Itemize
3984 Don't change the option 
3985 \family sans
3986 Page
3987 \begin_inset space ~
3988 \end_inset
3989
3990 style
3991 \family default
3992 : Leave it set to 
3993 \family sans
3994 default
3995 \family default
3996 .
3997  The whole layout is done by the macros, you shouldn't change anything.
3998 \end_layout
3999
4000 \begin_layout Subsection
4001 The header block
4002 \end_layout
4003
4004 \begin_layout Standard
4005 First thing to enter is the header information.
4006  It consists of seven entries, of which some are optional.
4007  They are
4008 \end_layout
4009
4010 \begin_layout Itemize
4011
4012 \family sans
4013 Title
4014 \family default
4015 : [required] 
4016 \end_layout
4017
4018 \begin_layout Itemize
4019
4020 \family sans
4021 Subtitle
4022 \family default
4023 : [optional] 
4024 \end_layout
4025
4026 \begin_layout Itemize
4027
4028 \family sans
4029 Author
4030 \family default
4031 : [required]
4032 \end_layout
4033
4034 \begin_layout Itemize
4035
4036 \family sans
4037 Address
4038 \family default
4039 : [required]
4040 \end_layout
4041
4042 \begin_layout Itemize
4043
4044 \family sans
4045 Offprints
4046 \family default
4047 : [optional] if more than one author: whom to contact for offprint requests.
4048 \end_layout
4049
4050 \begin_layout Itemize
4051
4052 \family sans
4053 Mail
4054 \family default
4055 : [optional] mail address for contacts.
4056 \end_layout
4057
4058 \begin_layout Itemize
4059
4060 \family sans
4061 Date
4062 \family default
4063 : [required].
4064  Suggested format is 
4065 \family typewriter
4066 Received: <date>; Accepted <date> 
4067 \end_layout
4068
4069 \begin_layout Standard
4070 There is no need to issue the 
4071 \family typewriter
4072
4073 \backslash
4074 maketitle
4075 \family default
4076  command, this is done automatically by LyX when the header is finished.
4077  Although the order of the single header entries doesn't matter it is advised
4078  to keep the above sequence, just to get the best optics and meets the layout
4079  of the real document.
4080 \end_layout
4081
4082 \begin_layout Standard
4083 If you want to place footnotes in the header block, e.
4084 \begin_inset space \thinspace{}
4085 \end_inset
4086
4087 g.
4088 \begin_inset space ~
4089 \end_inset
4090
4091 to state your present address, just use the standard footnote via 
4092 \family sans
4093 \bar under
4094 I
4095 \bar default
4096 nsert\SpecialChar \menuseparator
4097
4098 \bar under
4099 F
4100 \bar default
4101 ootnote.
4102
4103 \family default
4104  LyX will automagically use the term 
4105 \family typewriter
4106
4107 \backslash
4108 thanks{}
4109 \family default
4110  in that case.
4111 \end_layout
4112
4113 \begin_layout Standard
4114 In addition to these topics, the macros use three additional LaTeX commands
4115  that have no counterpart in LyX:
4116 \end_layout
4117
4118 \begin_layout Itemize
4119
4120 \family typewriter
4121
4122 \backslash
4123 and
4124 \family default
4125  to separate different names for more than one author and institute, respectivel
4126 y.
4127 \end_layout
4128
4129 \begin_layout Itemize
4130
4131 \family typewriter
4132
4133 \backslash
4134 inst{<nr>}
4135 \family default
4136 to mark corresponding author/institute pairs.
4137  The institutes are numbered sequentially as they appear in the 
4138 \family sans
4139 Address
4140 \family default
4141  field, so you have to put a marker to each author.
4142 \end_layout
4143
4144 \begin_layout Itemize
4145
4146 \family typewriter
4147
4148 \backslash
4149 email{address}
4150 \family default
4151  to supply an email address for fast contact.
4152 \end_layout
4153
4154 \begin_layout Standard
4155 In all cases, the appropriate command has to be entered in LyX and marked
4156  as LaTeX code.
4157  See the examples.
4158  
4159 \end_layout
4160
4161 \begin_layout Subsection
4162 The abstract
4163 \end_layout
4164
4165 \begin_layout Standard
4166 The abstract should immediately follow the header block.
4167  With version 5 the abstract environment was changed to a command, and there
4168  is now a resctriction to only one paragraph.
4169  In addition, it should contain an entry with the keywords.
4170  This is not yet implemented for LyX, therefore you have to enter the LaTeX
4171  command 
4172 \family typewriter
4173
4174 \backslash
4175 keywords{}
4176 \family default
4177  by hand and mark it as LaTeX code.
4178  Refer to the example paper.
4179 \end_layout
4180
4181 \begin_layout Subsection
4182 Supported environments
4183 \end_layout
4184
4185 \begin_layout Standard
4186 The A&A paper layout supports the following environments for structuring
4187  your text:
4188 \end_layout
4189
4190 \begin_layout Itemize
4191
4192 \family sans
4193 Standard
4194 \end_layout
4195
4196 \begin_layout Itemize
4197
4198 \family sans
4199 Section
4200 \end_layout
4201
4202 \begin_layout Itemize
4203
4204 \family sans
4205 Subsection
4206 \end_layout
4207
4208 \begin_layout Itemize
4209
4210 \family sans
4211 Subsubsection
4212 \end_layout
4213
4214 \begin_layout Itemize
4215
4216 \family sans
4217 Itemize
4218 \end_layout
4219
4220 \begin_layout Itemize
4221
4222 \family sans
4223 Enumerate
4224 \end_layout
4225
4226 \begin_layout Itemize
4227
4228 \family sans
4229 Description
4230 \end_layout
4231
4232 \begin_layout Itemize
4233
4234 \family sans
4235 Caption
4236 \end_layout
4237
4238 \begin_layout Itemize
4239
4240 \family sans
4241 Abstract
4242 \end_layout
4243
4244 \begin_layout Itemize
4245
4246 \family sans
4247 Acknowledgment
4248 \end_layout
4249
4250 \begin_layout Itemize
4251
4252 \family sans
4253 Bibliography
4254 \end_layout
4255
4256 \begin_layout Itemize
4257
4258 \family sans
4259 LaTeX
4260 \end_layout
4261
4262 \begin_layout Subsection
4263 Commands not supported by LyX
4264 \end_layout
4265
4266 \begin_layout Standard
4267 Some commands are not yet supported by the 
4268 \family sans
4269 paper (A&A)
4270 \family default
4271  layout for LyX.
4272  Some have already been mentioned.
4273  For the sake of completeness, they are listed all together here:
4274 \end_layout
4275
4276 \begin_layout Itemize
4277
4278 \family typewriter
4279
4280 \backslash
4281 and
4282 \end_layout
4283
4284 \begin_layout Itemize
4285
4286 \family typewriter
4287
4288 \backslash
4289 email
4290 \end_layout
4291
4292 \begin_layout Itemize
4293
4294 \family typewriter
4295
4296 \backslash
4297 appendix
4298 \end_layout
4299
4300 \begin_layout Itemize
4301
4302 \family typewriter
4303
4304 \backslash
4305 authorrunning
4306 \end_layout
4307
4308 \begin_layout Itemize
4309
4310 \family typewriter
4311
4312 \backslash
4313 inst{}
4314 \end_layout
4315
4316 \begin_layout Itemize
4317
4318 \family typewriter
4319
4320 \backslash
4321 keywords{}
4322 \end_layout
4323
4324 \begin_layout Itemize
4325
4326 \family typewriter
4327
4328 \backslash
4329 object{}
4330 \end_layout
4331
4332 \begin_layout Itemize
4333
4334 \family typewriter
4335
4336 \backslash
4337 titlerunning{}
4338 \end_layout
4339
4340 \begin_layout Standard
4341 If you want to use any of these commands, you have to enter them yourself.
4342  
4343 \series bold
4344 Do not forget to mark them as LaTeX code!
4345 \end_layout
4346
4347 \begin_layout Subsection
4348 Figure and Table Floats
4349 \end_layout
4350
4351 \begin_layout Standard
4352 LyX provides support for the necessary float environments 
4353 \family sans
4354 figure, figure*, table
4355 \family default
4356  and 
4357 \family sans
4358 table*
4359 \family default
4360 , therefore we won't tell much about it here.
4361  Refer to the 
4362 \emph on
4363 User's
4364 \begin_inset space ~
4365 \end_inset
4366
4367 Guide
4368 \emph default
4369 .
4370  Just remember that tables should be left-aligned.
4371  For that, select the table and change the alignment in 
4372 \family sans
4373 \bar under
4374 E
4375 \bar default
4376 dit\SpecialChar \menuseparator
4377
4378 \bar under
4379 P
4380 \bar default
4381 aragraph
4382 \begin_inset space ~
4383 \end_inset
4384
4385 Settings.
4386 \end_layout
4387
4388 \begin_layout Standard
4389 There is only one special thing: the figures with caption besides the figure.
4390  To create such a figure, you have to do the following:
4391 \end_layout
4392
4393 \begin_layout Enumerate
4394 Create a wide figure float: 
4395 \family sans
4396 \bar under
4397 I
4398 \bar default
4399 nsert\SpecialChar \menuseparator
4400 Flo
4401 \bar under
4402 a
4403 \bar default
4404 t\SpecialChar \menuseparator
4405 Figure
4406 \family default
4407 , then right click in the figure and select 
4408 \family sans
4409 \bar under
4410 S
4411 \bar default
4412 pan
4413 \begin_inset space ~
4414 \end_inset
4415
4416 columns
4417 \family default
4418 .
4419 \end_layout
4420
4421 \begin_layout Enumerate
4422 Enter your caption text.
4423 \end_layout
4424
4425 \begin_layout Enumerate
4426 Press 
4427 \family sans
4428 Return
4429 \family default
4430  to move the cursor above the caption.
4431 \end_layout
4432
4433 \begin_layout Enumerate
4434 Insert your figure
4435 \end_layout
4436
4437 \begin_layout Enumerate
4438 Position the cursor behind the figure and insert a horizontal fill: 
4439 \family sans
4440 \bar under
4441 I
4442 \bar default
4443 nsert\SpecialChar \menuseparator
4444
4445 \bar under
4446 S
4447 \bar default
4448 pecial
4449 \begin_inset space ~
4450 \end_inset
4451
4452 Character
4453 \bar under
4454 \SpecialChar \menuseparator
4455 H
4456 \bar default
4457 orizontal
4458 \begin_inset space ~
4459 \end_inset
4460
4461 Fill
4462 \family default
4463 .
4464 \end_layout
4465
4466 \begin_layout Enumerate
4467 Switch to LaTeX mode: 
4468 \family sans
4469 M-c
4470 \begin_inset space ~
4471 \end_inset
4472
4473 t
4474 \family default
4475 .
4476 \end_layout
4477
4478 \begin_layout Enumerate
4479 Enter 
4480 \family typewriter
4481
4482 \backslash
4483 parbox[b]{55mm}{
4484 \family default
4485 .
4486  
4487 \series bold
4488 Do not close the brace!
4489 \end_layout
4490
4491 \begin_layout Enumerate
4492 Position the cursor behind the caption text, switch to LaTeX mode and insert
4493  the closing brace: 
4494 \family sans
4495 M-c
4496 \begin_inset space ~
4497 \end_inset
4498
4499 t
4500 \family default
4501  
4502 \family typewriter
4503 }
4504 \family default
4505 .
4506 \end_layout
4507
4508 \begin_layout Standard
4509 Also, refer to the figures in the example paper.
4510 \end_layout
4511
4512 \begin_layout Subsection
4513 Referee layout
4514 \end_layout
4515
4516 \begin_layout Standard
4517 For submission, the paper has to be formated in a special double-spacing
4518  layout.
4519  For this purpose, you have to give the option 
4520 \family typewriter
4521 referee
4522 \family default
4523  to the documentclass.
4524  This must be done using the extra class options field in the 
4525 \family sans
4526 \bar under
4527 D
4528 \bar default
4529 ocument\SpecialChar \menuseparator
4530
4531 \bar under
4532 S
4533 \bar default
4534 ettings
4535 \family default
4536  dialog.
4537  Just enter the string 
4538 \family typewriter
4539 referee
4540 \family default
4541  there.
4542 \end_layout
4543
4544 \begin_layout Subsection
4545 The example paper
4546 \end_layout
4547
4548 \begin_layout Standard
4549 The 
4550 \family sans
4551 Examples
4552 \family default
4553  directory contains an example paper written with LyX.
4554  It is the example paper from the original macro package, translated to
4555  LyX.
4556  Use it for inspiration, and compare the original LaTeX code with LyX way
4557  of writing.
4558 \end_layout
4559
4560 \begin_layout Section
4561 AASTeX
4562 \end_layout
4563
4564 \begin_layout Standard
4565 by 
4566 \noun on
4567 Mike Ressler
4568 \end_layout
4569
4570 \begin_layout Subsection
4571 Introduction
4572 \end_layout
4573
4574 \begin_layout Standard
4575 AASTeX is a set of macros produced by the American Astronomical Society
4576  to facilitate electronic manuscript submission to the three journals they
4577  publish: the Astrophysical Journal (including the Letters and Supplement),
4578  the Astronomical Journal, and the Publications of the Astronomical Society
4579  of the Pacific.
4580  LyX has proven to be an excellent tool for generating these documents,
4581  especially given its equation, citation, and figure handling capabilities.
4582  LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
4583  is the version described here, or higher.
4584  Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
4585  incompatible with LyX.
4586  The AASTeX package may be downloaded from the AASTeX Web site
4587 \end_layout
4588
4589 \begin_layout Standard
4590 \begin_inset VSpace medskip
4591 \end_inset
4592
4593
4594 \end_layout
4595
4596 \begin_layout Standard
4597 \align center
4598 \begin_inset Flex URL
4599 status collapsed
4600
4601 \begin_layout Plain Layout
4602
4603 http://www.journals.uchicago.edu/AAS/AASTeX
4604 \end_layout
4605
4606 \end_inset
4607
4608
4609 \end_layout
4610
4611 \begin_layout Standard
4612 \begin_inset VSpace medskip
4613 \end_inset
4614
4615
4616 \end_layout
4617
4618 \begin_layout Standard
4619 A complete user guide is contained in that package and you should familiarize
4620  yourself with it thoroughly before embarking on writing a paper in LyX.
4621  LyX will not reduce the need to figure out all the AASTeX commands, it
4622  will only reduce the drudgery of typing everything in.
4623  It is your responsibility to ensure that the final exported LaTeX document
4624  conforms completely to the requirements of the journal to which you are
4625  submitting your paper.
4626 \end_layout
4627
4628 \begin_layout Subsection
4629 Starting a New Paper
4630 \end_layout
4631
4632 \begin_layout Standard
4633 I strongly suggest that you start with the AASTeX template file.
4634  Click on 
4635 \family sans
4636 \bar under
4637 F
4638 \bar default
4639 ile\SpecialChar \menuseparator
4640 New from
4641 \family default
4642  
4643 \family sans
4644 \bar under
4645 T
4646 \bar default
4647 emplate
4648 \family default
4649 , enter the new file name, then choose the 
4650 \family typewriter
4651 aastex.lyx
4652 \family default
4653  template.
4654  This will show the most common fields found in a manuscript.
4655  Simply overwrite the existing text (including the brackets, 
4656 \family typewriter
4657 <>
4658 \family default
4659 ) with the correct information.
4660  Many of the AASTeX commands and environments can be implemented directly
4661  in LyX, but some cannot: most noticeably 
4662 \family typewriter
4663
4664 \backslash
4665 altaffilmark
4666 \family default
4667  and 
4668 \family typewriter
4669
4670 \backslash
4671 altaffiltext
4672 \family default
4673 , which should stick out like a sore thumb if you actually just opened the
4674  template file.
4675  For commands such as these, the LaTeX code must be entered directly and
4676  marked as such.
4677  Such commands are referred to as ERT, or Evil Red Text.
4678  I tried to minimize the amount of ERT needed in an AASTeX document, but
4679  there is still a bit more required than any of us would like.
4680 \end_layout
4681
4682 \begin_layout Subsection
4683 Finishing Your Paper
4684 \end_layout
4685
4686 \begin_layout Standard
4687 When the paper is finished to your satisfaction and previews/prints correctly,
4688  there are a few 
4689 \begin_inset Quotes eld
4690 \end_inset
4691
4692 postprocessing
4693 \begin_inset Quotes erd
4694 \end_inset
4695
4696  actions which need to be done before you submit it to the journals.
4697  
4698 \end_layout
4699
4700 \begin_layout Enumerate
4701 Export your paper as a LaTeX file (
4702 \family sans
4703 \bar under
4704 F
4705 \bar default
4706 ile\SpecialChar \menuseparator
4707
4708 \bar under
4709 E
4710 \bar default
4711 xport\SpecialChar \menuseparator
4712
4713 \bar under
4714 L
4715 \bar default
4716 aTeX
4717 \family default
4718 ).
4719  
4720 \end_layout
4721
4722 \begin_layout Enumerate
4723 Edit the resulting 
4724 \family typewriter
4725 .tex
4726 \family default
4727  file with your favorite text editor
4728 \end_layout
4729
4730 \begin_deeper
4731 \begin_layout Enumerate
4732 remove the comment lines before the 
4733 \family typewriter
4734
4735 \backslash
4736 documentclass
4737 \family default
4738  command
4739 \end_layout
4740
4741 \begin_layout Enumerate
4742 remove the 
4743 \family typewriter
4744
4745 \backslash
4746 usepackage...{fontenc}
4747 \family default
4748  line if it appears (usually just after 
4749 \family typewriter
4750
4751 \backslash
4752 documentclass
4753 \family default
4754 }; also remove the 
4755 \family typewriter
4756
4757 \backslash
4758 secnumdepth
4759 \family default
4760  line if it appears.
4761 \end_layout
4762
4763 \begin_layout Enumerate
4764 remove everything between (and including) the 
4765 \family typewriter
4766
4767 \backslash
4768 makeatletter
4769 \family default
4770  and 
4771 \family typewriter
4772
4773 \backslash
4774 makeatother
4775 \family default
4776  commands, except for any commands you specifically put into the LaTeX preamble
4777  (which should appear immediately after the 
4778 \begin_inset Quotes eld
4779 \end_inset
4780
4781 User specified LaTeX commands
4782 \begin_inset Quotes erd
4783 \end_inset
4784
4785  comment in the 
4786 \family typewriter
4787 .tex
4788 \family default
4789  file).
4790 \end_layout
4791
4792 \end_deeper
4793 \begin_layout Enumerate
4794 Run the resulting file through LaTeX to make sure it still processes correctly.
4795 \end_layout
4796
4797 \begin_layout Enumerate
4798 Reread the journal requirements to make sure your filenames and formats
4799  are correct.
4800 \end_layout
4801
4802 \begin_layout Enumerate
4803 Submit it.
4804 \end_layout
4805
4806 \begin_layout Subsection
4807 Comments On Specific Commands
4808 \end_layout
4809
4810 \begin_layout Standard
4811 I will not describe the detailed usage of the individual AASTeX commands:
4812  the AASTeX User Guide (
4813 \family typewriter
4814 aasguide.tex
4815 \family default
4816 ) gives a good description of each.
4817  Thus it's probably easiest for me to go down the list as found in the guide
4818  and offer comments where necessary.
4819  So let's begin \SpecialChar \ldots{}
4820
4821 \end_layout
4822
4823 \begin_layout Subsubsection
4824 Things that work as expected
4825 \end_layout
4826
4827 \begin_layout Standard
4828 \begin_inset ERT
4829 status open
4830
4831 \begin_layout Plain Layout
4832
4833
4834 \backslash
4835 begin{sloppypar}
4836 \end_layout
4837
4838 \end_inset
4839
4840
4841 \end_layout
4842
4843 \begin_layout Standard
4844 Because they work as you might expect, I simply list them and the section
4845  they are found in: 
4846 \family typewriter
4847
4848 \backslash
4849 documentclass
4850 \family default
4851  (2.1.1), 
4852 \family typewriter
4853
4854 \backslash
4855 begin{document}
4856 \family default
4857  (2.2), 
4858 \family typewriter
4859
4860 \backslash
4861 title
4862 \family default
4863  (2.3), 
4864 \family typewriter
4865
4866 \backslash
4867 author
4868 \family default
4869  (2.3), 
4870 \family typewriter
4871
4872 \backslash
4873 affil
4874 \family default
4875  (2.3), 
4876 \family typewriter
4877
4878 \backslash
4879 abstract
4880 \family default
4881  (2.4), 
4882 \family typewriter
4883
4884 \backslash
4885 keywords
4886 \family default
4887  (2.5), 
4888 \family typewriter
4889
4890 \backslash
4891 section
4892 \family default
4893  (2.7), 
4894 \family typewriter
4895
4896 \backslash
4897 subsection
4898 \family default
4899  (2.7), 
4900 \family typewriter
4901
4902 \backslash
4903 subsubsection
4904 \family default
4905  (2.7), 
4906 \family typewriter
4907
4908 \backslash
4909 paragraph
4910 \family default
4911  (2.7), 
4912 \family typewriter
4913
4914 \backslash
4915 facility
4916 \family default
4917  (2.10), 
4918 \family typewriter
4919
4920 \backslash
4921 begin{displaymath}
4922 \family default
4923  (2.12), 
4924 \family typewriter
4925
4926 \backslash
4927 begin{equation}
4928 \family default
4929  (2.12), 
4930 \family typewriter
4931
4932 \backslash
4933 begin{eqnarray}
4934 \family default
4935  (2.12), 
4936 \family typewriter
4937
4938 \backslash
4939 begin{mathletters}
4940 \family default
4941  (2.12), 
4942 \family typewriter
4943
4944 \backslash
4945 begin{thebibliography}
4946 \family default
4947  (2.13.1), 
4948 \family typewriter
4949
4950 \backslash
4951 bibitem
4952 \family default
4953  (2.13.2), all the cite commands and their variations (2.13.2), the generic
4954  graphicx figure commands (2.14.1), 
4955 \family typewriter
4956
4957 \backslash
4958 begin{table}
4959 \family default
4960  (2.15.4), 
4961 \family typewriter
4962
4963 \backslash
4964 begin{tabular}
4965 \family default
4966  (2.15.4), 
4967 \family typewriter
4968
4969 \backslash
4970 caption
4971 \family default
4972  (2.15.4), 
4973 \family typewriter
4974
4975 \backslash
4976 label
4977 \family default
4978  (2.15.4, amongst other places), 
4979 \family typewriter
4980
4981 \backslash
4982 tablerefs
4983 \family default
4984  (2.15.5), 
4985 \family typewriter
4986
4987 \backslash
4988 tablecomments
4989 \family default
4990  (2.15.5), 
4991 \family typewriter
4992
4993 \backslash
4994 url
4995 \family default
4996  (2.17.4), 
4997 \family typewriter
4998
4999 \backslash
5000 end{document}
5001 \family default
5002  (2.18).
5003 \end_layout
5004
5005 \begin_layout Standard
5006 The following style options also work correctly: 
5007 \family typewriter
5008 longabstract
5009 \family default
5010  (2.4), 
5011 \family typewriter
5012 preprint
5013 \family default
5014  (3.2.1), 
5015 \family typewriter
5016 preprint2
5017 \family default
5018  (3.2.2), 
5019 \family typewriter
5020 eqsecnum
5021 \family default
5022  (3.3), 
5023 \family typewriter
5024 flushrt
5025 \family default
5026  (3.4).
5027  Simply put them in the 
5028 \family sans
5029 Options
5030 \family default
5031  box in 
5032 \family sans
5033 Layout\SpecialChar \menuseparator
5034 Document
5035 \family default
5036 .
5037 \end_layout
5038
5039 \begin_layout Standard
5040 \begin_inset ERT
5041 status open
5042
5043 \begin_layout Plain Layout
5044
5045
5046 \backslash
5047 end{sloppypar}
5048 \end_layout
5049
5050 \end_inset
5051
5052
5053 \end_layout
5054
5055 \begin_layout Subsubsection
5056 Things that work, but require more comment
5057 \end_layout
5058
5059 \begin_layout Standard
5060 The following items work, but require a little more discussion:
5061 \end_layout
5062
5063 \begin_layout Itemize
5064 These items are reserved for use by the journal editors, but you can put
5065  them into the LaTeX preamble if you feel compelled to do so: 
5066 \family typewriter
5067
5068 \backslash
5069 received
5070 \family default
5071
5072 \family typewriter
5073
5074 \backslash
5075 revised
5076 \family default
5077
5078 \family typewriter
5079
5080 \backslash
5081 accepted
5082 \family default
5083
5084 \family typewriter
5085
5086 \backslash
5087 ccc
5088 \family default
5089
5090 \family typewriter
5091
5092 \backslash
5093 cpright
5094 \family default
5095  (all from 2.1.3)
5096 \end_layout
5097
5098 \begin_layout Itemize
5099 These items may be placed in the LaTeX preamble, and are included as blanks
5100  in the template file: 
5101 \family typewriter
5102
5103 \backslash
5104 slugcomment
5105 \family default
5106  (2.1.4), 
5107 \family typewriter
5108
5109 \backslash
5110 shorttitle
5111 \family default
5112  (2.1.5), 
5113 \family typewriter
5114
5115 \backslash
5116 shortauthors
5117 \family default
5118  (2.1.5)
5119 \end_layout
5120
5121 \begin_layout Itemize
5122
5123 \family typewriter
5124
5125 \backslash
5126 email
5127 \family default
5128  (2.3) -- can only be used 
5129 \begin_inset Quotes eld
5130 \end_inset
5131
5132 standalone
5133 \begin_inset Quotes erd
5134 \end_inset
5135
5136 , not in the middle of a paragraph.
5137  Use ERT if you need to embed it.
5138 \end_layout
5139
5140 \begin_layout Itemize
5141
5142 \family typewriter
5143
5144 \backslash
5145 and
5146 \family default
5147  (2.3) -- will have extra {} after it.
5148  This should not cause an error.
5149 \end_layout
5150
5151 \begin_layout Itemize
5152
5153 \family typewriter
5154
5155 \backslash
5156 notetoeditor
5157 \family default
5158  (2.6) -- can only be used 
5159 \begin_inset Quotes eld
5160 \end_inset
5161
5162 standalone
5163 \begin_inset Quotes erd
5164 \end_inset
5165
5166 , not in the middle of a paragraph.
5167  Use ERT if you need to embed it.
5168 \end_layout
5169
5170 \begin_layout Itemize
5171
5172 \family typewriter
5173
5174 \backslash
5175 placetable
5176 \family default
5177  (2.8) -- can't insert a cross-reference tag, you must type the tag name
5178  by hand
5179 \end_layout
5180
5181 \begin_layout Itemize
5182
5183 \family typewriter
5184
5185 \backslash
5186 placefigure
5187 \family default
5188  (2.8) -- same as for 
5189 \family typewriter
5190
5191 \backslash
5192 placetable
5193 \end_layout
5194
5195 \begin_layout Itemize
5196
5197 \family typewriter
5198
5199 \backslash
5200 acknowledgements
5201 \family default
5202  (2.9) -- will have extra {} after it.
5203  This should not cause an error.
5204 \end_layout
5205
5206 \begin_layout Itemize
5207
5208 \family typewriter
5209
5210 \backslash
5211 appendix
5212 \family default
5213  (2.11) -- will have extra {} after it.
5214  This should not cause an error.
5215 \end_layout
5216
5217 \begin_layout Itemize
5218
5219 \family typewriter
5220
5221 \backslash
5222 figcaption
5223 \family default
5224  (2.14.2) -- you can insert an optional filename argument by placing the cursor
5225  at the beginning of the text and selecting 
5226 \family sans
5227 Insert\SpecialChar \menuseparator
5228 Short Title
5229 \family default
5230 .
5231  
5232 \begin_inset Quotes eld
5233 \end_inset
5234
5235 Short Title
5236 \begin_inset Quotes erd
5237 \end_inset
5238
5239  inserts an optional argument of the type needed by 
5240 \family typewriter
5241
5242 \backslash
5243 figcaption
5244 \family default
5245 .
5246  Hopefully it will be renamed someday.
5247 \end_layout
5248
5249 \begin_layout Itemize
5250
5251 \family typewriter
5252
5253 \backslash
5254 objectname
5255 \family default
5256  (2.17.1) -- same as 
5257 \family typewriter
5258
5259 \backslash
5260 figcaption
5261 \family default
5262  for the catalog ID optional parameter
5263 \end_layout
5264
5265 \begin_layout Itemize
5266
5267 \family typewriter
5268
5269 \backslash
5270 dataset
5271 \family default
5272  (2.17.1) -- same as 
5273 \family typewriter
5274
5275 \backslash
5276 figcaption
5277 \family default
5278  for the catalog ID optional parameter
5279 \end_layout
5280
5281 \begin_layout Subsubsection
5282 Things not implemented, use ERT
5283 \end_layout
5284
5285 \begin_layout Standard
5286 \begin_inset ERT
5287 status open
5288
5289 \begin_layout Plain Layout
5290
5291
5292 \backslash
5293 begin{sloppypar}
5294 \end_layout
5295
5296 \end_inset
5297
5298
5299 \end_layout
5300
5301 \begin_layout Standard
5302
5303 \family typewriter
5304
5305 \backslash
5306 altaffilmark
5307 \family default
5308  (2.3), 
5309 \family typewriter
5310
5311 \backslash
5312 altaffiltext
5313 \family default
5314  (2.3), 
5315 \family typewriter
5316
5317 \backslash
5318 eqnum
5319 \family default
5320  (2.12), 
5321 \family typewriter
5322
5323 \backslash
5324 setcounter{equation}
5325 \family default
5326  (2.12), Journal name abbreviations (2.13.4), 
5327 \family typewriter
5328
5329 \backslash
5330 figurenum
5331 \family default
5332  (2.14.1), 
5333 \family typewriter
5334
5335 \backslash
5336 epsscale
5337 \family default
5338  (2.14.1), 
5339 \family typewriter
5340
5341 \backslash
5342 plotone
5343 \family default
5344  (2.14.1), 
5345 \family typewriter
5346
5347 \backslash
5348 plottwo
5349 \family default
5350  (2.14.1), 
5351 \family typewriter
5352
5353 \backslash
5354 tablenum
5355 \family default
5356  (2.15.4), 
5357 \family typewriter
5358
5359 \backslash
5360 tableline
5361 \family default
5362  (2.15.4, insert it as the first element in the lefthand cell after where
5363  you want it.
5364  Don't use any of LyX's rules in the table), 
5365 \family typewriter
5366
5367 \backslash
5368 tablenotemark
5369 \family default
5370  (2.15.5), 
5371 \family typewriter
5372
5373 \backslash
5374 tablenotetext
5375 \family default
5376  (2.15.5), much of Misc (2.17, except 
5377 \family typewriter
5378
5379 \backslash
5380 objectname
5381 \family default
5382
5383 \family typewriter
5384
5385 \backslash
5386 dataset
5387 \family default
5388
5389 \family typewriter
5390
5391 \backslash
5392 url
5393 \family default
5394 , and 
5395 \family typewriter
5396
5397 \backslash
5398 email
5399 \family default
5400 ; see above), 
5401 \family typewriter
5402
5403 \backslash
5404 singlespace
5405 \family default
5406  (3.1), 
5407 \family typewriter
5408
5409 \backslash
5410 doublespace
5411 \family default
5412  (3.1), 
5413 \family typewriter
5414
5415 \backslash
5416 onecolumn
5417 \family default
5418  (3.2), 
5419 \family typewriter
5420
5421 \backslash
5422 twocolumn
5423 \family default
5424  (3.2)
5425 \end_layout
5426
5427 \begin_layout Standard
5428 \begin_inset ERT
5429 status open
5430
5431 \begin_layout Plain Layout
5432
5433
5434 \backslash
5435 end{sloppypar}
5436 \end_layout
5437
5438 \end_inset
5439
5440
5441 \end_layout
5442
5443 \begin_layout Subsubsection
5444 Things that cannot be implemented
5445 \end_layout
5446
5447 \begin_layout Standard
5448 \SpecialChar \ldots{}
5449  at least in any meaningful sort of way, so I suggest ignoring them.
5450  They are the references environment (2.13.3), and the deluxetable environment
5451  (2.15).
5452  If you really, really need to use deluxetable, I suggest editing it in
5453  a separate file with a text editor, then using 
5454 \family sans
5455 \bar under
5456 I
5457 \bar default
5458 nsert\SpecialChar \menuseparator
5459 Chil
5460 \bar under
5461 d
5462 \bar default
5463
5464 \begin_inset space ~
5465 \end_inset
5466
5467 Document
5468 \family default
5469  to include it in your LyX document.
5470  See the 
5471 \family typewriter
5472 aas_sample.lyx
5473 \family default
5474  file to see an example of this.
5475 \end_layout
5476
5477 \begin_layout Subsection
5478 FAQs, Tips, Tricks, and Other Ruminations
5479 \end_layout
5480
5481 \begin_layout Subsubsection
5482 Getting LyX and AASTeX to cooperate
5483 \end_layout
5484
5485 \begin_layout Standard
5486 It can be a bit tricky to get LyX to recognize a new layout and document
5487  class.
5488  When all else fails, do this:
5489 \end_layout
5490
5491 \begin_layout Enumerate
5492 Make certain that LaTeX can find AASTeX.
5493  Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
5494  a directory completely unrelated to LaTeX or AASTeX and run LaTeX on 
5495 \family typewriter
5496 sample.tex
5497 \family default
5498 .
5499 \end_layout
5500
5501 \begin_layout Enumerate
5502 Make certain that 
5503 \family typewriter
5504 aastex.layout
5505 \family default
5506  appears in LyX's 
5507 \family typewriter
5508 layouts
5509 \family default
5510  folder
5511 \end_layout
5512
5513 \begin_layout Enumerate
5514 Rerun 
5515 \family sans
5516 \bar under
5517 T
5518 \bar default
5519 ools\SpecialChar \menuseparator
5520
5521 \bar under
5522 R
5523 \bar default
5524 econfigure
5525 \family default
5526  in LyX, then restart LyX.
5527 \end_layout
5528
5529 \begin_layout Enumerate
5530 Open a regular new file, not from a template.
5531  Does AASTeX appear in the class list in 
5532 \family sans
5533 \bar under
5534 D
5535 \bar default
5536 ocument\SpecialChar \menuseparator
5537
5538 \bar under
5539 S
5540 \bar default
5541 ettings
5542 \family default
5543 ?
5544 \end_layout
5545
5546 \begin_layout Standard
5547 If you get a warning from an existing AASTeX document about not being able
5548  to find the AASTeX layout or a message about 
5549 \begin_inset Quotes eld
5550 \end_inset
5551
5552 You should not mix title layouts with normal ones
5553 \begin_inset Quotes erd
5554 \end_inset
5555
5556 , things haven't been installed correctly.
5557 \end_layout
5558
5559 \begin_layout Subsubsection
5560 LaTeX error processing a table 
5561 \end_layout
5562
5563 \begin_layout Standard
5564 LyX, by default, attempts to center the table caption/title.
5565  This seems to produce a bad interaction in AASTeX so you should click somewhere
5566  in the caption/title, then select 
5567 \family sans
5568 \bar under
5569 E
5570 \bar default
5571 dit\SpecialChar \menuseparator
5572
5573 \bar under
5574 P
5575 \bar default
5576 aragraph
5577 \begin_inset space ~
5578 \end_inset
5579
5580 Settings
5581 \family default
5582 , then set the 
5583 \family sans
5584 Alignment
5585 \family default
5586  to 
5587 \family sans
5588 \bar under
5589 B
5590 \bar default
5591 lock
5592 \family default
5593 .
5594  This took care of it for me.
5595 \end_layout
5596
5597 \begin_layout Subsubsection
5598 References
5599 \end_layout
5600
5601 \begin_layout Standard
5602 A couple of things: 1) I have noticed some funny spacing in the reference
5603  entries in the text.
5604  When you enter the bibliography item data, make sure their is 
5605 \emph on
5606 no
5607 \emph default
5608  space between the last author and the parenthesis setting off the year;
5609  
5610 \emph on
5611 e.
5612 \begin_inset space \thinspace{}
5613 \end_inset
5614
5615 g.
5616 \begin_inset space ~
5617 \end_inset
5618
5619
5620 \emph default
5621 type 
5622 \family typewriter
5623 Ressler(1992)
5624 \family default
5625 , not 
5626 \family typewriter
5627 Ressler (1992)
5628 \family default
5629 .
5630  2) Entering the references at all is not obvious.
5631  The easiest thing is to start typing your first reference at the end of
5632  the document, then mark it as type 
5633 \family sans
5634 References
5635 \family default
5636 .
5637  That will put a small gray box in front of what you just typed.
5638  Click on the box to fill in the rest of the information.
5639  For new references, go to the end of an existing reference and press return.
5640  That will create a new line with its own box, etc.
5641 \end_layout
5642
5643 \begin_layout Subsubsection
5644 Including EPS files
5645 \end_layout
5646
5647 \begin_layout Standard
5648 Even though AASTeX provides its own figure commands (
5649 \family typewriter
5650
5651 \backslash
5652 plotone
5653 \family default
5654 , for example), I much prefer LaTeX's standard figure commands (with the
5655  default graphicx).
5656  You can insert the 
5657 \family typewriter
5658
5659 \backslash
5660 plotone
5661 \family default
5662 , etc.
5663 \begin_inset space ~
5664 \end_inset
5665
5666 commands as ERT into a Figure Float box if you desire, but I never have
5667  much luck getting the layout right.
5668  With the standard graphics, LyX will insert a 
5669 \family typewriter
5670
5671 \backslash
5672 usepackage{graphicx}
5673 \family default
5674  command into the LaTeX preamble and handle the figures in the standard
5675  LaTeX2e way, interspersing the figures in the text.
5676  I believe ApJ accepts figures exactly this way now; AJ might still use
5677  the 
5678 \begin_inset Quotes eld
5679 \end_inset
5680
5681 stack everything at the end
5682 \begin_inset Quotes erd
5683 \end_inset
5684
5685  technique.
5686 \end_layout
5687
5688 \begin_layout Subsubsection
5689 Things I could have done, but didn't
5690 \end_layout
5691
5692 \begin_layout Standard
5693 There are a few 
5694 \begin_inset Quotes eld
5695 \end_inset
5696
5697 pretty
5698 \begin_inset Quotes erd
5699 \end_inset
5700
5701  things I could have implemented, but chose not to.
5702  For instance, I saw no point in double-spacing the text in the LyX window,
5703  even though it is double-spaced in the paper manuscript.
5704  Also, I chose not to make separate layouts for the preprint and preprint2
5705  styles.
5706  Since I assume you will spend most of your time in the plain manuscript
5707  mode anyway, I decided not to chew up more disk space with this.
5708  
5709 \end_layout
5710
5711 \begin_layout Subsection
5712 Final Caveat
5713 \end_layout
5714
5715 \begin_layout Standard
5716 Your mileage may vary.
5717  I've now had papers published by both ApJ and AJ that have had 98% of the
5718  effort done in LyX; the last 2% was the LaTeX post-processing and a few
5719  cleanups.
5720  I have had no trouble with the submission process, and I'm sure the journals
5721  were never aware that there might be a difference.
5722  So, go forth and publish!
5723 \end_layout
5724
5725 \begin_layout Section
5726 ijmpc and ijmpd
5727 \end_layout
5728
5729 \begin_layout Standard
5730 by 
5731 \noun on
5732 Panayotis Papasotiriou
5733 \end_layout
5734
5735 \begin_layout Subsection
5736 Overview
5737 \end_layout
5738
5739 \begin_layout Standard
5740 The ijmpc package is a set of macros that facilitates electronic manuscript
5741  submission to the 
5742 \emph on
5743 International Journal of Modern Physics C
5744 \emph default
5745 .
5746  Similarly, the ijmpd package is for creating manuscripts to be submitted
5747  to the 
5748 \emph on
5749 International Journal of Modern Physics D
5750 \emph default
5751 .
5752  Both journals are published by World Scientific.
5753  The corresponding document classes are named 
5754 \family typewriter
5755 ws-ijmpc.cls
5756 \family default
5757  and 
5758 \family typewriter
5759 ws-ijmpd.cls
5760 \family default
5761 , respectively.
5762  These files, together with instructions for the authors, can be downloaded
5763  from the sites 
5764 \begin_inset Flex URL
5765 status collapsed
5766
5767 \begin_layout Plain Layout
5768
5769 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
5770 \end_layout
5771
5772 \end_inset
5773
5774  and 
5775 \begin_inset Flex URL
5776 status collapsed
5777
5778 \begin_layout Plain Layout
5779
5780 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
5781 \end_layout
5782
5783 \end_inset
5784
5785 .
5786  Both packages are modified versions of the standard 
5787 \begin_inset Quotes eld
5788 \end_inset
5789
5790 article
5791 \begin_inset Quotes erd
5792 \end_inset
5793
5794  package, and they are almost (but not exactly) identical.
5795  Most of their features are supported by LyX.
5796  I have used LyX successfully to write articles submitted to both journals
5797  without any problem.
5798 \end_layout
5799
5800 \begin_layout Subsection
5801 Writing a paper
5802 \end_layout
5803
5804 \begin_layout Standard
5805 As usual, the easiest way to write a paper is to start with a template.
5806  Click on 
5807 \family sans
5808 \bar under
5809 F
5810 \bar default
5811 ile\SpecialChar \menuseparator
5812 New from
5813 \family default
5814  
5815 \family sans
5816 \bar under
5817 T
5818 \bar default
5819 emplate
5820 \family default
5821 , then choose the 
5822 \family typewriter
5823 ijmpc.lyx
5824 \family default
5825  or 
5826 \family typewriter
5827 ijmpd.lyx
5828 \family default
5829  template.
5830  This will give an (almost) empty document that includes the most common
5831  fields found in a manuscript.
5832  Simply overwrite the existing text (including the brackets, 
5833 \family typewriter
5834 <>
5835 \family default
5836 ) with your text.
5837  You should keep in mind the following remarks.
5838 \end_layout
5839
5840 \begin_layout Enumerate
5841 LyX won't let you change the font size and the page style of the document,
5842  because such modifications are not allowed by both packages.
5843 \end_layout
5844
5845 \begin_layout Enumerate
5846 The language of the document should not be changed.
5847  Before previewing your paper, be sure that the babel package is not used.
5848  To do this, click on 
5849 \family sans
5850 \bar under
5851 T
5852 \bar default
5853 ools\SpecialChar \menuseparator
5854
5855 \bar under
5856 P
5857 \bar default
5858 references
5859 \family default
5860 , select the 
5861 \family sans
5862 Lang Opts
5863 \family default
5864  tab, deselect the 
5865 \family sans
5866 \bar under
5867 U
5868 \bar default
5869 se babel
5870 \family default
5871  checkbox in the language settings, and click on 
5872 \family sans
5873 \bar under
5874 A
5875 \bar default
5876 pply
5877 \family default
5878  (or 
5879 \family sans
5880 Save
5881 \family default
5882 , if you wish to make this change permanent).
5883 \end_layout
5884
5885 \begin_layout Enumerate
5886 The 
5887 \begin_inset Quotes eld
5888 \end_inset
5889
5890 Keywords
5891 \begin_inset Quotes erd
5892 \end_inset
5893
5894  style must be used to define keywords.
5895 \end_layout
5896
5897 \begin_layout Enumerate
5898 The ijmpc package provides a style named 
5899 \begin_inset Quotes eld
5900 \end_inset
5901
5902 Classification Codes
5903 \begin_inset Quotes erd
5904 \end_inset
5905
5906 , which can be used to define classification codes, such as PACS numbers.
5907  Note that this facility is not supported by the ijmpd package.
5908 \end_layout
5909
5910 \begin_layout Enumerate
5911 Several new environments are available: 
5912 \begin_inset Quotes eld
5913 \end_inset
5914
5915 Definition
5916 \begin_inset Quotes erd
5917 \end_inset
5918
5919
5920 \begin_inset Quotes eld
5921 \end_inset
5922
5923 Step
5924 \begin_inset Quotes erd
5925 \end_inset
5926
5927
5928 \begin_inset Quotes eld
5929 \end_inset
5930
5931 Example
5932 \begin_inset Quotes erd
5933 \end_inset
5934
5935
5936 \begin_inset Quotes eld
5937 \end_inset
5938
5939 Remark
5940 \begin_inset Quotes erd
5941 \end_inset
5942
5943
5944 \begin_inset Quotes eld
5945 \end_inset
5946
5947 Notation
5948 \begin_inset Quotes erd
5949 \end_inset
5950
5951
5952 \begin_inset Quotes eld
5953 \end_inset
5954
5955 Theorem
5956 \begin_inset Quotes erd
5957 \end_inset
5958
5959
5960 \begin_inset Quotes eld
5961 \end_inset
5962
5963 Proof
5964 \begin_inset Quotes erd
5965 \end_inset
5966
5967
5968 \begin_inset Quotes eld
5969 \end_inset
5970
5971 Corollary
5972 \begin_inset Quotes erd
5973 \end_inset
5974
5975
5976 \begin_inset Quotes eld
5977 \end_inset
5978
5979 Lemma
5980 \begin_inset Quotes erd
5981 \end_inset
5982
5983
5984 \begin_inset Quotes eld
5985 \end_inset
5986
5987 Proposition
5988 \begin_inset Quotes erd
5989 \end_inset
5990
5991
5992 \begin_inset Quotes eld
5993 \end_inset
5994
5995 Prop
5996 \begin_inset Quotes erd
5997 \end_inset
5998
5999
6000 \begin_inset Quotes eld
6001 \end_inset
6002
6003 Question
6004 \begin_inset Quotes erd
6005 \end_inset
6006
6007
6008 \begin_inset Quotes eld
6009 \end_inset
6010
6011 Claim
6012 \begin_inset Quotes erd
6013 \end_inset
6014
6015 , and 
6016 \begin_inset Quotes eld
6017 \end_inset
6018
6019 Conjecture
6020 \begin_inset Quotes erd
6021 \end_inset
6022
6023 .
6024  Their use is more or less obvious.
6025  LyX supports all these environments; it will use the proper label, text
6026  style, and numbering scheme for each of them.
6027 \end_layout
6028
6029 \begin_layout Enumerate
6030 Both packages use basic citations; the natbib package should not be used.
6031  In LyX, citation references are shown as usual; in the output, citations
6032  are shown as superscripts.
6033  If you want to use a citation as normal text, you should use the 
6034 \family typewriter
6035 refcite
6036 \family default
6037  command, e.
6038 \begin_inset space \thinspace{}
6039 \end_inset
6040
6041 g., 
6042 \begin_inset Quotes eld
6043 \end_inset
6044
6045 See Ref.
6046 \begin_inset space ~
6047 \end_inset
6048
6049
6050 \family typewriter
6051
6052 \backslash
6053 refcite{key}
6054 \family default
6055
6056 \begin_inset Quotes erd
6057 \end_inset
6058
6059 .
6060 \end_layout
6061
6062 \begin_layout Enumerate
6063 There is no 
6064 \begin_inset Quotes eld
6065 \end_inset
6066
6067 Acknowledgments
6068 \begin_inset Quotes erd
6069 \end_inset
6070
6071  section in both packages.
6072  To put acknowledgments, just use the 
6073 \begin_inset Quotes eld
6074 \end_inset
6075
6076 Section*
6077 \begin_inset Quotes erd
6078 \end_inset
6079
6080  environment.
6081 \end_layout
6082
6083 \begin_layout Enumerate
6084 Appendices may be added to the paper, 
6085 \emph on
6086 after
6087 \emph default
6088  the Acknowledgments and 
6089 \shape italic
6090 before
6091 \shape default
6092  the References.
6093  LyX provides a special environment, called 
6094 \begin_inset Quotes eld
6095 \end_inset
6096
6097 Appendices Section
6098 \begin_inset Quotes erd
6099 \end_inset
6100
6101  which marks the beginning of the appendices.
6102  This environment should be left blank; it just sends a LaTeX command, but
6103  nothing is really printed.
6104  In LyX, the word 
6105 \begin_inset Quotes eld
6106 \end_inset
6107
6108 Appendix
6109 \begin_inset Quotes erd
6110 \end_inset
6111
6112  is printed with blue letters, as a signal that all sections after that
6113  point are appendices.
6114  To write an appendix, use the 
6115 \begin_inset Quotes eld
6116 \end_inset
6117
6118 Appendix
6119 \begin_inset Quotes erd
6120 \end_inset
6121
6122  environment.
6123  LyX will number each appendix with capital letters, as required by both
6124  journals.
6125  Note that 
6126 \begin_inset Quotes eld
6127 \end_inset
6128
6129 Appendices Section
6130 \begin_inset Quotes erd
6131 \end_inset
6132
6133  
6134 \emph on
6135 must
6136 \emph default
6137  be present before the first appendix; if not, all appendices will be numbered
6138  as normal sections in the output.
6139 \end_layout
6140
6141 \begin_layout Enumerate
6142 The ijmpc and the ijmpd packages use the 
6143 \family typewriter
6144 tbl
6145 \family default
6146  command to implement table captions.
6147  As a result, a table created by LyX is printed correctly, but its caption
6148  is ignored.
6149  However, you can use some ERT to overpass this problem, so that captions
6150  are printed as expected.
6151  To do so, create a float table as usual, remove the caption, and replace
6152  it with the ERT 
6153 \family typewriter
6154
6155 \backslash
6156 tbl{
6157 \emph on
6158 your table caption
6159 \emph default
6160 }{
6161 \family default
6162  (sic); you must also the ERT 
6163 \family typewriter
6164 }
6165 \family default
6166  immediately after the tabular material.
6167  Study the example table included in the template files to see how this
6168  trick is implemented.
6169  Alternatively, If you need table captions, you should implement the whole
6170  table float in a 
6171 \family typewriter
6172 .tex
6173 \family default
6174  file, then include this file to the LyX document (
6175 \family sans
6176 \bar under
6177 I
6178 \bar default
6179 nsert\SpecialChar \menuseparator
6180 Fil
6181 \bar under
6182 e
6183 \bar default
6184 \SpecialChar \menuseparator
6185 Chil
6186 \bar under
6187 d
6188 \bar default
6189
6190 \begin_inset space ~
6191 \end_inset
6192
6193 Document
6194 \family default
6195 ).
6196  Details on how to create a table float can be found in the files 
6197 \family typewriter
6198 ws-ijmpc.tex
6199 \family default
6200  and 
6201 \family typewriter
6202 ws-ijmpd.tex
6203 \family default
6204 , included in the corresponding packages.
6205 \end_layout
6206
6207 \begin_layout Subsection
6208 Preparing a paper for submission
6209 \end_layout
6210
6211 \begin_layout Standard
6212 Before you submit your paper you must export the LyX document as a LaTeX
6213  file (
6214 \family sans
6215 \bar under
6216 F
6217 \bar default
6218 ile\SpecialChar \menuseparator
6219
6220 \bar under
6221 E
6222 \bar default
6223 xport\SpecialChar \menuseparator
6224
6225 \bar under
6226 L
6227 \bar default
6228 a
6229 \family default
6230 T
6231 \family sans
6232 eX
6233 \family default
6234 )
6235 \begin_inset Foot
6236 status open
6237
6238 \begin_layout Plain Layout
6239 Actually you have the choice between LaTeX (plain) and pdflatex.
6240  If you intend to use pdflatex to prepare the paper, you should use the
6241  pdflatex option so that included graphics are converted to PDF format,
6242  ready for use by pdflatex.
6243 \end_layout
6244
6245 \end_inset
6246
6247 , then make the following changes to the resulting 
6248 \family typewriter
6249 .tex
6250 \family default
6251  file.
6252 \end_layout
6253
6254 \begin_layout Enumerate
6255 Remove the comment lines before the 
6256 \family typewriter
6257
6258 \backslash
6259 documentclass
6260 \family default
6261  command.
6262 \end_layout
6263
6264 \begin_layout Enumerate
6265 Remove everything between (and including) the 
6266 \family typewriter
6267
6268 \backslash
6269 makeatletter
6270 \family default
6271  and 
6272 \family typewriter
6273
6274 \backslash
6275 makeatother
6276 \family default
6277  commands, except for any commands you specifically put into the LaTeX preamble.
6278 \end_layout
6279
6280 \begin_layout Standard
6281 The modified 
6282 \family typewriter
6283 .tex
6284 \family default
6285  file should be saved and processed through LaTeX as many times as necessary.
6286  You may also want to check the resulting 
6287 \family typewriter
6288 .dvi
6289 \family default
6290  document.
6291 \end_layout
6292
6293 \begin_layout Subsection
6294 Use of ERT
6295 \end_layout
6296
6297 \begin_layout Standard
6298 The use of ERT is reduced to two commands, which must be placed at the top
6299  of the document.
6300  If you started writing your paper by using the 
6301 \family typewriter
6302 ijmpc.lyx
6303 \family default
6304  or the 
6305 \family typewriter
6306 ijmpd.lyx
6307 \family default
6308  template, the ERT needed is already in its place; you usually don't need
6309  to delete it.
6310  You may only modify the first ERT to specify the information printed to
6311  the top of odd and even pages (authors' names and short paper's title,
6312  respectively).
6313  This ERT must have the form 
6314 \family typewriter
6315
6316 \backslash
6317 markboth{Authors' Names}{Short Paper's Title}
6318 \family default
6319 .
6320 \end_layout
6321
6322 \begin_layout Section
6323 iopart
6324 \end_layout
6325
6326 \begin_layout Standard
6327 by 
6328 \noun on
6329 Uwe Stöhr
6330 \end_layout
6331
6332 \begin_layout Subsection
6333 Overview
6334 \end_layout
6335
6336 \begin_layout Standard
6337 The iopart package provides a document class to create electronic manuscript
6338  submission to the journals published by the Institute of Physics.
6339  Instructions for the authors how to create a paper using the iopart class
6340  can be downloaded together with the iopart package from the site 
6341 \begin_inset Flex URL
6342 status collapsed
6343
6344 \begin_layout Plain Layout
6345
6346 ftp://ftp.iop.org/pub/journals/latex2e
6347 \end_layout
6348
6349 \end_inset
6350
6351 .
6352 \end_layout
6353
6354 \begin_layout Subsection
6355 Writing a paper
6356 \end_layout
6357
6358 \begin_layout Standard
6359 The easiest way to write a paper is to start with the file 
6360 \emph on
6361 IOP-article.lyx
6362 \emph default
6363  that is available in LyX's examples files folder.
6364  Open this file, save it under a new name, and start writing.
6365  The example file explains how to use the special text environments.
6366  Here are the most important advices:
6367 \end_layout
6368
6369 \begin_layout Itemize
6370 To be able to compile your document to a PDF, PS, or DVI, assure that the
6371  two options 
6372 \family sans
6373 Use AMS math package
6374 \family default
6375  in the document settings under 
6376 \family sans
6377 Math Options
6378 \family default
6379  are not used!
6380 \end_layout
6381
6382 \begin_layout Itemize
6383
6384 \size normal
6385 The title environment defines the kind of your paper.
6386  So use one of the following environments for the title:
6387 \end_layout
6388
6389 \begin_deeper
6390 \begin_layout Itemize
6391
6392 \family sans
6393 \size normal
6394 Title
6395 \family default
6396  for a Paper
6397 \end_layout
6398
6399 \begin_layout Itemize
6400
6401 \family sans
6402 \size normal
6403 Review
6404 \family default
6405  for a Review
6406 \end_layout
6407
6408 \begin_layout Itemize
6409
6410 \family sans
6411 \size normal
6412 Topical
6413 \family default
6414  for a Topical review
6415 \end_layout
6416
6417 \begin_layout Itemize
6418
6419 \family sans
6420 \size normal
6421 Comment
6422 \family default
6423  for a Comment
6424 \end_layout
6425
6426 \begin_layout Itemize
6427
6428 \family sans
6429 \size normal
6430 Note
6431 \family default
6432  for a Note
6433 \end_layout
6434
6435 \begin_layout Itemize
6436
6437 \family sans
6438 \size normal
6439 Paper
6440 \family default
6441  for a Paper (same as Title)
6442 \end_layout
6443
6444 \begin_layout Itemize
6445
6446 \family sans
6447 \size normal
6448 Prelim
6449 \family default
6450  for a Preliminary communication
6451 \end_layout
6452
6453 \begin_layout Itemize
6454
6455 \family sans
6456 \size normal
6457 Rapid
6458 \family default
6459  for a Rapid communication
6460 \end_layout
6461
6462 \begin_layout Itemize
6463
6464 \family sans
6465 \size normal
6466 Letter
6467 \family default
6468  for a Letter to the editor
6469 \end_layout
6470
6471 \end_deeper
6472 \begin_layout Itemize
6473
6474 \size normal
6475 All title environments except of 
6476 \family sans
6477 Letter
6478 \family default
6479  can have an optional short title.
6480 \end_layout
6481
6482 \begin_layout Itemize
6483 There is a general title environment 
6484 \family sans
6485 Article
6486 \family default
6487  which is not directly supported by the LyX.
6488  This can be used as ERT when your document doesn't fit into one of the
6489  other title types.
6490 \end_layout
6491
6492 \begin_layout Standard
6493 For more informations like hints for special table and formula formatting,
6494  look at the IOP author guidelines.
6495 \end_layout
6496
6497 \begin_layout Section
6498 Kluwer
6499 \end_layout
6500
6501 \begin_layout Standard
6502 by 
6503 \noun on
6504 Panayotis Papasotiriou
6505 \end_layout
6506
6507 \begin_layout Subsection
6508 Overview
6509 \end_layout
6510
6511 \begin_layout Standard
6512 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
6513  that facilitates electronic manuscript submission to the journals they
6514  publish.
6515  Most known of them (at least in my domain of interest) are 
6516 \emph on
6517 Astrophysics and Space Science
6518 \emph default
6519  and 
6520 \emph on
6521 Solar Physics
6522 \emph default
6523 , but there are many others (see a complete list at 
6524 \begin_inset Flex URL
6525 status collapsed
6526
6527 \begin_layout Plain Layout
6528
6529 http://www.wkap.nl/jrnllist.htm/JRNLHOME
6530 \end_layout
6531
6532 \end_inset
6533
6534 ).
6535  The Kluwer package may be downloaded from the site 
6536 \begin_inset Flex URL
6537 status collapsed
6538
6539 \begin_layout Plain Layout
6540
6541 http://www.wkap.nl/kaphtml.htm/STYLEFILES
6542 \end_layout
6543
6544 \end_inset
6545
6546 .
6547  A complete user guide is contained in that package (but it can also be
6548  downloaded separately).
6549 \end_layout
6550
6551 \begin_layout Standard
6552 LyX supports many features of the package but not everything.
6553  However, the ERT needed is reduced to some 
6554 \begin_inset Quotes eld
6555 \end_inset
6556
6557 peculiar
6558 \begin_inset Quotes erd
6559 \end_inset
6560
6561  commands of the package (see
6562 \begin_inset space ~
6563 \end_inset
6564
6565
6566 \begin_inset CommandInset ref
6567 LatexCommand ref
6568 reference "subsec:kluwer_peculiarities"
6569
6570 \end_inset
6571
6572 ).
6573  I have recently used LyX to write an article submitted to the 
6574 \emph on
6575 Astrophysics and Space Science
6576 \emph default
6577  without any problem.
6578 \end_layout
6579
6580 \begin_layout Subsection
6581 Writing a paper
6582 \end_layout
6583
6584 \begin_layout Standard
6585 The easiest way to write a paper is to start with the Kluwer template file.
6586  Click on 
6587 \family sans
6588 File\SpecialChar \menuseparator
6589 New from
6590 \family default
6591  
6592 \family sans
6593 \bar under
6594 T
6595 \bar default
6596 emplate
6597 \family default
6598 , then choose the 
6599 \family typewriter
6600 kluwer.lyx
6601 \family default
6602  template.
6603  This will give an (almost) empty document that includes the most common
6604  fields found in a manuscript and a short description of their use.
6605  As in most templates, simply overwrite the existing text (including the
6606  brackets, 
6607 \family typewriter
6608 <>
6609 \family default
6610 ) with the correct information.
6611 \end_layout
6612
6613 \begin_layout Subsection
6614 Preparing a paper for submission
6615 \end_layout
6616
6617 \begin_layout Standard
6618 As in the AASTeX package, before you submit your paper to a journal you
6619  must 
6620 \begin_inset Quotes eld
6621 \end_inset
6622
6623 postprocess
6624 \begin_inset Quotes erd
6625 \end_inset
6626
6627  it as follows.
6628 \end_layout
6629
6630 \begin_layout Enumerate
6631 Export your paper as a LaTeX file.
6632  To do this, click on 
6633 \family sans
6634 \bar under
6635 F
6636 \bar default
6637 ile\SpecialChar \menuseparator
6638
6639 \bar under
6640 E
6641 \bar default
6642 xport\SpecialChar \menuseparator
6643
6644 \bar under
6645 L
6646 \bar default
6647 aTeX
6648 \family default
6649 .
6650  
6651 \end_layout
6652
6653 \begin_layout Enumerate
6654 Edit the resulting 
6655 \family typewriter
6656 .tex
6657 \family default
6658  file with a text editor and make the following changes
6659 \end_layout
6660
6661 \begin_deeper
6662 \begin_layout Enumerate
6663 remove the comment lines before the 
6664 \family typewriter
6665
6666 \backslash
6667 documentclass
6668 \family default
6669  command,
6670 \end_layout
6671
6672 \begin_layout Enumerate
6673 remove everything between (and including) the 
6674 \family typewriter
6675
6676 \backslash
6677 makeatletter
6678 \family default
6679  and 
6680 \family typewriter
6681
6682 \backslash
6683 makeatother
6684 \family default
6685  commands, except for any commands you specifically put into the LaTeX preamble.
6686 \end_layout
6687
6688 \begin_layout Standard
6689 Save the resulting 
6690 \family typewriter
6691 .tex
6692 \family default
6693  file.
6694 \end_layout
6695
6696 \end_deeper
6697 \begin_layout Enumerate
6698 Run the 
6699 \family typewriter
6700 .tex
6701 \family default
6702  file through LaTeX as many times as necessary (usually up to three).
6703 \end_layout
6704
6705 \begin_layout Enumerate
6706 View the resulting 
6707 \family typewriter
6708 .dvi
6709 \family default
6710  document using, e.
6711 \begin_inset space \thinspace{}
6712 \end_inset
6713
6714 g., 
6715 \family sans
6716 xdvi
6717 \family default
6718 , and check if everything is OK (it should, if you didn't make any mistake).
6719 \end_layout
6720
6721 \begin_layout Subsection
6722 \begin_inset Quotes eld
6723 \end_inset
6724
6725 Peculiarities
6726 \begin_inset Quotes erd
6727 \end_inset
6728
6729  of the Kluwer package
6730 \begin_inset CommandInset label
6731 LatexCommand label
6732 name "subsec:kluwer_peculiarities"
6733
6734 \end_inset
6735
6736
6737 \end_layout
6738
6739 \begin_layout Standard
6740 The Kluwer package has the following 
6741 \begin_inset Quotes eld
6742 \end_inset
6743
6744 peculiarities
6745 \begin_inset Quotes erd
6746 \end_inset
6747
6748 .
6749 \end_layout
6750
6751 \begin_layout Enumerate
6752 It is possible to write multiple articles in the same LaTeX file
6753 \begin_inset Foot
6754 status collapsed
6755
6756 \begin_layout Plain Layout
6757 I can't imagine any good reason to do this.
6758 \end_layout
6759
6760 \end_inset
6761
6762 .
6763  Each article must be included in the environment 
6764 \begin_inset Quotes eld
6765 \end_inset
6766
6767 article
6768 \begin_inset Quotes erd
6769 \end_inset
6770
6771 .
6772  Unfortunately, this environment cannot be omitted, even if you write just
6773  one article.
6774  Therefore, each article starts with the command 
6775 \family typewriter
6776
6777 \backslash
6778 begin{article}
6779 \family default
6780  and, obviously, ends with the command 
6781 \family typewriter
6782
6783 \backslash
6784 end{article}
6785 \family default
6786 .
6787  Although this can be implemented in LyX, I didn't included it, since it
6788  looks ugly and can confuse the novice user.
6789  Therefore, you need to enter them directly and mark them as LaTeX code
6790  (the well-known 
6791 \begin_inset Quotes eld
6792 \end_inset
6793
6794 ERT
6795 \begin_inset Quotes erd
6796 \end_inset
6797
6798 ).
6799 \end_layout
6800
6801 \begin_layout Enumerate
6802 Information given at the beginning of the article (i.e., title, subtitle,
6803  author, institution, running title, running author, abstract and keywords)
6804  must be included in an environment called 
6805 \begin_inset Quotes eld
6806 \end_inset
6807
6808 opening
6809 \begin_inset Quotes erd
6810 \end_inset
6811
6812 .
6813  This is not implemented in LyX, so you must enter title, subtitle etc.
6814 \begin_inset space ~
6815 \end_inset
6816
6817 between two ERT lines (
6818 \family typewriter
6819
6820 \backslash
6821 begin{opening}
6822 \family default
6823  and 
6824 \family typewriter
6825
6826 \backslash
6827 end{opening}
6828 \family default
6829 ).
6830 \end_layout
6831
6832 \begin_layout Enumerate
6833 According to the user manual, the label of each bibliography item must be
6834  written as 
6835 \family typewriter
6836
6837 \backslash
6838 protect
6839 \backslash
6840 citeauthoryear{
6841 \family default
6842 \emph on
6843 author(s)
6844 \family typewriter
6845 \emph default
6846 }{
6847 \family default
6848 \emph on
6849 year
6850 \family typewriter
6851 \emph default
6852 }
6853 \family default
6854 .
6855 \end_layout
6856
6857 \begin_layout Standard
6858 The 
6859 \family typewriter
6860 kluwer.lyx
6861 \family default
6862  template takes care of all these 
6863 \begin_inset Quotes eld
6864 \end_inset
6865
6866 peculiarities
6867 \begin_inset Quotes erd
6868 \end_inset
6869
6870 .
6871  If you start a new paper using this template you don't need to do anything
6872  special.
6873  Just 
6874 \end_layout
6875
6876 \begin_layout Enumerate
6877 don't delete the ERT included in the template, and
6878 \end_layout
6879
6880 \begin_layout Enumerate
6881 copy the example bibliography item included in the template and modify it
6882  as necessary to enter new bibliography items.
6883 \end_layout
6884
6885 \begin_layout Section
6886 Koma-Script
6887 \end_layout
6888
6889 \begin_layout Standard
6890 by 
6891 \noun on
6892 Bernd Rellermeyer
6893 \end_layout
6894
6895 \begin_layout Subsection
6896 Overview
6897 \end_layout
6898
6899 \begin_layout Standard
6900 The LyX document classes 
6901 \emph on
6902 article (koma-script)
6903 \emph default
6904
6905 \emph on
6906 report (koma-script)
6907 \emph default
6908
6909 \emph on
6910 book
6911 \emph default
6912  
6913 \emph on
6914 (koma-script)
6915 \emph default
6916 , and 
6917 \emph on
6918 letter
6919 \emph default
6920  
6921 \emph on
6922 (koma-script)
6923 \emph default
6924  correspond to the LaTeX document classes 
6925 \family typewriter
6926 scrartcl.cls
6927 \family default
6928
6929 \family typewriter
6930 scrreprt.cls
6931 \family default
6932
6933 \family typewriter
6934 scrbook.cls
6935 \family default
6936 , and 
6937 \family typewriter
6938 scrlettr.cls
6939 \family default
6940 , resp.
6941 \begin_inset space ~
6942 \end_inset
6943
6944 of the Koma-Script family.
6945  They are replacements for the standard document classes 
6946 \family typewriter
6947 article.cls
6948 \family default
6949
6950 \family typewriter
6951 report.cls
6952 \family default
6953
6954 \family typewriter
6955 book.cls
6956 \family default
6957  and 
6958 \family typewriter
6959 letter.cls
6960 \family default
6961 , resp., and fit better to European typography conventions in a number of
6962  points.
6963 \end_layout
6964
6965 \begin_layout Itemize
6966 Standard character size is 11pt in 
6967 \emph on
6968 article (koma-script)
6969 \emph default
6970
6971 \emph on
6972 report (koma-script)
6973 \emph default
6974 , and 
6975 \emph on
6976 book (koma-script)
6977 \emph default
6978 , and 12pt in 
6979 \emph on
6980 letter (koma-script)
6981 \emph default
6982 .
6983 \end_layout
6984
6985 \begin_layout Itemize
6986 Headings, labels of the description environment, and a number of elements
6987  of the 
6988 \emph on
6989 letter (koma-script)
6990 \emph default
6991  document class are set in a bold sans serif font.
6992 \begin_inset Foot
6993 status collapsed
6994
6995 \begin_layout Plain Layout
6996 There is a big difference between the bold sans serif old cm fonts and new
6997  ec fonts, especially in the appearance of headings.
6998  In comparison, the ec bold sans serif fonts look a bit thin.
6999  Here the LaTeX package 
7000 \family typewriter
7001 cmsd.sty by
7002 \family default
7003  
7004 \shape smallcaps
7005 Walter Schmidt
7006 \shape default
7007  helps to produce the 
7008 \begin_inset Quotes eld
7009 \end_inset
7010
7011 usual
7012 \begin_inset Quotes erd
7013 \end_inset
7014
7015  appearance when using the ec fonts.
7016 \end_layout
7017
7018 \end_inset
7019
7020  The numbering of chapter headings is made in the same way as the numbering
7021  of section headings, that is without the extra line 
7022 \begin_inset Quotes eld
7023 \end_inset
7024
7025 Chapter\SpecialChar \ldots{}
7026
7027 \begin_inset Quotes erd
7028 \end_inset
7029
7030 .
7031  In addition, the appearance of the headings can be modified by using a
7032  number of options (in LyX to be entered in the field 
7033 \family sans
7034 E
7035 \bar under
7036 x
7037 \bar default
7038 tra
7039 \begin_inset space ~
7040 \end_inset
7041
7042 Options
7043 \family default
7044  of the dialog 
7045 \family sans
7046 \bar under
7047 L
7048 \bar default
7049 ayout\SpecialChar \menuseparator
7050
7051 \bar under
7052 D
7053 \bar default
7054 ocument
7055 \family default
7056 ).
7057  A detailed German description of these options can be found in the Koma-Script
7058  documentation 
7059 \emph on
7060 scrguide
7061 \emph default
7062 .
7063 \end_layout
7064
7065 \begin_layout Itemize
7066 The main means in the Koma-Script document classes to design the type area
7067  are the options 
7068 \family sans
7069 BCOR
7070 \family default
7071  and 
7072 \family sans
7073 DIV
7074 \family default
7075  (in LyX to be entered in the extra class options field in the dialog 
7076 \family sans
7077 \bar under
7078 D
7079 \bar default
7080 ocument\SpecialChar \menuseparator
7081
7082 \bar under
7083 S
7084 \bar default
7085 ettings
7086 \family default
7087 ).
7088  They make a clearer modification of page margins possible as do the options
7089  of the dialog 
7090 \family sans
7091 \bar under
7092 D
7093 \bar default
7094 ocument\SpecialChar \menuseparator
7095
7096 \bar under
7097 S
7098 \bar default
7099 ettings
7100 \family default
7101 .
7102  A detailed German description of these and other type area options can
7103  be found in the Koma-Script documentation 
7104 \emph on
7105 scrguide
7106 \emph default
7107 .
7108 \end_layout
7109
7110 \begin_layout Itemize
7111 The LaTeX document classes of the Koma-Script family define a number of
7112  additional commands.
7113  Those part of it which makes sense in LyX is implemented in corresponding
7114  paragraph types.
7115 \end_layout
7116
7117 \begin_layout Standard
7118 A detailed German description of the LaTeX document classes of the Koma-Script
7119  family can be found in the Koma-Script documentation 
7120 \emph on
7121 scrguide
7122 \emph default
7123 .
7124 \begin_inset Foot
7125 status collapsed
7126
7127 \begin_layout Plain Layout
7128 There is an English translation 
7129 \emph on
7130 screnggu
7131 \emph default
7132 , but it is not a complete one.
7133 \end_layout
7134
7135 \end_inset
7136
7137  The following sections describe only those aspects, which are relevant
7138  in LyX.
7139 \end_layout
7140
7141 \begin_layout Subsection
7142 article (koma-script), report (koma-script), and book (koma-script)
7143 \end_layout
7144
7145 \begin_layout Standard
7146 The document classes 
7147 \emph on
7148 article (koma-script)
7149 \emph default
7150
7151 \emph on
7152 report (koma-script)
7153 \emph default
7154 , and 
7155 \emph on
7156 book
7157 \emph default
7158  
7159 \emph on
7160 (koma-script)
7161 \emph default
7162  are implemented in the layout files 
7163 \family typewriter
7164 scrartcl.layout
7165 \family default
7166
7167 \family typewriter
7168 scrreprt.layout
7169 \family default
7170 , and 
7171 \family typewriter
7172 scrbook.layout
7173 \family default
7174 , resp.
7175  They contain all the paragraph types of the corresponding standard document
7176  classes 
7177 \emph on
7178 article
7179 \emph default
7180
7181 \emph on
7182 report
7183 \emph default
7184 , and 
7185 \emph on
7186 book
7187 \emph default
7188 , resp., partly modified, with the exception of the LyX specific 
7189 \family sans
7190 List
7191 \family default
7192 -type, which is replaced by the new 
7193 \family sans
7194 Labeling
7195 \family default
7196 -type having the same functionality.
7197  Beside the 
7198 \family sans
7199 Labeling
7200 \family default
7201 -Type there is a number of new paragraph types added.
7202  They are 
7203 \emph on
7204 not
7205 \emph default
7206  part of 
7207 \emph on
7208 letter (koma-script)
7209 \emph default
7210 .
7211 \end_layout
7212
7213 \begin_layout Itemize
7214
7215 \family sans
7216 Addpart, Addchap
7217 \family default
7218
7219 \family sans
7220 Addsec
7221 \family default
7222 : are equivalents to 
7223 \family sans
7224 Part*, Chapter*
7225 \family default
7226  and 
7227 \family sans
7228 Section*
7229 \family default
7230 , resp., additionally inserting an entry in the table of contents.
7231  
7232 \family sans
7233 Addpart
7234 \family default
7235  and 
7236 \family sans
7237 Addchap
7238 \family default
7239  are not contained in 
7240 \emph on
7241 article (koma-script)
7242 \emph default
7243 .
7244 \end_layout
7245
7246 \begin_layout Itemize
7247
7248 \family sans
7249 Addchap*
7250 \family default
7251
7252 \family sans
7253 Addsec*
7254 \family default
7255 : behave exactly as 
7256 \family sans
7257 Addchap
7258 \family default
7259  and 
7260 \family sans
7261 Addsec
7262 \family default
7263 , resp., additionally clearing running heads.
7264  
7265 \family sans
7266 Addchap*
7267 \family default
7268  is not contained in 
7269 \emph on
7270 article (koma-script)
7271 \emph default
7272 .
7273 \begin_inset Foot
7274 status collapsed
7275
7276 \begin_layout Plain Layout
7277 There is also an 
7278 \family typewriter
7279
7280 \backslash
7281 addpart*
7282 \family default
7283  command in 
7284 \emph on
7285 book (koma-script)
7286 \emph default
7287  and in 
7288 \emph on
7289 report (koma-script)
7290 \emph default
7291 , but since this is identical to 
7292 \family sans
7293 Part*
7294 \family default
7295 , is has not been implemented in LyX.
7296 \end_layout
7297
7298 \end_inset
7299
7300
7301 \end_layout
7302
7303 \begin_layout Itemize
7304
7305 \family sans
7306 Minisec
7307 \family default
7308 : generates a heading directly above the following paragraph in the standard
7309  character size without affecting the structure of the document.
7310 \end_layout
7311
7312 \begin_layout Itemize
7313
7314 \family sans
7315 Captionabove
7316 \family default
7317  and 
7318 \family sans
7319 Captionbelow
7320 \family default
7321  are special captions which respect the different space settings needed
7322  for captions placed above or below an element (if you follow strict typographic
7323  rules, you might want to place table captions always above the table).
7324  You can also use the class option 
7325 \family typewriter
7326 tablecaptionsabove
7327 \family default
7328 , which will switch 
7329 \family sans
7330 caption
7331 \family default
7332  to 
7333 \family sans
7334 captionabove
7335 \family default
7336  for tables and 
7337 \family sans
7338 captionbelow
7339 \family default
7340  for figures.
7341  You need at least Koma-Script version 2.8q to use this.
7342 \end_layout
7343
7344 \begin_layout Itemize
7345
7346 \family sans
7347 Dictum
7348 \family default
7349 : can be used to set a bonmot, e.
7350 \begin_inset space \thinspace{}
7351 \end_inset
7352
7353 g.
7354 \begin_inset space ~
7355 \end_inset
7356
7357 at the beginning of a chapter.
7358  If you use the optional argument (
7359 \family sans
7360 \bar under
7361 I
7362 \bar default
7363 nsert\SpecialChar \menuseparator
7364 Short
7365 \begin_inset space ~
7366 \end_inset
7367
7368 Title
7369 \family default
7370 ), you can insert the dictum's author there.
7371  Dictum and author are separated by a line.
7372  You need at least Koma-Script version 2.8q to use this.
7373  
7374 \family sans
7375 Dictum
7376 \family default
7377  is not contained in 
7378 \emph on
7379 article (koma-script)
7380 \emph default
7381 .
7382 \end_layout
7383
7384 \begin_layout Standard
7385 The following types, together with the standard types 
7386 \family sans
7387 Title
7388 \family default
7389
7390 \family sans
7391 Author
7392 \family default
7393 , and 
7394 \family sans
7395 Date
7396 \family default
7397 , form the title area of the document.
7398  They must be entered ahead of the first 
7399 \begin_inset Quotes eld
7400 \end_inset
7401
7402 ordinary
7403 \begin_inset Quotes erd
7404 \end_inset
7405
7406  paragraph.
7407 \begin_inset Foot
7408 status collapsed
7409
7410 \begin_layout Plain Layout
7411 The corresponding LaTeX commands must appear before the 
7412 \family typewriter
7413
7414 \backslash
7415 maketitle
7416 \family default
7417  command.
7418 \end_layout
7419
7420 \end_inset
7421
7422  When such a type is used more than once, the latter usage overwrites the
7423  former one, that means, for every type only the latest usage is valid.
7424  The order of the different types however has, like 
7425 \family sans
7426 Title
7427 \family default
7428
7429 \family sans
7430 Author
7431 \family default
7432 , and 
7433 \family sans
7434 Date
7435 \family default
7436 , no effect on the appearance of the produced document.
7437 \end_layout
7438
7439 \begin_layout Itemize
7440
7441 \family sans
7442 Subject
7443 \family default
7444 : produces a centered paragraph above the ordinary title (
7445 \family sans
7446 Title
7447 \family default
7448
7449 \family sans
7450 Author
7451 \family default
7452
7453 \family sans
7454 Date
7455 \family default
7456 ) for the subject of the document.
7457 \end_layout
7458
7459 \begin_layout Itemize
7460
7461 \family sans
7462 Publishers
7463 \family default
7464 : produces a centered paragraph below the ordinary title (
7465 \family sans
7466 Title
7467 \family default
7468
7469 \family sans
7470 Author
7471 \family default
7472
7473 \family sans
7474 Date
7475 \family default
7476 ) for the publishers' name.
7477 \end_layout
7478
7479 \begin_layout Itemize
7480
7481 \family sans
7482 Dedication
7483 \family default
7484 : in 
7485 \emph on
7486 report (koma-script)
7487 \emph default
7488  and 
7489 \emph on
7490 book (koma-script)
7491 \emph default
7492  produces a centered paragraph on its own page behind the title page, or
7493  in 
7494 \emph on
7495 article (koma-script)
7496 \emph default
7497  produces a centered paragraph below the ordinary title (
7498 \family sans
7499 Title
7500 \family default
7501
7502 \family sans
7503 Author
7504 \family default
7505
7506 \family sans
7507 Date
7508 \family default
7509
7510 \family sans
7511 Publishers
7512 \family default
7513 ) for a dedication.
7514 \end_layout
7515
7516 \begin_layout Itemize
7517
7518 \family sans
7519 Titlehead
7520 \family default
7521 : produces a left aligned paragraph above the ordinary title (
7522 \family sans
7523 Title
7524 \family default
7525
7526 \family sans
7527 Author
7528 \family default
7529
7530 \family sans
7531 Date
7532 \family default
7533
7534 \family sans
7535 Subject
7536 \family default
7537 ) for a document`s head.
7538 \end_layout
7539
7540 \begin_layout Itemize
7541
7542 \family sans
7543 Uppertitleback
7544 \family default
7545 : produces in a double-sided print in 
7546 \emph on
7547 report (koma-script)
7548 \emph default
7549  and 
7550 \emph on
7551 book (koma-script)
7552 \emph default
7553  a left-aligned paragraph at the top of the title page`s back or has no
7554  effect in a single-sided print or in 
7555 \emph on
7556 article (koma-script)
7557 \emph default
7558 .
7559 \end_layout
7560
7561 \begin_layout Itemize
7562
7563 \family sans
7564 Lowertitleback
7565 \family default
7566 : produces in a double-sided print in 
7567 \emph on
7568 report (koma-script)
7569 \emph default
7570  and 
7571 \emph on
7572 book (koma-script)
7573 \emph default
7574  a left-aligned paragraph at the bottom of the title page`s back or has
7575  no effect in a single-sided print or in 
7576 \emph on
7577 article (koma-script)
7578 \emph default
7579 .
7580 \end_layout
7581
7582 \begin_layout Itemize
7583
7584 \family sans
7585 Extratitle
7586 \family default
7587 : produces a special 
7588 \begin_inset Quotes eld
7589 \end_inset
7590
7591 dirty
7592 \begin_inset Quotes erd
7593 \end_inset
7594
7595  page ahead of the actual document containing a paragraph without special
7596  formatting.
7597 \end_layout
7598
7599 \begin_layout Standard
7600 The layout files for the document classes 
7601 \emph on
7602 article (koma-script)
7603 \emph default
7604
7605 \emph on
7606 report (koma-script)
7607 \emph default
7608 , and 
7609 \emph on
7610 book (koma-script)
7611 \emph default
7612  do include the file 
7613 \family typewriter
7614 scrmacros.inc
7615 \family default
7616 .
7617  This is thought of as a place to define your own types.
7618  Copy s
7619 \family typewriter
7620 crmacros.inc
7621 \family default
7622  in your personal layout directory and edit the file!
7623 \end_layout
7624
7625 \begin_layout Subsection
7626 letter (koma-script)
7627 \end_layout
7628
7629 \begin_layout Standard
7630 \begin_inset ERT
7631 status open
7632
7633 \begin_layout Plain Layout
7634
7635
7636 \backslash
7637 begin{sloppypar}
7638 \end_layout
7639
7640 \end_inset
7641
7642
7643 \end_layout
7644
7645 \begin_layout Standard
7646 \noindent
7647 The document class 
7648 \emph on
7649 letter (koma-script)
7650 \emph default
7651  is implemented in the layout file 
7652 \family typewriter
7653 scrlettr.layout
7654 \family default
7655 .
7656  It contains all the paragraph types of the corresponding standard document
7657  class 
7658 \emph on
7659 letter
7660 \emph default
7661 , partly modified, with the exception of the LyX specific types 
7662 \family sans
7663 LyX-Code
7664 \family default
7665  and 
7666 \family sans
7667 Comment
7668 \family default
7669  and the 
7670 \family sans
7671 List
7672 \family default
7673  type, which is replaced by the new 
7674 \family sans
7675 Labeling
7676 \family default
7677  type.
7678  In addition, it contains, in contrast to the standard document class, the
7679  standard types 
7680 \family sans
7681 LaTeX
7682 \family default
7683
7684 \family sans
7685 Quotation
7686 \family default
7687
7688 \family sans
7689 Quote
7690 \family default
7691 , and 
7692 \family sans
7693 Verse
7694 \family default
7695 .
7696  Furthermore, there are a number of new letter specific types.
7697 \end_layout
7698
7699 \begin_layout Standard
7700 \begin_inset ERT
7701 status open
7702
7703 \begin_layout Plain Layout
7704
7705
7706 \backslash
7707 end{sloppypar}
7708 \end_layout
7709
7710 \end_inset
7711
7712
7713 \end_layout
7714
7715 \begin_layout Standard
7716 The appearance of the letter produced by this document class can be controlled
7717  by a number of LaTeX commands, which you can put in the LaTeX preamble.
7718 \begin_inset Foot
7719 status collapsed
7720
7721 \begin_layout Plain Layout
7722 For example, the standard appearance of the letter`s heading, consisting
7723  of name and address, is quite self-willed.
7724  An 
7725 \begin_inset Quotes eld
7726 \end_inset
7727
7728 ordinary
7729 \begin_inset Quotes erd
7730 \end_inset
7731
7732  heading is produced by the following LaTeX commands in the preamble:
7733 \end_layout
7734
7735 \begin_layout LyX-Code
7736
7737 \backslash
7738 firsthead{
7739 \backslash
7740 parbox[b]{
7741 \backslash
7742 textwidth}
7743 \end_layout
7744
7745 \begin_layout LyX-Code
7746   {
7747 \backslash
7748 ignorespaces 
7749 \backslash
7750 fromname
7751 \backslash
7752
7753 \backslash
7754  
7755 \backslash
7756 ignorespaces 
7757 \backslash
7758 fromaddress}} 
7759 \end_layout
7760
7761 \begin_layout LyX-Code
7762
7763 \backslash
7764 nexthead{
7765 \backslash
7766 parbox[b]{
7767 \backslash
7768 textwidth}
7769 \end_layout
7770
7771 \begin_layout LyX-Code
7772   {
7773 \backslash
7774 ignorespaces 
7775 \backslash
7776 fromname 
7777 \backslash
7778 hfill 
7779 \backslash
7780 ignorespaces 
7781 \backslash
7782 pagename
7783 \backslash
7784  
7785 \backslash
7786 thepage}}
7787 \end_layout
7788
7789 \end_inset
7790
7791  A detailed German description of such LaTeX commands can be found in the
7792  Koma-Script documentation 
7793 \emph on
7794 scrguide
7795 \emph default
7796 .
7797  With it, the letter's author can produce his personal letter layout.
7798 \end_layout
7799
7800 \begin_layout Standard
7801 The types 
7802 \family sans
7803 Letter
7804 \family default
7805  and 
7806 \family sans
7807 Opening
7808 \family default
7809  define the beginning of the letter and must be used in every letter.
7810  To emphasize them in the LyX document class, they are marked with the letter
7811  
7812 \shape italic
7813 L
7814 \shape default
7815  or 
7816 \shape italic
7817 O
7818 \shape default
7819 , resp.
7820 \begin_inset space ~
7821 \end_inset
7822
7823 in the left margin.
7824  It is possible to write any number of letters in one file.
7825  An 
7826 \family sans
7827 Opening
7828 \family default
7829  type produces a new letter using the same addressee and a 
7830 \family sans
7831 Letter
7832 \family default
7833  type produces a new addressee.
7834  The types 
7835 \family sans
7836 Closing
7837 \family default
7838
7839 \family sans
7840 PS
7841 \family default
7842
7843 \family sans
7844 CC
7845 \family default
7846 , and 
7847 \family sans
7848 Encl
7849 \family default
7850  are ordinary paragraph types and can also be used several times in one
7851  and the same letter.
7852 \end_layout
7853
7854 \begin_layout Itemize
7855
7856 \family sans
7857 Letter
7858 \family default
7859 : produces a paragraph for the addressee and implicitly defines the beginning
7860  of the letter.
7861 \end_layout
7862
7863 \begin_layout Itemize
7864
7865 \family sans
7866 Opening
7867 \family default
7868 : produces a paragraph for the form of address and implicitly produces a
7869  new letter.
7870 \end_layout
7871
7872 \begin_layout Itemize
7873
7874 \family sans
7875 Closing
7876 \family default
7877 : produces a paragraph for a close.
7878 \end_layout
7879
7880 \begin_layout Itemize
7881
7882 \family sans
7883 PS
7884 \family default
7885 : produces a paragraph for a postscript.
7886 \end_layout
7887
7888 \begin_layout Itemize
7889
7890 \family sans
7891 CC
7892 \family default
7893 : produces a paragraph for a distribution list.
7894 \end_layout
7895
7896 \begin_layout Itemize
7897
7898 \family sans
7899 Encl
7900 \family default
7901 : produces a paragraph for enclosures.
7902 \end_layout
7903
7904 \begin_layout Standard
7905 The types 
7906 \family sans
7907 Name
7908 \family default
7909
7910 \family sans
7911 Signature
7912 \family default
7913
7914 \family sans
7915 Address
7916 \family default
7917
7918 \family sans
7919 Telephone
7920 \family default
7921
7922 \family sans
7923 Place
7924 \family default
7925
7926 \family sans
7927 Backaddress
7928 \family default
7929
7930 \family sans
7931 Specialmail
7932 \family default
7933
7934 \family sans
7935 Location
7936 \family default
7937
7938 \family sans
7939 Title
7940 \family default
7941 , and 
7942 \family sans
7943 Subject
7944 \family default
7945  are input types provided with a label to enter information, which will
7946  be processed by the document class.
7947 \begin_inset Foot
7948 status open
7949
7950 \begin_layout Plain Layout
7951 It could be seen as a matter of inconsequence, that the types 
7952 \family sans
7953 Letter
7954 \family default
7955  and 
7956 \family sans
7957 Opening
7958 \family default
7959  described above are not such input types as well.
7960  Because of the special meaning of those types, however, I have implemented
7961  them as ordinary paragraph types with a one letter mark in the left margin.
7962  Moreover, it would affect my feeling of symmetry, if the 
7963 \family sans
7964 Opening
7965 \family default
7966  type and the 
7967 \family sans
7968 Closing
7969 \family default
7970  type had such a serious different appearance.
7971 \end_layout
7972
7973 \end_inset
7974
7975  The types must be used ahead of the corresponding 
7976 \family sans
7977 Opening
7978 \family default
7979  type.
7980 \end_layout
7981
7982 \begin_layout Standard
7983 An implementation of these types in a WYSIWYG fashion does not seem to make
7984  sense, because the real appearance of the produced letter does not only
7985  depend on the usage of the particular type, but also on other factors.
7986  For example, a signature entered in the 
7987 \family sans
7988 Signature
7989 \family default
7990  type will in the standard behavior appear in the produced letter only,
7991  when in the same letter also a 
7992 \family sans
7993 Closing
7994 \family default
7995  type is used.
7996  The entered value of the 
7997 \family sans
7998 Telephone
7999 \family default
8000  type will in the standard behavior not appear in the produced letter at
8001  all.
8002  The possibility to design the letter`s heading freely is already indicated
8003  in a footnote above.
8004 \end_layout
8005
8006 \begin_layout Standard
8007 The input types can also be used as empty paragraphs.
8008  This makes sense e.
8009 \begin_inset space \thinspace{}
8010 \end_inset
8011
8012 g.
8013 \begin_inset space ~
8014 \end_inset
8015
8016 for the 
8017 \family sans
8018 Signature
8019 \family default
8020  type.
8021  If the 
8022 \family sans
8023 Signature
8024 \family default
8025  type is not used at all, in the standard behavior the value of the 
8026 \family sans
8027 Name
8028 \family default
8029  type is used as signature, whereas if an empty 
8030 \family sans
8031 Signature
8032 \family default
8033  type is used, no signature value is defined.
8034 \end_layout
8035
8036 \begin_layout Standard
8037 By using the input types it is possible to write a letter template, containing
8038  filled input types with your personal dates (name, address, etc.) and empty
8039  input types for other dates you want to enter.
8040 \end_layout
8041
8042 \begin_layout Itemize
8043
8044 \family sans
8045 Name
8046 \family default
8047 : sender's name, in the standard behavior appears as a centered paragraph
8048  in small caps in the letter`s heading.
8049 \end_layout
8050
8051 \begin_layout Itemize
8052
8053 \family sans
8054 Signature
8055 \family default
8056 : sender's signature, in the standard behavior appears below the 
8057 \family sans
8058 Closing
8059 \family default
8060  type.
8061  If no 
8062 \family sans
8063 Signature
8064 \family default
8065  type is used, the value of the 
8066 \family sans
8067 Name
8068 \family default
8069  type appears instead.
8070 \end_layout
8071
8072 \begin_layout Itemize
8073
8074 \family sans
8075 Address
8076 \family default
8077 : sender's address, in the standard behavior appears in a centered paragraph
8078  in the letter`s heading below the sender's name.
8079 \end_layout
8080
8081 \begin_layout Itemize
8082
8083 \family sans
8084 Telephone
8085 \family default
8086 : sender's telephone number, in the standard behavior only sets the LaTeX
8087  variable 
8088 \family typewriter
8089
8090 \backslash
8091 telephonenum
8092 \family default
8093 .
8094 \end_layout
8095
8096 \begin_layout Itemize
8097
8098 \family sans
8099 Place
8100 \family default
8101 : place of the letter`s making.
8102 \end_layout
8103
8104 \begin_layout Itemize
8105
8106 \family sans
8107 Date
8108 \family default
8109 : date of the letter`s making.
8110  
8111 \family sans
8112 Place
8113 \family default
8114  and 
8115 \family sans
8116 Date
8117 \family default
8118 , in the standard behavior, produce the place and the date in a right-aligned
8119  line below the addressee's field.
8120  If an empty 
8121 \family sans
8122 Date
8123 \family default
8124  type is used, neither place nor date appear, independent of the value of
8125  the 
8126 \family sans
8127 Place
8128 \family default
8129  type.
8130  If no 
8131 \family sans
8132 Date
8133 \family default
8134  type is used, the date of the letter `s production is used.
8135 \end_layout
8136
8137 \begin_layout Itemize
8138
8139 \family sans
8140 Backaddress
8141 \family default
8142 : sender`s back address, in the standard behavior appears above the addressee's
8143  field in a small sans serif font.
8144 \end_layout
8145
8146 \begin_layout Itemize
8147
8148 \family sans
8149 Specialmail
8150 \family default
8151 : special mail information, in the standard behavior appears underlined
8152  above the addressee's field below the back address.
8153 \end_layout
8154
8155 \begin_layout Itemize
8156
8157 \family sans
8158 Location
8159 \family default
8160 : additional information, in the standard behavior appears on right side
8161  below the addressee`s field.
8162 \end_layout
8163
8164 \begin_layout Itemize
8165
8166 \family sans
8167 Title
8168 \family default
8169 : the letter's title, in the standard behavior appears in a big, bold, sans
8170  serif font above the subject.
8171 \end_layout
8172
8173 \begin_layout Itemize
8174
8175 \family sans
8176 Subject
8177 \family default
8178 : the letter's subject, in the standard behavior appears in a bold font
8179  above the 
8180 \family sans
8181 Opening
8182 \family default
8183  paragraph.
8184 \end_layout
8185
8186 \begin_layout Standard
8187 The types 
8188 \family sans
8189 Yourref
8190 \family default
8191
8192 \family sans
8193 Yourmail
8194 \family default
8195
8196 \family sans
8197 Myref
8198 \family default
8199
8200 \family sans
8201 Customer
8202 \family default
8203 , and 
8204 \family sans
8205 Invoice
8206 \family default
8207  produce a business letter like line above the 
8208 \family sans
8209 Title
8210 \family default
8211  line containing the fields 
8212 \begin_inset Quotes eld
8213 \end_inset
8214
8215 Your ref.
8216 \begin_inset Quotes erd
8217 \end_inset
8218
8219
8220 \begin_inset Quotes eld
8221 \end_inset
8222
8223 Your letter of
8224 \begin_inset Quotes erd
8225 \end_inset
8226
8227
8228 \begin_inset Quotes eld
8229 \end_inset
8230
8231 Our ref.
8232 \begin_inset Quotes erd
8233 \end_inset
8234
8235
8236 \begin_inset Quotes eld
8237 \end_inset
8238
8239 Customer no.
8240 \begin_inset Quotes erd
8241 \end_inset
8242
8243
8244 \begin_inset Quotes eld
8245 \end_inset
8246
8247 Invoice no.
8248 \begin_inset Quotes erd
8249 \end_inset
8250
8251 , and 
8252 \begin_inset Quotes eld
8253 \end_inset
8254
8255 Date
8256 \begin_inset Quotes erd
8257 \end_inset
8258
8259 .
8260  For the date field, the value of the 
8261 \family sans
8262 Date
8263 \family default
8264  type is used.
8265  If one of these 
8266 \begin_inset Quotes eld
8267 \end_inset
8268
8269 business letter types
8270 \begin_inset Quotes erd
8271 \end_inset
8272
8273  is used, the value of the 
8274 \family sans
8275 Place
8276 \family default
8277  type however does not appear, but only the LaTeX variable 
8278 \family typewriter
8279
8280 \backslash
8281 fromplace
8282 \family default
8283  is set.
8284  The ordinary output of place and date in a right-aligned line below the
8285  addressee`s field is suppressed.
8286  The types are implemented as input types provided with a label and must
8287  be used ahead of the corresponding 
8288 \family sans
8289 Opening
8290 \family default
8291  type.
8292 \end_layout
8293
8294 \begin_layout Itemize
8295
8296 \family sans
8297 Yourref
8298 \family default
8299 : Your ref.
8300 \end_layout
8301
8302 \begin_layout Itemize
8303
8304 \family sans
8305 Yourmail
8306 \family default
8307 : Your letter of.
8308 \end_layout
8309
8310 \begin_layout Itemize
8311
8312 \family sans
8313 Myref
8314 \family default
8315 : Our ref.
8316 \end_layout
8317
8318 \begin_layout Itemize
8319
8320 \family sans
8321 Customer
8322 \family default
8323 : Customer no.
8324 \end_layout
8325
8326 \begin_layout Itemize
8327
8328 \family sans
8329 Invoice
8330 \family default
8331 : Invoice no.
8332 \end_layout
8333
8334 \begin_layout Subsection
8335 The new letter class: letter (koma-script v.2)
8336 \end_layout
8337
8338 \begin_layout Standard
8339 by 
8340 \noun on
8341 Jürgen Spitzmüller
8342 \end_layout
8343
8344 \begin_layout Standard
8345 \begin_inset VSpace medskip
8346 \end_inset
8347
8348
8349 \end_layout
8350
8351 \begin_layout Standard
8352 \noindent
8353 Koma-Script version 2.8 has introduced a new letter class 
8354 \family typewriter
8355 scrlttr2
8356 \family default
8357  which supersedes the now unsupported 
8358 \family typewriter
8359 scrlettr
8360 \family default
8361 .
8362  It has --- on the LaTeX side --- a completely new interface and is not
8363  compatible with the old class.
8364  Therefore, LyX supports both, though it is recommended to use the new class.
8365 \end_layout
8366
8367 \begin_layout Standard
8368 This class covers the same functionality as 
8369 \emph on
8370 letter (koma-script),
8371 \emph default
8372  and a few more.
8373  The basic items are 
8374 \family sans
8375 Address
8376 \family default
8377  (receiver's address, same as 
8378 \family sans
8379 Letter
8380 \family default
8381  in the old layout), 
8382 \family sans
8383 Opening
8384 \family default
8385 , and 
8386 \family sans
8387 Closing
8388 \family default
8389 .
8390  
8391 \family sans
8392 NextAddress
8393 \family default
8394  will start a new letter (i.
8395 \begin_inset space \thinspace{}
8396 \end_inset
8397
8398 e.
8399 \begin_inset space ~
8400 \end_inset
8401
8402 you can write several letters per document).
8403  New elements are sender's 
8404 \family sans
8405 E-Mail
8406 \family default
8407
8408 \family sans
8409 URL
8410 \family default
8411
8412 \family sans
8413 Fax
8414 \family default
8415
8416 \family sans
8417 Bank
8418 \family default
8419  and the possibility to use a 
8420 \family sans
8421 Logo
8422 \family default
8423  (via 
8424 \family sans
8425 \bar under
8426 I
8427 \bar default
8428 nsert\SpecialChar \menuseparator
8429
8430 \bar under
8431 G
8432 \bar default
8433 raphics
8434 \family default
8435 ) in the header.
8436 \end_layout
8437
8438 \begin_layout Standard
8439 The biggest improvement is, though, that the letter's layout is configurable
8440  at almost any needs.
8441  This can be done via the preamble or with a special style file (Letter
8442  Class Option, extension 
8443 \family typewriter
8444 *.lco
8445 \family default
8446 ), that will be read in as a class option.
8447 \begin_inset Foot
8448 status collapsed
8449
8450 \begin_layout Plain Layout
8451 The KOMA package comes with some default 
8452 \family typewriter
8453 *.lco
8454 \family default
8455  files.
8456  There is, for instance, a 
8457 \family typewriter
8458 DIN.lco
8459 \family default
8460  file that follows german typesetting rules, or a 
8461 \family typewriter
8462 KOMAold.lco
8463 \family default
8464  that provides the default layout of the old 
8465 \family typewriter
8466 scrlettr
8467 \family default
8468  class.
8469  The latter can be loaded with the class option 
8470 \family typewriter
8471 KOMAold
8472 \family default
8473 , inserted via the 
8474 \family sans
8475 \bar under
8476 L
8477 \bar default
8478 ayout\SpecialChar \menuseparator
8479
8480 \bar under
8481 D
8482 \bar default
8483 ocument\SpecialChar \menuseparator
8484 Extra Options
8485 \family default
8486  field.
8487 \end_layout
8488
8489 \end_inset
8490
8491  Have a look at the 
8492 \emph on
8493 koma-letter2
8494 \emph default
8495  template that is included in LyX for examples.
8496  A detailed description is to be found in the Koma-Script documentation
8497  (
8498 \emph on
8499 scrguide
8500 \emph default
8501 ).
8502 \end_layout
8503
8504 \begin_layout Subsection
8505 Problems
8506 \end_layout
8507
8508 \begin_layout Standard
8509 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
8510  some problems.
8511 \end_layout
8512
8513 \begin_layout Itemize
8514 The chapter number of a 
8515 \family sans
8516 Chapter
8517 \family default
8518  type appears on a line of its own above the chapter heading instead of
8519  appearing in the same line ahead of it.
8520  The cause for that is the LyX internal behavior for the labeltype 
8521 \family sans
8522 Counter_Chapter
8523 \family default
8524  in the layout file.
8525 \end_layout
8526
8527 \begin_layout Itemize
8528 The headings of the types 
8529 \family sans
8530 Addchap
8531 \family default
8532  and 
8533 \family sans
8534 Addsec
8535 \family default
8536  are only put in the 
8537 \begin_inset Quotes eld
8538 \end_inset
8539
8540 true
8541 \begin_inset Quotes erd
8542 \end_inset
8543
8544  LaTeX table of contents, but not in the LyX table of contents (
8545 \family sans
8546 \bar under
8547 D
8548 \bar default
8549 ocument\SpecialChar \menuseparator
8550
8551 \bar under
8552 T
8553 \bar default
8554 able
8555 \begin_inset space ~
8556 \end_inset
8557
8558 of
8559 \begin_inset space ~
8560 \end_inset
8561
8562 Contents
8563 \family default
8564 ).
8565 \end_layout
8566
8567 \begin_layout Itemize
8568 The paragraphs in a 
8569 \emph on
8570 letter
8571 \emph default
8572  document class appear in a skip separation mode, not indented.
8573  This is the standard behavior, no special LaTeX commands are needed for
8574  that.
8575  But in the 
8576 \family sans
8577 \bar under
8578 D
8579 \bar default
8580 ocument\SpecialChar \menuseparator
8581
8582 \bar under
8583 S
8584 \bar default
8585 ettings
8586 \family default
8587  dialog the corresponding radio button indicates 
8588 \family sans
8589 \bar under
8590 I
8591 \bar default
8592 ndent
8593 \family default
8594 .
8595  A 
8596 \family sans
8597 S
8598 \bar under
8599 k
8600 \bar default
8601 ip
8602 \family default
8603  value always has the effect that extra LaTeX commands are inserted in the
8604  document to produce the gap, which is not what is wanted in this case.
8605 \end_layout
8606
8607 \begin_layout Section
8608 Springer Journals (
8609 \family sans
8610 svjour
8611 \family default
8612 )
8613 \end_layout
8614
8615 \begin_layout Standard
8616 by 
8617 \noun on
8618 Martin Vermeer
8619 \end_layout
8620
8621 \begin_layout Subsection
8622 Description
8623 \end_layout
8624
8625 \begin_layout Standard
8626 These are the layout files for some of the journal formats used by Springer
8627  Verlag and listed on 
8628 \begin_inset Flex URL
8629 status collapsed
8630
8631 \begin_layout Plain Layout
8632
8633 http://www.springer.de/author/tex/help-journals.html
8634 \end_layout
8635
8636 \end_inset
8637
8638 , where you should also go to fetch the class files (yes, these are LaTeX2e
8639  now!).
8640  It is a modular system: the things common to all journals are implemented
8641  in 
8642 \family typewriter
8643 svjour.inc
8644 \family default
8645 , which journal-specific layout files (such as, e.
8646 \begin_inset space \thinspace{}
8647 \end_inset
8648
8649 g., 
8650 \family typewriter
8651 svjog.layout
8652 \family default
8653  for Journal of Geodesy) can include.
8654 \end_layout
8655
8656 \begin_layout Standard
8657 This means that implementing support for any other Springer journal on this
8658  list is as simple as writing your own 
8659 \family typewriter
8660 sv
8661 \family default
8662 <myjournal>
8663 \family typewriter
8664 .layout
8665 \family default
8666  file following the outline given in 
8667 \family typewriter
8668 svjog.layout
8669 \family default
8670 .
8671  
8672 \end_layout
8673
8674 \begin_layout Standard
8675 It is reasonably well tested only for the Journal of Geodesy.
8676  
8677 \family typewriter
8678 svjour
8679 \family default
8680  and 
8681 \family typewriter
8682 svjog
8683 \family default
8684  come with the standard LyX distribution.
8685  Install the relevant class file (downloaded from Springer) in a proper
8686  directory, reconfigure LaTeX (in the teTeX case by running 
8687 \family typewriter
8688 texhash
8689 \family default
8690 , as root if necessary --- doesn't LyX take care of this?), reconfigure
8691  LyX and it should work.
8692 \end_layout
8693
8694 \begin_layout Subsection
8695 New styles
8696 \end_layout
8697
8698 \begin_layout Standard
8699 A large number of theorem-like styles --- 
8700 \family sans
8701 Claim, Conjecture,
8702 \family default
8703  
8704 \family sans
8705 \SpecialChar \ldots{}
8706 Theorem
8707 \family default
8708 .
8709 \end_layout
8710
8711 \begin_layout Standard
8712
8713 \family sans
8714 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
8715  Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
8716 \family default
8717 .
8718  See the Springer class file documentation for details.
8719 \end_layout
8720
8721 \begin_layout Subsection
8722 Supported journals
8723 \end_layout
8724
8725 \begin_layout Itemize
8726
8727 \emph on
8728 Journal of Geodesy
8729 \emph default
8730
8731 \family typewriter
8732 svjog.layout
8733 \family default
8734  --- Martin Vermeer
8735 \end_layout
8736
8737 \begin_layout Itemize
8738
8739 \emph on
8740 Probability Theory and Related Fields
8741 \emph default
8742
8743 \family typewriter
8744 svprobth.layout
8745 \family default
8746  --- Jean-Marc Lasgouttes
8747 \end_layout
8748
8749 \begin_layout Standard
8750 Add your own, it isn't so hard!
8751 \end_layout
8752
8753 \begin_layout Subsection
8754 Credits
8755 \end_layout
8756
8757 \begin_layout Standard
8758 These files are partly based on the older 
8759 \family typewriter
8760 ejour2.layout
8761 \family default
8762 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
8763  file from Springer.
8764  All this, and the 
8765 \family typewriter
8766 ejour2
8767 \family default
8768  layout, are now defunct.
8769  Jean-Marc Lasgouttes helped out big in making me find my way around the
8770  LyX layout file mechanism.
8771 \end_layout
8772
8773 \begin_layout Subsection
8774 Bugs
8775 \end_layout
8776
8777 \begin_layout Standard
8778 Probably.
8779  But probably less than in the old hacked-LaTeX 
8780 \family typewriter
8781 ejour2
8782 \family default
8783 .
8784 \end_layout
8785
8786 \begin_layout Standard
8787 Limitations e.
8788 \begin_inset space \thinspace{}
8789 \end_inset
8790
8791 g.: does not display the number for theorem-like layouts, just #.
8792 \end_layout
8793
8794 \begin_layout Section
8795 AGU journals (
8796 \family sans
8797 aguplus
8798 \family default
8799 )
8800 \end_layout
8801
8802 \begin_layout Standard
8803 by 
8804 \shape smallcaps
8805 Martin Vermeer
8806 \end_layout
8807
8808 \begin_layout Subsection
8809 Description
8810 \end_layout
8811
8812 \begin_layout Standard
8813 These are the layout files for some of the journals of the American Geophysical
8814  Society.
8815  It is assumed that you have both the AGU's own class files and AGUplus
8816  installed (everything to be found at
8817 \begin_inset Flex URL
8818 status collapsed
8819
8820 \begin_layout Plain Layout
8821
8822 ftp://ftp.agu.org/journals/latex/journals
8823 \end_layout
8824
8825 \end_inset
8826
8827 ).
8828 \end_layout
8829
8830 \begin_layout Subsection
8831 New styles
8832 \end_layout
8833
8834 \begin_layout Standard
8835 Redefined are 
8836 \family sans
8837 Paragraph
8838 \family default
8839
8840 \family sans
8841 Paragraph*
8842 \family default
8843 .
8844  They are still called this in the LyX GUI, though their LaTeX equivalents
8845  in the AGU classes are 
8846 \family sans
8847 Subsubsubsection
8848 \family default
8849  and 
8850 \family sans
8851 Subsubsubsection*
8852 \family default
8853 .
8854 \end_layout
8855
8856 \begin_layout Standard
8857 Newly defined styles are 
8858 \family sans
8859 Left_Header
8860 \family default
8861
8862 \family sans
8863 Right_Header
8864 \family default
8865
8866 \family sans
8867 Received
8868 \family default
8869
8870 \family sans
8871 Revised
8872 \family default
8873
8874 \family sans
8875 Accepted
8876 \family default
8877
8878 \family sans
8879 CCC
8880 \family default
8881
8882 \family sans
8883 PaperId
8884 \family default
8885
8886 \family sans
8887 AuthorAddr
8888 \family default
8889
8890 \family sans
8891 SlugComment
8892 \family default
8893 .
8894  These are mostly manuscript attributes and defined in the AGU class documentati
8895 on.
8896 \end_layout
8897
8898 \begin_layout Standard
8899 I suspect this is still badly incomplete.
8900 \end_layout
8901
8902 \begin_layout Subsection
8903 New floats
8904 \end_layout
8905
8906 \begin_layout Standard
8907
8908 \family sans
8909 Planotable
8910 \family default
8911  and 
8912 \family sans
8913 Plate
8914 \family default
8915 .
8916  We also have a new 
8917 \family sans
8918 Table_Caption
8919 \family default
8920 .
8921 \end_layout
8922
8923 \begin_layout Subsection
8924 Supported journals
8925 \end_layout
8926
8927 \begin_layout Itemize
8928
8929 \emph on
8930 Journal of Geophysical Research
8931 \emph default
8932
8933 \family typewriter
8934 jgrga.layout
8935 \family default
8936  --- Martin Vermeer
8937 \end_layout
8938
8939 \begin_layout Standard
8940 Add your own, it isn't so hard! Look at the 
8941 \family typewriter
8942 jgrga.layout
8943 \family default
8944  example and 
8945 \family typewriter
8946 aguplus.inc
8947 \family default
8948 .
8949 \end_layout
8950
8951 \begin_layout Subsection
8952 Bugs and things to remember
8953 \end_layout
8954
8955 \begin_layout Standard
8956 In order to use the new layouts, you must remember to do the following for
8957  a new document:
8958 \end_layout
8959
8960 \begin_layout Enumerate
8961
8962 \emph on
8963 Turn off babel
8964 \emph default
8965 .
8966  This can be done in the 
8967 \family sans
8968 layout\SpecialChar \menuseparator
8969 document
8970 \family default
8971  or 
8972 \family sans
8973 document\SpecialChar \menuseparator
8974 settings
8975 \family default
8976  menu item.
8977  (AGU articles are always in English, right? So 
8978 \emph on
8979 don't
8980 \emph default
8981  choose a language.)
8982 \end_layout
8983
8984 \begin_layout Enumerate
8985 Enter 
8986 \family typewriter
8987 jgrga
8988 \family default
8989  into the document's 
8990 \family sans
8991 Extra Options
8992 \family default
8993  field.
8994  (Yes, this is a bug.)
8995 \end_layout
8996
8997 \begin_layout Enumerate
8998 Make sure you use the 
8999 \family typewriter
9000 agu.bst
9001 \family default
9002  bibliography style, by entering 
9003 \family sans
9004 agu
9005 \family default
9006  into the second field of the BibTeX inset.
9007  None of the standard styles will do.
9008 \end_layout
9009
9010 \begin_layout Section
9011 EGS journals (
9012 \family sans
9013 egs
9014 \family default
9015 )
9016 \end_layout
9017
9018 \begin_layout Standard
9019 by 
9020 \shape smallcaps
9021 Martin Vermeer
9022 \end_layout
9023
9024 \begin_layout Subsection
9025 Description
9026 \end_layout
9027
9028 \begin_layout Standard
9029 This is the layout file for the European Geophysical Society journals.
9030  The needed 
9031 \family typewriter
9032 egs.cls
9033 \family default
9034  can be downloaded from the web site of the EGS under 
9035 \begin_inset Flex URL
9036 status collapsed
9037
9038 \begin_layout Plain Layout
9039
9040 www.copernicus.org
9041 \end_layout
9042
9043 \end_inset
9044
9045 .
9046 \end_layout
9047
9048 \begin_layout Subsection
9049 New styles
9050 \end_layout
9051
9052 \begin_layout Standard
9053
9054 \family sans
9055 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
9056  Accepted
9057 \family default
9058
9059 \family sans
9060 Offsets
9061 \family default
9062 .
9063  The current layout file is unfortunately very unmodular and would benefit
9064  from using the various 
9065 \family typewriter
9066 std*.inc
9067 \family default
9068  file inclusions.
9069 \end_layout
9070
9071 \begin_layout Section
9072 Slides [aka 
9073 \noun on
9074 Sli
9075 \noun default
9076 TeX]
9077 \begin_inset CommandInset label
9078 LatexCommand label
9079 name "sec:slitex"
9080
9081 \end_inset
9082
9083
9084 \end_layout
9085
9086 \begin_layout Standard
9087 by 
9088 \noun on
9089 John Weiss
9090 \noun default
9091  
9092 \end_layout
9093
9094 \begin_layout Subsection
9095 Introduction
9096 \end_layout
9097
9098 \begin_layout Standard
9099 This section describes how to use LyX to make slides for overhead projectors.
9100  There are two document classes that can do this: the default slides class
9101  and the 
9102 \family sans
9103 Foil
9104 \family default
9105 TeX slides class.
9106  This section documents the former.
9107 \end_layout
9108
9109 \begin_layout Standard
9110 I'm going to say this again, nice and clear, so that there's no misunderstanding
9111 :
9112 \end_layout
9113
9114 \begin_layout Standard
9115 \begin_inset VSpace bigskip
9116 \end_inset
9117
9118
9119 \end_layout
9120
9121 \begin_layout Standard
9122 \align center
9123
9124 \size large
9125 This section documents the class 
9126 \begin_inset Quotes eld
9127 \end_inset
9128
9129
9130 \family sans
9131 slides (default)
9132 \family default
9133
9134 \begin_inset Quotes erd
9135 \end_inset
9136
9137  
9138 \emph on
9139 only.
9140 \end_layout
9141
9142 \begin_layout Standard
9143 \begin_inset VSpace bigskip
9144 \end_inset
9145
9146
9147 \end_layout
9148
9149 \begin_layout Standard
9150 If you're looking for the documentation for 
9151 \begin_inset Quotes eld
9152 \end_inset
9153
9154
9155 \family sans
9156 slides (FoilTeX)
9157 \family default
9158
9159 \begin_inset Quotes erd
9160 \end_inset
9161
9162 , check out section
9163 \begin_inset space ~
9164 \end_inset
9165
9166
9167 \begin_inset CommandInset ref
9168 LatexCommand ref
9169 reference "sec:foiltex"
9170
9171 \end_inset
9172
9173 .
9174  The 
9175 \family sans
9176 foils
9177 \family default
9178  class [
9179 \begin_inset Quotes eld
9180 \end_inset
9181
9182
9183 \family sans
9184 slides (FoilTeX)
9185 \family default
9186
9187 \begin_inset Quotes erd
9188 \end_inset
9189
9190 ] is actually somewhat better than the default 
9191 \family sans
9192 slides
9193 \family default
9194  class,
9195 \begin_inset Foot
9196 status collapsed
9197
9198 \begin_layout Plain Layout
9199 \SpecialChar \ldots{}
9200 or so I've been told repeatedly by its advocates.
9201  Having never used it, I have no idea if this claim is true or not.
9202 \end_layout
9203
9204 \end_inset
9205
9206  which this section documents.
9207 \end_layout
9208
9209 \begin_layout Standard
9210 This class is the LaTeX2e improvement of the old 
9211 \noun on
9212 Sli
9213 \noun default
9214 TeX package.
9215  Every LaTeX2e distribution includes this class [which I'll just refer to
9216  as 
9217 \begin_inset Quotes eld
9218 \end_inset
9219
9220
9221 \family sans
9222 slides
9223 \family default
9224
9225 \begin_inset Quotes erd
9226 \end_inset
9227
9228  from now on], so you're bound to have it.
9229  As I noted earlier, there are other classes, such as 
9230 \family sans
9231 foils
9232 \family default
9233 , which also produce slides for overhead projectors and do a better job
9234  at it.
9235  However, there are some things which 
9236 \family sans
9237 slides
9238 \family default
9239  can do which the others can't, such as generate overlays.
9240  Read on to learn more!
9241 \end_layout
9242
9243 \begin_layout Subsection
9244 Getting Started
9245 \begin_inset CommandInset label
9246 LatexCommand label
9247 name "sec:slidesetup"
9248
9249 \end_inset
9250
9251
9252 \end_layout
9253
9254 \begin_layout Standard
9255 Obviously, to use this document class, you need to select 
9256 \begin_inset Quotes eld
9257 \end_inset
9258
9259
9260 \family sans
9261 slides (default)
9262 \family default
9263
9264 \begin_inset Quotes erd
9265 \end_inset
9266
9267  from the class list in the 
9268 \family sans
9269 \bar under
9270 D
9271 \bar default
9272 ocument\SpecialChar \menuseparator
9273
9274 \bar under
9275 S
9276 \bar default
9277 ettings
9278 \family default
9279  dialog.
9280  There are some other special things you should know about this class:
9281 \end_layout
9282
9283 \begin_layout Itemize
9284 Don't bother changing the options 
9285 \family sans
9286 Sides and Columns
9287 \family default
9288 .
9289  They're not supported by the 
9290 \family sans
9291 slides
9292 \family default
9293  class, anyways.
9294 \end_layout
9295
9296 \begin_layout Itemize
9297 The option 
9298 \family sans
9299 \bar under
9300 P
9301 \bar default
9302 age
9303 \begin_inset space ~
9304 \end_inset
9305
9306 style
9307 \family default
9308  behaves a bit differently for this class.
9309  The possible choices and what they do are as follows:
9310 \end_layout
9311
9312 \begin_deeper
9313 \begin_layout Description
9314
9315 \family sans
9316 plain
9317 \family default
9318  The final output contains page numbers in the lower right corner.
9319 \end_layout
9320
9321 \begin_layout Description
9322
9323 \family sans
9324 headings
9325 \family default
9326  Like 
9327 \family sans
9328 plain
9329 \family default
9330 , but also prints out any time markers you've put in.
9331  This is the default.
9332 \end_layout
9333
9334 \begin_layout Description
9335
9336 \family sans
9337 empty
9338 \family default
9339  The final output contains no page numbers, time markers, or alignment markers.
9340 \end_layout
9341
9342 \end_deeper
9343 \begin_layout Itemize
9344 The 
9345 \family sans
9346 slides
9347 \family default
9348  class has an extra option: 
9349 \family typewriter
9350 clock
9351 \family default
9352 .
9353  To use it, put 
9354 \begin_inset Quotes eld
9355 \end_inset
9356
9357
9358 \family typewriter
9359 clock
9360 \family default
9361
9362 \begin_inset Quotes erd
9363 \end_inset
9364
9365  in the extra class options.
9366 \end_layout
9367
9368 \begin_deeper
9369 \begin_layout Standard
9370 Using this options allows you to add time markers to 
9371 \family sans
9372 Note
9373 \family default
9374 s.
9375  See section
9376 \begin_inset space ~
9377 \end_inset
9378
9379
9380 \begin_inset CommandInset ref
9381 LatexCommand ref
9382 reference "sec:slideNote"
9383
9384 \end_inset
9385
9386  for more details.
9387 \end_layout
9388
9389 \end_deeper
9390 \begin_layout Standard
9391 You can also use the template file 
9392 \begin_inset Quotes eld
9393 \end_inset
9394
9395
9396 \family typewriter
9397 slides.lyx
9398 \family default
9399
9400 \begin_inset Quotes erd
9401 \end_inset
9402
9403  to automatically set up a document to use the 
9404 \family sans
9405 slides
9406 \family default
9407  class [using 
9408 \family sans
9409 \bar under
9410 F
9411 \bar default
9412 ile\SpecialChar \menuseparator
9413 New
9414 \begin_inset space ~
9415 \end_inset
9416
9417 from
9418 \begin_inset space ~
9419 \end_inset
9420
9421
9422 \bar under
9423 T
9424 \bar default
9425 emplate
9426 \family default
9427  to open your new document].
9428  The template file also contains some examples of the special paragraph
9429  environments used by this class.
9430  I'll describe those next.
9431 \end_layout
9432
9433 \begin_layout Subsection
9434 Paragraph Environments
9435 \end_layout
9436
9437 \begin_layout Subsubsection
9438 Supported Environments
9439 \end_layout
9440
9441 \begin_layout Standard
9442 The first thing you'll notice when you start up a new 
9443 \family sans
9444 slides
9445 \family default
9446  document is the font size and type: it's the equivalent of the size 
9447 \begin_inset Quotes eld
9448 \end_inset
9449
9450
9451 \family sans
9452 Largest
9453 \family default
9454
9455 \begin_inset Quotes erd
9456 \end_inset
9457
9458  in the 
9459 \family sans
9460 Sans
9461 \begin_inset space ~
9462 \end_inset
9463
9464 Serif
9465 \family default
9466  font.
9467  This is also what's used in the output.
9468  Think of this as a 
9469 \begin_inset Quotes eld
9470 \end_inset
9471
9472 visual cue
9473 \begin_inset Quotes erd
9474 \end_inset
9475
9476  to remind you that this is a slide.
9477  Your final slides will use a larger font; ergo, you'll have less space.
9478  Of course, the larger default screen font isn't WYSIWYG, only a reminder.
9479 \end_layout
9480
9481 \begin_layout Standard
9482 The next thing that becomes obvious is the changes to the paragraph environment
9483  pull-down box [at the far-left end of the toolbar].
9484  Most of the paragraph environments you're used to seeing are missing.
9485  There are also five new ones.
9486  That's because the 
9487 \family sans
9488 slides
9489 \family default
9490  class itself only supports certain paragraph environments:
9491 \end_layout
9492
9493 \begin_layout Itemize
9494
9495 \family sans
9496 Standard
9497 \end_layout
9498
9499 \begin_layout Itemize
9500
9501 \family sans
9502 Itemize
9503 \end_layout
9504
9505 \begin_layout Itemize
9506
9507 \family sans
9508 Enumerate
9509 \end_layout
9510
9511 \begin_layout Itemize
9512
9513 \family sans
9514 Description
9515 \end_layout
9516
9517 \begin_layout Itemize
9518
9519 \family sans
9520 List
9521 \end_layout
9522
9523 \begin_layout Itemize
9524
9525 \family sans
9526 Quotation
9527 \end_layout
9528
9529 \begin_layout Itemize
9530
9531 \family sans
9532 Quote
9533 \end_layout
9534
9535 \begin_layout Itemize
9536
9537 \family sans
9538 Verse
9539 \end_layout
9540
9541 \begin_layout Itemize
9542
9543 \family sans
9544 Caption
9545 \end_layout
9546
9547 \begin_layout Itemize
9548
9549 \family sans
9550 LyX-Code
9551 \end_layout
9552
9553 \begin_layout Itemize
9554
9555 \family sans
9556 Comment
9557 \end_layout
9558
9559 \begin_layout Standard
9560 All of the other standard environments, including the section-heading environmen
9561 ts, aren't used in the 
9562 \family sans
9563 slides
9564 \family default
9565  class.
9566 \end_layout
9567
9568 \begin_layout Standard
9569 On the other hand, you'll notice the following new environments:
9570 \end_layout
9571
9572 \begin_layout Itemize
9573
9574 \family sans
9575 Slide
9576 \end_layout
9577
9578 \begin_layout Itemize
9579
9580 \family sans
9581 Overlay
9582 \end_layout
9583
9584 \begin_layout Itemize
9585
9586 \family sans
9587 Note
9588 \end_layout
9589
9590 \begin_layout Itemize
9591
9592 \family sans
9593 InvisibleText
9594 \end_layout
9595
9596 \begin_layout Itemize
9597
9598 \family sans
9599 VisibleText
9600 \end_layout
9601
9602 \begin_layout Standard
9603 These five are kind of quirky, due to a 
9604 \begin_inset Quotes eld
9605 \end_inset
9606
9607 feature
9608 \begin_inset Quotes erd
9609 \end_inset
9610
9611  in LyX.
9612  You see, LyX doesn't permit you to nest any other paragraph environment
9613  into an empty environment.
9614  Now, that's fine and dandy, but it means that you wouldn't be able to start
9615  a slide with anything except plain text.
9616  To deal with this, I've performed a little 
9617 \begin_inset Quotes eld
9618 \end_inset
9619
9620 LaTeX magic.
9621 \begin_inset Quotes erd
9622 \end_inset
9623
9624  
9625 \end_layout
9626
9627 \begin_layout Subsubsection
9628 Quirks of the New Environments
9629 \begin_inset CommandInset label
9630 LatexCommand label
9631 name "sec:slideQuirk"
9632
9633 \end_inset
9634
9635
9636 \end_layout
9637
9638 \begin_layout Standard
9639 All five of the new paragraph environments are somewhat quirky due to inherent
9640  limitiations in the current version of LyX.
9641  As I just mentioned, LyX forbids environments that begin with another environme
9642 nt.
9643  To get around this, the 
9644 \family sans
9645 Slide
9646 \family default
9647  environment isn't a paragraph environment as described in the 
9648 \emph on
9649 User's Guide
9650 \emph default
9651 .
9652  
9653 \end_layout
9654
9655 \begin_layout Standard
9656 You should consider 
9657 \family sans
9658 Slide
9659 \family default
9660
9661 \family sans
9662 Overlay
9663 \family default
9664 , and 
9665 \family sans
9666 Note
9667 \family default
9668  to be 
9669 \begin_inset Quotes eld
9670 \end_inset
9671
9672 pseudo-environments.
9673 \begin_inset Quotes erd
9674 \end_inset
9675
9676  They look like a section heading or a 
9677 \begin_inset Quotes eld
9678 \end_inset
9679
9680
9681 \family sans
9682 Caption
9683 \family default
9684 ,
9685 \begin_inset Quotes erd
9686 \end_inset
9687
9688  but really begin a [and, if necessary, end the previous] paragraph environment.
9689  Likewise, treat 
9690 \family sans
9691 InvisibleText
9692 \family default
9693  and 
9694 \family sans
9695 VisibleText
9696 \family default
9697  as 
9698 \begin_inset Quotes eld
9699 \end_inset
9700
9701 pseudo-commands.
9702 \begin_inset Quotes erd
9703 \end_inset
9704
9705  These two perform some action.
9706 \end_layout
9707
9708 \begin_layout Standard
9709 A common feature of all five environments, 
9710 \family sans
9711 Slide
9712 \family default
9713
9714 \family sans
9715 Overlay
9716 \family default
9717
9718 \family sans
9719 Note
9720 \family default
9721
9722 \family sans
9723 InvisibleText
9724 \family default
9725  and 
9726 \family sans
9727 VisibleText
9728 \family default
9729 , is a rather long-ish label.
9730  The text following this label --- ordinarily the contents of the paragraph
9731  environment --- is utterly irrelevant for 
9732 \family sans
9733 Slide
9734 \family default
9735
9736 \family sans
9737 Overlay
9738 \family default
9739
9740 \family sans
9741 Note
9742 \family default
9743
9744 \family sans
9745 InvisibleText
9746 \family default
9747  and 
9748 \family sans
9749 VisibleText
9750 \family default
9751 .
9752  LyX completely ignores it.
9753  In fact, you can leave these five environments completely empty.
9754  
9755 \end_layout
9756
9757 \begin_layout Standard
9758 While you don't 
9759 \emph on
9760 have
9761 \emph default
9762  to put any text after the rather long-ish label, you might want to.
9763  This could be a short description of the contents of the 
9764 \family sans
9765 Slide
9766 \family default
9767 , for example.
9768  In that case, enter in your descriptive comment and hit 
9769 \family sans
9770 Return
9771 \family default
9772  as you normally would.
9773 \end_layout
9774
9775 \begin_layout Standard
9776 If, on the other hand, you don't want to enter in any descriptive text,
9777  you'll hit another LyX quirk.
9778  LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
9779  environment until you put something in the old one.
9780  So, do this:
9781 \end_layout
9782
9783 \begin_layout Itemize
9784 Start entering the text that will 
9785 \emph on
9786 follow
9787 \emph default
9788  the new 
9789 \family sans
9790 Slide
9791 \family default
9792
9793 \family sans
9794 Overlay
9795 \family default
9796
9797 \family sans
9798 Note
9799 \family default
9800
9801 \family sans
9802 InvisibleText
9803 \family default
9804  or 
9805 \family sans
9806 VisibleText
9807 \family default
9808 .
9809  
9810 \end_layout
9811
9812 \begin_layout Itemize
9813 Now move to the beginning of that paragraph.
9814  
9815 \end_layout
9816
9817 \begin_layout Itemize
9818 Next, hit 
9819 \family sans
9820 Return
9821 \family default
9822 .
9823  
9824 \end_layout
9825
9826 \begin_layout Itemize
9827 Finally, change this new, empty paragraph to a 
9828 \family sans
9829 Slide
9830 \family default
9831
9832 \family sans
9833 Overlay
9834 \family default
9835
9836 \family sans
9837 Note
9838 \family default
9839
9840 \family sans
9841 InvisibleText
9842 \family default
9843  or 
9844 \family sans
9845 VisibleText
9846 \family default
9847 .
9848  
9849 \end_layout
9850
9851 \begin_layout Standard
9852 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
9853
9854 \end_layout
9855
9856 \begin_layout Subsection
9857 Making a Presentation with 
9858 \family sans
9859 Slide
9860 \family default
9861
9862 \family sans
9863 Overlay
9864 \family default
9865  and 
9866 \family sans
9867 Note
9868 \end_layout
9869
9870 \begin_layout Subsubsection
9871 Using the 
9872 \family sans
9873 Slide
9874 \family default
9875  Environment
9876 \end_layout
9877
9878 \begin_layout Standard
9879 If you're expecting this section to teach you how to actually make a presentatio
9880 n, you'll be sorely disappointed.
9881  Naturally, I'll describe all of the ways the 
9882 \family sans
9883 slides
9884 \family default
9885  class can assist you in preparing the materials for a presentation.
9886  Filling in the contents, however, is up to you.
9887  [Then again, that 
9888 \emph on
9889 is
9890 \emph default
9891  the LyX philosophy.]
9892 \end_layout
9893
9894 \begin_layout Standard
9895 Choosing the 
9896 \family sans
9897 Slide
9898 \family default
9899  environment [in the manner described in section
9900 \begin_inset space ~
9901 \end_inset
9902
9903
9904 \begin_inset CommandInset ref
9905 LatexCommand ref
9906 reference "sec:slideQuirk"
9907
9908 \end_inset
9909
9910 ] tells LyX to begin a new slide [duh].
9911  The label for this environment/
9912 \begin_inset Quotes erd
9913 \end_inset
9914
9915 pseudo-command
9916 \begin_inset Quotes erd
9917 \end_inset
9918
9919  is an 
9920 \begin_inset Quotes eld
9921 \end_inset
9922
9923 ASCII line,
9924 \begin_inset Quotes erd
9925 \end_inset
9926
9927  in cool blue, followed by the label, 
9928 \begin_inset Quotes eld
9929 \end_inset
9930
9931 NewSlide:
9932 \begin_inset Quotes erd
9933 \end_inset
9934
9935 .
9936  Any text or paragraph environments that follow this one go on the new slide.
9937  It's that simple.
9938 \end_layout
9939
9940 \begin_layout Standard
9941 Slides are probably the only time you'll need to forcibly end pages in LyX
9942  (this can be specified in the 
9943 \family sans
9944 Paragraph Layout
9945 \family default
9946  dialog).
9947  In fact, you'll want to, once you finish entering the contents of one slide.
9948  If you've entered more text than can physically fit on a slide, the extra
9949  overflows onto a new slide.
9950  I don't recommend doing this, however, since the overflow slide won't have
9951  any page number on it.
9952  Furthermore, it may interfere with any 
9953 \family sans
9954 Overlay
9955 \family default
9956  you've made to accompany the oversized 
9957 \family sans
9958 Slide
9959 \family default
9960 .
9961 \end_layout
9962
9963 \begin_layout Standard
9964 The 
9965 \family sans
9966 Overlay
9967 \family default
9968  and 
9969 \family sans
9970 Note
9971 \family default
9972  environments work the same way as the 
9973 \family sans
9974 Slide
9975 \family default
9976  environment.
9977  They both create an 
9978 \begin_inset Quotes eld
9979 \end_inset
9980
9981 ASCII line
9982 \begin_inset Quotes erd
9983 \end_inset
9984
9985  followed by a label [
9986 \begin_inset Quotes eld
9987 \end_inset
9988
9989 NewOverlay:
9990 \begin_inset Quotes erd
9991 \end_inset
9992
9993  and 
9994 \begin_inset Quotes eld
9995 \end_inset
9996
9997 NewNote:
9998 \begin_inset Quotes erd
9999 \end_inset
10000
10001 , respectively].
10002  The color is a stunning magenta instead of blue, and the 
10003 \begin_inset Quotes eld
10004 \end_inset
10005
10006 ASCII line
10007 \begin_inset Quotes erd
10008 \end_inset
10009
10010  will look different, in style and in length.
10011  The label fonts of all three also differ from one another.
10012 \end_layout
10013
10014 \begin_layout Standard
10015 As with a 
10016 \family sans
10017 Slide
10018 \family default
10019 , if the contents of a 
10020 \family sans
10021 Note
10022 \family default
10023  or 
10024 \family sans
10025 Overlay
10026 \family default
10027  exceed the physical size of a slide or sheet of paper, the extra will overflow
10028  onto a new sheet.
10029  Again, you should avoid this.
10030  It defeats the whole purpose of 
10031 \family sans
10032 Note
10033 \family default
10034 s and 
10035 \family sans
10036 Overlay
10037 \family default
10038 s.
10039 \end_layout
10040
10041 \begin_layout Subsubsection
10042 Using 
10043 \family sans
10044 Overlay
10045 \family default
10046  with 
10047 \family sans
10048 Slide
10049 \end_layout
10050
10051 \begin_layout Standard
10052 The idea behind an 
10053 \family sans
10054 Overlay
10055 \family default
10056  is a slide that sits atop another slide.
10057  Perhaps you wish to discuss a figure on the main 
10058 \family sans
10059 Slide
10060 \family default
10061  before displaying the text associated with it.
10062  One way to accomplish this is tape a flap of dark paper over the part of
10063  the 
10064 \family sans
10065 Slide
10066 \family default
10067  you want to display later.
10068  This method fails, however, if you wish to overlap one graph with another,
10069  for example.
10070  You would then have to fumble while speaking to align the two separate,
10071  overlapping 
10072 \family sans
10073 Slide
10074 \family default
10075 s to align the two graphs.
10076  The use of an 
10077 \family sans
10078 Overlay
10079 \family default
10080  environment in both cases makes life much easier.
10081 \end_layout
10082
10083 \begin_layout Standard
10084 Each 
10085 \family sans
10086 Overlay
10087 \family default
10088  receives the page number of its 
10089 \begin_inset Quotes eld
10090 \end_inset
10091
10092 parent
10093 \begin_inset Quotes erd
10094 \end_inset
10095
10096  
10097 \family sans
10098 Slide
10099 \family default
10100 , appended by 
10101 \begin_inset Quotes eld
10102 \end_inset
10103
10104
10105 \family typewriter
10106 -a
10107 \family default
10108
10109 \begin_inset Quotes erd
10110 \end_inset
10111
10112 .
10113 \begin_inset Foot
10114 status collapsed
10115
10116 \begin_layout Plain Layout
10117 Presumably, mutliple 
10118 \family sans
10119 Overlay
10120 \family default
10121 s would have 
10122 \begin_inset Quotes eld
10123 \end_inset
10124
10125
10126 \family typewriter
10127 -a
10128 \family default
10129
10130 \begin_inset Quotes erd
10131 \end_inset
10132
10133
10134 \begin_inset Quotes eld
10135 \end_inset
10136
10137
10138 \family typewriter
10139 -b
10140 \family default
10141
10142 \begin_inset Quotes erd
10143 \end_inset
10144
10145
10146 \begin_inset Quotes eld
10147 \end_inset
10148
10149
10150 \family typewriter
10151 -c
10152 \family default
10153
10154 \begin_inset Quotes erd
10155 \end_inset
10156
10157 , etc.
10158 \begin_inset space ~
10159 \end_inset
10160
10161 appended to the page number of the parent 
10162 \family sans
10163 Slide
10164 \family default
10165 .
10166  
10167 \end_layout
10168
10169 \end_inset
10170
10171  Clearly, you want the contents of both the 
10172 \family sans
10173 Slide
10174 \family default
10175  and the 
10176 \family sans
10177 Overlay
10178 \family default
10179  to each fit on a single physical slide! You should probably consider an
10180  
10181 \family sans
10182 Overlay
10183 \family default
10184  as 
10185 \begin_inset Quotes eld
10186 \end_inset
10187
10188 part of
10189 \begin_inset Quotes erd
10190 \end_inset
10191
10192  a 
10193 \family sans
10194 Slide
10195 \family default
10196 .
10197  Indeed, the LyX 
10198 \family sans
10199 slides
10200 \family default
10201  class provides a visual cue for this: the label at the start of an 
10202 \family sans
10203 Overlay
10204 \family default
10205  is shorter than that at the start of a 
10206 \family sans
10207 Slide
10208 \family default
10209 .
10210  Lastly, when you generate printable output, you'll find alignment markers
10211  in all four corners of both the 
10212 \family sans
10213 Overlay
10214 \family default
10215  page and its parent 
10216 \family sans
10217 Slide
10218 \family default
10219 .
10220  These will assist you in lining up the two physical slides.
10221 \end_layout
10222
10223 \begin_layout Standard
10224 The major problem in overlaying two slides is aligning the contents of the
10225  two transparencies.
10226  How much space should you leave for that graph on the second slide? Worse
10227  still, what if you want a graph and a sentence on second slide, but there
10228  is text on the main transparency that goes in between them? You could try
10229  and insert vertical space of the right size.
10230  The better way is to use 
10231 \family sans
10232 InvisibleText
10233 \family default
10234  and 
10235 \family sans
10236 VisibleText
10237 \family default
10238 .
10239 \end_layout
10240
10241 \begin_layout Standard
10242 As their names imply, 
10243 \family sans
10244 InvisibleText
10245 \family default
10246  and 
10247 \family sans
10248 VisibleText
10249 \family default
10250  are two command-like paragraph environments that make all subsequent text
10251  invisible and visible, respectively.
10252  Note from section
10253 \begin_inset space ~
10254 \end_inset
10255
10256
10257 \begin_inset CommandInset ref
10258 LatexCommand ref
10259 reference "sec:slideQuirk"
10260
10261 \end_inset
10262
10263  that you don't place anything 
10264 \emph on
10265 into
10266 \emph default
10267  these two environments, however.
10268  When you create an 
10269 \family sans
10270 InvisibleText
10271 \family default
10272 , it inserts a centered, sky-blue label into the page reading 
10273 \begin_inset Quotes eld
10274 \end_inset
10275
10276 <Invisible Text Follows>
10277 \begin_inset Quotes erd
10278 \end_inset
10279
10280 .
10281  For paragraphs following this label, the parts of the 
10282 \family sans
10283 Slide
10284 \family default
10285  [or 
10286 \family sans
10287 Overlay
10288 \family default
10289 ; it doesn't matter which] where they would be contain instead blank space.
10290  
10291 \end_layout
10292
10293 \begin_layout Standard
10294 For 
10295 \family sans
10296 VisibleText
10297 \family default
10298 , the corresponding centered label is 
10299 \begin_inset Quotes eld
10300 \end_inset
10301
10302 <Visible Text Follows>
10303 \begin_inset Quotes erd
10304 \end_inset
10305
10306  in blazing green.
10307  Paragraphs following this label behave normally.
10308  Note that the beginning of a new 
10309 \family sans
10310 Slide
10311 \family default
10312
10313 \family sans
10314 Overlay
10315 \family default
10316 , or 
10317 \family sans
10318 Note
10319 \family default
10320  automatically shuts off an 
10321 \family sans
10322 InvisibleText
10323 \family default
10324 .
10325  It's therefore not necessary to use 
10326 \family sans
10327 VisibleText
10328 \family default
10329  at the end of a 
10330 \family sans
10331 Slide
10332 \family default
10333 .
10334 \end_layout
10335
10336 \begin_layout Standard
10337 By now, it should be obvious how to create overlay transparencies using
10338  the proper combination of 
10339 \family sans
10340 InvisibleText
10341 \family default
10342  and 
10343 \family sans
10344 VisibleText
10345 \family default
10346  on a 
10347 \family sans
10348 Slide
10349 \family default
10350  and 
10351 \family sans
10352 Overlay
10353 \family default
10354 :
10355 \end_layout
10356
10357 \begin_layout Enumerate
10358 Create a 
10359 \family sans
10360 Slide
10361 \family default
10362 , including everything that will appear on it, whether on the main slide
10363  or on the 
10364 \family sans
10365 Overlay
10366 \family default
10367 .
10368 \end_layout
10369
10370 \begin_layout Enumerate
10371 Before each figure or paragraph that will appear only on the 
10372 \family sans
10373 Overlay
10374 \family default
10375 , insert an 
10376 \family sans
10377 InvisibleText
10378 \family default
10379  environment.
10380  If necessary, insert a 
10381 \family sans
10382 VisibleText
10383 \family default
10384  environment after the 
10385 \family sans
10386 Overlay
10387 \family default
10388 -only text.
10389 \end_layout
10390
10391 \begin_layout Enumerate
10392 Start an 
10393 \family sans
10394 Overlay
10395 \family default
10396  immediately following the 
10397 \family sans
10398 Slide
10399 \family default
10400 .
10401 \end_layout
10402
10403 \begin_layout Enumerate
10404 Copy the contents of this 
10405 \family sans
10406 Slide
10407 \family default
10408  into the 
10409 \family sans
10410 Overlay
10411 \family default
10412 .
10413 \end_layout
10414
10415 \begin_layout Enumerate
10416 Within the 
10417 \family sans
10418 Overlay
10419 \family default
10420 , change all of the 
10421 \family sans
10422 InvisibleText
10423 \family default
10424  lines to 
10425 \family sans
10426 VisibleText
10427 \family default
10428  and vice-versa.
10429 \end_layout
10430
10431 \begin_layout Standard
10432 That's it.
10433  You've just made an 
10434 \family sans
10435 Overlay
10436 \family default
10437 .
10438 \end_layout
10439
10440 \begin_layout Standard
10441 There's one problem with the way I've designed the LyX 
10442 \family sans
10443 slides
10444 \family default
10445  class: you can't make text in the middle of a paragraph invisible, nor
10446  make text in the middle of an invisible paragraph visible again.
10447  To accomplish this feat, you'll need to use some inlined LaTeX codes.
10448 \begin_inset Foot
10449 status collapsed
10450
10451 \begin_layout Plain Layout
10452 The commands of interest are: 
10453 \end_layout
10454
10455 \begin_layout Itemize
10456
10457 \family typewriter
10458 {
10459 \backslash
10460 invisible \SpecialChar \ldots{}
10461  }
10462 \end_layout
10463
10464 \begin_layout Itemize
10465
10466 \family typewriter
10467 {
10468 \backslash
10469 visible \SpecialChar \ldots{}
10470  }
10471 \end_layout
10472
10473 \begin_layout Plain Layout
10474 \SpecialChar \ldots{}
10475 and need to be marked as TeX.
10476  The text whose 
10477 \begin_inset Quotes eld
10478 \end_inset
10479
10480 visibility
10481 \begin_inset Quotes erd
10482 \end_inset
10483
10484  you wish to change goes in between the brackets [and after the 
10485 \family typewriter
10486
10487 \backslash
10488 invisible
10489 \family default
10490  or 
10491 \family typewriter
10492
10493 \backslash
10494 visible
10495 \family default
10496  command].
10497  If you don't know how to mark text as TeX, see the appropriate section
10498  of the 
10499 \emph on
10500 User's Guide
10501 \emph default
10502 .
10503 \end_layout
10504
10505 \end_inset
10506
10507
10508 \end_layout
10509
10510 \begin_layout Subsubsection
10511 Using 
10512 \family sans
10513 Note
10514 \family default
10515  with 
10516 \family sans
10517 Slide
10518 \family default
10519
10520 \begin_inset CommandInset label
10521 LatexCommand label
10522 name "sec:slideNote"
10523
10524 \end_inset
10525
10526
10527 \end_layout
10528
10529 \begin_layout Standard
10530 Like an 
10531 \family sans
10532 Overlay
10533 \family default
10534 , a 
10535 \family sans
10536 Note
10537 \family default
10538  is associated with a 
10539 \begin_inset Quotes eld
10540 \end_inset
10541
10542 parent
10543 \begin_inset Quotes erd
10544 \end_inset
10545
10546  
10547 \family sans
10548 Slide
10549 \family default
10550 .
10551  Here, too, the LyX 
10552 \family sans
10553 slides
10554 \family default
10555  class provides visual cues.
10556  The label for a 
10557 \family sans
10558 Note
10559 \family default
10560  is shorter than that of a 
10561 \family sans
10562 Slide
10563 \family default
10564  [yet longer than that of an 
10565 \family sans
10566 Overlay
10567 \family default
10568 ] and, like the label of an 
10569 \family sans
10570 Overlay
10571 \family default
10572  is shockingly magenta.
10573  Additionally, the printed 
10574 \family sans
10575 Note
10576 \family default
10577  has the page number of its 
10578 \begin_inset Quotes eld
10579 \end_inset
10580
10581 parent
10582 \begin_inset Quotes erd
10583 \end_inset
10584
10585  
10586 \family sans
10587 Slide
10588 \family default
10589 , appended by 
10590 \begin_inset Quotes eld
10591 \end_inset
10592
10593
10594 \family typewriter
10595 -
10596 \family default
10597 1
10598 \begin_inset Quotes erd
10599 \end_inset
10600
10601
10602 \begin_inset Quotes eld
10603 \end_inset
10604
10605
10606 \family typewriter
10607 -
10608 \family default
10609 2
10610 \begin_inset Quotes erd
10611 \end_inset
10612
10613
10614 \begin_inset Quotes eld
10615 \end_inset
10616
10617
10618 \family typewriter
10619 -
10620 \family default
10621 3
10622 \begin_inset Quotes erd
10623 \end_inset
10624
10625 , etc.
10626  You can have multiple 
10627 \family sans
10628 Note
10629 \family default
10630 s associated with a single 
10631 \family sans
10632 Slide
10633 \family default
10634 , and, as with 
10635 \family sans
10636 Slide
10637 \family default
10638  and 
10639 \family sans
10640 Overlay
10641 \family default
10642 , you'll probably want to break up long 
10643 \family sans
10644 Note
10645 \family default
10646 s so that they fit on a single sheet of paper.
10647 \end_layout
10648
10649 \begin_layout Standard
10650 The purpose of a 
10651 \family sans
10652 Note
10653 \family default
10654  is obvious: it contains anything additional you might want to say about
10655  a 
10656 \family sans
10657 Slide
10658 \family default
10659 .
10660  It could also be used as a sheet of reminders for a particular 
10661 \family sans
10662 Slide
10663 \family default
10664 .
10665  In the case of the latter, you might want to make use of time markers.
10666  Currently, the LyX 
10667 \family sans
10668 slides
10669 \family default
10670  class has no 
10671 \begin_inset Quotes eld
10672 \end_inset
10673
10674 native
10675 \begin_inset Quotes erd
10676 \end_inset
10677
10678  support for time markers, a 
10679 \noun on
10680 Sli
10681 \noun default
10682 TeX feature.
10683  So, you'll have to resort to using the LaTeX codes.
10684 \end_layout
10685
10686 \begin_layout Standard
10687 To use time markers, you'll need to specify the extra class option 
10688 \begin_inset Quotes eld
10689 \end_inset
10690
10691
10692 \family typewriter
10693 clock
10694 \family default
10695
10696 \begin_inset Quotes erd
10697 \end_inset
10698
10699  [see section
10700 \begin_inset space ~
10701 \end_inset
10702
10703
10704 \begin_inset CommandInset ref
10705 LatexCommand ref
10706 reference "sec:slidesetup"
10707
10708 \end_inset
10709
10710 ].
10711  This option turns on timing marks, which will appear in the lower-left-hand
10712  corner of every 
10713 \family sans
10714 Note
10715 \family default
10716  you generate.
10717  To set what appears in the time marker, you use the LaTeX commands 
10718 \begin_inset Quotes eld
10719 \end_inset
10720
10721
10722 \family typewriter
10723
10724 \backslash
10725 settime{}
10726 \family default
10727
10728 \begin_inset Quotes erd
10729 \end_inset
10730
10731  and 
10732 \begin_inset Quotes eld
10733 \end_inset
10734
10735
10736 \family typewriter
10737
10738 \backslash
10739 addtime{}
10740 \family default
10741
10742 \begin_inset Quotes erd
10743 \end_inset
10744
10745 .
10746  The arguments of both commands are time measured in seconds.
10747  
10748 \begin_inset Quotes eld
10749 \end_inset
10750
10751
10752 \family typewriter
10753
10754 \backslash
10755 settime{}
10756 \family default
10757
10758 \begin_inset Quotes erd
10759 \end_inset
10760
10761  sets the time marker to a given time.
10762  
10763 \begin_inset Quotes eld
10764 \end_inset
10765
10766
10767 \family typewriter
10768
10769 \backslash
10770 addtime{}
10771 \family default
10772
10773 \begin_inset Quotes erd
10774 \end_inset
10775
10776  increments the time marker by the specified amount.
10777  Using time markers and 
10778 \family sans
10779 Note
10780 \family default
10781 s in this fashion, you can remind yourself how much time to spend on a particula
10782
10783 \family sans
10784 Slide
10785 \family default
10786 .
10787 \end_layout
10788
10789 \begin_layout Standard
10790 There's one last feature to describe.
10791  Clearly, you'd like to print out all of your 
10792 \family sans
10793 Slide
10794 \family default
10795 s and 
10796 \family sans
10797 Overlay
10798 \family default
10799 s on transparencies while printing all of your 
10800 \family sans
10801 Note
10802 \family default
10803 s on plain paper.
10804  However, a 
10805 \family sans
10806 Note
10807 \family default
10808  
10809 \emph on
10810 must
10811 \emph default
10812  follow the 
10813 \family sans
10814 Slide
10815 \family default
10816  with which it is associated.
10817  What's a person to do?
10818 \end_layout
10819
10820 \begin_layout Standard
10821 Luckily, there are two LaTeX commands that allow you to select what to print
10822  out.
10823  Both must be placed into the preamble of your document.
10824  The command 
10825 \begin_inset Quotes eld
10826 \end_inset
10827
10828
10829 \family typewriter
10830
10831 \backslash
10832 onlyslides{
10833 \backslash
10834 slides}
10835 \family default
10836
10837 \begin_inset Quotes erd
10838 \end_inset
10839
10840  will cause the output to contain only the 
10841 \family sans
10842 Slide
10843 \family default
10844 s and 
10845 \family sans
10846 Overlay
10847 \family default
10848 s.
10849  Correspondingly, the command 
10850 \begin_inset Quotes eld
10851 \end_inset
10852
10853
10854 \family typewriter
10855
10856 \backslash
10857 onlynotes{
10858 \backslash
10859 notes}
10860 \family default
10861
10862 \begin_inset Quotes erd
10863 \end_inset
10864
10865  prevents the output of anything but 
10866 \family sans
10867 Note
10868 \family default
10869 s.
10870  I'd advise placing both commands in the preamble and initially comment
10871  both out.
10872  You can then preview your entire presentation as you write.
10873  When you're done writing, you can then uncomment one of the two to select
10874  what you want to print.
10875  I like to uncomment 
10876 \begin_inset Quotes eld
10877 \end_inset
10878
10879
10880 \family typewriter
10881
10882 \backslash
10883 onlyslides{
10884 \backslash
10885 slides}
10886 \family default
10887
10888 \begin_inset Quotes erd
10889 \end_inset
10890
10891  , print to a file with 
10892 \begin_inset Quotes eld
10893 \end_inset
10894
10895
10896 \family typewriter
10897 -slides
10898 \family default
10899
10900 \begin_inset Quotes erd
10901 \end_inset
10902
10903  in its name, comment it back out, then uncomment 
10904 \begin_inset Quotes eld
10905 \end_inset
10906
10907
10908 \family typewriter
10909
10910 \backslash
10911 onlynotes{
10912 \backslash
10913 notes}
10914 \family default
10915
10916 \begin_inset Quotes erd
10917 \end_inset
10918
10919  and print to a 
10920 \begin_inset Quotes eld
10921 \end_inset
10922
10923
10924 \family typewriter
10925 *-notes.ps
10926 \family default
10927
10928 \begin_inset Quotes erd
10929 \end_inset
10930
10931  file.
10932  I can then send either file to a printer, loading transparencies or plain
10933  paper as appropriate.
10934 \end_layout
10935
10936 \begin_layout Standard
10937 You can also provide other arguments to the 
10938 \begin_inset Quotes eld
10939 \end_inset
10940
10941
10942 \family typewriter
10943
10944 \backslash
10945 onlyslides{}
10946 \family default
10947
10948 \begin_inset Quotes erd
10949 \end_inset
10950
10951  and 
10952 \begin_inset Quotes eld
10953 \end_inset
10954
10955
10956 \family typewriter
10957
10958 \backslash
10959 onlynotes{}
10960 \family default
10961
10962 \begin_inset Quotes erd
10963 \end_inset
10964
10965  commands.
10966  See a good LaTeX book for details.
10967 \end_layout
10968
10969 \begin_layout Subsection
10970 The 
10971 \family sans
10972 slides
10973 \family default
10974  Class Template File
10975 \end_layout
10976
10977 \begin_layout Standard
10978 I have also provided a template file, 
10979 \begin_inset Quotes eld
10980 \end_inset
10981
10982
10983 \family typewriter
10984 slides.lyx
10985 \family default
10986
10987 \begin_inset Quotes erd
10988 \end_inset
10989
10990 , with the 
10991 \family sans
10992 slides
10993 \family default
10994  class.
10995  To use it, begin your new presentation with 
10996 \family sans
10997 \bar under
10998 F
10999 \bar default
11000 ile\SpecialChar \menuseparator
11001 New
11002 \begin_inset space ~
11003 \end_inset
11004
11005 from
11006 \begin_inset space ~
11007 \end_inset
11008
11009
11010 \bar under
11011 T
11012 \bar default
11013 emplate
11014 \family default
11015 .
11016  Your new LyX presentation file will contain an example 
11017 \family sans
11018 Slide
11019 \family default
11020  -- 
11021 \family sans
11022 Overlay
11023 \family default
11024  -- 
11025 \family sans
11026 Note
11027 \family default
11028  triplet.
11029  The 
11030 \family sans
11031 Slide
11032 \family default
11033  and 
11034 \family sans
11035 Overlay
11036 \family default
11037  additionally contain an example of the use of 
11038 \family sans
11039 InvisibleText
11040 \family default
11041  and 
11042 \family sans
11043 VisibleText
11044 \family default
11045 .
11046  Lastly, the preamble will contain:
11047 \end_layout
11048
11049 \begin_layout LyX-Code
11050 % Uncomment to print out only slides and overlays
11051 \end_layout
11052
11053 \begin_layout LyX-Code
11054 %
11055 \end_layout
11056
11057 \begin_layout LyX-Code
11058 %
11059 \backslash
11060 onlyslides{
11061 \backslash
11062 slides}
11063 \begin_inset Newline newline
11064 \end_inset
11065
11066  
11067 \end_layout
11068
11069 \begin_layout LyX-Code
11070 % Uncomment to print out only notes
11071 \end_layout
11072
11073 \begin_layout LyX-Code
11074 %
11075 \end_layout
11076
11077 \begin_layout LyX-Code
11078 %
11079 \backslash
11080 onlynotes{
11081 \backslash
11082 notes}
11083 \end_layout
11084
11085 \begin_layout Standard
11086 One final thing: I created this class to support the LaTeX2e 
11087 \begin_inset Quotes eld
11088 \end_inset
11089
11090
11091 \noun on
11092 Sli
11093 \noun default
11094 TeX emulation
11095 \begin_inset Quotes erd
11096 \end_inset
11097
11098  class, one of the built-in LaTeX2e classes.
11099  Neither I nor the rest of the LyX Team endorse or oppose the use of this
11100  built-in slide class.
11101  It's here if you want it or need it.
11102  There exist other LaTeX2e classes for creating presentations, such as the
11103  
11104 \family sans
11105 Foils
11106 \family default
11107  class [see section
11108 \begin_inset space ~
11109 \end_inset
11110
11111
11112 \begin_inset CommandInset ref
11113 LatexCommand ref
11114 reference "sec:foiltex"
11115
11116 \end_inset
11117
11118 ] or the 
11119 \begin_inset Quotes eld
11120 \end_inset
11121
11122
11123 \family typewriter
11124 seminar
11125 \family default
11126
11127 \begin_inset Quotes erd
11128 \end_inset
11129
11130  package [present on some TeX distributions].
11131  The latter is not yet supported under LyX.
11132 \begin_inset Foot
11133 status collapsed
11134
11135 \begin_layout Plain Layout
11136 Perhaps you can take on the task\SpecialChar \ldots{}
11137
11138 \end_layout
11139
11140 \end_inset
11141
11142  I know nothing about these other classes.
11143  Try them out to see what sort of alternative they provide.
11144 \end_layout
11145
11146 \begin_layout Section
11147 Foils [aka 
11148 \family sans
11149 Foil
11150 \family default
11151 \noun on
11152 TeX
11153 \noun default
11154 ]
11155 \begin_inset CommandInset label
11156 LatexCommand label
11157 name "sec:foiltex"
11158
11159 \end_inset
11160
11161
11162 \end_layout
11163
11164 \begin_layout Standard
11165 by 
11166 \noun on
11167 Allan Rae
11168 \end_layout
11169
11170 \begin_layout Subsection
11171 Introduction
11172 \end_layout
11173
11174 \begin_layout Standard
11175 This section describes how to use LyX to make slides for overhead projectors.
11176  There are two document classes that can do this: the default slides class
11177  and the 
11178 \family sans
11179 Foil
11180 \family default
11181 TeX slides class.
11182  This section documents the latter.
11183 \end_layout
11184
11185 \begin_layout Standard
11186 I'm going to say this again, nice and clear, so that there's no misunderstanding
11187 :
11188 \end_layout
11189
11190 \begin_layout Standard
11191 \begin_inset VSpace bigskip
11192 \end_inset
11193
11194
11195 \end_layout
11196
11197 \begin_layout Standard
11198 \align center
11199
11200 \size large
11201 This section documents the class 
11202 \begin_inset Quotes eld
11203 \end_inset
11204
11205
11206 \family sans
11207 slides (FoilTeX)
11208 \family default
11209
11210 \begin_inset Quotes erd
11211 \end_inset
11212
11213  
11214 \emph on
11215 only.
11216 \end_layout
11217
11218 \begin_layout Standard
11219 \begin_inset VSpace bigskip
11220 \end_inset
11221
11222
11223 \end_layout
11224
11225 \begin_layout Standard
11226 If you're looking for the documentation for 
11227 \begin_inset Quotes eld
11228 \end_inset
11229
11230
11231 \family sans
11232 slides (default)
11233 \family default
11234
11235 \begin_inset Quotes erd
11236 \end_inset
11237
11238 , check out section
11239 \begin_inset space ~
11240 \end_inset
11241
11242
11243 \begin_inset CommandInset ref
11244 LatexCommand ref
11245 reference "sec:slitex"
11246
11247 \end_inset
11248
11249 .
11250  If your machine doesn't have the 
11251 \family sans
11252 foils
11253 \family default
11254  class [
11255 \begin_inset Quotes eld
11256 \end_inset
11257
11258
11259 \family sans
11260 slides (FoilTeX)
11261 \family default
11262
11263 \begin_inset Quotes erd
11264 \end_inset
11265
11266 ] installed, you'll probably have to use the default 
11267 \family sans
11268 slides
11269 \family default
11270  class, which isn't quite as good as 
11271 \family sans
11272 foils.
11273 \end_layout
11274
11275 \begin_layout Standard
11276 The 
11277 \family sans
11278 foils
11279 \family default
11280  class is designed for use with version 2.1 of the 
11281 \family sans
11282 foils.cls
11283 \family default
11284  LaTeX class file which is now an integral part of LaTeX2e.
11285 \end_layout
11286
11287 \begin_layout Subsection
11288 Getting Started
11289 \end_layout
11290
11291 \begin_layout Standard
11292 Obviously, to use this document class, you need to select 
11293 \begin_inset Quotes eld
11294 \end_inset
11295
11296
11297 \family sans
11298 slides (FoilTeX)
11299 \family default
11300
11301 \begin_inset Quotes erd
11302 \end_inset
11303
11304  from the 
11305 \family sans
11306 \bar under
11307 C
11308 \bar default
11309 lass
11310 \family default
11311  entry in the 
11312 \family sans
11313 Document
11314 \begin_inset space ~
11315 \end_inset
11316
11317 Layout
11318 \family default
11319  dialog.
11320  There are some settings in the 
11321 \family sans
11322 Document
11323 \begin_inset space ~
11324 \end_inset
11325
11326 Layout
11327 \family default
11328  dialog that you should know about that are specific to this class:
11329 \end_layout
11330
11331 \begin_layout Itemize
11332 Don't change the options 
11333 \family sans
11334 Sides
11335 \family default
11336  and 
11337 \family sans
11338 Columns
11339 \family default
11340  on the 
11341 \family sans
11342 Document
11343 \begin_inset space ~
11344 \end_inset
11345
11346 Layout
11347 \family default
11348  dialog.
11349  They're ignored by the 
11350 \family sans
11351 foils
11352 \family default
11353  class.
11354 \end_layout
11355
11356 \begin_layout Itemize
11357 The default font size is 20pt with the other options being 17pt, 25pt and
11358  30pt.
11359 \end_layout
11360
11361 \begin_layout Itemize
11362 The default font is 
11363 \family sans
11364 sans
11365 \family default
11366  
11367 \family sans
11368 serif
11369 \family default
11370  but all math equations are still typeset in the usual roman font.
11371 \end_layout
11372
11373 \begin_layout Itemize
11374
11375 \family sans
11376 Foil
11377 \family default
11378 TeX supports A4 and Letter paper sizes as well as a special size for working
11379  with 35mm slides.
11380  It doesn't support A5, B5, legal or executive paper sizes.
11381 \end_layout
11382
11383 \begin_layout Itemize
11384 Don't bother changing the 
11385 \family sans
11386 Float Placement
11387 \family default
11388  settings because they are ignored anyway.
11389  All floats appear where they are defined in the text.
11390 \end_layout
11391
11392 \begin_layout Itemize
11393 The 
11394 \family sans
11395 \bar under
11396 P
11397 \bar default
11398 agestyle
11399 \family default
11400  setting behaves a bit differently for this class.
11401  
11402 \family sans
11403 Foil
11404 \family default
11405 TeX provides extensive footer and header capabilities including a user-defined
11406  logo.
11407  See section
11408 \begin_inset space ~
11409 \end_inset
11410
11411
11412 \begin_inset CommandInset ref
11413 LatexCommand ref
11414 reference "sec:foilfoot"
11415
11416 \end_inset
11417
11418  for more details.
11419  The title page is treated differently to all other pages in the document
11420  and is 
11421 \emph on
11422 always
11423 \emph default
11424  unnumbered and 
11425 \emph on
11426 always
11427 \emph default
11428  has the logo centered at the bottom of the page (if one is defined).
11429  The possible page style choices and what they do are as follows:
11430 \end_layout
11431
11432 \begin_deeper
11433 \begin_layout Labeling
11434 \labelwidthstring MMMMMMM
11435
11436 \family sans
11437 \series bold
11438 empty
11439 \family default
11440 \series default
11441  The final output contains no page numbers, or other headers or footers
11442  (except footnotes of course).
11443  
11444 \end_layout
11445
11446 \begin_layout Labeling
11447 \labelwidthstring MMMMMMM
11448
11449 \family sans
11450 \series bold
11451 plain
11452 \family default
11453 \series default
11454  The final output contains page numbers centered at the bottom of the page.
11455  No other headings or footers (other than footnotes).
11456 \end_layout
11457
11458 \begin_layout Labeling
11459 \labelwidthstring MMMMMMM
11460
11461 \series bold
11462 foilheadings
11463 \series default
11464  Page numbers in lower right corner.
11465  Additional headers and footers are also shown.
11466  This is also the default.
11467 \end_layout
11468
11469 \begin_layout Labeling
11470 \labelwidthstring MMMMMMM
11471
11472 \series bold
11473 fancy
11474 \series default
11475  Gives you access to the 
11476 \family sans
11477 fancyheadings
11478 \family default
11479  package although its use with 
11480 \family sans
11481 Foil
11482 \family default
11483 TeX is discouraged by the writer of the 
11484 \family sans
11485 Foil
11486 \family default
11487 TeX package because of some potential page layout clashes.
11488 \end_layout
11489
11490 \end_deeper
11491 \begin_layout Subsubsection
11492 Extra Options
11493 \end_layout
11494
11495 \begin_layout Standard
11496 The following options may be used in the extra class options in the 
11497 \family sans
11498 \bar under
11499 D
11500 \bar default
11501 ocument\SpecialChar \menuseparator
11502
11503 \bar under
11504 S
11505 \bar default
11506 ettings
11507 \family default
11508  dialog.
11509 \end_layout
11510
11511 \begin_layout Labeling
11512 \labelwidthstring MMMMMMx
11513
11514 \series bold
11515 35mmSlide
11516 \series default
11517  This sets up the page layout for 7.33in by 11in paper, which is about the
11518  same aspect ratio as a 35mm slide, making it a bit easier to work with
11519  this medium.
11520 \end_layout
11521
11522 \begin_layout Labeling
11523 \labelwidthstring MMMMMMx
11524
11525 \series bold
11526 headrule
11527 \series default
11528  Places a rule across the page below the header on every page except the
11529  title page.
11530 \end_layout
11531
11532 \begin_layout Labeling
11533 \labelwidthstring MMMMMMx
11534
11535 \series bold
11536 footrule
11537 \series default
11538  Places a rule across the page above the footer on every page except the
11539  title page.
11540 \end_layout
11541
11542 \begin_layout Labeling
11543 \labelwidthstring MMMMMMx
11544
11545 \series bold
11546 dvips
11547 \series default
11548  This is automatically set each time you create a new 
11549 \family sans
11550 foils
11551 \family default
11552  document.
11553  This option tells 
11554 \family sans
11555 Foil
11556 \family default
11557 TeX to use the dvips driver to rotate those pages that are set as landscape
11558  foils.
11559 \end_layout
11560
11561 \begin_layout Labeling
11562 \labelwidthstring MMMMMMx
11563
11564 \series bold
11565 landscape
11566 \series default
11567  Simply changes the page dimensions to those of a landscape page but doesn't
11568  do any rotation.
11569  Thus if you use this option you need to use an external program to rotate
11570  each page or feed your paper through your printer as landscape.
11571  Note that this option effectively reverses the roles of the 
11572 \family sans
11573 Foilhead
11574 \family default
11575  and 
11576 \family sans
11577 Rotatefoilhead
11578 \family default
11579  environments (don't worry these are described in the next section).
11580 \end_layout
11581
11582 \begin_layout Labeling
11583 \labelwidthstring MMMMMMx
11584
11585 \series bold
11586 leqno
11587 \series default
11588  Equation numbers on the left.
11589 \end_layout
11590
11591 \begin_layout Labeling
11592 \labelwidthstring MMMMMMx
11593
11594 \series bold
11595 fleqn
11596 \series default
11597  Flush-left equations.
11598 \end_layout
11599
11600 \begin_layout Subsection
11601 Supported Environments
11602 \end_layout
11603
11604 \begin_layout Standard
11605 Most of the environments commonly supported in other classes are also supported
11606  by the 
11607 \family sans
11608 foils
11609 \family default
11610  class.
11611  There are several additional environments provided by 
11612 \family sans
11613 Foil
11614 \family default
11615 TeX as well as a couple added by LyX.
11616  The following environments are shared with other classes:
11617 \end_layout
11618
11619 \begin_layout Standard
11620 \begin_inset ERT
11621 status open
11622
11623 \begin_layout Plain Layout
11624
11625
11626 \backslash
11627 begin{multicols}{2}
11628 \end_layout
11629
11630 \end_inset
11631
11632
11633 \end_layout
11634
11635 \begin_layout Itemize
11636
11637 \family sans
11638 Standard
11639 \end_layout
11640
11641 \begin_layout Itemize
11642
11643 \family sans
11644 Itemize
11645 \end_layout
11646
11647 \begin_layout Itemize
11648
11649 \family sans
11650 Enumerate
11651 \end_layout
11652
11653 \begin_layout Itemize
11654
11655 \family sans
11656 Description
11657 \end_layout
11658
11659 \begin_layout Itemize
11660
11661 \family sans
11662 List
11663 \end_layout
11664
11665 \begin_layout Itemize
11666
11667 \family sans
11668 LyX-Code
11669 \end_layout
11670
11671 \begin_layout Itemize
11672
11673 \family sans
11674 Verse
11675 \end_layout
11676
11677 \begin_layout Itemize
11678
11679 \family sans
11680 Quote
11681 \end_layout
11682
11683 \begin_layout Itemize
11684
11685 \family sans
11686 Quotation
11687 \end_layout
11688
11689 \begin_layout Itemize
11690
11691 \family sans
11692 Title
11693 \end_layout
11694
11695 \begin_layout Itemize
11696
11697 \family sans
11698 Author
11699 \end_layout
11700
11701 \begin_layout Itemize
11702
11703 \family sans
11704 Date
11705 \end_layout
11706
11707 \begin_layout Itemize
11708
11709 \family sans
11710 Abstract
11711 \end_layout
11712
11713 \begin_layout Itemize
11714
11715 \family sans
11716 Bibliography
11717 \end_layout
11718
11719 \begin_layout Itemize
11720
11721 \family sans
11722 Address
11723 \end_layout
11724
11725 \begin_layout Itemize
11726
11727 \family sans
11728 RightAddress
11729 \end_layout
11730
11731 \begin_layout Itemize
11732
11733 \family sans
11734 Caption
11735 \end_layout
11736
11737 \begin_layout Itemize
11738
11739 \family sans
11740 Comment
11741 \end_layout
11742
11743 \begin_layout Standard
11744 \begin_inset ERT
11745 status open
11746
11747 \begin_layout Plain Layout
11748
11749
11750 \backslash
11751 end{multicols}
11752 \end_layout
11753
11754 \end_inset
11755
11756
11757 \end_layout
11758
11759 \begin_layout Standard
11760 That is, all the major environments apart from the sectioning environments.
11761  Since foils are essentially self-contained sections, with a title and body,
11762  
11763 \family sans
11764 Foil
11765 \family default
11766 TeX provides specific commands for starting new foils and these are:
11767 \end_layout
11768
11769 \begin_layout Itemize
11770
11771 \family sans
11772 Foilhead
11773 \end_layout
11774
11775 \begin_layout Itemize
11776
11777 \family sans
11778 Rotatefoilhead
11779 \end_layout
11780
11781 \begin_layout Standard
11782 LyX also provides slightly modified versions of these two environments called:
11783 \end_layout
11784
11785 \begin_layout Itemize
11786
11787 \family sans
11788 ShortFoilhead
11789 \end_layout
11790
11791 \begin_layout Itemize
11792
11793 \family sans
11794 ShortRotatefoilhead
11795 \end_layout
11796
11797 \begin_layout Standard
11798 and the differences will be explained in the next section.
11799 \end_layout
11800
11801 \begin_layout Standard
11802 Since foils are often used in presenting ideas or new theorems and such
11803  
11804 \family sans
11805 Foil
11806 \family default
11807 TeX also provides a comprehensive box of goodies for presenting them:
11808 \end_layout
11809
11810 \begin_layout Standard
11811 \begin_inset ERT
11812 status open
11813
11814 \begin_layout Plain Layout
11815
11816
11817 \backslash
11818 begin{multicols}{2}
11819 \end_layout
11820
11821 \end_inset
11822
11823
11824 \end_layout
11825
11826 \begin_layout Itemize
11827
11828 \family sans
11829 Theorem
11830 \end_layout
11831
11832 \begin_layout Itemize
11833
11834 \family sans
11835 Lemma
11836 \end_layout
11837
11838 \begin_layout Itemize
11839
11840 \family sans
11841 Corollary
11842 \end_layout
11843
11844 \begin_layout Itemize
11845
11846 \family sans
11847 Proposition
11848 \end_layout
11849
11850 \begin_layout Itemize
11851
11852 \family sans
11853 Definition
11854 \end_layout
11855
11856 \begin_layout Itemize
11857
11858 \family sans
11859 Proof
11860 \end_layout
11861
11862 \begin_layout Itemize
11863
11864 \family sans
11865 Theorem*
11866 \end_layout
11867
11868 \begin_layout Itemize
11869
11870 \family sans
11871 Lemma*
11872 \end_layout
11873
11874 \begin_layout Itemize
11875
11876 \family sans
11877 Corollary*
11878 \end_layout
11879
11880 \begin_layout Itemize
11881
11882 \family sans
11883 Proposition*
11884 \end_layout
11885
11886 \begin_layout Itemize
11887
11888 \family sans
11889 Definition*
11890 \end_layout
11891
11892 \begin_layout Standard
11893 \begin_inset ERT
11894 status open
11895
11896 \begin_layout Plain Layout
11897
11898
11899 \backslash
11900 end{multicols}
11901 \end_layout
11902
11903 \end_inset
11904
11905
11906 \end_layout
11907
11908 \begin_layout Standard
11909 The starred versions are unnumbered while the unstarred versions are numbered.
11910  There are also two list environments added by LyX and these are:
11911 \end_layout
11912
11913 \begin_layout Itemize
11914
11915 \family sans
11916 TickList
11917 \end_layout
11918
11919 \begin_layout Itemize
11920
11921 \family sans
11922 CrossList
11923 \end_layout
11924
11925 \begin_layout Standard
11926
11927 \family sans
11928 Foil
11929 \family default
11930 TeX provides some powerful header and footer capabilities that are best
11931  set in the preamble although they may be set at any point in a document.
11932  If you want to change these settings in your document the best place to
11933  do so is at the very top of a foil, 
11934 \emph on
11935 i.e.
11936
11937 \emph default
11938  straight after the foilhead.
11939 \end_layout
11940
11941 \begin_layout Standard
11942 For this purpose, the following command styles are provided [
11943 \shape smallcaps
11944 Martin Vermeer
11945 \shape default
11946 ]:
11947 \end_layout
11948
11949 \begin_layout Standard
11950 \begin_inset ERT
11951 status open
11952
11953 \begin_layout Plain Layout
11954
11955
11956 \backslash
11957 begin{multicols}{2}
11958 \end_layout
11959
11960 \end_inset
11961
11962
11963 \end_layout
11964
11965 \begin_layout Itemize
11966
11967 \family sans
11968 My
11969 \begin_inset space ~
11970 \end_inset
11971
11972 Logo
11973 \end_layout
11974
11975 \begin_layout Itemize
11976
11977 \family sans
11978 Restriction
11979 \end_layout
11980
11981 \begin_layout Itemize
11982
11983 \family sans
11984 Right
11985 \begin_inset space ~
11986 \end_inset
11987
11988 Footer
11989 \end_layout
11990
11991 \begin_layout Itemize
11992
11993 \family sans
11994 Right
11995 \begin_inset space ~
11996 \end_inset
11997
11998 Header
11999 \end_layout
12000
12001 \begin_layout Itemize
12002
12003 \family sans
12004 Left
12005 \begin_inset space ~
12006 \end_inset
12007
12008 Header
12009 \end_layout
12010
12011 \begin_deeper
12012 \begin_layout Standard
12013 \begin_inset space ~
12014 \end_inset
12015
12016
12017 \end_layout
12018
12019 \end_deeper
12020 \begin_layout Standard
12021 \begin_inset ERT
12022 status open
12023
12024 \begin_layout Plain Layout
12025
12026
12027 \backslash
12028 end{multicols}
12029 \end_layout
12030
12031 \end_inset
12032
12033
12034 \end_layout
12035
12036 \begin_layout Standard
12037 There are also a few commands provided by 
12038 \family sans
12039 Foil
12040 \family default
12041 TeX that aren't directly supported by LyX but I'll tell you what they do
12042  and how to use them in section
12043 \begin_inset space ~
12044 \end_inset
12045
12046
12047 \begin_inset CommandInset ref
12048 LatexCommand ref
12049 reference "sec:unsuppfoils"
12050
12051 \end_inset
12052
12053 .
12054 \end_layout
12055
12056 \begin_layout Subsection
12057 Building a Set of Foils
12058 \end_layout
12059
12060 \begin_layout Standard
12061 This section will give a simple introduction to using the different environments
12062  to build a set of foils.
12063  If you want to see an example set of foils, take a look at the 
12064 \family typewriter
12065 Foils.lyx
12066 \family default
12067  file you find in LyX's 
12068 \family typewriter
12069 examples
12070 \family default
12071  folder.
12072 \end_layout
12073
12074 \begin_layout Subsubsection
12075 Give It a Title Page
12076 \end_layout
12077
12078 \begin_layout Standard
12079 Unlike other classes that provide 
12080 \family sans
12081 Title
12082 \family default
12083
12084 \family sans
12085 Author
12086 \family default
12087
12088 \family sans
12089 Date
12090 \family default
12091  and 
12092 \family sans
12093 Abstract
12094 \family default
12095  environments, 
12096 \family sans
12097 foils
12098 \family default
12099  creates the title on a page of its own.
12100  If you leave out the 
12101 \family sans
12102 Date
12103 \family default
12104  environment LaTeX will substitute the current date (every time you regenerate
12105  the output).
12106 \end_layout
12107
12108 \begin_layout Subsubsection
12109 Start a New Foil
12110 \end_layout
12111
12112 \begin_layout Standard
12113 As I mentioned earlier, there are four ways of starting a new foil.
12114  For portrait foils you should use 
12115 \family sans
12116 Foilhead
12117 \family default
12118  or 
12119 \family sans
12120 ShortFoilhead.
12121
12122 \family default
12123  The difference between these two environments is the amount of space between
12124  the title of the foil (the foilhead) and the body of the foil.
12125 \end_layout
12126
12127 \begin_layout Standard
12128 Landscape foils are generated using the 
12129 \family sans
12130 Rotatefoilhead
12131 \family default
12132  and 
12133 \family sans
12134 ShortRotatefoilhead
12135 \family default
12136  environments.
12137  Again the only difference is the spacing between foilhead and body.
12138  Both of the short versions have 0.5 inches less separation between the foilhead
12139  and the body.
12140  
12141 \end_layout
12142
12143 \begin_layout Standard
12144 One problem with the support for landscape foils is the requirement that
12145  you have to use the 
12146 \family typewriter
12147 dvips
12148 \family default
12149  driver to generate the PostScript output otherwise the foils won't be rotated.
12150  It is possible to get landscape foils even if you haven't got the 
12151 \family typewriter
12152 dvips
12153 \family default
12154  driver provided you can feed your foils sideways through your printer ;-)
12155 \end_layout
12156
12157 \begin_layout Subsubsection
12158 Theorems, Lemmas, Proofs and more
12159 \end_layout
12160
12161 \begin_layout Standard
12162 Due to a small bug in LyX you can't have two of the same type of these environme
12163 nts directly following each other.
12164  They must be separated by something.
12165  If you try, you will just be extending the previous environment as if you
12166  had merged the two environments together.
12167  So, how do you get around this problem? The simplest option is to insert
12168  some text between the two environments or add a 
12169 \family sans
12170 LaTeX
12171 \family default
12172  environment between the two with just a 
12173 \begin_inset Quotes eld
12174 \end_inset
12175
12176
12177 \family typewriter
12178 %
12179 \family default
12180
12181 \begin_inset Quotes erd
12182 \end_inset
12183
12184  in it.
12185  This will force LyX to produce two separate environments and hence the
12186  correct LaTeX output.
12187  An example is provided in the example file included with the LyX distribution.
12188  Remember, this problem only occurs if you are trying to place two of the
12189  same type of theorem-like environments one directly after the other.
12190 \end_layout
12191
12192 \begin_layout Subsubsection
12193 Lists
12194 \end_layout
12195
12196 \begin_layout Standard
12197 You get all the commonly supported list styles found in other classes as
12198  well as two new ones.
12199  I'll only describe the new ones here.
12200  If you want to find out more about the other list environments check out
12201  the 
12202 \emph on
12203 User's Guide.
12204
12205 \emph default
12206  If you intend to use itemized lists you might also want to read about the
12207  
12208 \family sans
12209 Itemize
12210 \begin_inset space ~
12211 \end_inset
12212
12213 Bullet
12214 \begin_inset space ~
12215 \end_inset
12216
12217 Selection
12218 \family default
12219  dialog described above in section
12220 \begin_inset space ~
12221 \end_inset
12222
12223
12224 \begin_inset CommandInset ref
12225 LatexCommand ref
12226 reference "sec:bullet"
12227
12228 \end_inset
12229
12230 .
12231 \end_layout
12232
12233 \begin_layout Standard
12234 The two new list styles, 
12235 \family sans
12236 TickList
12237 \family default
12238  and 
12239 \family sans
12240 CrossList
12241 \family default
12242 , are designed to make it easier for you to create lists of do's and don'ts
12243  or right and wrong by providing dedicated environments that use a tick
12244  or a cross as the label of the list.
12245  These lists are in fact dedicated variants of the 
12246 \family sans
12247 Itemize
12248 \family default
12249  environment.
12250  They do however require that you have the 
12251 \family typewriter
12252 psnfss
12253 \family default
12254  packages installed.
12255 \end_layout
12256
12257 \begin_layout Subsubsection
12258 Figures and Tables
12259 \end_layout
12260
12261 \begin_layout Standard
12262
12263 \family sans
12264 Foil
12265 \family default
12266 TeX redefines the floating tables and figures so that they appear exactly
12267  where they are in the text rather than pushing them to the top of the page
12268  or to some user specified location.
12269  In fact if you change the float placement settings they are simply ignored.
12270 \end_layout
12271
12272 \begin_layout Subsubsection
12273 Page Headers and Footers
12274 \begin_inset CommandInset label
12275 LatexCommand label
12276 name "sec:foilfoot"
12277
12278 \end_inset
12279
12280
12281 \end_layout
12282
12283 \begin_layout Standard
12284
12285 \family sans
12286 My
12287 \begin_inset space ~
12288 \end_inset
12289
12290 Logo
12291 \family default
12292  and 
12293 \family sans
12294 Restriction
12295 \family default
12296  are two commands used to control the left-footer text string.
12297  The first is meant to allow you to include a graphic logo on your foils
12298  and defaults to 
12299 \begin_inset Quotes eld
12300 \end_inset
12301
12302 -Typeset by 
12303 \family sans
12304 Foil
12305 \family default
12306 TeX-
12307 \begin_inset Quotes erd
12308 \end_inset
12309
12310 .
12311  While the second is meant to provide a classification for the audience,
12312  
12313 \emph on
12314 e.
12315 \begin_inset space \thinspace{}
12316 \end_inset
12317
12318 g.
12319 \emph default
12320
12321 \begin_inset space ~
12322 \end_inset
12323
12324 Confidential.
12325  It is empty by default.
12326 \end_layout
12327
12328 \begin_layout Standard
12329 The remaining page corners can be filled by 
12330 \family sans
12331 Right
12332 \begin_inset space ~
12333 \end_inset
12334
12335 Footer
12336 \family default
12337  (which defaults to page numbers), 
12338 \family sans
12339 Right
12340 \begin_inset space ~
12341 \end_inset
12342
12343 Header
12344 \family default
12345  (top right) and 
12346 \family sans
12347 Left
12348 \begin_inset space ~
12349 \end_inset
12350
12351 Header
12352 \family default
12353  (top left).
12354 \end_layout
12355
12356 \begin_layout Subsection
12357 Unsupported 
12358 \family sans
12359 Foil
12360 \family default
12361 TeX Goodies
12362 \begin_inset CommandInset label
12363 LatexCommand label
12364 name "sec:unsuppfoils"
12365
12366 \end_inset
12367
12368
12369 \end_layout
12370
12371 \begin_layout Standard
12372 All the commands mentioned below need to be set in a 
12373 \family sans
12374 LaTeX
12375 \family default
12376  environment or as 
12377 \family sans
12378 TeX
12379 \family default
12380  within another environment.
12381 \end_layout
12382
12383 \begin_layout Subsubsection
12384 Lengths
12385 \end_layout
12386
12387 \begin_layout Standard
12388 All lengths are adjusted using the 
12389 \family typewriter
12390
12391 \backslash
12392 setlength{
12393 \family default
12394 \emph on
12395 lengthname
12396 \family typewriter
12397 \emph default
12398 }{
12399 \family default
12400 \emph on
12401 newlength
12402 \family typewriter
12403 \emph default
12404 }
12405 \family default
12406  command.
12407  Where 
12408 \emph on
12409 lengthname
12410 \emph default
12411  should be replaced by the name given to the length you want to change and
12412  
12413 \emph on
12414 newlength
12415 \emph default
12416  is the length value.
12417  All lengths should be specified in units of length such as inches (
12418 \family typewriter
12419 in
12420 \family default
12421 ), millimeters (
12422 \family typewriter
12423 mm
12424 \family default
12425 ) or points (
12426 \family typewriter
12427 pt
12428 \family default
12429 ) or relative to some document or font-based length such as 
12430 \family typewriter
12431
12432 \backslash
12433 textwidth
12434 \family default
12435 .
12436  
12437 \end_layout
12438
12439 \begin_layout Standard
12440 It's possible to change the spacing between a foilhead and the body of the
12441  foil by adjusting the length specified by 
12442 \family typewriter
12443
12444 \backslash
12445 foilheadskip
12446 \family default
12447 .
12448  For example, to make 
12449 \emph on
12450 all
12451 \emph default
12452  foilheads 0.5 inches closer to their bodies put the following in the preamble:
12453  
12454 \family typewriter
12455
12456 \backslash
12457 setlength{
12458 \backslash
12459 foilheadskip}{-0.5in}
12460 \end_layout
12461
12462 \begin_layout Standard
12463 The spacings around floats can be adjusted by setting these lengths:
12464 \end_layout
12465
12466 \begin_layout Labeling
12467 \labelwidthstring MMMMMMMMMMM
12468
12469 \family typewriter
12470
12471 \backslash
12472 abovefloatskip
12473 \family default
12474  Separation between the text and the top of the float
12475 \end_layout
12476
12477 \begin_layout Labeling
12478 \labelwidthstring MMMMMMMMMMM
12479
12480 \family typewriter
12481
12482 \backslash
12483 abovecaptionskip
12484 \family default
12485  Separation between the float and the caption
12486 \end_layout
12487
12488 \begin_layout Labeling
12489 \labelwidthstring MMMMMMMMMMM
12490
12491 \family typewriter
12492
12493 \backslash
12494 belowcaptionskip
12495 \family default
12496  Separation between the caption and the following text
12497 \end_layout
12498
12499 \begin_layout Labeling
12500 \labelwidthstring MMMMMMMMMMM
12501
12502 \family typewriter
12503
12504 \backslash
12505 captionwidth
12506 \family default
12507  You can make the captions narrower than the surrounding text by adjusting
12508  this length.
12509  Best done relative to 
12510 \family typewriter
12511
12512 \backslash
12513 textwidth
12514 \family default
12515 .
12516 \end_layout
12517
12518 \begin_layout Standard
12519 There are also several title page related lengths that you may find useful
12520  if you have a long title or several authors:
12521 \end_layout
12522
12523 \begin_layout Labeling
12524 \labelwidthstring MMMMMMMMMMM
12525
12526 \family typewriter
12527
12528 \backslash
12529 abovetitleskip
12530 \family default
12531  Separation from headers to 
12532 \family sans
12533 Title
12534 \end_layout
12535
12536 \begin_layout Labeling
12537 \labelwidthstring MMMMMMMMMMM
12538
12539 \family typewriter
12540
12541 \backslash
12542 titleauthorskip
12543 \family default
12544  between 
12545 \family sans
12546 Title
12547 \family default
12548  and 
12549 \family sans
12550 Author
12551 \family default
12552  environments
12553 \end_layout
12554
12555 \begin_layout Labeling
12556 \labelwidthstring MMMMMMMMMMM
12557
12558 \family typewriter
12559
12560 \backslash
12561 authorauthorskip
12562 \family default
12563  between multiple 
12564 \family sans
12565 Author
12566 \family default
12567  lines
12568 \end_layout
12569
12570 \begin_layout Labeling
12571 \labelwidthstring MMMMMMMMMMM
12572
12573 \family typewriter
12574
12575 \backslash
12576 authordateskip
12577 \family default
12578  between the 
12579 \family sans
12580 Author
12581 \family default
12582  and the 
12583 \family sans
12584 Date
12585 \end_layout
12586
12587 \begin_layout Labeling
12588 \labelwidthstring MMMMMMMMMMM
12589
12590 \family typewriter
12591
12592 \backslash
12593 dateabstractskip
12594 \family default
12595  between the 
12596 \family sans
12597 Date
12598 \family default
12599  and the 
12600 \family sans
12601 Abstract
12602 \end_layout
12603
12604 \begin_layout Standard
12605 The last length related command affects all the list environments.
12606  If you place 
12607 \family typewriter
12608
12609 \backslash
12610 zerolistvertdimens
12611 \family default
12612  
12613 \emph on
12614 inside
12615 \emph default
12616  a list environment then all the vertical spacing between the list items
12617  is removed.
12618  Note that this is a command not a length so it doesn't require 
12619 \family typewriter
12620
12621 \backslash
12622 setlength
12623 \family default
12624  like the stuff mentioned above.
12625 \end_layout
12626
12627 \begin_layout Subsubsection
12628 Headers and Footers
12629 \end_layout
12630
12631 \begin_layout Standard
12632 The 
12633 \family typewriter
12634
12635 \backslash
12636 LogoOn
12637 \family default
12638  and 
12639 \family typewriter
12640
12641 \backslash
12642 LogoOff
12643 \family default
12644  commands control whether the logo in the 
12645 \family sans
12646 MyLogo
12647 \family default
12648  definition appear on a given page.
12649  If you put 
12650 \family typewriter
12651
12652 \backslash
12653 LogoOff
12654 \family default
12655  in the preamble then none of the foils will have the logo on them.
12656  If you don't want the logo on a particular page place the 
12657 \family typewriter
12658
12659 \backslash
12660 LogoOff
12661 \family default
12662  directly after the foilhead of that page and the 
12663 \family typewriter
12664
12665 \backslash
12666 LogoOn
12667 \family default
12668  directly after the next foilhead.
12669 \end_layout
12670
12671 \begin_layout Standard
12672 If you decide to use the 
12673 \family sans
12674 fancy
12675 \family default
12676  page style setting in the 
12677 \family sans
12678 Document
12679 \begin_inset space ~
12680 \end_inset
12681
12682 Layout
12683 \family default
12684  dialog you should probably add 
12685 \family typewriter
12686
12687 \backslash
12688 let
12689 \backslash
12690 headwidth
12691 \backslash
12692 textwidth
12693 \family default
12694  to your preamble so headers and footers on landscape pages are correctly
12695  placed when rotated.
12696  This is due to some clashes between the page layouts provided by the 
12697 \family sans
12698 fancyheadings
12699 \family default
12700  package and the 
12701 \family sans
12702 foils
12703 \family default
12704  class.
12705 \end_layout
12706
12707 \begin_layout Section
12708 Latex8 (IEEE Conference Papers)
12709 \end_layout
12710
12711 \begin_layout Standard
12712 by 
12713 \noun on
12714 Allan Rae
12715 \end_layout
12716
12717 \begin_layout Subsection
12718 Introduction
12719 \end_layout
12720
12721 \begin_layout Standard
12722 Since this class is specifically for writing submissions to IEEE sponsored
12723  conferences I strongly recommend that you get a copy of their Authors Kit.
12724  The 
12725 \family sans
12726 latex.sty
12727 \family default
12728  package and associated bibliography style file is included in the kit.
12729  The Authors Kit is usually sent out by email once your initial submission
12730  has been accepted.
12731  There is a lot of useful information in the Authors Kit explaining formatting
12732  restrictions and so on and I will assume you have read this since that
12733  means I don't have to repeat it all here.
12734 \end_layout
12735
12736 \begin_layout Subsection
12737 Getting Started
12738 \end_layout
12739
12740 \begin_layout Standard
12741 [AR\SpecialChar \@.
12742  more to come]
12743 \end_layout
12744
12745 \begin_layout Subsection
12746 Supported Environments
12747 \end_layout
12748
12749 \begin_layout Itemize
12750
12751 \family sans
12752 Standard
12753 \end_layout
12754
12755 \begin_layout Itemize
12756
12757 \family sans
12758 Title
12759 \end_layout
12760
12761 \begin_layout Itemize
12762
12763 \family sans
12764 Author
12765 \end_layout
12766
12767 \begin_layout Itemize
12768
12769 \family sans
12770 E-mail
12771 \end_layout
12772
12773 \begin_layout Itemize
12774
12775 \family sans
12776 Affiliation
12777 \end_layout
12778
12779 \begin_layout Itemize
12780
12781 \family sans
12782 Abstract
12783 \end_layout
12784
12785 \begin_layout Itemize
12786
12787 \family sans
12788 Section
12789 \end_layout
12790
12791 \begin_layout Itemize
12792
12793 \family sans
12794 SubSection
12795 \end_layout
12796
12797 \begin_layout Itemize
12798
12799 \family sans
12800 Caption
12801 \end_layout
12802
12803 \begin_layout Subsection
12804 Differences Between Screen and Paper
12805 \end_layout
12806
12807 \begin_layout Standard
12808 There are slight differences in appearance mainly with the presentation
12809  of section counters.
12810  On screen the trailing period of the section counter is missing but it
12811  will appear in the output so don't let this worry you.
12812 \end_layout
12813
12814 \begin_layout Section
12815 Hollywood (Hollywood spec scripts)
12816 \end_layout
12817
12818 \begin_layout Standard
12819 by 
12820 \shape smallcaps
12821 Garst Reese
12822 \end_layout
12823
12824 \begin_layout Subsection
12825 Introduction
12826 \end_layout
12827
12828 \begin_layout Standard
12829 Getting the format of a Hollywood script right is a 
12830 \begin_inset Quotes eld
12831 \end_inset
12832
12833 rite of passage.
12834 \begin_inset Quotes erd
12835 \end_inset
12836
12837  It is designed to make the readers focus on content and to be easy and
12838  familiar for the actors to read.
12839  Each page of a script should be one minute of film.
12840  Nothing goes in a script that you cannot see or hear on screen.
12841  The courier 12 pt font should be used throughout.
12842  No italics.
12843 \end_layout
12844
12845 \begin_layout Subsection
12846 Special problems
12847 \end_layout
12848
12849 \begin_layout Standard
12850 Speakers' lines should NEVER break in mid-sentence.
12851  If a speaker's lines continue over a page break, repeat the 
12852 \family sans
12853 Speaker
12854 \family default
12855  title followed by (Cont'd).
12856 \end_layout
12857
12858 \begin_layout Subsection
12859 Special features
12860 \end_layout
12861
12862 \begin_layout Standard
12863 Insert the 
12864 \family sans
12865 Speaker
12866 \family default
12867  names as labels then cross-reference the label to insert the name.
12868  The cross-reference dialog will show the current cast of characters.
12869  You can use this to insert the speaker name in narratives also.
12870 \end_layout
12871
12872 \begin_layout Subsection
12873 Paper size and Margins
12874 \end_layout
12875
12876 \begin_layout Standard
12877 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12878 \end_layout
12879
12880 \begin_layout Subsection
12881 Environments
12882 \end_layout
12883
12884 \begin_layout Standard
12885 The following environments are available.
12886  You can use hollywood.bind to get the bind keys shown at the right.
12887 \end_layout
12888
12889 \begin_layout Itemize
12890
12891 \family sans
12892 Standard
12893 \begin_inset Newline newline
12894 \end_inset
12895
12896
12897 \family default
12898 Used where nothing else works.
12899  Try to avoid it.
12900 \end_layout
12901
12902 \begin_layout Itemize
12903
12904 \family sans
12905 FADE_IN
12906 \family default
12907 :
12908 \begin_inset space \hfill{}
12909 \end_inset
12910
12911
12912 \family sans
12913 M-z S-I
12914 \family default
12915
12916 \begin_inset Newline newline
12917 \end_inset
12918
12919 Usually followed by something like 
12920 \begin_inset Quotes eld
12921 \end_inset
12922
12923 on Sally waking up.
12924 \begin_inset Quotes erd
12925 \end_inset
12926
12927
12928 \end_layout
12929
12930 \begin_layout Itemize
12931
12932 \family sans
12933 INT:
12934 \begin_inset space \hfill{}
12935 \end_inset
12936
12937 M-z i
12938 \begin_inset Newline newline
12939 \end_inset
12940
12941
12942 \family default
12943 Introduces a new INTERIOR camera set-up.
12944  Always followed by DAY or NIGHT, or something similar to define the lighting
12945  required.
12946  Everthing on this line in CAPS.
12947 \end_layout
12948
12949 \begin_layout Itemize
12950
12951 \family sans
12952 EXT:
12953 \begin_inset space \hfill{}
12954 \end_inset
12955
12956 M-z e
12957 \begin_inset Newline newline
12958 \end_inset
12959
12960
12961 \family default
12962 Introduces a new EXTERIOR camera set-up.
12963  Everthing on this line in CAPS.
12964 \end_layout
12965
12966 \begin_layout Itemize
12967
12968 \family sans
12969 Speaker
12970 \begin_inset space \hfill{}
12971 \end_inset
12972
12973 M-z s
12974 \begin_inset Newline newline
12975 \end_inset
12976
12977
12978 \family default
12979 The character speaking.
12980 \end_layout
12981
12982 \begin_layout Itemize
12983
12984 \family sans
12985 Parenthetical
12986 \begin_inset space \hfill{}
12987 \end_inset
12988
12989 M-z p
12990 \begin_inset Newline newline
12991 \end_inset
12992
12993
12994 \family default
12995 Instructions to the speaker.
12996  The () are automatically inserted, but only the ( will show in LyX.
12997  Both will be printed.
12998 \end_layout
12999
13000 \begin_layout Itemize
13001
13002 \family sans
13003 Dialogue
13004 \begin_inset space \hfill{}
13005 \end_inset
13006
13007 M-z d
13008 \begin_inset Newline newline
13009 \end_inset
13010
13011
13012 \family default
13013 What the 
13014 \family sans
13015 Speaker
13016 \family default
13017  says.
13018 \end_layout
13019
13020 \begin_layout Itemize
13021
13022 \family sans
13023 Transition
13024 \begin_inset space \hfill{}
13025 \end_inset
13026
13027 M-z t
13028 \begin_inset Newline newline
13029 \end_inset
13030
13031
13032 \family default
13033 Camera movement instruction.
13034  e.
13035 \begin_inset space \thinspace{}
13036 \end_inset
13037
13038 g.
13039 \begin_inset space ~
13040 \end_inset
13041
13042 CUT TO:
13043 \end_layout
13044
13045 \begin_layout Itemize
13046
13047 \family sans
13048 FADE OUT:
13049 \begin_inset space \hfill{}
13050 \end_inset
13051
13052 M-z S-I
13053 \end_layout
13054
13055 \begin_layout Itemize
13056
13057 \family sans
13058 Author
13059 \begin_inset space \hfill{}
13060 \end_inset
13061
13062 M-z S-A
13063 \end_layout
13064
13065 \begin_layout Itemize
13066
13067 \family sans
13068 Title
13069 \begin_inset space \hfill{}
13070 \end_inset
13071
13072 M-z S-T
13073 \end_layout
13074
13075 \begin_layout Itemize
13076
13077 \family sans
13078 Right_Address
13079 \begin_inset space \hfill{}
13080 \end_inset
13081
13082 M-z r
13083 \end_layout
13084
13085 \begin_layout Subsection
13086 Script jargon
13087 \end_layout
13088
13089 \begin_layout Itemize
13090 (O.S) --- off screen
13091 \end_layout
13092
13093 \begin_layout Itemize
13094 (V.0) --- voice over
13095 \end_layout
13096
13097 \begin_layout Itemize
13098 b.g.
13099  --- background
13100 \end_layout
13101
13102 \begin_layout Itemize
13103 C.U.
13104  --- close-up
13105 \end_layout
13106
13107 \begin_layout Itemize
13108 PAN --- camera movement
13109 \end_layout
13110
13111 \begin_layout Itemize
13112 INSERT --- cut to close-up of
13113 \end_layout
13114
13115 \begin_layout Section
13116 Broadway
13117 \end_layout
13118
13119 \begin_layout Standard
13120 by 
13121 \shape smallcaps
13122 Garst Reese
13123 \end_layout
13124
13125 \begin_layout Subsection
13126 Introduction
13127 \end_layout
13128
13129 \begin_layout Standard
13130 Broadway is for writing plays.
13131  The format is more decorative than Hollywood, and much less standardized.
13132  This format should be suitable for workshops.
13133 \end_layout
13134
13135 \begin_layout Subsection
13136 Special problems
13137 \end_layout
13138
13139 \begin_layout Standard
13140 The same as in Hollywood.
13141 \end_layout
13142
13143 \begin_layout Subsection
13144 Special features
13145 \end_layout
13146
13147 \begin_layout Standard
13148 Insert the 
13149 \family sans
13150 Speaker
13151 \family default
13152  names as labels then cross-reference the label to insert the name.
13153  The cross-reference dialog will show the current cast of characters.
13154 \end_layout
13155
13156 \begin_layout Subsection
13157 Paper size and Margins
13158 \end_layout
13159
13160 \begin_layout Standard
13161 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13162 \end_layout
13163
13164 \begin_layout Subsection
13165 Environments
13166 \end_layout
13167
13168 \begin_layout Standard
13169 The following environments are available.
13170  You can use broadway.bind to get the bind keys shown at the right.
13171 \end_layout
13172
13173 \begin_layout Itemize
13174
13175 \family sans
13176 Standard
13177 \begin_inset Newline newline
13178 \end_inset
13179
13180
13181 \family default
13182 You should not have to use this, but it is here for anything that does not
13183  fit otherwise.
13184 \end_layout
13185
13186 \begin_layout Itemize
13187
13188 \family sans
13189 Narrative
13190 \begin_inset space \hfill{}
13191 \end_inset
13192
13193 M-z n
13194 \begin_inset Newline newline
13195 \end_inset
13196
13197
13198 \family default
13199 Used to describe stage setting and the action.
13200  First use of speaker names in all CAPs.
13201 \end_layout
13202
13203 \begin_layout Itemize
13204
13205 \family sans
13206 ACT
13207 \begin_inset space \hfill{}
13208 \end_inset
13209
13210 M-z a
13211 \begin_inset Newline newline
13212 \end_inset
13213
13214
13215 \family default
13216 Automatically numbered.
13217  On screen it will be arabic, but will print as Roman.
13218 \end_layout
13219
13220 \begin_layout Itemize
13221
13222 \family sans
13223 ACT*
13224 \begin_inset space \hfill{}
13225 \end_inset
13226
13227 M-z S at
13228 \begin_inset Newline newline
13229 \end_inset
13230
13231
13232 \family default
13233 Subtitle for 
13234 \family sans
13235 ACT.
13236
13237 \family default
13238  It is just centered text.
13239 \end_layout
13240
13241 \begin_layout Itemize
13242
13243 \family sans
13244 SCENE
13245 \begin_inset space \hfill{}
13246 \end_inset
13247
13248 M-z S-S
13249 \begin_inset Newline newline
13250 \end_inset
13251
13252
13253 \family default
13254 Not automatically numbered.
13255  You supply the number.
13256  This is because I couldn't figure out how.
13257 \end_layout
13258
13259 \begin_layout Itemize
13260
13261 \family sans
13262 AT_RISE:
13263 \begin_inset space \hfill{}
13264 \end_inset
13265
13266 M-z S-R
13267 \begin_inset Newline newline
13268 \end_inset
13269
13270
13271 \family default
13272 A special case of Narrative to describe the setting and action as the curtain
13273  rises.
13274 \end_layout
13275
13276 \begin_layout Itemize
13277
13278 \family sans
13279 Speaker
13280 \begin_inset space \hfill{}
13281 \end_inset
13282
13283 M-z s
13284 \begin_inset Newline newline
13285 \end_inset
13286
13287
13288 \family default
13289 The speaker's (actor's) title, centered in all CAPS.
13290 \end_layout
13291
13292 \begin_layout Itemize
13293
13294 \family sans
13295 Parenthetical
13296 \begin_inset space \hfill{}
13297 \end_inset
13298
13299 M-z p
13300 \begin_inset Newline newline
13301 \end_inset
13302
13303
13304 \family default
13305 Instructions to the speaker.
13306  The parentheses are automatically inserted.
13307  The ( will appear on screen, but both will be in the printed play.
13308  This environment is only used within 
13309 \family sans
13310 Dialogue
13311 \family default
13312 .
13313 \end_layout
13314
13315 \begin_layout Itemize
13316
13317 \family sans
13318 Dialogue
13319 \begin_inset space \hfill{}
13320 \end_inset
13321
13322 M-z d
13323 \begin_inset Newline newline
13324 \end_inset
13325
13326
13327 \family default
13328 What the Speaker says.
13329 \end_layout
13330
13331 \begin_layout Itemize
13332
13333 \family sans
13334 CURTAIN
13335 \begin_inset space \hfill{}
13336 \end_inset
13337
13338 M-z S-C
13339 \begin_inset Newline newline
13340 \end_inset
13341
13342
13343 \family default
13344 The curtain comes down.
13345 \end_layout
13346
13347 \begin_layout Itemize
13348
13349 \family sans
13350 Title
13351 \begin_inset space \hfill{}
13352 \end_inset
13353
13354 M-z S-T
13355 \end_layout
13356
13357 \begin_layout Itemize
13358
13359 \family sans
13360 Author
13361 \begin_inset space \hfill{}
13362 \end_inset
13363
13364 M-z S-A
13365 \end_layout
13366
13367 \begin_layout Itemize
13368
13369 \family sans
13370 Right_Address
13371 \begin_inset space \hfill{}
13372 \end_inset
13373
13374 M-z r
13375 \end_layout
13376
13377 \begin_layout Standard
13378 Hello there.
13379 \end_layout
13380
13381 \begin_layout Section
13382 RevTeX4
13383 \end_layout
13384
13385 \begin_layout Standard
13386 by 
13387 \noun on
13388 Amir Karger
13389 \end_layout
13390
13391 \begin_layout Standard
13392 \begin_inset VSpace bigskip
13393 \end_inset
13394
13395
13396 \end_layout
13397
13398 \begin_layout Standard
13399 \noindent
13400 The 
13401 \family sans
13402 Revtex
13403 \begin_inset space ~
13404 \end_inset
13405
13406 4
13407 \family default
13408  textclass works with the American Physical Sociey's RevTeX 4.0 (the 
13409 \begin_inset Formula $\beta$
13410 \end_inset
13411
13412  release of May, 1999) class.
13413 \end_layout
13414
13415 \begin_layout Standard
13416 LyX has a 
13417 \family sans
13418 Revtex
13419 \family default
13420  textclass, which works with RevTeX 3.1.
13421  However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
13422  That means that it doesn't interact very well with LyX, which requires
13423  LaTeX2e, although it has been kludged to work.
13424  Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
13425  LyX with the 
13426 \family sans
13427 RevTeX
13428 \begin_inset space ~
13429 \end_inset
13430
13431 4
13432 \family default
13433  textclass should also be pretty easy to use.
13434 \end_layout
13435
13436 \begin_layout Standard
13437 These documents are supposed to be used in 
13438 \emph on
13439 addition
13440 \emph default
13441  to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
13442  macros, and assume you'll know what to put in the preamble if necessary.
13443 \end_layout
13444
13445 \begin_layout Subsection
13446 Installation
13447 \end_layout
13448
13449 \begin_layout Standard
13450 All you need to do is install RevTeX 4, as described in the package's README
13451  file.
13452  The package can be found at The RevTeX 4 Web Site 
13453 \begin_inset Flex URL
13454 status collapsed
13455
13456 \begin_layout Plain Layout
13457
13458 http://publish.aps.org/revtex4/
13459 \end_layout
13460
13461 \end_inset
13462
13463 .
13464  Install it somewhere that LaTeX can see it.
13465  Test it by trying to LaTeX a short RevTeX 4 document in some random directory
13466  (i.e., not the directory where you installed the class file.) Then, if you
13467  reconfigure LyX, it will find the class file and let you use the RevTeX4
13468  textclass.
13469 \end_layout
13470
13471 \begin_layout Standard
13472 Probably the easiest way to get started is either to import a RevTeX 4 document
13473  using 
13474 \family typewriter
13475 tex2lyx
13476 \family default
13477 , or to use the 
13478 \family sans
13479 Revtex
13480 \begin_inset space ~
13481 \end_inset
13482
13483 4
13484 \family default
13485  template, found in the templates directory.
13486 \end_layout
13487
13488 \begin_layout Subsection
13489 Preamble Matter
13490 \end_layout
13491
13492 \begin_layout Standard
13493 Optional arguments to 
13494 \family typewriter
13495
13496 \backslash
13497 documentclass
13498 \family default
13499 , like 
13500 \begin_inset Quotes eld
13501 \end_inset
13502
13503 preprint
13504 \begin_inset Quotes erd
13505 \end_inset
13506
13507  and 
13508 \begin_inset Quotes eld
13509 \end_inset
13510
13511 aps
13512 \begin_inset Quotes erd
13513 \end_inset
13514
13515 , go in the 
13516 \family sans
13517 E
13518 \bar under
13519 x
13520 \bar default
13521 tra
13522 \begin_inset space ~
13523 \end_inset
13524
13525 Options
13526 \family default
13527  field in the 
13528 \family sans
13529 Document
13530 \begin_inset space ~
13531 \end_inset
13532
13533 Layout
13534 \family default
13535  dialog, as usual.
13536  Remember that in RevTeX, at least one optional argument is required! 
13537 \end_layout
13538
13539 \begin_layout Standard
13540 Other preamble matter, like 
13541 \family typewriter
13542
13543 \backslash
13544 draft
13545 \family default
13546  etc.
13547 \begin_inset space ~
13548 \end_inset
13549
13550 goes in the 
13551 \family sans
13552 La
13553 \family default
13554 T
13555 \family sans
13556 eX
13557 \begin_inset space ~
13558 \end_inset
13559
13560 Preamble
13561 \family default
13562  dialog, also as usual.
13563 \end_layout
13564
13565 \begin_layout Subsection
13566 Layouts
13567 \end_layout
13568
13569 \begin_layout Standard
13570 The layouts basically correspond to the commands in RevTeX4.0.
13571  For example, the Email layout corresponds to 
13572 \family typewriter
13573
13574 \backslash
13575 email{}
13576 \family default
13577 .
13578  Note that (at least as of RevTeX 4.0 Beta), the 
13579 \family sans
13580 Address
13581 \family default
13582  and 
13583 \family sans
13584 Affiliation
13585 \family default
13586  layouts are exactly equivalent, so you shouldn't need to use both.
13587 \begin_inset Foot
13588 status collapsed
13589
13590 \begin_layout Plain Layout
13591 In case you're curious, both were included so that 
13592 \family typewriter
13593 tex2lyx
13594 \family default
13595  would be able to translate both 
13596 \family typewriter
13597
13598 \backslash
13599 address
13600 \family default
13601  and 
13602 \family typewriter
13603
13604 \backslash
13605 affiliation
13606 \family default
13607 .
13608 \end_layout
13609
13610 \end_inset
13611
13612
13613 \end_layout
13614
13615 \begin_layout Subsection
13616 Important Notes
13617 \end_layout
13618
13619 \begin_layout Standard
13620 There are a couple of important unique aspects of RevTeX 4 which might cause
13621  bugs that will be even more confusing in LyX.
13622 \end_layout
13623
13624 \begin_layout Standard
13625 In RevTeX, the 
13626 \family typewriter
13627
13628 \backslash
13629 thanks
13630 \family default
13631  command goes 
13632 \emph on
13633 outside
13634 \emph default
13635  the 
13636 \family typewriter
13637
13638 \backslash
13639 author
13640 \family default
13641  command.
13642  The LyX equivalent is that there is a separate Thanks layout.
13643  Do 
13644 \emph on
13645 not
13646 \emph default
13647  write footnotes in the 
13648 \family sans
13649 Author
13650 \family default
13651  layout, or weird things may happen.
13652  See the RevTeX 4 documentation for more details.
13653 \end_layout
13654
13655 \begin_layout Standard
13656 Also, the 
13657 \family sans
13658 Author
13659 \begin_inset space ~
13660 \end_inset
13661
13662 Email
13663 \family default
13664
13665 \family sans
13666 Author
13667 \begin_inset space ~
13668 \end_inset
13669
13670 URL
13671 \family default
13672 , and 
13673 \family sans
13674 Thanks
13675 \family default
13676  layouts must be placed 
13677 \emph on
13678 in between
13679 \emph default
13680  the 
13681 \family sans
13682 Author
13683 \family default
13684  layout and the corresponding 
13685 \family sans
13686 Address
13687 \family default
13688  (or equivalent 
13689 \family sans
13690 Affiliation
13691 \family default
13692 ) layout.
13693  If you put the 
13694 \family sans
13695 Thanks
13696 \family default
13697  after the 
13698 \family sans
13699 Address
13700 \family default
13701 , the LaTeX won't compile.
13702 \end_layout
13703
13704 \begin_layout Subsection
13705 Drawbacks
13706 \end_layout
13707
13708 \begin_layout Standard
13709 The main problem with this layout is that you can't use the optional arguments
13710  to layouts like Email and Title.
13711  (The problem is not unique to this layout; you can't use optional arguments
13712  to the Section layouts either.) This means that after you export that file
13713  to LaTeX (which you'll need to do eventually to send it in to APS), you'll
13714  need to edit the LaTeX file with a text editor to add the optional arguments
13715  to set, e.
13716 \begin_inset space \thinspace{}
13717 \end_inset
13718
13719 g., the running title for the page headers.
13720  Lacking these layouts makes the 
13721 \family typewriter
13722
13723 \backslash
13724 altaffiliation
13725 \family default
13726  (and the equivalent 
13727 \family typewriter
13728
13729 \backslash
13730 altaddress
13731 \family default
13732 ) useless, so the corresponding layouts don't exist, and will have to be
13733  added by hand.
13734 \begin_inset Foot
13735 status collapsed
13736
13737 \begin_layout Plain Layout
13738
13739 \emph on
13740 Note from JMarc:
13741 \emph default
13742  actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
13743  has not been updated yet to take advantage of it.
13744 \end_layout
13745
13746 \end_inset
13747
13748  
13749 \end_layout
13750
13751 \begin_layout Section
13752 Article (mwart), book (mwbk) and report (mwrep)
13753 \begin_inset OptArg
13754 status collapsed
13755
13756 \begin_layout Plain Layout
13757 The 
13758 \family typewriter
13759 mw
13760 \family default
13761  Classes
13762 \end_layout
13763
13764 \end_inset
13765
13766
13767 \end_layout
13768
13769 \begin_layout Standard
13770 by 
13771 \noun on
13772 Tomasz Luczak
13773 \end_layout
13774
13775 \begin_layout Standard
13776 The LyX document classes 
13777 \emph on
13778 article (mwart)
13779 \emph default
13780
13781 \emph on
13782 report (mwrep)
13783 \emph default
13784  and 
13785 \emph on
13786 book
13787 \emph default
13788  
13789 \emph on
13790 (mwbk)
13791 \emph default
13792  correspond to the LaTeX document classes 
13793 \family typewriter
13794 mwart.cls
13795 \family default
13796
13797 \family typewriter
13798 mwrep.cls
13799 \family default
13800  and 
13801 \family typewriter
13802 mwbk.cls
13803 \family default
13804 , resp.
13805  They are replacements for the standard document classes 
13806 \family typewriter
13807 article.cls
13808 \family default
13809
13810 \family typewriter
13811 report.cls
13812 \family default
13813  and 
13814 \family typewriter
13815 book.cls
13816 \family default
13817 , resp., and fit better to Polish typography conventions in a number of points.
13818  
13819 \end_layout
13820
13821 \begin_layout Standard
13822 Basic differences:
13823 \end_layout
13824
13825 \begin_layout Itemize
13826 Unnumbered titles (with star, eg.
13827  
13828 \family sans
13829 Section*
13830 \family default
13831 ) are added into table of contents,
13832 \end_layout
13833
13834 \begin_layout Itemize
13835 Additional page styles:
13836 \end_layout
13837
13838 \begin_deeper
13839 \begin_layout Description
13840 uheadings header with separated lines,
13841 \end_layout
13842
13843 \begin_layout Description
13844 myheadings custom header, contents headers via commands: 
13845 \family typewriter
13846
13847 \backslash
13848 markright
13849 \family default
13850  and 
13851 \family typewriter
13852
13853 \backslash
13854 markboth
13855 \family default
13856 ,
13857 \end_layout
13858
13859 \begin_layout Description
13860 myuheadings custom header with separated lines,
13861 \end_layout
13862
13863 \begin_layout Description
13864 outer page number is placed on outer side of page
13865 \end_layout
13866
13867 \end_deeper
13868 \begin_layout Itemize
13869 Options 
13870 \end_layout
13871
13872 \begin_deeper
13873 \begin_layout Description
13874 rmheadings serif titles --- default,
13875 \end_layout
13876
13877 \begin_layout Description
13878 sfheadings sansserif titles,
13879 \end_layout
13880
13881 \begin_layout Description
13882 authortitle on title page first placed is author next title --- default,
13883 \end_layout
13884
13885 \begin_layout Description
13886 titleauthor on title page first placed is title next author,
13887 \end_layout
13888
13889 \begin_layout Description
13890 withmarginpar reserve place on page for margins.
13891 \end_layout
13892
13893 \end_deeper
13894 \begin_layout Section
13895 Elsevier Journals
13896 \end_layout
13897
13898 \begin_layout Standard
13899 By 
13900 \noun on
13901 Rod Pinna
13902 \end_layout
13903
13904 \begin_layout Standard
13905 Elsevier Science Publishers B.V.
13906  provides a standard LaTeX document class (
13907 \family typewriter
13908 elsart.cls
13909 \family default
13910 ) for submitting articles to their various journals.
13911  The style file can be downloaded directly from their web site: 
13912 \begin_inset Flex URL
13913 status collapsed
13914
13915 \begin_layout Plain Layout
13916
13917 http://authors.elsevier.com/
13918 \end_layout
13919
13920 \end_inset
13921
13922 .
13923  Instructions are supplied along with the class file, which details the
13924  requirements of the publishers.
13925  LyX includes package that allows for the use of this class, by a layout
13926  and a template file.
13927  Installation of the class file is the same as for any other LaTeX package;
13928  instructions are provided in the Elsevier documentation.
13929 \end_layout
13930
13931 \begin_layout Standard
13932 To make use of 
13933 \family typewriter
13934 elsart.cls
13935 \family default
13936 , a file 
13937 \family typewriter
13938 elsart.layout
13939 \family default
13940  is supplied.
13941  As the Elsevier class file is based mainly on the standard article class,
13942  most of the normal functionality is provided.
13943  The Elsevier class defines a number of mathematical environments, which
13944  are similar to the AMS environments.
13945  These commands are all described in the Elsevier documentation, and are
13946  available in LyX.
13947 \end_layout
13948
13949 \begin_layout Standard
13950 The easiest way to use the Elsevier style is to base documents on the included
13951  template file.
13952  It is best not to use options such as fancy headings or the geometry package,
13953  as elements such as these are defined by Elsevier in their style file.
13954  Ideally, no extra packages except those mentioned in the Elsevier documentation
13955  should be used.
13956  Essentially, Elsevier require as 
13957 \begin_inset Quotes eld
13958 \end_inset
13959
13960 clean
13961 \begin_inset Quotes erd
13962 \end_inset
13963
13964  a LaTeX file as possible, as their intention is to take the supplied file
13965  and replace the class file with one for the particular journal to which
13966  the paper has been submitted.
13967  This also means that not too much time should be spent on the formating
13968  of the document.
13969  When it comes to be published, this will change anyway.
13970  The rest of the usage for this layout is substantially the same as for
13971  the normal article class.
13972  For details of what Elsevier do and don't allow, refer to their documentation.
13973 \end_layout
13974
13975 \begin_layout Section
13976 Memoir
13977 \end_layout
13978
13979 \begin_layout Standard
13980 By 
13981 \noun on
13982 Jürgen Spitzmüller
13983 \end_layout
13984
13985 \begin_layout Subsection
13986 Overview
13987 \end_layout
13988
13989 \begin_layout Standard
13990 Memoir is a very powerful and constantly evolving class.
13991  It has been designed with regard to fictional and non-fictional literature.
13992  Its aim is to let the user have maximum control over the typesetting of
13993  his document.
13994  Memoir is based on the standard book class, but it can also emulate the
13995  article class (see below).
13996 \end_layout
13997
13998 \begin_layout Standard
13999 Peter Wilson, the developer of Memoir, is known as the author of lots of
14000  useful packages in the LaTeX world.
14001  Most of them have been merged with Memoir.
14002  Therefore, it is much easier to layout the table of contents, appendices,
14003  chapter designs and such.
14004  LyX, though, does not support all of these goodies natively.
14005  Some of them might be added to forthcoming releases
14006 \begin_inset Foot
14007 status collapsed
14008
14009 \begin_layout Plain Layout
14010 You are invited to send suggestions to 
14011 \begin_inset Flex URL
14012 status collapsed
14013
14014 \begin_layout Plain Layout
14015
14016 lyx-devel@lists.lyx.org
14017 \end_layout
14018
14019 \end_inset
14020
14021 .
14022 \end_layout
14023
14024 \end_inset
14025
14026 , lots will probably never, due to the limitations of LyX's framework.
14027  Of course you can still use all features with the help of some native LaTeX
14028  commands (ERT
14029 \begin_inset Foot
14030 status collapsed
14031
14032 \begin_layout Plain Layout
14033 Cf.
14034 \begin_inset ERT
14035 status collapsed
14036
14037 \begin_layout Plain Layout
14038
14039
14040 \backslash
14041  
14042 \end_layout
14043
14044 \end_inset
14045
14046 section
14047 \begin_inset space ~
14048 \end_inset
14049
14050
14051 \begin_inset CommandInset ref
14052 LatexCommand ref
14053 reference "sec:Inserting-TeX-Code"
14054
14055 \end_inset
14056
14057  for details.
14058 \end_layout
14059
14060 \end_inset
14061
14062 ).
14063  In this section, we can only list those features which are natively supported
14064  by LyX.
14065  For detailed descriptions (and for the rest of features) we are recommending
14066  to have a look at the detailed manual of the Memoir class
14067 \begin_inset Foot
14068 status collapsed
14069
14070 \begin_layout Plain Layout
14071 Cf.
14072 \begin_inset ERT
14073 status collapsed
14074
14075 \begin_layout Plain Layout
14076
14077
14078 \backslash
14079  
14080 \end_layout
14081
14082 \end_inset
14083
14084
14085 \begin_inset Flex URL
14086 status collapsed
14087
14088 \begin_layout Plain Layout
14089
14090 CTAN:/macros/latex/memoir/memman.pdf
14091 \end_layout
14092
14093 \end_inset
14094
14095 .
14096 \end_layout
14097
14098 \end_inset
14099
14100 , which is not only a user guide for the class, but also both a comprehensive
14101  description on good typesetting and a superb example for good typesetting
14102  itself.
14103 \end_layout
14104
14105 \begin_layout Subsection
14106 Basic features and restrictions
14107 \end_layout
14108
14109 \begin_layout Standard
14110 Memoir supports basically all features of the standard book classes.
14111  There are, however, some differences, as follows:
14112 \end_layout
14113
14114 \begin_layout Description
14115 Font
14116 \begin_inset space ~
14117 \end_inset
14118
14119 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
14120 \end_layout
14121
14122 \begin_layout Description
14123 Page
14124 \begin_inset space ~
14125 \end_inset
14126
14127 style: The fancy page style is not supported, due to a command clash between
14128  Memoir and the fancyhdr package (they are both defining a command with
14129  the same name, which confuses LaTeX).
14130  Instead, Memoir comes with a bunch of own page styles (see 
14131 \family sans
14132 Layout\SpecialChar \menuseparator
14133 Document\SpecialChar \menuseparator
14134 Page
14135 \begin_inset space ~
14136 \end_inset
14137
14138 Style
14139 \family default
14140 ).
14141  If you want to use these for the chapter pages, you have to use the command
14142  
14143 \family typewriter
14144
14145 \backslash
14146 chapterstyle
14147 \family default
14148  in the main text or in preamble (e.
14149 \begin_inset space \thinspace{}
14150 \end_inset
14151
14152 g.
14153 \begin_inset space ~
14154 \end_inset
14155
14156
14157 \family typewriter
14158
14159 \backslash
14160 chapterstyle{companion}
14161 \family default
14162 ).
14163 \end_layout
14164
14165 \begin_layout Description
14166 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
14167  an optional argument in the standard classes.
14168  With this, you can specify an alternative version of the title for the
14169  table of contents and the headers (for instance, if the title is too long).
14170  In LyX, you can do this via 
14171 \family sans
14172 Insert\SpecialChar \menuseparator
14173 Short
14174 \begin_inset space ~
14175 \end_inset
14176
14177 Title
14178 \family default
14179  at the beginning of a chapter/section.
14180  Memoir features a second optional argument and thus separates the table
14181  of contents from the header.
14182  You can define three variants of a title with this: one for the main text,
14183  one for the table of contents, and one for the headers.
14184  Simply insert two optional arguments if you need this feature, the first
14185  one containing the short title for the Table of Contents, the second one
14186  containing an alternative short title for the headers.
14187 \end_layout
14188
14189 \begin_layout Description
14190 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
14191  of contents, the list of figures and the list of table start a new page
14192  automatically.
14193  Memoir does not follow this route.
14194  You have to insert a page break yourself, if you want to have one.
14195 \end_layout
14196
14197 \begin_layout Description
14198 Titlepage: For some unknown reason, Memoir uses pagination on the title
14199  page (in the standard classes, title pages are 
14200 \begin_inset Quotes eld
14201 \end_inset
14202
14203 empty
14204 \begin_inset Quotes erd
14205 \end_inset
14206
14207 , i
14208 \begin_inset space \thinspace{}
14209 \end_inset
14210
14211 e.
14212 \begin_inset space ~
14213 \end_inset
14214
14215 without pagina).
14216  If you want an empty title page, type 
14217 \family typewriter
14218
14219 \backslash
14220 aliaspagestyle{title}{empty}
14221 \family default
14222  in the preamble.
14223 \end_layout
14224
14225 \begin_layout Description
14226 Article: With the class option 
14227 \emph on
14228 article
14229 \emph default
14230  (to be inserted in 
14231 \family sans
14232 Layout\SpecialChar \menuseparator
14233 Document\SpecialChar \menuseparator
14234 Extra
14235 \begin_inset space ~
14236 \end_inset
14237
14238 Options
14239 \family default
14240 ), you can emulate article style.
14241  That is, counters (footnotes, figures, tables etc.) will not be reset on
14242  new chapters, chapters don't start a new page (but are---in contrary to
14243  
14244 \begin_inset Quotes eld
14245 \end_inset
14246
14247 real
14248 \begin_inset Quotes erd
14249 \end_inset
14250
14251  article classes---still allowed), parts, though, use their own page, as
14252  in book.
14253 \end_layout
14254
14255 \begin_layout Description
14256 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
14257  font commands, which have been used in the old LaTeX version 2.09 (e.
14258 \begin_inset space \thinspace{}
14259 \end_inset
14260
14261 g.
14262 \begin_inset space ~
14263 \end_inset
14264
14265
14266 \family typewriter
14267
14268 \backslash
14269 rm
14270 \family default
14271
14272 \family typewriter
14273
14274 \backslash
14275 it
14276 \family default
14277 ).
14278  It produces an error and stops LaTeX whenever such a command appears.
14279  The class option 
14280 \emph on
14281 oldfontcommands
14282 \emph default
14283  reallows the commands and spits out warnings instead (which does at least
14284  not stop LaTeX).
14285  Since a lot of packages and particularly BibTeX style files are still using
14286  those commands, we have decided to use this option by default.
14287 \end_layout
14288
14289 \begin_layout Subsection
14290 Extra features
14291 \end_layout
14292
14293 \begin_layout Standard
14294 We will only describe the features supported by LyX (which is not much currently
14295 ).
14296  Please consult the Memoir manual
14297 \begin_inset Foot
14298 status collapsed
14299
14300 \begin_layout Plain Layout
14301 Cf.
14302 \begin_inset ERT
14303 status collapsed
14304
14305 \begin_layout Plain Layout
14306
14307
14308 \backslash
14309  
14310 \end_layout
14311
14312 \end_inset
14313
14314
14315 \begin_inset Flex URL
14316 status collapsed
14317
14318 \begin_layout Plain Layout
14319
14320 CTAN:/macros/latex/memoir/memman.pdf
14321 \end_layout
14322
14323 \end_inset
14324
14325 .
14326 \end_layout
14327
14328 \end_inset
14329
14330  for details.
14331 \end_layout
14332
14333 \begin_layout Description
14334 Abstract: You may wonder why an abstract is an extra feature.
14335  Well, it is in book class.
14336  Usually books don't have abstracts.
14337  Memoir, however, has.
14338  You can use it wherever and how often you like.
14339 \end_layout
14340
14341 \begin_layout Description
14342 Chapterprecis: You may know this from belletristic: The contents of a chapter
14343  is shortly described below the title and also in the table of contents
14344  (e.
14345 \begin_inset space \thinspace{}
14346 \end_inset
14347
14348 g.
14349 \begin_inset space ~
14350 \end_inset
14351
14352
14353 \emph on
14354 Our hero arrives in Troia; he loses some friends; he finds others
14355 \emph default
14356 ).
14357  Chapterprecis does exactly this.
14358  It is therefore only sensible below a chapter.
14359 \end_layout
14360
14361 \begin_layout Description
14362 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
14363  The epigraph environment provides an elegant way of typesetting such a
14364  motto.
14365  The motto itself (text) and its author (source) are divided by a short
14366  line.
14367  Unfortunately, we have to fool LyX a bit here again, since the environment
14368  needs two arguments (text and source).
14369  In this case, we have to use curly brackets (in TeX mode) between the two
14370  arguments: 
14371 \emph on
14372 <smart slogan>
14373 \emph default
14374  
14375 \family typewriter
14376 }{
14377 \family default
14378  
14379 \emph on
14380 <author of the slogan>.
14381 \end_layout
14382
14383 \begin_layout Description
14384 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
14385  complex figurative poems).
14386  LyX can only support a few of them.
14387  One is poemtitle, which is a centered title for poems, which will also
14388  be added to the table of contents (verse is the standard environment for
14389  poems.
14390  Memoir has some enhanced versions of verse, but you need to use ERT, because
14391  they have to be nested inside regular verse environments, which is not
14392  possible with LyX).
14393 \end_layout
14394
14395 \begin_layout Description
14396 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
14397 \end_layout
14398
14399 \begin_layout Chapter
14400 LyX Features needing Extra Software
14401 \end_layout
14402
14403 \begin_layout Section
14404 Checking TeX
14405 \end_layout
14406
14407 \begin_layout Standard
14408 by 
14409 \noun on
14410 Asger Alstrup
14411 \end_layout
14412
14413 \begin_layout Subsection
14414 Introduction
14415 \end_layout
14416
14417 \begin_layout Standard
14418 When you to have the 
14419 \family typewriter
14420 chktex
14421 \family default
14422  program installed, you'll find in the 
14423 \family sans
14424 Tools
14425 \family default
14426  menu the entry 
14427 \family sans
14428 Check
14429 \begin_inset space ~
14430 \end_inset
14431
14432 TeX
14433 \family default
14434  command.
14435  You can get 
14436 \family typewriter
14437 chktex
14438 \family default
14439  it from CTAN, 
14440 \begin_inset CommandInset href
14441 LatexCommand href
14442 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
14443
14444 \end_inset
14445
14446 .
14447 \end_layout
14448
14449 \begin_layout Standard
14450 The 
14451 \family sans
14452 ChkTeX
14453 \family default
14454  package is a program that was written by 
14455 \noun on
14456 Jens T.
14457  Berger Thielemann
14458 \noun default
14459  in frustration because some constructs in LaTeX are sometimes non-intuitive,
14460  and easy to forget.
14461  The program runs over your LaTeX file and checks the integrity of the file,
14462  and flags some common errors.
14463  In other technical words, it is 
14464 \family typewriter
14465 Lint
14466 \family default
14467  for LaTeX.
14468 \end_layout
14469
14470 \begin_layout Standard
14471 Well, what is a syntax checker doing in LyX which is supposed to produce
14472  correct LaTeX anyways? The answer is simple: Just as 
14473 \family typewriter
14474 Lint
14475 \family default
14476  not only checks the 
14477 \emph on
14478 syntax
14479 \emph default
14480  of C programs, but also does 
14481 \emph on
14482 semantic
14483 \emph default
14484  checks for type-errors, 
14485 \family sans
14486 ChkTeX
14487 \family default
14488  catches some common 
14489 \emph on
14490 typographic
14491 \emph default
14492  errors, in addition to the syntactical ones.
14493  Specifically, 
14494 \family sans
14495 ChkTeX
14496 \family default
14497  is capable of detecting several common errors, such as
14498 \end_layout
14499
14500 \begin_layout Itemize
14501 Ellipsis detection:
14502 \begin_inset Newline newline
14503 \end_inset
14504
14505 Use \SpecialChar \ldots{}
14506  instead of ...
14507 \end_layout
14508
14509 \begin_layout Itemize
14510 No space in front of/after parenthesis:
14511 \begin_inset Newline newline
14512 \end_inset
14513
14514 ( wrong spacing )
14515 \end_layout
14516
14517 \begin_layout Itemize
14518 Enforcement of normal space after common abbreviations:
14519 \begin_inset Newline newline
14520 \end_inset
14521
14522 e.
14523  g.
14524  is too wide spacing.
14525 \end_layout
14526
14527 \begin_layout Itemize
14528 Enforcement of end-of-sentence space when the last sentence ends with a
14529  capital letter:
14530 \begin_inset Newline newline
14531 \end_inset
14532
14533 This is a TEST.
14534  And this is wrong spacing.
14535 \end_layout
14536
14537 \begin_layout Itemize
14538 Space in front of labels and similar commands:
14539 \begin_inset Newline newline
14540 \end_inset
14541
14542 The label should stick right up to the text to avoid falling to a wrong
14543  page.
14544  
14545 \begin_inset CommandInset label
14546 LatexCommand label
14547 name "sec:chktex"
14548
14549 \end_inset
14550
14551  
14552 \begin_inset Foot
14553 status collapsed
14554
14555 \begin_layout Plain Layout
14556 This footnote is in danger of falling off to a wrong page
14557 \end_layout
14558
14559 \end_inset
14560
14561  The label is separated too much.
14562 \end_layout
14563
14564 \begin_layout Itemize
14565 Space in front of references, instead of hard spaces:
14566 \begin_inset Newline newline
14567 \end_inset
14568
14569 In you are in bad luck, the text will break right between the referenced
14570  text and reference number, and that's a pity.
14571  See section 
14572 \begin_inset CommandInset ref
14573 LatexCommand ref
14574 reference "sec:chktex"
14575
14576 \end_inset
14577
14578 .
14579 \end_layout
14580
14581 \begin_layout Itemize
14582 Use of 
14583 \begin_inset Quotes eld
14584 \end_inset
14585
14586 x
14587 \begin_inset Quotes erd
14588 \end_inset
14589
14590  instead of 
14591 \begin_inset Formula $\times$
14592 \end_inset
14593
14594  between numbers:
14595 \begin_inset Newline newline
14596 \end_inset
14597
14598 2x2 looks cheap compared to 
14599 \begin_inset Formula $2\times2$
14600 \end_inset
14601
14602 .
14603 \end_layout
14604
14605 \begin_layout Standard
14606 and more \SpecialChar \ldots{}
14607  It is an invaluable tool when you are 
14608 \begin_inset Quotes eld
14609 \end_inset
14610
14611 finishing up
14612 \begin_inset Quotes erd
14613 \end_inset
14614
14615  your document before printing, and you should run it right after the obligatory
14616  spelling check, and before you go fine tuning the typesetting.
14617 \end_layout
14618
14619 \begin_layout Subsection
14620 How to use it
14621 \end_layout
14622
14623 \begin_layout Standard
14624 If you have the program installed, usage is as simple as choosing 
14625 \family sans
14626 \bar under
14627 T
14628 \bar default
14629 ools\SpecialChar \menuseparator
14630
14631 \bar under
14632 C
14633 \bar default
14634 heck
14635 \begin_inset space ~
14636 \end_inset
14637
14638 TeX
14639 \family default
14640 .
14641  This will make LyX generate a LaTeX file of your document, start 
14642 \family sans
14643 ChkTeX
14644 \family default
14645  to check it, and then make LyX insert 
14646 \begin_inset Quotes eld
14647 \end_inset
14648
14649 error boxes
14650 \begin_inset Quotes erd
14651 \end_inset
14652
14653  with the warnings from 
14654 \family sans
14655 ChkTeX
14656 \family default
14657 , if there were any.
14658  The warnings will be placed close to the point of the mistake, and you
14659  can quickly find them by using the 
14660 \family sans
14661 \bar under
14662 N
14663 \bar default
14664 avigate\SpecialChar \menuseparator
14665
14666 \bar under
14667 E
14668 \bar default
14669 rror
14670 \family default
14671  menu item, or the shortcut key 
14672 \family sans
14673 C-g
14674 \family default
14675  from the default 
14676 \family typewriter
14677 cua
14678 \family default
14679  bind file.
14680  Open the error boxes by clicking on them with the mouse, or use the shortcut
14681  key 
14682 \family sans
14683 C-i
14684 \family default
14685  from 
14686 \family typewriter
14687 cua
14688 \family default
14689  bindings, or the corresponding 
14690 \family sans
14691 C-o
14692 \family default
14693  for the alternate 
14694 \family typewriter
14695 emacs
14696 \family default
14697  bind file.
14698  Read the warning and correct the mistake, if it is a mistake.
14699  If you have trouble understanding what the warning is about, you can safely
14700  ignore it.
14701  Remember that there is a hidden layer between the document on screen and
14702  the technical details in invoking 
14703 \family sans
14704 ChkTeX
14705 \family default
14706 , and this gap can make some warnings seem arcane or just right down plain
14707  silly.
14708 \end_layout
14709
14710 \begin_layout Standard
14711 This document is an excellent testing bed for the feature, and it should
14712  provide quite a few warnings for you to fiddle with.
14713  Since computers are only so smart, expect most of the warnings to be false
14714  alarms, though.
14715 \end_layout
14716
14717 \begin_layout Subsection
14718 How to fine tune it
14719 \end_layout
14720
14721 \begin_layout Standard
14722 Sometimes, you'll find that 
14723 \family sans
14724 ChkTeX
14725 \family default
14726  makes more noise than suits your mood.
14727  Then you can choose not to use it, wait until your mood changes, or try
14728  to customize 
14729 \family sans
14730 ChkTeX
14731 \family default
14732  to get better along with you.
14733  Another choice in the most desperate situations is to use 
14734 \family sans
14735 \bar under
14736 V
14737 \bar default
14738 iew\SpecialChar \menuseparator
14739
14740 \bar under
14741 R
14742 \bar default
14743 emove
14744 \begin_inset space ~
14745 \end_inset
14746
14747 All
14748 \begin_inset space ~
14749 \end_inset
14750
14751 Error
14752 \begin_inset space ~
14753 \end_inset
14754
14755 Boxes
14756 \family default
14757 , which will get rid of all warnings instantly.
14758 \end_layout
14759
14760 \begin_layout Standard
14761 Although 
14762 \family sans
14763 ChkTeX
14764 \family default
14765  
14766 \emph on
14767 is
14768 \emph default
14769  very configurable and extensible, you shouldn't expect to solve all problems
14770  with 
14771 \family sans
14772 ChkTeX
14773 \family default
14774  in LyX this way.
14775  Since LyX has to generate a somewhat special LaTeX file to be able to match
14776  the line numbers from the 
14777 \family sans
14778 ChkTeX
14779 \family default
14780  output
14781 \begin_inset Foot
14782 status collapsed
14783
14784 \begin_layout Plain Layout
14785 You can inspect the specific output from 
14786 \family sans
14787 chktex
14788 \family default
14789  by using 
14790 \family sans
14791 Edit\SpecialChar \menuseparator
14792 View
14793 \begin_inset space ~
14794 \end_inset
14795
14796 LaTeX
14797 \begin_inset space ~
14798 \end_inset
14799
14800 Log
14801 \family default
14802  right after a 
14803 \family sans
14804 chktex
14805 \family default
14806  run.
14807 \end_layout
14808
14809 \end_inset
14810
14811  to the internal document structure, some of the warnings will not seen
14812  to appear correctly.
14813  There are two things you can do about this:
14814 \end_layout
14815
14816 \begin_layout Itemize
14817 Fine tune the 
14818 \family sans
14819 ChkTeX
14820 \family default
14821  invocation command line in 
14822 \family sans
14823 Preferences
14824 \family default
14825  (tabs 
14826 \family sans
14827 Outputs
14828 \family default
14829
14830 \family sans
14831 Misc
14832 \family default
14833 ), or the global 
14834 \family sans
14835 ChkTeX
14836 \family default
14837  installation configuration file (usually with the file 
14838 \family typewriter
14839 chktexrc
14840 \family default
14841 ).
14842  See below to learn what warnings can be enabled and disabled on the command
14843  line.
14844  
14845 \end_layout
14846
14847 \begin_layout Itemize
14848 Export your document as a raw LaTeX file using 
14849 \family sans
14850 \bar under
14851 F
14852 \bar default
14853 ile\SpecialChar \menuseparator
14854
14855 \bar under
14856 E
14857 \bar default
14858 xport\SpecialChar \menuseparator
14859
14860 \bar under
14861 L
14862 \bar default
14863 aTeX
14864 \family default
14865  and run 
14866 \family typewriter
14867 chktex
14868 \family default
14869  manually on that.
14870  Invoked in this way, it can be a hassle to find the corresponding place
14871  in the document inside LyX, but with a little patience, you should be able
14872  to do it.
14873 \end_layout
14874
14875 \begin_layout Standard
14876 Here follows the warning messages that can be enabled and disabled in 
14877 \family sans
14878 Preferences
14879 \family default
14880 .
14881  Use 
14882 \family typewriter
14883 -n#
14884 \family default
14885  to disable a warning, and 
14886 \family typewriter
14887 -w#
14888 \family default
14889  to enable a warning.
14890  The emphasized entries are disabled by default, because the default is
14891  "
14892 \family typewriter
14893 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
14894 \family default
14895 ".
14896 \end_layout
14897
14898 \begin_layout Standard
14899 Notice that you should only use the options that enable and disable warnings,
14900  because LyX relies on some of the other command line parameters to be set
14901  in a specific way to have a chance to communicate with 
14902 \family typewriter
14903 chktex
14904 \family default
14905 .
14906 \end_layout
14907
14908 \begin_layout Enumerate
14909
14910 \size small
14911 \emph on
14912 Command terminated with space.
14913 \end_layout
14914
14915 \begin_layout Enumerate
14916
14917 \size small
14918 Non-breaking space (
14919 \begin_inset Quotes eld
14920 \end_inset
14921
14922
14923 \family typewriter
14924 ~
14925 \family default
14926
14927 \begin_inset Quotes erd
14928 \end_inset
14929
14930 ) should have been used.
14931 \end_layout
14932
14933 \begin_layout Enumerate
14934
14935 \size small
14936 \emph on
14937 You should enclose the previous parenthesis with 
14938 \begin_inset Quotes eld
14939 \end_inset
14940
14941
14942 \family typewriter
14943 {}
14944 \family default
14945
14946 \begin_inset Quotes erd
14947 \end_inset
14948
14949 .
14950 \end_layout
14951
14952 \begin_layout Enumerate
14953
14954 \size small
14955 Italic correction (
14956 \begin_inset Quotes eld
14957 \end_inset
14958
14959
14960 \family typewriter
14961
14962 \backslash
14963 /
14964 \family default
14965
14966 \begin_inset Quotes erd
14967 \end_inset
14968
14969 ) found in non-italic buffer.
14970 \end_layout
14971
14972 \begin_layout Enumerate
14973
14974 \size small
14975 Italic correction (
14976 \begin_inset Quotes eld
14977 \end_inset
14978
14979
14980 \family typewriter
14981
14982 \backslash
14983 /
14984 \family default
14985
14986 \begin_inset Quotes erd
14987 \end_inset
14988
14989 ) found more than once.
14990 \end_layout
14991
14992 \begin_layout Enumerate
14993
14994 \size small
14995 \emph on
14996 No italic correction (
14997 \begin_inset Quotes eld
14998 \end_inset
14999
15000
15001 \family typewriter
15002
15003 \backslash
15004 /
15005 \family default
15006
15007 \begin_inset Quotes erd
15008 \end_inset
15009
15010 ) found.
15011 \end_layout
15012
15013 \begin_layout Enumerate
15014
15015 \size small
15016 Accent command 
15017 \begin_inset Quotes eld
15018 \end_inset
15019
15020
15021 \family typewriter
15022 cmd
15023 \family default
15024
15025 \begin_inset Quotes erd
15026 \end_inset
15027
15028  needs use of 
15029 \begin_inset Quotes eld
15030 \end_inset
15031
15032
15033 \family typewriter
15034 cmd
15035 \family default
15036
15037 \begin_inset Quotes erd
15038 \end_inset
15039
15040 .
15041 \end_layout
15042
15043 \begin_layout Enumerate
15044
15045 \size small
15046 Wrong length of dash may have been used.
15047 \end_layout
15048
15049 \begin_layout Enumerate
15050
15051 \size small
15052 \emph on
15053 \begin_inset Quotes eld
15054 \end_inset
15055
15056
15057 \family typewriter
15058 %s
15059 \family default
15060
15061 \begin_inset Quotes erd
15062 \end_inset
15063
15064  expected, found 
15065 \begin_inset Quotes eld
15066 \end_inset
15067
15068
15069 \family typewriter
15070 %s
15071 \family default
15072
15073 \begin_inset Quotes erd
15074 \end_inset
15075
15076 .
15077 \end_layout
15078
15079 \begin_layout Enumerate
15080
15081 \size small
15082 Solo 
15083 \begin_inset Quotes eld
15084 \end_inset
15085
15086
15087 \family typewriter
15088 %s
15089 \family default
15090
15091 \begin_inset Quotes erd
15092 \end_inset
15093
15094  found.
15095 \end_layout
15096
15097 \begin_layout Enumerate
15098
15099 \size small
15100 You should use 
15101 \begin_inset Quotes eld
15102 \end_inset
15103
15104
15105 \family typewriter
15106 %s
15107 \family default
15108
15109 \begin_inset Quotes erd
15110 \end_inset
15111
15112  to achieve an ellipsis.
15113 \end_layout
15114
15115 \begin_layout Enumerate
15116
15117 \size small
15118 Inter-word spacing (
15119 \begin_inset Quotes eld
15120 \end_inset
15121
15122
15123 \family typewriter
15124
15125 \backslash
15126
15127 \family default
15128  
15129 \begin_inset Quotes eld
15130 \end_inset
15131
15132 ) should perhaps be used.
15133 \end_layout
15134
15135 \begin_layout Enumerate
15136
15137 \size small
15138 Inter-sentence spacing (
15139 \begin_inset Quotes eld
15140 \end_inset
15141
15142
15143 \family typewriter
15144
15145 \backslash
15146 @
15147 \family default
15148
15149 \begin_inset Quotes erd
15150 \end_inset
15151
15152 ) should perhaps be used.
15153 \end_layout
15154
15155 \begin_layout Enumerate
15156
15157 \size small
15158 Could not find argument for command.
15159 \end_layout
15160
15161 \begin_layout Enumerate
15162
15163 \size small
15164 No match found for 
15165 \begin_inset Quotes eld
15166 \end_inset
15167
15168
15169 \family typewriter
15170 %s
15171 \family default
15172
15173 \begin_inset Quotes erd
15174 \end_inset
15175
15176 .
15177 \end_layout
15178
15179 \begin_layout Enumerate
15180
15181 \size small
15182 Math mode still on at end of LaTeX file.
15183 \end_layout
15184
15185 \begin_layout Enumerate
15186
15187 \size small
15188 Number of 
15189 \begin_inset Quotes eld
15190 \end_inset
15191
15192
15193 \family typewriter
15194 char
15195 \family default
15196
15197 \begin_inset Quotes erd
15198 \end_inset
15199
15200  doesn't match the number of 
15201 \begin_inset Quotes eld
15202 \end_inset
15203
15204
15205 \family typewriter
15206 char
15207 \family default
15208
15209 \begin_inset Quotes erd
15210 \end_inset
15211
15212 .
15213 \end_layout
15214
15215 \begin_layout Enumerate
15216
15217 \size small
15218 You should use either 
15219 \family typewriter
15220
15221 \begin_inset Quotes eld
15222 \end_inset
15223
15224
15225 \family default
15226  or 
15227 \family typewriter
15228
15229 \begin_inset Quotes erd
15230 \end_inset
15231
15232
15233 \family default
15234  as an alternative to 
15235 \begin_inset Quotes eld
15236 \end_inset
15237
15238
15239 \family typewriter
15240 "
15241 \family default
15242
15243 \begin_inset Quotes erd
15244 \end_inset
15245
15246 .
15247 \end_layout
15248
15249 \begin_layout Enumerate
15250
15251 \size small
15252 You should use "
15253 \family typewriter
15254 '
15255 \family default
15256 " (ASCII 39) instead of "
15257 \family typewriter
15258 ´
15259 \family default
15260 " (ASCII 180).
15261 \end_layout
15262
15263 \begin_layout Enumerate
15264
15265 \size small
15266 User-specified pattern found.
15267 \end_layout
15268
15269 \begin_layout Enumerate
15270
15271 \size small
15272 This command might not be intended.
15273 \end_layout
15274
15275 \begin_layout Enumerate
15276
15277 \size small
15278 \emph on
15279 Comment displayed.
15280 \end_layout
15281
15282 \begin_layout Enumerate
15283
15284 \size small
15285 Either 
15286 \family typewriter
15287 ''
15288 \backslash
15289 ,'
15290 \family default
15291  or 
15292 \family typewriter
15293 '
15294 \backslash
15295 ,''
15296 \family default
15297  will look better.
15298 \end_layout
15299
15300 \begin_layout Enumerate
15301
15302 \size small
15303 Delete this space to maintain correct page references.
15304 \end_layout
15305
15306 \begin_layout Enumerate
15307
15308 \size small
15309 \emph on
15310 You might wish to put this between a pair of 
15311 \begin_inset Quotes eld
15312 \end_inset
15313
15314
15315 \family typewriter
15316 {}
15317 \family default
15318
15319 \begin_inset Quotes erd
15320 \end_inset
15321
15322 .
15323 \end_layout
15324
15325 \begin_layout Enumerate
15326
15327 \size small
15328 You ought to remove spaces in front of punctuation.
15329 \end_layout
15330
15331 \begin_layout Enumerate
15332
15333 \size small
15334 Could not execute LaTeX command.
15335 \end_layout
15336
15337 \begin_layout Enumerate
15338
15339 \size small
15340 Don't use 
15341 \family typewriter
15342
15343 \backslash
15344 /
15345 \family default
15346  in front of small punctuation.
15347 \end_layout
15348
15349 \begin_layout Enumerate
15350
15351 \family typewriter
15352 \size small
15353 $
15354 \backslash
15355 times$
15356 \family default
15357  may look prettier here.
15358 \end_layout
15359
15360 \begin_layout Enumerate
15361
15362 \size small
15363 \emph on
15364 Multiple spaces detected in output.
15365 \end_layout
15366
15367 \begin_layout Enumerate
15368
15369 \size small
15370 This text may be ignored.
15371 \end_layout
15372
15373 \begin_layout Enumerate
15374
15375 \size small
15376 Use 
15377 \family typewriter
15378
15379 \begin_inset Quotes eld
15380 \end_inset
15381
15382
15383 \family default
15384  to begin quotation, not 
15385 \family typewriter
15386 '
15387 \family default
15388 .
15389 \end_layout
15390
15391 \begin_layout Enumerate
15392
15393 \size small
15394 Use 
15395 \family typewriter
15396 '
15397 \family default
15398  to end quotation, not 
15399 \family typewriter
15400
15401 \begin_inset Quotes eld
15402 \end_inset
15403
15404
15405 \family default
15406 .
15407 \end_layout
15408
15409 \begin_layout Enumerate
15410
15411 \size small
15412 Don't mix quotes.
15413 \end_layout
15414
15415 \begin_layout Enumerate
15416
15417 \size small
15418 You should perhaps use 
15419 \begin_inset Quotes eld
15420 \end_inset
15421
15422
15423 \family typewriter
15424 cmd
15425 \family default
15426
15427 \begin_inset Quotes erd
15428 \end_inset
15429
15430  instead.
15431 \end_layout
15432
15433 \begin_layout Enumerate
15434
15435 \size small
15436 You should put a space in front of/after parenthesis.
15437 \end_layout
15438
15439 \begin_layout Enumerate
15440
15441 \size small
15442 You should avoid spaces in front of/after parenthesis.
15443 \end_layout
15444
15445 \begin_layout Enumerate
15446
15447 \size small
15448 \emph on
15449 You should not use punctuation in front of/after quotes.
15450 \end_layout
15451
15452 \begin_layout Enumerate
15453
15454 \size small
15455 Double space found.
15456 \end_layout
15457
15458 \begin_layout Enumerate
15459
15460 \size small
15461 You should put punctuation outside inner/inside display math mode.
15462 \end_layout
15463
15464 \begin_layout Enumerate
15465
15466 \size small
15467 You ought to not use primitive TeX in LaTeX code.
15468 \end_layout
15469
15470 \begin_layout Enumerate
15471
15472 \size small
15473 You should remove spaces in front of 
15474 \begin_inset Quotes eld
15475 \end_inset
15476
15477
15478 \family typewriter
15479 %s
15480 \family default
15481
15482 \begin_inset Quotes erd
15483 \end_inset
15484
15485
15486 \end_layout
15487
15488 \begin_layout Enumerate
15489
15490 \size small
15491 \begin_inset Quotes eld
15492 \end_inset
15493
15494
15495 \family typewriter
15496 %s
15497 \family default
15498
15499 \begin_inset Quotes erd
15500 \end_inset
15501
15502  is normally not followed by 
15503 \begin_inset Quotes eld
15504 \end_inset
15505
15506
15507 \family typewriter
15508 %c
15509 \family default
15510
15511 \begin_inset Quotes erd
15512 \end_inset
15513
15514 .
15515 \end_layout
15516
15517 \begin_layout Standard
15518 In later versions of LyX, we hope to provide a more complete interface to
15519  this tool (and it's smaller cousin 
15520 \family typewriter
15521 lacheck
15522 \family default
15523 ) to exploit the full power of it.
15524  But it's not exactly useless as it is now: go try it on one of your existing
15525  documents of a certain length and be surprised.
15526 \end_layout
15527
15528 \begin_layout Section
15529 Version Control in LyX
15530 \end_layout
15531
15532 \begin_layout Standard
15533 by
15534 \noun on
15535  Lars Gullik Bjønnes, 
15536 \noun default
15537 updated by 
15538 \noun on
15539 Pavel Sanda
15540 \end_layout
15541
15542 \begin_layout Subsection
15543 Introduction
15544 \end_layout
15545
15546 \begin_layout Standard
15547 A friend of mine wanted to try LyX for a group project.
15548  When he didn't find support for version control or file locking, he dropped
15549  it.
15550  This angered me a bit, so I thought that I should at least make support
15551  for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
15552  This has now been done.
15553  LyX now supports some of the most basic RCS commands.
15554  If you need to something a bit more sophisticated you will have to do that
15555  manually in an xterm.
15556 \end_layout
15557
15558 \begin_layout Standard
15559 Before you begin to use the version control features in LyX, you should
15560  read 
15561 \begin_inset Quotes eld
15562 \end_inset
15563
15564 rcsintro
15565 \begin_inset Quotes erd
15566 \end_inset
15567
15568  (a man file, read it with 
15569 \family typewriter
15570 man rcsintro
15571 \family default
15572 ).
15573  This file describes all the basic features of RCS.
15574  You should especially notice the comment about a RCS directory, and the
15575  notion of a master RCS file (the file ending in 
15576 \family typewriter
15577 ,v
15578 \family default
15579 ).
15580 \end_layout
15581
15582 \begin_layout Standard
15583 Later basic CVS/SVN support was added.
15584  You should be familiar with CVS/SVN usage before start using it under LyX.
15585  Most of the log messages are not currently displayed after operations -
15586  you can check them in terminal window if unsure.
15587 \end_layout
15588
15589 \begin_layout Standard
15590 The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
15591  package---no guarantees are made for older versions.
15592 \end_layout
15593
15594 \begin_layout Subsection
15595 RCS commands in LyX
15596 \end_layout
15597
15598 \begin_layout Standard
15599 The following sections describe the RCS commands supported by LyX.
15600  You can find them in the 
15601 \family sans
15602 \bar under
15603 F
15604 \bar default
15605 ile\SpecialChar \menuseparator
15606
15607 \bar under
15608 V
15609 \bar default
15610 ersion
15611 \begin_inset space ~
15612 \end_inset
15613
15614 Control
15615 \family default
15616  submenu.
15617 \end_layout
15618
15619 \begin_layout Subsubsection
15620
15621 \family sans
15622 Register
15623 \end_layout
15624
15625 \begin_layout Standard
15626 If your document is not under revision control, this is the only item shown
15627  in the menu.
15628  And if it is under revision control, the 
15629 \family sans
15630 \bar under
15631 R
15632 \bar default
15633 egister
15634 \family default
15635  item is not visible.
15636  
15637 \end_layout
15638
15639 \begin_layout Standard
15640 This command registers your document with RCS (unless you are under the
15641  directory managed by CVS)\SpecialChar \@.
15642  You are asked interactively to supply an initial
15643  description of the document.
15644  The document is now set in Read-Only mode and you have to 
15645 \family sans
15646 Check
15647 \begin_inset space ~
15648 \end_inset
15649
15650 Out
15651 \begin_inset space ~
15652 \end_inset
15653
15654 For
15655 \begin_inset space ~
15656 \end_inset
15657
15658 Edit
15659 \family default
15660 , before making any changes to it.
15661  A document under revision control has a 
15662 \begin_inset Quotes eld
15663 \end_inset
15664
15665 [RCS:<version> <locker>]
15666 \begin_inset Quotes erd
15667 \end_inset
15668
15669  item tagged to the filename in the minibuffer.
15670 \end_layout
15671
15672 \begin_layout Standard
15673 RCS command that is run: 
15674 \family typewriter
15675 ci -q -u -i -t-"<initial description>" <file-name>
15676 \end_layout
15677
15678 \begin_layout Standard
15679 Read 
15680 \family typewriter
15681 man ci
15682 \family default
15683  to understand the switches.
15684  
15685 \end_layout
15686
15687 \begin_layout Subsubsection
15688
15689 \family sans
15690 Check In Changes
15691 \end_layout
15692
15693 \begin_layout Standard
15694 When you are finished editing a file, you check in your changes.
15695  When you do this, you are asked for a description of the changes.
15696  This is stored in the history log.
15697  The version number is bumped, your changes are applied to the master RCS
15698  file, the document is unlocked and set to Read-Only mode.
15699  
15700 \end_layout
15701
15702 \begin_layout Standard
15703 RCS command: 
15704 \family typewriter
15705 ci -q -u -m"<description>" <file-name>
15706 \end_layout
15707
15708 \begin_layout Subsubsection
15709
15710 \family sans
15711 Check Out For Edit
15712 \end_layout
15713
15714 \begin_layout Standard
15715 By doing this you lock the document so that only you can edit it.
15716  This will also make the document Read-Write only for you.
15717  You will usually continue editing for a while and when you are finished
15718  you check in your changes.
15719  The status line is changed to reflect that you have locked the file.
15720  
15721 \end_layout
15722
15723 \begin_layout Standard
15724 RCS command: 
15725 \family typewriter
15726 co -q -l <file-name>
15727 \end_layout
15728
15729 \begin_layout Subsubsection
15730
15731 \family sans
15732 Revert To Repository Version
15733 \end_layout
15734
15735 \begin_layout Standard
15736 This will discard all changes made to the document since the last check
15737  in.
15738  You get a warning before changes are discarded.
15739 \end_layout
15740
15741 \begin_layout Standard
15742 RCS command: 
15743 \family typewriter
15744 co -f -u<version> <file-name>
15745 \end_layout
15746
15747 \begin_layout Subsubsection
15748
15749 \family sans
15750 Undo Last Checkin
15751 \end_layout
15752
15753 \begin_layout Standard
15754 This makes as if the last check in never happened.
15755  No changes are made to the document loaded into LyX, but the last version
15756  is removed from the master RCS file.
15757  
15758 \end_layout
15759
15760 \begin_layout Standard
15761 RCS command: 
15762 \family typewriter
15763 rcs -o<version> <file-name>
15764 \end_layout
15765
15766 \begin_layout Subsubsection
15767
15768 \family sans
15769 Show History
15770 \end_layout
15771
15772 \begin_layout Standard
15773 This show the complete history of the RCS document.
15774  The output of 
15775 \family typewriter
15776 rlog <file-name>
15777 \family default
15778  is shown in a browser.
15779  See 
15780 \family typewriter
15781 man rlog
15782 \family default
15783  for more info.
15784 \end_layout
15785
15786 \begin_layout Subsection
15787 CVS commands in LyX
15788 \end_layout
15789
15790 \begin_layout Standard
15791 CVS is now partially supported by LyX.
15792  You can find the commands in the 
15793 \family sans
15794 \bar under
15795 F
15796 \bar default
15797 ile\SpecialChar \menuseparator
15798
15799 \bar under
15800 V
15801 \bar default
15802 ersion
15803 \begin_inset space ~
15804 \end_inset
15805
15806 Control
15807 \family default
15808  submenu.
15809 \end_layout
15810
15811 \begin_layout Subsubsection
15812
15813 \family sans
15814 Register
15815 \end_layout
15816
15817 \begin_layout Standard
15818 If your document is not under revision control, this is the only item shown
15819  in the menu.
15820  And if it is under revision control, the 
15821 \family sans
15822 \bar under
15823 R
15824 \bar default
15825 egister
15826 \family default
15827  item is not visible.
15828  
15829 \end_layout
15830
15831 \begin_layout Standard
15832 This command registers in CVS your document ONLY in case you have already
15833  the documents directory under CVS control (in particular 
15834 \family typewriter
15835 CVS/Entries
15836 \family default
15837  file exists).
15838  This means you have to checkout the archive by yourself.
15839  
15840 \end_layout
15841
15842 \begin_layout Standard
15843 Then you are asked interactively to supply an initial description of the
15844  document.
15845  Don't forget that registered file is not yet commited.
15846 \end_layout
15847
15848 \begin_layout Standard
15849 CVS command that is run: 
15850 \family typewriter
15851 cvs -q add -m
15852 \begin_inset Quotes erd
15853 \end_inset
15854
15855 <entered message>" 
15856 \begin_inset Quotes eld
15857 \end_inset
15858
15859 <file-name>
15860 \begin_inset Quotes erd
15861 \end_inset
15862
15863
15864 \end_layout
15865
15866 \begin_layout Standard
15867 Read 
15868 \family typewriter
15869 man svn
15870 \family default
15871  to understand the switches.
15872  
15873 \end_layout
15874
15875 \begin_layout Subsubsection
15876
15877 \family sans
15878 Check In Changes
15879 \end_layout
15880
15881 \begin_layout Standard
15882 When you are finished editing a file, you commit your changes.
15883  When you do this, you are asked for a description of the changes.
15884  After that changes are commited.
15885 \end_layout
15886
15887 \begin_layout Standard
15888 CVS command: 
15889 \family typewriter
15890 cvs -q commit -m"<description>" <file-name>
15891 \end_layout
15892
15893 \begin_layout Subsubsection
15894
15895 \family sans
15896 Revert To Repository Version
15897 \end_layout
15898
15899 \begin_layout Standard
15900 This will discard all changes made to the document since the last check
15901  in.
15902  You get a warning before changes are discarded.
15903  Firstly the file is deleted, secondly CVS update command is run.
15904 \end_layout
15905
15906 \begin_layout Standard
15907 CVS command: 
15908 \family typewriter
15909 cvs update 
15910 \begin_inset Quotes eld
15911 \end_inset
15912
15913 <file-name>
15914 \begin_inset Quotes erd
15915 \end_inset
15916
15917
15918 \end_layout
15919
15920 \begin_layout Subsubsection
15921
15922 \family sans
15923 Show History
15924 \end_layout
15925
15926 \begin_layout Standard
15927 This show the complete history of the CVS document.
15928  The output of 
15929 \family typewriter
15930 cvs log 
15931 \begin_inset Quotes eld
15932 \end_inset
15933
15934 <file-name>
15935 \begin_inset Quotes erd
15936 \end_inset
15937
15938
15939 \family default
15940  is shown in a browser.
15941 \end_layout
15942
15943 \begin_layout Subsection
15944 SVN commands in LyX
15945 \end_layout
15946
15947 \begin_layout Standard
15948 SVN is now partially supported by LyX.
15949  You can find the commands in the 
15950 \family sans
15951 \bar under
15952 F
15953 \bar default
15954 ile\SpecialChar \menuseparator
15955
15956 \bar under
15957 V
15958 \bar default
15959 ersion
15960 \begin_inset space ~
15961 \end_inset
15962
15963 Control
15964 \family default
15965  submenu.
15966  Please note that if you use password protected access to repository via
15967  ssh, you will be asked in terminal window.
15968 \end_layout
15969
15970 \begin_layout Subsubsection
15971
15972 \family sans
15973 Register
15974 \end_layout
15975
15976 \begin_layout Standard
15977 If your document is not under revision control, this is the only item shown
15978  in the menu.
15979  And if it is under revision control, the 
15980 \family sans
15981 \bar under
15982 R
15983 \bar default
15984 egister
15985 \family default
15986  item is not visible.
15987  
15988 \end_layout
15989
15990 \begin_layout Standard
15991 This command registers in SVN your document ONLY in case you have already
15992  the documents directory under SVN control (in particular 
15993 \family typewriter
15994 .svn/entries
15995 \family default
15996  file exists).
15997  This means you have to checkout the archive by yourself.
15998  
15999 \end_layout
16000
16001 \begin_layout Standard
16002 Then you are asked interactively to supply an initial description of the
16003  document.
16004  Don't forget that registered file is not yet commited.
16005 \end_layout
16006
16007 \begin_layout Standard
16008 SVN command that is run: 
16009 \family typewriter
16010 snv add -q 
16011 \begin_inset Quotes eld
16012 \end_inset
16013
16014 <file-name>
16015 \begin_inset Quotes erd
16016 \end_inset
16017
16018
16019 \end_layout
16020
16021 \begin_layout Standard
16022 Read 
16023 \family typewriter
16024 man svn
16025 \family default
16026  to understand the switches.
16027  
16028 \end_layout
16029
16030 \begin_layout Subsubsection
16031
16032 \family sans
16033 Check In Changes
16034 \end_layout
16035
16036 \begin_layout Standard
16037 When you are finished editing a file, you commit your changes.
16038  When you do this, you are asked for a description of the changes.
16039  After that changes are commited.
16040 \end_layout
16041
16042 \begin_layout Standard
16043 SVN command: 
16044 \family typewriter
16045 svn commit -q -m"<description>" <file-name>
16046 \end_layout
16047
16048 \begin_layout Subsubsection
16049
16050 \family sans
16051 Check Out For Edit
16052 \end_layout
16053
16054 \begin_layout Standard
16055 Updates the changes of this file from the repository.
16056  Be sure you understand SVN merging and conflicts resolving before using
16057  this function, because all conflicts has to be done manually by you!
16058 \end_layout
16059
16060 \begin_layout Standard
16061 SVN command: 
16062 \family typewriter
16063 svn update 
16064 \begin_inset Quotes eld
16065 \end_inset
16066
16067 <file-name>
16068 \begin_inset Quotes erd
16069 \end_inset
16070
16071
16072 \end_layout
16073
16074 \begin_layout Subsubsection
16075
16076 \family sans
16077 Revert To Repository Version
16078 \end_layout
16079
16080 \begin_layout Standard
16081 This will discard all changes made to the document since the last check
16082  in.
16083  You get a warning before changes are discarded.
16084  
16085 \end_layout
16086
16087 \begin_layout Standard
16088 SVN command: 
16089 \family typewriter
16090 svn revert -q 
16091 \begin_inset Quotes eld
16092 \end_inset
16093
16094 <file-name>
16095 \begin_inset Quotes erd
16096 \end_inset
16097
16098
16099 \end_layout
16100
16101 \begin_layout Subsubsection
16102
16103 \family sans
16104 Show History
16105 \end_layout
16106
16107 \begin_layout Standard
16108 This show the complete history of the SVN document.
16109  The output of 
16110 \family typewriter
16111 svn log 
16112 \begin_inset Quotes eld
16113 \end_inset
16114
16115 <file-name>
16116 \begin_inset Quotes erd
16117 \end_inset
16118
16119
16120 \family default
16121  is shown in a browser.
16122 \end_layout
16123
16124 \begin_layout Section
16125 Literate Programming
16126 \end_layout
16127
16128 \begin_layout Standard
16129 Updated by 
16130 \noun on
16131 Kayvan Sylvan 
16132 \noun default
16133 (kayvan@sylvan.com)
16134 \noun on
16135
16136 \noun default
16137 original documentation written by 
16138 \noun on
16139 Edmar Wienskoski Jr.
16140
16141 \noun default
16142  (edmar-w-jr@technologist.com)
16143 \end_layout
16144
16145 \begin_layout Subsection
16146 Introduction
16147 \end_layout
16148
16149 \begin_layout Standard
16150 The main purpose of this documentation is to show you how to use LyX for
16151  literate programming.
16152  Where it is assumed that you are familiar with this programming technique,
16153  and know what 
16154 \begin_inset Quotes eld
16155 \end_inset
16156
16157 tangling
16158 \begin_inset Quotes erd
16159 \end_inset
16160
16161  and 
16162 \begin_inset Quotes eld
16163 \end_inset
16164
16165 weaving
16166 \begin_inset Quotes erd
16167 \end_inset
16168
16169  means.
16170  If that is not the case, please follow the web links provided in the following
16171  sections.
16172  There is a lot of good documentation out there covering old development
16173  history to the latest tools tips.
16174 \end_layout
16175
16176 \begin_layout Standard
16177 It is also assumed that you are familiar with LyX itself to a point that
16178  you are comfortable changing your LyX preferences, and X resources file.
16179  If that is not the case please refer to other LyX documentation to cover
16180  your specific needs.
16181 \end_layout
16182
16183 \begin_layout Subsection
16184 Literate Programming
16185 \end_layout
16186
16187 \begin_layout Standard
16188 From the Literate Programming FAQ: 
16189 \end_layout
16190
16191 \begin_layout Quotation
16192 Literate programming is the combination of documentation and source together
16193  in a fashion suited for reading by human beings.
16194  In fact, literate programs should be enjoyable reading, even inviting!
16195  (Sorry Bob, I couldn't resist!) In general, literate programs combine source
16196  and documentation in a single file.
16197  Literate programming tools then parse the file to produce either readable
16198  documentation or compilable source.
16199  The WEB style of literate programming was created by D.E.
16200  Knuth during the development of his TeX typesetting software.
16201  
16202 \end_layout
16203
16204 \begin_layout Standard
16205 Another excerpt says:
16206 \end_layout
16207
16208 \begin_layout Quotation
16209
16210 \emph on
16211 How is literate programming different from verbose commenting?
16212 \end_layout
16213
16214 \begin_layout Quotation
16215 There are three distinguishing characteristics.
16216  In order of importance, they are: 
16217 \end_layout
16218
16219 \begin_deeper
16220 \begin_layout Itemize
16221 flexible order of elaboration 
16222 \end_layout
16223
16224 \begin_layout Itemize
16225 automatic support for browsing 
16226 \end_layout
16227
16228 \begin_layout Itemize
16229 typeset documentation, especially diagrams and mathematics 
16230 \end_layout
16231
16232 \end_deeper
16233 \begin_layout Standard
16234 Now that I sparked your curiosity, take a look in the references.
16235 \end_layout
16236
16237 \begin_layout Subsubsection
16238 References
16239 \end_layout
16240
16241 \begin_layout Standard
16242 The complete Literate Programming FAQ can be found at:
16243 \end_layout
16244
16245 \begin_layout Quote
16246 Literate Programming FAQ 
16247 \begin_inset Flex URL
16248 status collapsed
16249
16250 \begin_layout Plain Layout
16251
16252 http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
16253 \end_layout
16254
16255 \end_inset
16256
16257
16258 \end_layout
16259
16260 \begin_layout Standard
16261 The FAQ lists 23 (twenty three!) different literate programming tools.
16262  Where some are specialized or 
16263 \begin_inset Quotes eld
16264 \end_inset
16265
16266 tailored
16267 \begin_inset Quotes erd
16268 \end_inset
16269
16270  for particular programming languages, while other have general scope.
16271  I selected 
16272 \noun on
16273 Noweb
16274 \noun default
16275  for my own use for several reasons:
16276 \end_layout
16277
16278 \begin_layout Itemize
16279 It can generate the documentation either in LaTeX or HTML.
16280 \end_layout
16281
16282 \begin_layout Itemize
16283 It has a open architecture, i.e., it is easy to plug in new filters and to
16284  perform special processing that you may need.
16285  
16286 \end_layout
16287
16288 \begin_layout Itemize
16289 There is a good selection of filters available already (the HTML is one
16290  of them).
16291 \end_layout
16292
16293 \begin_layout Itemize
16294 It is free.
16295 \end_layout
16296
16297 \begin_layout Standard
16298 The Noweb web page can be found at: 
16299 \end_layout
16300
16301 \begin_layout Quote
16302 Noweb home page 
16303 \begin_inset Flex URL
16304 status collapsed
16305
16306 \begin_layout Plain Layout
16307
16308 http://www.cs.virginia.edu/~nr/noweb/
16309 \end_layout
16310
16311 \end_inset
16312
16313
16314 \end_layout
16315
16316 \begin_layout Standard
16317 Starting from there you can reach many other interesting links and even
16318  some literate program examples.
16319 \end_layout
16320
16321 \begin_layout Subsection
16322 LyX and Literate Programming
16323 \end_layout
16324
16325 \begin_layout Standard
16326 The LyX support for Literate Programming is provided by using the generic
16327  LyX convertors mechanism.
16328  This support is provided in a 
16329 \begin_inset Quotes eld
16330 \end_inset
16331
16332 Noweb independent
16333 \begin_inset Quotes erd
16334 \end_inset
16335
16336  way, i.e., you will be able to use this new LyX feature with some other literate
16337  programming tool of your choice by just changing your LyX preferences.
16338 \end_layout
16339
16340 \begin_layout Subsubsection
16341 Generating documents and code (weaving and tangling)
16342 \end_layout
16343
16344 \begin_layout Paragraph
16345 Selecting the document class
16346 \end_layout
16347
16348 \begin_layout Standard
16349 If you have installed Noweb and LyX successfully, whenever you open a new
16350  document or try to change the document class of an existing one, you will
16351  find that there are three new document classes available:
16352 \end_layout
16353
16354 \begin_layout Itemize
16355 Article (Noweb)
16356 \end_layout
16357
16358 \begin_layout Itemize
16359 Book (Noweb)
16360 \end_layout
16361
16362 \begin_layout Itemize
16363 Report (Noweb)
16364 \end_layout
16365
16366 \begin_layout Standard
16367 You must select one of them to create your literate documents from.
16368  
16369 \end_layout
16370
16371 \begin_layout Standard
16372 Note that literate documents are not limited to these three classes.
16373  New classes can be generated from other styles like letter or in combination
16374  with other class variations like Article (AMS).
16375  If you have special needs that cannot be covered by one of the existing
16376  classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
16377  will arrange to insert a new entry, or teach you how to do it.
16378 \begin_inset Foot
16379 status collapsed
16380
16381 \begin_layout Plain Layout
16382 It is very simple, it involves the creation of a file with four lines, and
16383  re-running of the auto configuration.
16384 \end_layout
16385
16386 \end_inset
16387
16388  Moreover, if you use a literate tool other than Noweb you may need to create
16389  a new set of document classes for it.
16390 \end_layout
16391
16392 \begin_layout Paragraph
16393 Typing code in
16394 \end_layout
16395
16396 \begin_layout Standard
16397 LyX enables you to write code with a layout named 
16398 \noun on
16399 Scrap
16400 \noun default
16401 .
16402 \begin_inset Foot
16403 status collapsed
16404
16405 \begin_layout Plain Layout
16406 The equivalent Noweb term is 
16407 \begin_inset Quotes eld
16408 \end_inset
16409
16410 Chunk
16411 \begin_inset Quotes erd
16412 \end_inset
16413
16414 .
16415  For historical reasons, I got used to the term 
16416 \begin_inset Quotes eld
16417 \end_inset
16418
16419 scrap
16420 \begin_inset Quotes erd
16421 \end_inset
16422
16423  introduced by other literate tool named Nuweb, which I used for many years
16424  before rendering myself to Noweb.
16425 \end_layout
16426
16427 \end_inset
16428
16429  Noweb delimits scraps like this:
16430 \end_layout
16431
16432 \begin_layout LyX-Code
16433 <<My scrap>>=
16434 \end_layout
16435
16436 \begin_layout LyX-Code
16437   code
16438 \end_layout
16439
16440 \begin_layout LyX-Code
16441   more code
16442 \end_layout
16443
16444 \begin_layout LyX-Code
16445   even more code
16446 \end_layout
16447
16448 \begin_layout LyX-Code
16449   @
16450 \end_layout
16451
16452 \begin_layout Standard
16453 The problem is that whatever is written in between the << and the 
16454 \family typewriter
16455 @
16456 \family default
16457  must be taken literally, i.e., LyX should be prevented from making any special
16458  interpretation of what has been written.
16459  This is handled by a special layout named Scrap, that works like a normal
16460  paragraph but has a free spacing capability.
16461 \end_layout
16462
16463 \begin_layout Standard
16464 The down side of the Scrap paragraph layout is that consecutive paragraphs
16465  of code will be spaced with one empty line in the source code and also
16466  in the printed documentation.
16467  The work around is to enter each line of code within a single Scrap, with
16468  a newline (ctrl-return).
16469  The example above will look like this:
16470 \begin_inset Foot
16471 status collapsed
16472
16473 \begin_layout Plain Layout
16474 If you have a printed version of this document you will not see any difference
16475  between the previous example and this one.
16476 \end_layout
16477
16478 \end_inset
16479
16480
16481 \end_layout
16482
16483 \begin_layout LyX-Code
16484 <<My scrap>>=
16485 \begin_inset Newline newline
16486 \end_inset
16487
16488   code
16489 \begin_inset Newline newline
16490 \end_inset
16491
16492   more code
16493 \begin_inset Newline newline
16494 \end_inset
16495
16496   even more code
16497 \begin_inset Newline newline
16498 \end_inset
16499
16500   @
16501 \end_layout
16502
16503 \begin_layout Standard
16504 This layout works fine.
16505  The only real inconvenience is that you have to type ctrl-return instead
16506  of a plain return.
16507 \begin_inset Foot
16508 status collapsed
16509
16510 \begin_layout Plain Layout
16511 It is in my list of 
16512 \begin_inset Quotes eld
16513 \end_inset
16514
16515 improvements
16516 \begin_inset Quotes erd
16517 \end_inset
16518
16519  to fix that.
16520 \end_layout
16521
16522 \end_inset
16523
16524
16525 \end_layout
16526
16527 \begin_layout Standard
16528 As a special note, you can also use the 
16529 \begin_inset Quotes eld
16530 \end_inset
16531
16532 %def
16533 \begin_inset Quotes erd
16534 \end_inset
16535
16536  construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
16537 rence:
16538 \end_layout
16539
16540 \begin_layout LyX-Code
16541 <<My scrap>>=
16542 \begin_inset Newline newline
16543 \end_inset
16544
16545   def some_function(args):
16546 \begin_inset Newline newline
16547 \end_inset
16548
16549     "This is the doc string for this function."
16550 \begin_inset Newline newline
16551 \end_inset
16552
16553     print "My args: ", args
16554 \end_layout
16555
16556 \begin_layout LyX-Code
16557 @ %def some_function
16558 \end_layout
16559
16560 \begin_layout Standard
16561 For an example of this usage and the resulting cross-reference output, look
16562  at the Literate python program in 
16563 \emph on
16564 LIBDIR/examples/listerrors.lyx
16565 \emph default
16566  which should make this all clear.
16567 \end_layout
16568
16569 \begin_layout Paragraph
16570 Generating the documentation
16571 \end_layout
16572
16573 \begin_layout Standard
16574 At this point you already have a new document file with a proper document
16575  class, and with some code and text on it.
16576  How do I print it? The answer is simple, you select 
16577 \family sans
16578 \bar under
16579 V
16580 \bar default
16581 iew\SpecialChar \menuseparator
16582
16583 \bar under
16584 D
16585 \bar default
16586 VI,
16587 \family default
16588  etc.
16589  Just like you would do for a plain document.
16590  No special procedure is required.
16591 \end_layout
16592
16593 \begin_layout Standard
16594 To help orientate you, I will now explain what happens inside LyX:
16595 \end_layout
16596
16597 \begin_layout Enumerate
16598 When the 
16599 \family sans
16600 Update\SpecialChar \menuseparator
16601 DVI
16602 \family default
16603  menu option is chosen, a LaTeX file is generated.
16604  
16605 \end_layout
16606
16607 \begin_deeper
16608 \begin_layout Standard
16609 If the document is of any literate class the generated file will be named
16610  with an extension name defined by the 
16611 \begin_inset Quotes eld
16612 \end_inset
16613
16614 literate
16615 \begin_inset Quotes erd
16616 \end_inset
16617
16618  format (defined in the Preferences panel), otherwise the file will have
16619  the usual 
16620 \family typewriter
16621 .tex
16622 \family default
16623  extension.
16624 \end_layout
16625
16626 \end_deeper
16627 \begin_layout Enumerate
16628 Note that the only difference so far is in the name of the file, no special
16629  processing is required by LyX.
16630  Given that you formatted the code using the Scrap layout that, by itself,
16631  takes care of the business.
16632 \end_layout
16633
16634 \begin_layout Enumerate
16635 If the document is of any literate class LyX will then use the internal
16636  LyX to Noweb converter, followed by the Noweb to LaTeX converter
16637 \begin_inset Foot
16638 status collapsed
16639
16640 \begin_layout Plain Layout
16641 The converters are defined in the 
16642 \family sans
16643 Tools\SpecialChar \menuseparator
16644 Preferences
16645 \family default
16646  panel, under the 
16647 \begin_inset Quotes eld
16648 \end_inset
16649
16650 Conversion
16651 \begin_inset Quotes erd
16652 \end_inset
16653
16654  tab.
16655  See section 
16656 \emph on
16657 Converters
16658 \emph default
16659  of the 
16660 \emph on
16661 Customization
16662 \emph default
16663  manual for general information about converters.
16664 \end_layout
16665
16666 \end_inset
16667
16668  to generate the LaTeX file.
16669 \end_layout
16670
16671 \begin_deeper
16672 \begin_layout Standard
16673 Otherwise it will just skip this step.
16674 \end_layout
16675
16676 \end_deeper
16677 \begin_layout Enumerate
16678 Finally, LaTeX is invoked and the regular post processing continues as in
16679  a plain document.
16680 \end_layout
16681
16682 \begin_layout Standard
16683 Independence from a particular 
16684 \begin_inset Quotes eld
16685 \end_inset
16686
16687 literate tool
16688 \begin_inset Quotes erd
16689 \end_inset
16690
16691  is easily achieved by changing the commands that are run by the various
16692  converters.
16693 \end_layout
16694
16695 \begin_layout Paragraph
16696 Generating the code
16697 \end_layout
16698
16699 \begin_layout Standard
16700 When the build menu option is chosen or the corresponding button in the
16701  toolbar is pressed, a LaTeX file is generated just like step 1 above.
16702  Next, LyX invokes the 
16703 \family typewriter
16704 Noweb->Program
16705 \family default
16706  converter.
16707  This converter needs to be defined by the user and is not installed by
16708  default, though the Program format is.
16709  This converter (like any other converter) will have two parts:
16710 \end_layout
16711
16712 \begin_layout Enumerate
16713 The converter program itself.
16714  This program performs the conversion from the one format to the other (in
16715  this case, from the Noweb format to the Program pseudo-format).
16716 \end_layout
16717
16718 \begin_layout Enumerate
16719 The error log parser.
16720  This is a program whose sole purpose is to rewrite error messages in a
16721  format that LyX understands.
16722  This makes it possible for LyX to place error boxes in the right places
16723  in the file buffer.
16724 \end_layout
16725
16726 \begin_layout Standard
16727 The first part, the 
16728 \begin_inset Quotes eld
16729 \end_inset
16730
16731 Converter
16732 \begin_inset Quotes erd
16733 \end_inset
16734
16735  setting, should be set to 
16736 \begin_inset Quotes eld
16737 \end_inset
16738
16739
16740 \family typewriter
16741 build-script $$i
16742 \family default
16743
16744 \begin_inset Quotes erd
16745 \end_inset
16746
16747 .
16748  This basically means that LyX will call 
16749 \begin_inset Quotes eld
16750 \end_inset
16751
16752 build-script
16753 \begin_inset Quotes erd
16754 \end_inset
16755
16756  (a program or script) with the name of the Noweb file (normally a file
16757  in the LyX temp directory).
16758  
16759 \end_layout
16760
16761 \begin_layout Standard
16762 This is an implementation of 
16763 \begin_inset Quotes eld
16764 \end_inset
16765
16766 build-script
16767 \begin_inset Quotes erd
16768 \end_inset
16769
16770  that you can place in a directory on your path:
16771 \end_layout
16772
16773 \begin_layout LyX-Code
16774 #!/bin/sh
16775 \end_layout
16776
16777 \begin_layout LyX-Code
16778 #
16779 \end_layout
16780
16781 \begin_layout LyX-Code
16782 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
16783 \end_layout
16784
16785 \begin_layout Standard
16786 The next part of the converter setting is the 
16787 \begin_inset Quotes eld
16788 \end_inset
16789
16790 Flags
16791 \begin_inset Quotes erd
16792 \end_inset
16793
16794  which is to be set to 
16795 \begin_inset Quotes eld
16796 \end_inset
16797
16798
16799 \family typewriter
16800 parselog=listerrors
16801 \family default
16802
16803 \begin_inset Quotes erd
16804 \end_inset
16805
16806 .
16807  This will run any errors that are generated by the 
16808 \begin_inset Quotes eld
16809 \end_inset
16810
16811 build-script
16812 \begin_inset Quotes erd
16813 \end_inset
16814
16815  process through the 
16816 \begin_inset Quotes eld
16817 \end_inset
16818
16819 listerrors
16820 \begin_inset Quotes erd
16821 \end_inset
16822
16823  program.
16824 \end_layout
16825
16826 \begin_layout Standard
16827 The converter code looks in 
16828 \emph on
16829 MYLYXDIR/scripts
16830 \emph default
16831  first, then in 
16832 \emph on
16833 LIBDIR/scripts
16834 \emph default
16835  then on the path for the 
16836 \begin_inset Quotes eld
16837 \end_inset
16838
16839 listerrors
16840 \begin_inset Quotes erd
16841 \end_inset
16842
16843  program.
16844 \end_layout
16845
16846 \begin_layout Standard
16847 The build will normally take place in LyX's temporary directory, so the
16848  files produced by the conversion will be in that directory.
16849  LyX will copy out what it regards as the `main' file, but the 
16850 \family typewriter
16851 Noweb->Program
16852 \family default
16853  conversion may produce several files, and so most of these would then be
16854  deleted when LyX was closed.
16855  The present solution is to use a `copier',
16856 \begin_inset Foot
16857 status collapsed
16858
16859 \begin_layout Plain Layout
16860 See section 
16861 \emph on
16862 Copiers
16863 \emph default
16864  of the 
16865 \emph on
16866 Customization
16867 \emph default
16868  manual for information on these.
16869 \end_layout
16870
16871 \end_inset
16872
16873  in this case, the 
16874 \family typewriter
16875 ext_copy.py
16876 \family default
16877  script in its default mode, so that the entire contents of the temporary
16878  directory is copied.
16879  More will get copied than is needed, to be sure, but nothing will be lost.
16880  If, however, you know what extensions the generated files will have, this
16881  can be improved by using the 
16882 \family typewriter
16883 -e
16884 \family default
16885  option to 
16886 \family typewriter
16887 ext_copy
16888 \family default
16889 .
16890  This option takes a comma-separated list of extensions to copy.
16891  So, for example, if the conversion will generate only files with the extensions
16892  
16893 \family typewriter
16894 .c
16895 \family default
16896  and 
16897 \family typewriter
16898 .h
16899 \family default
16900 , then the correct definition would be:
16901 \end_layout
16902
16903 \begin_layout LyX-Code
16904 python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
16905 \end_layout
16906
16907 \begin_layout Standard
16908 The result will be that only files with these two extensions will be copied
16909  out.
16910 \end_layout
16911
16912 \begin_layout Paragraph
16913 Build instructions in the document
16914 \end_layout
16915
16916 \begin_layout Standard
16917 The last piece of the integration between LyX and noweb is the 
16918 \begin_inset Quotes eld
16919 \end_inset
16920
16921 build-script
16922 \begin_inset Quotes erd
16923 \end_inset
16924
16925  scrap.
16926  Generally, the instructions for building your program should be embedded
16927  in a scrap of its own.
16928  The noweb-specific 
16929 \begin_inset Quotes eld
16930 \end_inset
16931
16932 build-script
16933 \begin_inset Quotes erd
16934 \end_inset
16935
16936  above uses the notangle command to look for this scrap (called 
16937 \begin_inset Quotes eld
16938 \end_inset
16939
16940 build-script
16941 \begin_inset Quotes erd
16942 \end_inset
16943
16944 ) and runs its contents through 
16945 \begin_inset Quotes eld
16946 \end_inset
16947
16948 sh
16949 \begin_inset Quotes erd
16950 \end_inset
16951
16952 .
16953 \end_layout
16954
16955 \begin_layout Standard
16956 Typically, such a scrap would look something like this:
16957 \end_layout
16958
16959 \begin_layout LyX-Code
16960 <<build-script>>=
16961 \begin_inset Newline newline
16962 \end_inset
16963
16964 #!/bin/sh
16965 \begin_inset Newline newline
16966 \end_inset
16967
16968
16969 \begin_inset Newline newline
16970 \end_inset
16971
16972 if [ -z "${NOWEB_SOURCE}" ]
16973 \begin_inset Newline newline
16974 \end_inset
16975
16976 then
16977 \begin_inset Newline newline
16978 \end_inset
16979
16980   NOWEB_SOURCE=myfile.nw
16981 \begin_inset Newline newline
16982 \end_inset
16983
16984 fi
16985 \begin_inset Newline newline
16986 \end_inset
16987
16988 [...
16989  code to extract files ...]
16990 \begin_inset Newline newline
16991 \end_inset
16992
16993 [...
16994  code to compile files ...]
16995 \begin_inset Newline newline
16996 \end_inset
16997
16998 @
16999 \end_layout
17000
17001 \begin_layout Standard
17002 Look in 
17003 \emph on
17004 LIBDIR/examples/listerrors.lyx
17005 \emph default
17006  or in 
17007 \emph on
17008 LIBDIR/examples/Literate.lyx
17009 \emph default
17010  which implement two versions of the 
17011 \begin_inset Quotes eld
17012 \end_inset
17013
17014 listerrors
17015 \begin_inset Quotes erd
17016 \end_inset
17017
17018  program for some illustrations of how all of these pieces go together or
17019  in 
17020 \emph on
17021 LIBDIR/examples/noweb2lyx.lyx.
17022
17023 \emph default
17024  Interestingly, these three files show off the language-indepence of the
17025  LyX literate programming support since they are written in Python, C and
17026  Perl respectively.
17027 \end_layout
17028
17029 \begin_layout Subsubsection
17030 Configuring LyX
17031 \end_layout
17032
17033 \begin_layout Standard
17034 All the Literate Programming support is configured by the 
17035 \family sans
17036 \bar under
17037 T
17038 \bar default
17039 ools\SpecialChar \menuseparator
17040
17041 \bar under
17042 P
17043 \bar default
17044 references
17045 \family default
17046  panel in the 
17047 \begin_inset Quotes eld
17048 \end_inset
17049
17050 Conversion
17051 \begin_inset Quotes erd
17052 \end_inset
17053
17054  tab.
17055  The important parts are:
17056 \end_layout
17057
17058 \begin_layout Description
17059 the
17060 \begin_inset space ~
17061 \end_inset
17062
17063
17064 \begin_inset Quotes eld
17065 \end_inset
17066
17067 literate
17068 \begin_inset Quotes erd
17069 \end_inset
17070
17071
17072 \begin_inset space ~
17073 \end_inset
17074
17075 format Set up via the Formats tab, this is where the Noweb-specific pieces
17076  are set up.
17077  The 
17078 \family sans
17079 GUI Name
17080 \family default
17081  is set to 
17082 \family typewriter
17083 NoWeb
17084 \family default
17085 , the file extension is set to 
17086 \family typewriter
17087 .nw
17088 \family default
17089 .
17090  This tells LyX to create a file with a 
17091 \family typewriter
17092 .nw
17093 \family default
17094  extension in the first step of the conversion process.
17095 \end_layout
17096
17097 \begin_layout Description
17098 the
17099 \begin_inset space ~
17100 \end_inset
17101
17102
17103 \family sans
17104 Program
17105 \family default
17106
17107 \begin_inset space ~
17108 \end_inset
17109
17110 format This is an empty format whose sole purpose is to be the endpoint
17111  of a conversion (which then allows us to set up a converter for it).
17112 \end_layout
17113
17114 \begin_layout Description
17115
17116 \family sans
17117 NoWeb
17118 \family default
17119 ->
17120 \family sans
17121 LaTeX
17122 \family default
17123  This converter performs the 
17124 \begin_inset Quotes eld
17125 \end_inset
17126
17127 weaving
17128 \begin_inset Quotes erd
17129 \end_inset
17130
17131  of the literate document.
17132  For Noweb, it is set to 
17133 \begin_inset Quotes eld
17134 \end_inset
17135
17136
17137 \family typewriter
17138 noweave -delay -index $$i > $$o
17139 \family default
17140
17141 \begin_inset Quotes erd
17142 \end_inset
17143
17144
17145 \end_layout
17146
17147 \begin_layout Description
17148
17149 \family sans
17150 NoWeb
17151 \family default
17152 ->
17153 \family sans
17154 Program
17155 \family default
17156  This performs the 
17157 \begin_inset Quotes eld
17158 \end_inset
17159
17160 tangling step
17161 \begin_inset Quotes erd
17162 \end_inset
17163
17164 .
17165  As stated above, the Converter is set to 
17166 \begin_inset Quotes eld
17167 \end_inset
17168
17169
17170 \family typewriter
17171 build-script $$i
17172 \family default
17173
17174 \begin_inset Quotes erd
17175 \end_inset
17176
17177 , with Flags set to 
17178 \begin_inset Quotes eld
17179 \end_inset
17180
17181
17182 \family typewriter
17183 originaldir,parselog=listerrors
17184 \family default
17185
17186 \begin_inset Quotes erd
17187 \end_inset
17188
17189 .
17190 \end_layout
17191
17192 \begin_layout Subsubsection
17193 Debug extensions
17194 \end_layout
17195
17196 \begin_layout Standard
17197 There is also a new function implemented in the LyX server, the 
17198 \begin_inset Quotes eld
17199 \end_inset
17200
17201 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
17202  
17203 \end_layout
17204
17205 \begin_layout Standard
17206 When debugging code with ddd/gdb, it is possible to invoke a text editor
17207  at the current execution position with a single key stroke.
17208  The default ddd configuration for that is shift-ctrl-V.
17209  It happens that you can define the editor command line invocation in ddd
17210  by accessing the 
17211 \family sans
17212 \bar under
17213 E
17214 \bar default
17215 dit\SpecialChar \menuseparator
17216
17217 \bar under
17218 P
17219 \bar default
17220 references\SpecialChar \menuseparator
17221
17222 \bar under
17223 H
17224 \bar default
17225 elpers
17226 \family default
17227  dialog and changing the "Edit Sources" entry.
17228 \end_layout
17229
17230 \begin_layout Standard
17231 I take advantage of the new created LyX server function and this ddd feature,
17232  and set 
17233 \begin_inset Quotes eld
17234 \end_inset
17235
17236 Edit Sources
17237 \begin_inset Quotes erd
17238 \end_inset
17239
17240  to:
17241 \end_layout
17242
17243 \begin_layout LyX-Code
17244 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
17245 \end_layout
17246
17247 \begin_layout Standard
17248 With this, whenever you are using ddd and find a point in the program that
17249  you want to edit, you just press shift-ctrl-V (in the ddd window), and
17250  ddd you forward this information to LyX through the LyX server and then
17251  the LyX window will show the same file with the cursor at the same position
17252  ddd was pointing to.
17253  No more guessing or long scrolling to locate a point in the program back
17254  from debugging !
17255 \end_layout
17256
17257 \begin_layout Standard
17258 Note however that you must enable the LyX server to get this feature working
17259  (it is disabled by default).
17260  You can enable it in 
17261 \family sans
17262 Preferences
17263 \family default
17264  (tabs 
17265 \family sans
17266 Inputs
17267 \family default
17268
17269 \family sans
17270 Paths
17271 \family default
17272 ) by entering in the 
17273 \family sans
17274 LyXserver pipe
17275 \family default
17276  a path like 
17277 \begin_inset Quotes eld
17278 \end_inset
17279
17280
17281 \family typewriter
17282 /home/<your-home-directory>/.lyx/lyxpipe
17283 \family default
17284
17285 \begin_inset Quotes erd
17286 \end_inset
17287
17288
17289 \end_layout
17290
17291 \begin_layout Standard
17292 Read the LyX server documentation in the 
17293 \emph on
17294 Customization Manual
17295 \emph default
17296  for further information.
17297 \end_layout
17298
17299 \begin_layout Subsubsection
17300 Toolbar extensions
17301 \end_layout
17302
17303 \begin_layout Standard
17304 There are six new buttons that can be added to your LyX toolbar.
17305  Five of these buttons are short cuts to layout styles: 
17306 \family sans
17307 Standard
17308 \family default
17309
17310 \family sans
17311 Section
17312 \family default
17313
17314 \family sans
17315 LaTeX
17316 \family default
17317
17318 \family sans
17319 LyX-Code
17320 \family default
17321 , and 
17322 \family sans
17323 Scrap
17324 \family default
17325 .
17326  The last one is a short cut to the 
17327 \begin_inset Quotes eld
17328 \end_inset
17329
17330 Build Program
17331 \begin_inset Quotes erd
17332 \end_inset
17333
17334  File menu entry.
17335  
17336 \end_layout
17337
17338 \begin_layout Standard
17339 LyX has a range of buttons that are available for tool bar customization.
17340  In my toolbar I like to combine the six short cuts above with two more:
17341  One for 
17342 \family sans
17343 \bar under
17344 V
17345 \bar default
17346 iew
17347 \family default
17348 \SpecialChar \menuseparator
17349
17350 \family sans
17351 \bar under
17352 U
17353 \bar default
17354 pdate
17355 \family default
17356 \SpecialChar \menuseparator
17357
17358 \family sans
17359 \bar under
17360 D
17361 \bar default
17362 VI
17363 \family default
17364  and the other for 
17365 \family sans
17366 \bar under
17367 V
17368 \bar default
17369 iew\SpecialChar \menuseparator
17370
17371 \bar under
17372 D
17373 \bar default
17374 VI
17375 \family default
17376  File menu entries.
17377  Here is how it looks like:
17378 \end_layout
17379
17380 \begin_layout LyX-Code
17381 Toolbar
17382 \end_layout
17383
17384 \begin_layout LyX-Code
17385   Layouts
17386 \end_layout
17387
17388 \begin_layout LyX-Code
17389   Icon "layout Standard"
17390 \end_layout
17391
17392 \begin_layout LyX-Code
17393   Icon "layout Section"
17394 \end_layout
17395
17396 \begin_layout LyX-Code
17397   Icon "layout LaTeX"
17398 \end_layout
17399
17400 \begin_layout LyX-Code
17401   Icon "layout LyX-Code"
17402 \end_layout
17403
17404 \begin_layout LyX-Code
17405   Icon "layout Scrap"
17406 \end_layout
17407
17408 \begin_layout LyX-Code
17409   Separator
17410 \end_layout
17411
17412 \begin_layout LyX-Code
17413   Icon "buffer-view"
17414 \end_layout
17415
17416 \begin_layout LyX-Code
17417   Icon "buffer-typeset"
17418 \end_layout
17419
17420 \begin_layout LyX-Code
17421   Icon "build-program"
17422 \end_layout
17423
17424 \begin_layout LyX-Code
17425   Separator
17426 \end_layout
17427
17428 \begin_layout LyX-Code
17429 .
17430 \end_layout
17431
17432 \begin_layout LyX-Code
17433 .
17434 \end_layout
17435
17436 \begin_layout LyX-Code
17437 .
17438 \end_layout
17439
17440 \begin_layout LyX-Code
17441 End
17442 \end_layout
17443
17444 \begin_layout Subsubsection
17445 Colors customization
17446 \end_layout
17447
17448 \begin_layout Standard
17449 There are a number of colors in LyX that can be customized in 
17450 \family sans
17451 Preferences
17452 \family default
17453 .
17454  One of the things that bothers people is the LaTeX font color.
17455  The default color is red, since the scraps uses LaTeX font, and there is
17456  a lot of scraps in literate documents, you may get tired of seeing everything
17457  in red.
17458  You can change it by going to the tabs 
17459 \family sans
17460 Look&Feel
17461 \family default
17462
17463 \family sans
17464 Colors.
17465 \end_layout
17466
17467 \begin_layout Standard
17468 The next thing is the visible presence of the newline character in the screen.
17469  You can choose the color of this particular character and make it blend
17470  in the background.
17471  I recommend you choosing a color that is close to the background but not
17472  equal, that way you still can see it is there, but it is not bothering
17473  you anymore.
17474  
17475 \end_layout
17476
17477 \begin_layout Chapter
17478 Secrets of the LaTeX Masters
17479 \begin_inset CommandInset label
17480 LatexCommand label
17481 name "cha:secrets"
17482
17483 \end_inset
17484
17485
17486 \end_layout
17487
17488 \begin_layout Standard
17489 Though LyX is a powerful tool, it cannot hope to support everything that
17490  can be done with pure TeX/LaTeX.
17491  However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
17492  as long as you are not afraid to use that 
17493 \begin_inset Quotes eld
17494 \end_inset
17495
17496 TeX
17497 \begin_inset Quotes erd
17498 \end_inset
17499
17500  button on the toolbar or add things to the LaTeX preamble.
17501  This section lists some tips, tricks, and otherwise cool ideas to give
17502  your document that extra little flair.
17503  
17504 \emph on
17505 Do try this at home
17506 \emph default
17507 , just start with something a little smaller and less important than your
17508  dissertation!
17509 \end_layout
17510
17511 \begin_layout Standard
17512 Most ideas in this section require less common files in your LaTeX installation.
17513  If you have a system like teTeX, most will already be available.
17514  A few, however, will need to be downloaded from one of the CTAN archives.
17515  Often, there are several ways to do something, or several LaTeX style files
17516  which do the same thing.
17517  We do not endorse one choice over another, we simply claim that we have
17518  done a particular task with a particular file.
17519  Put on your wizard hat, keep an eye out for dragons, and let us begin.
17520 \end_layout
17521
17522 \begin_layout Section
17523 Multiple Columns
17524 \end_layout
17525
17526 \begin_layout Standard
17527 by 
17528 \noun on
17529 Lars Gullik Bjønnes
17530 \end_layout
17531
17532 \begin_layout Subsection
17533 Purpose
17534 \end_layout
17535
17536 \begin_layout Standard
17537 The aim for this chapter
17538 \begin_inset Foot
17539 status collapsed
17540
17541 \begin_layout Plain Layout
17542 Editor's note: Lars' original chapter was a masterful description of how
17543  to use the 
17544 \family typewriter
17545 multicol
17546 \family default
17547  package.
17548  However, it was too long to flow smoothly in this document.
17549  I have therefore chosen to excerpt the most important sections here (sorry,
17550  Lars); you can read the original chapter (and more of the story!) in the
17551  example file 
17552 \family typewriter
17553 examples/multicol.lyx
17554 \family default
17555 .
17556  --- mer
17557 \end_layout
17558
17559 \end_inset
17560
17561  is to show how the LaTeX package 
17562 \family typewriter
17563 multicol
17564 \family default
17565  can be used in a LyX document.
17566  As LyX doesn't support the 
17567 \family typewriter
17568 multicol
17569 \family default
17570  package natively yet, we have to use some small hacks.
17571  By reading this section it should be obvious how to do this.
17572 \end_layout
17573
17574 \begin_layout Subsection
17575 Limitations 
17576 \end_layout
17577
17578 \begin_layout Standard
17579 The 
17580 \family typewriter
17581 multicol
17582 \family default
17583  package allows switching between one and multicolumn format on the same
17584  page.
17585  Footnotes are handled correctly (for the most part), but will be placed
17586  at the bottom of the page and not under each column.
17587  LaTeX's float mechanism, however, is partly disabled in the current implementat
17588 ion.
17589  At the moment only page-wide floats can be used within the scope of the
17590  environment.
17591 \end_layout
17592
17593 \begin_layout Subsection
17594 Examples
17595 \end_layout
17596
17597 \begin_layout Subsubsection
17598 Two columns
17599 \end_layout
17600
17601 \begin_layout Standard
17602 If you want to have two columns in your text, you have use LaTeX mode to
17603  insert 
17604 \family typewriter
17605
17606 \backslash
17607 begin{multicols}{2}
17608 \family default
17609  at the point where you want the two column layout to start, and then 
17610 \family typewriter
17611
17612 \backslash
17613 end{multicols}
17614 \family default
17615  where you want it to end.
17616  Like this:
17617 \end_layout
17618
17619 \begin_layout Standard
17620 \begin_inset ERT
17621 status open
17622
17623 \begin_layout Plain Layout
17624
17625
17626 \backslash
17627 begin{multicols}{2}
17628 \end_layout
17629
17630 \end_inset
17631
17632
17633 \end_layout
17634
17635 \begin_layout Standard
17636 \noindent
17637
17638 \series bold
17639 \size small
17640 The Adventure of the Empty House
17641 \series default
17642
17643 \begin_inset Newline newline
17644 \end_inset
17645
17646 by 
17647 \noun on
17648 Sir Arthur Conan Doyle
17649 \end_layout
17650
17651 \begin_layout Standard
17652
17653 \size small
17654 It was in the spring of the year 1894 that all London was interested, and
17655  the fashionable world dismayed, by the murder of the Honourable Ronald
17656  Adair under most unusual and inexplicable circumstances.
17657  The public has already learned those particulars of the crime which came
17658  out in the police investigation, but a good deal was suppressed upon that
17659  occasion, since the case for the prosecution was so overwhelmingly strong
17660  that it was not necessary to bring forward all the facts.
17661  Only now, at the end of nearly ten years, am I allowed to supply those
17662  missing links which make up the whole of that remarkable chain.
17663  The crime was of interest in itself, but that interest was as nothing to
17664  me compared to the inconceivable sequel, which afforded me the greatest
17665  shock and surprise of any event in my adventurous life.
17666  Even now, after this long interval, I find myself thrilling as I think
17667  of it, and feeling once more that sudden flood of joy, amazement, and increduli
17668 ty which utterly submerged my mind.
17669  Let me say to that public, which has shown some interest in those glimpses
17670  which I have occasionally given them of the thoughts and actions of a very
17671  remarkable man, that they are not to blame me if I have not shared my knowledge
17672  with them, for I should have considered it my first duty to do so, had
17673  I not been barred by a positive prohibition from his own lips, which was
17674  only withdrawn upon the third of last month.
17675 \end_layout
17676
17677 \begin_layout Standard
17678 \begin_inset ERT
17679 status open
17680
17681 \begin_layout Plain Layout
17682
17683
17684 \backslash
17685 end{multicols}
17686 \end_layout
17687
17688 \end_inset
17689
17690
17691 \end_layout
17692
17693 \begin_layout Subsubsection
17694 Multiple columns
17695 \end_layout
17696
17697 \begin_layout Standard
17698 The same pattern is used when you want more than two columns:
17699 \end_layout
17700
17701 \begin_layout Standard
17702 \begin_inset ERT
17703 status open
17704
17705 \begin_layout Plain Layout
17706
17707
17708 \backslash
17709 begin{multicols}{3}
17710 \end_layout
17711
17712 \end_inset
17713
17714
17715 \end_layout
17716
17717 \begin_layout Standard
17718
17719 \size footnotesize
17720 It can be imagined that my close intimacy with Sherlock Holmes had interested
17721  me deeply in crime, and that after his disappearance I never failed to
17722  read with care the various problems which came before the public.
17723  And I even attempted, more than once, for my own private satisfaction,
17724  to employ his methods in their solution, though with indifferent success.
17725  There was none, however, which appealed to me like this tragedy of Ronald
17726  Adair.
17727  As I read the evidence at the inquest, which led up to a verdict of willful
17728  murder against some person or persons unknown, I realized more clearly
17729  than I had ever done the loss which the community had sustained by the
17730  death of Sherlock Holmes.
17731  There were points about this strange business which would, I was sure,
17732  have specially appealed to him, and the efforts of the police would have
17733  been supplemented, or more probably anticipated, by the trained observation
17734  and the alert mind of the first criminal agent in Europe.
17735  All day, as I drove upon my round, I turned over the case in my mind and
17736  found no explanation which appeared to me to be adequate.
17737  At the risk of telling a twice-told tale, I will recapitulate the facts
17738  as they were known to the public at the conclusion of the inquest.
17739 \end_layout
17740
17741 \begin_layout Standard
17742 \begin_inset ERT
17743 status open
17744
17745 \begin_layout Plain Layout
17746
17747
17748 \backslash
17749 end{multicols}
17750 \end_layout
17751
17752 \end_inset
17753
17754
17755 \end_layout
17756
17757 \begin_layout Standard
17758 You can have more than 3 columns if you want to, but that might not be very
17759  pleasant for the eye.
17760 \end_layout
17761
17762 \begin_layout Subsubsection
17763 Columns inside columns
17764 \end_layout
17765
17766 \begin_layout Standard
17767 You can even have columns inside columns:
17768 \end_layout
17769
17770 \begin_layout Standard
17771 \begin_inset ERT
17772 status open
17773
17774 \begin_layout Plain Layout
17775
17776
17777 \backslash
17778 begin{multicols}{2}
17779 \end_layout
17780
17781 \end_inset
17782
17783
17784 \end_layout
17785
17786 \begin_layout Standard
17787
17788 \size footnotesize
17789 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
17790  at that time governor of one of the Australian colonies.
17791  Adair's mother had returned from Australia to undergo the operation for
17792  cataract, and she, her son Ronald, and her daughter Hilda were living together
17793  at 427 Park Lane.
17794 \end_layout
17795
17796 \begin_layout Standard
17797 \begin_inset ERT
17798 status open
17799
17800 \begin_layout Plain Layout
17801
17802
17803 \backslash
17804 begin{multicols}{2}
17805 \end_layout
17806
17807 \end_inset
17808
17809
17810 \end_layout
17811
17812 \begin_layout Standard
17813
17814 \size footnotesize
17815 The youth moved in the best society--had, so far as was known, no enemies
17816  and no particular vices.
17817  He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
17818  had been broken off by mutual consent some months before, and there was
17819  no sign that it had left any very profound feeling behind it.
17820  For the rest {sic} the man's life moved in a narrow and conventional circle,
17821  for his habits were quiet and his nature unemotional.
17822  Yet it was upon this easy-going young aristocrat that death came, in most
17823  strange and unexpected form, between the hours of ten and eleven-twenty
17824  on the night of March 30, 1894.
17825 \end_layout
17826
17827 \begin_layout Standard
17828 \begin_inset ERT
17829 status open
17830
17831 \begin_layout Plain Layout
17832
17833
17834 \backslash
17835 end{multicols}
17836 \end_layout
17837
17838 \end_inset
17839
17840
17841 \end_layout
17842
17843 \begin_layout Standard
17844
17845 \size footnotesize
17846 Ronald Adair was fond of cards--playing continually, but never for such
17847  stakes as would hurt him.
17848  He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
17849  It was shown that, after dinner on the day of his death, he had played
17850  a rubber of whist at the latter club.
17851  He had also played there in the afternoon.
17852
17853 \size default
17854  
17855 \size footnotesize
17856 The evidence of those who had played with him-- Mr.
17857  Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
17858  and that there was a fairly equal fall of the cards.
17859  Adair might have lost five pounds, but not more.
17860  His fortune was a considerable one, and such a loss could not in any way
17861  affect him.
17862  He had played nearly every day at one club or other, but he was a cautious
17863  player, and usually rose a winner.
17864  It came out in evidence that, in partnership with Colonel Moran, he had
17865  actually won as much as four hundred and twenty pounds in a sitting, some
17866  weeks before, from Godfrey Milner and Lord Balmoral.
17867  So much for his recent history as it came out at the inquest.
17868 \end_layout
17869
17870 \begin_layout Standard
17871 \begin_inset ERT
17872 status open
17873
17874 \begin_layout Plain Layout
17875
17876
17877 \backslash
17878 end{multicols}
17879 \end_layout
17880
17881 \end_inset
17882
17883
17884 \end_layout
17885
17886 \begin_layout Standard
17887 Please do read the file 
17888 \family typewriter
17889 examples/multicol.lyx
17890 \family default
17891  for more advanced examples including column and header spacing, vertical
17892  separator lines, and more.
17893 \end_layout
17894
17895 \begin_layout Section
17896 Numbering in the 
17897 \family sans
17898 Enumerate
17899 \family default
17900  Paragraph Environment
17901 \begin_inset OptArg
17902 status collapsed
17903
17904 \begin_layout Plain Layout
17905 Numbering in Enumerate
17906 \end_layout
17907
17908 \end_inset
17909
17910
17911 \end_layout
17912
17913 \begin_layout Standard
17914 by 
17915 \noun on
17916 John Weiss
17917 \end_layout
17918
17919 \begin_layout Standard
17920 \begin_inset VSpace bigskip
17921 \end_inset
17922
17923
17924 \end_layout
17925
17926 \begin_layout Standard
17927 \noindent
17928 The default numbering for the 
17929 \family sans
17930 Enumerate
17931 \family default
17932  paragraph environment begins with Arabic numbers and ends with uppercase
17933  letters.
17934  Suppose, however, you wanted a different type of numbering scheme.
17935  Here's a quickie example of how to change the numbering scheme:
17936 \end_layout
17937
17938 \begin_layout LyX-Code
17939
17940 \backslash
17941 renewcommand{
17942 \backslash
17943 labelenumi}{
17944 \backslash
17945 Roman{enumi}.}
17946 \end_layout
17947
17948 \begin_layout LyX-Code
17949
17950 \backslash
17951 renewcommand{
17952 \backslash
17953 labelenumii}{
17954 \backslash
17955 Alph{enumii}.}
17956 \end_layout
17957
17958 \begin_layout LyX-Code
17959
17960 \backslash
17961 renewcommand{
17962 \backslash
17963 labelenumiii}{
17964 \backslash
17965 arabic{enumiii}.}
17966 \end_layout
17967
17968 \begin_layout LyX-Code
17969
17970 \backslash
17971 renewcommand{
17972 \backslash
17973 labelenumiv}{
17974 \backslash
17975 alph{enumiv}.)}
17976 \end_layout
17977
17978 \begin_layout Standard
17979 \SpecialChar \ldots{}
17980  which changes the numbering scheme to uppercase Roman numerals, uppercase
17981  letters, Arabic numbers, and lowercase letter.
17982 \end_layout
17983
17984 \begin_layout Standard
17985 Additionally, the previous example also adds a little bit extra to the numbering
17986  scheme.
17987  For example, the first level label actually looks like: 
17988 \begin_inset Quotes eld
17989 \end_inset
17990
17991 I.
17992 \begin_inset Quotes erd
17993 \end_inset
17994
17995 .
17996  For ease of reading, we'll describe what the numbering schemes look like
17997  using a notation something like this: <
17998 \begin_inset Quotes eld
17999 \end_inset
18000
18001 I.
18002 \begin_inset Quotes erd
18003 \end_inset
18004
18005 ,
18006 \begin_inset space ~
18007 \end_inset
18008
18009
18010 \begin_inset Quotes erd
18011 \end_inset
18012
18013 A.
18014 \begin_inset Quotes erd
18015 \end_inset
18016
18017 ,
18018 \begin_inset space ~
18019 \end_inset
18020
18021
18022 \begin_inset Quotes erd
18023 \end_inset
18024
18025 1.
18026 \begin_inset Quotes erd
18027 \end_inset
18028
18029 ,
18030 \begin_inset space ~
18031 \end_inset
18032
18033
18034 \begin_inset Quotes eld
18035 \end_inset
18036
18037 a.)
18038 \begin_inset Quotes erd
18039 \end_inset
18040
18041 >.
18042  
18043 \end_layout
18044
18045 \begin_layout Standard
18046 As you can see in the example, there is a label command for each nesting
18047  level, 
18048 \family typewriter
18049
18050 \backslash
18051 labelenumi
18052 \family default
18053  \SpecialChar \ldots{}
18054  
18055 \family typewriter
18056
18057 \backslash
18058 labelenumiv
18059 \family default
18060 , as well as a counter, 
18061 \family typewriter
18062 enumi
18063 \family default
18064  \SpecialChar \ldots{}
18065  
18066 \family typewriter
18067 enumiv
18068 \family default
18069 .
18070  There are also five 
18071 \begin_inset Quotes eld
18072 \end_inset
18073
18074 number printing
18075 \begin_inset Quotes erd
18076 \end_inset
18077
18078  commands, 
18079 \family typewriter
18080
18081 \backslash
18082 arabic{}
18083 \family default
18084
18085 \family typewriter
18086
18087 \backslash
18088 roman{}
18089 \family default
18090
18091 \family typewriter
18092
18093 \backslash
18094 Roman{}
18095 \family default
18096
18097 \family typewriter
18098
18099 \backslash
18100 alph{}
18101 \family default
18102 , and 
18103 \family typewriter
18104
18105 \backslash
18106 Alph{}
18107 \family default
18108 , each of which take one counter as an argument.
18109  You can add characters before or after these, but there's no need to add
18110  spaces.
18111 \end_layout
18112
18113 \begin_layout Standard
18114 You can get really fancy with these.
18115  For example:
18116 \end_layout
18117
18118 \begin_layout LyX-Code
18119
18120 \backslash
18121 renewcommand{
18122 \backslash
18123 labelenumi}{
18124 \backslash
18125 #
18126 \backslash
18127 Alph{enumi}
18128 \backslash
18129 #}
18130 \end_layout
18131
18132 \begin_layout LyX-Code
18133
18134 \backslash
18135 renewcommand{
18136 \backslash
18137 labelenumii}{
18138 \backslash
18139 Alph{enumi}.
18140 \backslash
18141 arabic{enumii}}
18142 \end_layout
18143
18144 \begin_layout LyX-Code
18145
18146 \backslash
18147 renewcommand{
18148 \backslash
18149 labelenumiii}{
18150 \backslash
18151 alph{enumiii}+}
18152 \end_layout
18153
18154 \begin_layout LyX-Code
18155
18156 \backslash
18157 renewcommand{
18158 \backslash
18159 labelenumiv}{(
18160 \backslash
18161 roman{enumiv})}
18162 \end_layout
18163
18164 \begin_layout Standard
18165 produces the somewhat out of hand numbering scheme: <
18166 \begin_inset Quotes eld
18167 \end_inset
18168
18169 #A#
18170 \begin_inset Quotes erd
18171 \end_inset
18172
18173 ,
18174 \begin_inset space ~
18175 \end_inset
18176
18177
18178 \begin_inset Quotes erd
18179 \end_inset
18180
18181 A.1
18182 \begin_inset Quotes erd
18183 \end_inset
18184
18185 ,
18186 \begin_inset space ~
18187 \end_inset
18188
18189
18190 \begin_inset Quotes erd
18191 \end_inset
18192
18193 a+
18194 \begin_inset Quotes erd
18195 \end_inset
18196
18197 ,
18198 \begin_inset space ~
18199 \end_inset
18200
18201
18202 \begin_inset Quotes eld
18203 \end_inset
18204
18205 (i)
18206 \begin_inset Quotes erd
18207 \end_inset
18208
18209 >.
18210  
18211 \end_layout
18212
18213 \begin_layout Standard
18214
18215 \end_layout
18216
18217 \begin_layout Section
18218 Dropped Capitals
18219 \end_layout
18220
18221 \begin_layout Standard
18222 by 
18223 \noun on
18224 Mike Ressler
18225 \end_layout
18226
18227 \begin_layout Standard
18228 \begin_inset VSpace bigskip
18229 \end_inset
18230
18231
18232 \end_layout
18233
18234 \begin_layout Standard
18235 \noindent
18236 \begin_inset ERT
18237 status collapsed
18238
18239 \begin_layout Plain Layout
18240
18241
18242 \backslash
18243 newfont{
18244 \backslash
18245 tmpfont}{cmr17 scaled 2500}{
18246 \backslash
18247 tmpfont T}
18248 \backslash
18249 vspace*{-8.4ex}
18250 \end_layout
18251
18252 \end_inset
18253
18254
18255 \end_layout
18256
18257 \begin_layout Standard
18258 \noindent
18259 \begin_inset ERT
18260 status open
18261
18262 \begin_layout Plain Layout
18263
18264
18265 \backslash
18266 hangindent=3.3em 
18267 \backslash
18268 hangafter=-3
18269 \end_layout
18270
18271 \end_inset
18272
18273  hose of you who like the style of old books probably also like 
18274 \begin_inset Quotes eld
18275 \end_inset
18276
18277 dropped capitals
18278 \begin_inset Quotes erd
18279 \end_inset
18280
18281 ---those large capital letters which begin each new chapter or section.
18282  Implementing them with plain LyX/LaTeX is straightforward (assuming you
18283  know some plain TeX!) but does require a lot of work and many iterations,
18284  as you can see by all the ugly TeX-mode stuff at the beginning of this
18285  paragraph.
18286 \end_layout
18287
18288 \begin_layout Standard
18289 \begin_inset ERT
18290 status open
18291
18292 \begin_layout Plain Layout
18293
18294
18295 \backslash
18296 verb+
18297 \backslash
18298 bigdrop{-1em}{3}{ptmri}{T}+
18299 \end_layout
18300
18301 \end_inset
18302
18303 here is a much easier way of doing this, of course.
18304  The 
18305 \family typewriter
18306 dropcaps
18307 \family default
18308  (or the newer 
18309 \family typewriter
18310 dropping
18311 \family default
18312 ) package from CTAN allows a simple way to add such letters to your documents.
18313  Since this package is not a standard part of teTeX, I can't demonstrate
18314  it within this document, but if you copy this paragraph to a new document,
18315  delete the 
18316 \begin_inset Quotes eld
18317 \end_inset
18318
18319
18320 \family typewriter
18321
18322 \backslash
18323 verb
18324 \family default
18325
18326 \begin_inset Quotes erd
18327 \end_inset
18328
18329  and the pluses from the TeX code at the beginning of the paragraph, and
18330  add 
18331 \family typewriter
18332
18333 \backslash
18334 usepackage{dropcaps}
18335 \family default
18336  to your LaTeX preamble, you will get a nice Times Roman Italic 
18337 \begin_inset Quotes eld
18338 \end_inset
18339
18340 T
18341 \begin_inset Quotes erd
18342 \end_inset
18343
18344 , whose height is three lines of text and which protrudes 1 em into the
18345  margin.
18346  (Make certain you have copied 
18347 \begin_inset Quotes eld
18348 \end_inset
18349
18350
18351 \family typewriter
18352 dropcaps.sty
18353 \family default
18354
18355 \begin_inset Quotes erd
18356 \end_inset
18357
18358  into a directory where TeX can see it.) The first argument is the amount
18359  of indentation; in this case the negative sign moves it into the margin.
18360  The second argument is the height of the letter in number of lines of text.
18361  The third argument is the font name: virtually anything which has a tfm
18362  file should work (wade through the 
18363 \family typewriter
18364 .../texmf/fonts/tfm
18365 \family default
18366  directory for possibilities).
18367  My personal favorite is 
18368 \begin_inset Quotes eld
18369 \end_inset
18370
18371
18372 \family typewriter
18373 yinit
18374 \family default
18375
18376 \begin_inset Quotes erd
18377 \end_inset
18378
18379 , a fancy German font specifically designed for dropped capitals.
18380  The fourth argument is the letter (or letters) to be dropped.
18381  The 
18382 \family typewriter
18383 dropping
18384 \family default
18385  package also offers the 
18386 \family typewriter
18387
18388 \backslash
18389 bigdrop
18390 \family default
18391  command, as well as a slightly simplified 
18392 \family typewriter
18393
18394 \backslash
18395 dropping
18396 \family default
18397  command.
18398 \end_layout
18399
18400 \begin_layout Section
18401 Non-standard Paragraph Shapes
18402 \end_layout
18403
18404 \begin_layout Standard
18405 by 
18406 \noun on
18407 Mike Ressler
18408 \end_layout
18409
18410 \begin_layout Standard
18411 \begin_inset VSpace bigskip
18412 \end_inset
18413
18414
18415 \end_layout
18416
18417 \begin_layout Standard
18418 \begin_inset ERT
18419 status collapsed
18420
18421 \begin_layout Plain Layout
18422
18423
18424 \backslash
18425 begin{sloppypar}
18426 \end_layout
18427
18428 \end_inset
18429
18430
18431 \end_layout
18432
18433 \begin_layout Standard
18434 \begin_inset ERT
18435 status collapsed
18436
18437 \begin_layout Plain Layout
18438
18439
18440 \backslash
18441 newdimen
18442 \backslash
18443 varunit 
18444 \end_layout
18445
18446 \begin_layout Plain Layout
18447
18448
18449 \backslash
18450 setlength{
18451 \backslash
18452 varunit}{4.5in}
18453 \end_layout
18454
18455 \end_inset
18456
18457
18458 \end_layout
18459
18460 \begin_layout Standard
18461 \noindent
18462 \begin_inset ERT
18463 status collapsed
18464
18465 \begin_layout Plain Layout
18466
18467
18468 \backslash
18469 parshape 19 0.45
18470 \backslash
18471 varunit 0.332
18472 \backslash
18473 varunit
18474 \end_layout
18475
18476 \begin_layout Plain Layout
18477
18478 0.40
18479 \backslash
18480 varunit 0.300
18481 \backslash
18482 varunit
18483 \end_layout
18484
18485 \begin_layout Plain Layout
18486
18487 0.35
18488 \backslash
18489 varunit 0.293
18490 \backslash
18491 varunit
18492 \end_layout
18493
18494 \begin_layout Plain Layout
18495
18496 0.30
18497 \backslash
18498 varunit 0.300
18499 \backslash
18500 varunit
18501 \end_layout
18502
18503 \begin_layout Plain Layout
18504
18505 0.25
18506 \backslash
18507 varunit 0.317
18508 \backslash
18509 varunit
18510 \end_layout
18511
18512 \begin_layout Plain Layout
18513
18514 0.20
18515 \backslash
18516 varunit 0.342
18517 \backslash
18518 varunit
18519 \end_layout
18520
18521 \begin_layout Plain Layout
18522
18523 0.15
18524 \backslash
18525 varunit 0.373
18526 \backslash
18527 varunit
18528 \end_layout
18529
18530 \begin_layout Plain Layout
18531
18532 0.10
18533 \backslash
18534 varunit 0.410
18535 \backslash
18536 varunit
18537 \end_layout
18538
18539 \begin_layout Plain Layout
18540
18541 0.05
18542 \backslash
18543 varunit 0.453
18544 \backslash
18545 varunit
18546 \end_layout
18547
18548 \begin_layout Plain Layout
18549
18550 0.00
18551 \backslash
18552 varunit 0.500
18553 \backslash
18554 varunit
18555 \end_layout
18556
18557 \begin_layout Plain Layout
18558
18559 0.05
18560 \backslash
18561 varunit 0.453
18562 \backslash
18563 varunit
18564 \end_layout
18565
18566 \begin_layout Plain Layout
18567
18568 0.10
18569 \backslash
18570 varunit 0.410
18571 \backslash
18572 varunit
18573 \end_layout
18574
18575 \begin_layout Plain Layout
18576
18577 0.15
18578 \backslash
18579 varunit 0.373
18580 \backslash
18581 varunit
18582 \end_layout
18583
18584 \begin_layout Plain Layout
18585
18586 0.20
18587 \backslash
18588 varunit 0.342
18589 \backslash
18590 varunit
18591 \end_layout
18592
18593 \begin_layout Plain Layout
18594
18595 0.25
18596 \backslash
18597 varunit 0.317
18598 \backslash
18599 varunit
18600 \end_layout
18601
18602 \begin_layout Plain Layout
18603
18604 0.30
18605 \backslash
18606 varunit 0.300
18607 \backslash
18608 varunit
18609 \end_layout
18610
18611 \begin_layout Plain Layout
18612
18613 0.35
18614 \backslash
18615 varunit 0.293
18616 \backslash
18617 varunit
18618 \end_layout
18619
18620 \begin_layout Plain Layout
18621
18622 0.40
18623 \backslash
18624 varunit 0.300
18625 \backslash
18626 varunit
18627 \end_layout
18628
18629 \begin_layout Plain Layout
18630
18631 0.45
18632 \backslash
18633 varunit 0.332
18634 \backslash
18635 varunit
18636 \end_layout
18637
18638 \begin_layout Plain Layout
18639
18640 \end_layout
18641
18642 \end_inset
18643
18644 There are times when the tyranny of rectangular paragraphs must be overthrown.
18645  In such situations, a call to the delightful plain TeX command 
18646 \family typewriter
18647
18648 \backslash
18649 parshape
18650 \family default
18651  is called for.
18652  As you can see, completely arbitrary shapes can be laid out with a suitable
18653  set of linelength definitions.
18654  While this parshape may look a bit silly and useless, one could conceive
18655  of situations such as finely tuned dropped capitals, word wrapping around
18656  non-rectangular graphics, etc.
18657  which will benefit from such handcrafting.
18658 \end_layout
18659
18660 \begin_layout Standard
18661 \begin_inset VSpace bigskip
18662 \end_inset
18663
18664
18665 \end_layout
18666
18667 \begin_layout Standard
18668 The syntax is 
18669 \family typewriter
18670
18671 \backslash
18672 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
18673  #nindent #nlength
18674 \family default
18675 , where 
18676 \family typewriter
18677 numlines
18678 \family default
18679  is the number of lines of text which define the paragraph.
18680  If there turn out to be fewer lines, the shape is truncated; if there are
18681  more, the excess lines have the same dimensions as the last line of the
18682  definition.
18683  The 
18684 \family typewriter
18685 #nindent
18686 \family default
18687  and 
18688 \family typewriter
18689 #nlength
18690 \family default
18691  entries specify the indentation of the line from the left margin, and the
18692  length of the line as measured from that point.
18693  The shape applies only to the current paragraph; everything is reset to
18694  normal for the next paragraph.
18695 \end_layout
18696
18697 \begin_layout Standard
18698 \begin_inset ERT
18699 status collapsed
18700
18701 \begin_layout Plain Layout
18702
18703
18704 \backslash
18705 end{sloppypar}
18706 \end_layout
18707
18708 \end_inset
18709
18710
18711 \end_layout
18712
18713 \begin_layout Section
18714 Summary
18715 \end_layout
18716
18717 \begin_layout Standard
18718 As you can see, the examples in this section range from the useful to the
18719  whimsical.
18720  While I don't expect that anyone will ever need the paragraph shape demonstrate
18721 d in the last section, the important point is that you can do almost anything
18722  you want in LyX if you are willing to figure out how to do it in TeX and
18723  LaTeX.
18724  TeX is a fantastically powerful typesetting system and all that power is
18725  available to you since LyX uses it as its backend.
18726  Happy LyXing!
18727 \end_layout
18728
18729 \end_body
18730 \end_document