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