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