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