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