]> git.lyx.org Git - lyx.git/blob - lib/doc/Extended.lyx
2006-06-01 Panayotis Papasotiriou <papasot@physics.upatras.gr>
[lyx.git] / lib / doc / Extended.lyx
1 #LyX 1.4.2svn created this file. For more info see http://www.lyx.org/
2 \lyxformat 245
3 \begin_document
4 \begin_header
5 \textclass book
6 \begin_preamble
7 \usepackage{multicol}
8 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
9 \end_preamble
10 \language english
11 \inputencoding latin1
12 \fontscheme default
13 \graphics default
14 \paperfontsize default
15 \spacing single
16 \papersize default
17 \use_geometry false
18 \use_amsmath 0
19 \cite_engine basic
20 \use_bibtopic false
21 \paperorientation portrait
22 \secnumdepth 3
23 \tocdepth 3
24 \paragraph_separation indent
25 \defskip medskip
26 \quotes_language english
27 \papercolumns 1
28 \papersides 2
29 \paperpagestyle headings
30 \tracking_changes false
31 \output_changes true
32 \end_header
33
34 \begin_body
35
36 \begin_layout Title
37 Extended LyX Features
38 \end_layout
39
40 \begin_layout Author
41 by the LyX Team
42 \begin_inset Foot
43 status collapsed
44
45 \begin_layout Standard
46 \noindent
47 Principal maintainer of this file is
48 \noun on
49  Mike Ressler
50 \noun default
51 .
52  If you have comments or error corrections, please send them to the LyX
53  Documentation mailing list, <lyx-docs@lists.lyx.org>.
54 \end_layout
55
56 \end_inset
57
58  
59 \end_layout
60
61 \begin_layout Standard
62 \begin_inset LatexCommand \tableofcontents{}
63
64 \end_inset
65
66
67 \end_layout
68
69 \begin_layout Chapter
70 Introduction
71 \end_layout
72
73 \begin_layout Standard
74 The 
75 \emph on
76 Extended LyX Features
77 \emph default
78  manual, which you are now reading, is essentially Part II of the 
79 \emph on
80 User's Guide\SpecialChar \@.
81
82 \emph default
83  The reason for splitting this document is simple: the 
84 \emph on
85 User's Guide
86 \emph default
87  is already huge, and it contains all of the basic features one needs to
88  know in order to prepare most documents.
89  However, the LyX Team has a long-term goal of making LyX extensible through
90  various configuration files and external packages.
91  That means that if you want to support the Fizzwizzle LaTeX package, you
92  can create a layout file for it without having to alter LyX itself.
93  We've already had contributions of several new features this way.
94  This is the place where all of that gets documented.
95 \end_layout
96
97 \begin_layout Standard
98 This manual also documents some special features, like fax support, version
99  control, and SGML support, which require additional software to work properly.
100  Lastly, there's a chapter of LaTeX tools and tips, things you can use to
101  spruce up your documents by directly using the powerful features of LaTeX.
102  After all, LyX 
103 \emph on
104 is
105 \emph default
106  only WYSIWYM, and will only ever interface to certain LaTeX features.
107 \end_layout
108
109 \begin_layout Standard
110 Of course, with all of this extra documentation, 
111 \emph on
112 Extended LyX Features
113 \emph default
114  may itself grow too big for its britches.
115  In that case, you can just call it the 
116 \begin_inset Quotes eld
117 \end_inset
118
119 Overextended Manual
120 \begin_inset Quotes erd
121 \end_inset
122
123  for fun!
124 \end_layout
125
126 \begin_layout Standard
127 If you haven't read the 
128 \emph on
129 Introduction 
130 \emph default
131 yet, you are definitely in the wrong manual.
132  The 
133 \emph on
134 Introduction
135 \emph default
136  is the first place to go, since it will direct you to the correct manual,
137  and it also describes the notation and format of all of the manuals.
138  You should also be thoroughly familiar with the 
139 \emph on
140 User's Guide
141 \emph default
142  and all of the basic features of LyX.
143  
144 \end_layout
145
146 \begin_layout Standard
147 In this document, many sections are independent articles contributed by
148  an individual and are noted as such.
149  This person is generally whoever wrote the layout file for the new document
150  class or LaTeX package, or implemented the feature.
151  If there is no mention of an author to a chapter [or chapter sections],
152  that means it was written by the LyX Documentation Team.
153 \end_layout
154
155 \begin_layout Standard
156 Since all the topics in this manual depend heavily on LyX's interaction
157  with LaTeX, this first chapter covers
158 \emph on
159  
160 \emph default
161 the inner workings of LyX and how to direct LyX to generate exactly the
162  LaTeX code you want.
163  It is obviously for more seasoned LyX users.
164 \end_layout
165
166 \begin_layout Chapter
167 LyX and LaTeX
168 \end_layout
169
170 \begin_layout Section
171 How LyX Uses LaTeX
172 \end_layout
173
174 \begin_layout Standard
175 \begin_inset LatexCommand \label{sec:lyxandlatex}
176
177 \end_inset
178
179 This chapter is for both TeX-nicians and the LaTeX-curious.
180  In it, we'll explain how LyX and LaTeX work together to produce printable
181  output.
182  This is the only place in any of the manuals where we assume you know something
183  about LaTeX.
184 \end_layout
185
186 \begin_layout Standard
187 At one time, we called LyX a 
188 \begin_inset Quotes eld
189 \end_inset
190
191 WYSIWYM frontend to LaTeX,
192 \begin_inset Quotes erd
193 \end_inset
194
195  but that's no longer true.
196  There are frontends to LaTeX out there.
197  They are basically editors with the ability to run LaTeX and mark any errors
198  in the file you're editing.
199  Although LyX 
200 \emph on
201 is
202 \emph default
203  an editor, and it 
204 \emph on
205 does
206 \emph default
207  run LaTeX, and it also marks errors in the file, it also does much, much
208  more.
209  Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
210  LyX has also added a few extensions to LaTeX.
211  Try the following sometime: select 
212 \family sans
213 Export\SpecialChar \menuseparator
214 LaTeX
215 \family default
216  from the 
217 \family sans
218 \bar under
219 F
220 \bar default
221 ile
222 \family default
223  menu, then look at the preamble of the resulting 
224 \family typewriter
225 .tex
226 \family default
227  file.
228  You'll notice a variety of new macros defined specifically by LyX.
229  These macros are defined automatically, according to the features you use
230  in the document.
231 \end_layout
232
233 \begin_layout Standard
234 There are several commands that automatically invoke LaTeX.
235  They are:
236 \end_layout
237
238 \begin_layout Itemize
239
240 \family sans
241 \bar under
242 V
243 \bar default
244 iew\SpecialChar \menuseparator
245 View\InsetSpace ~
246
247 \emph on
248 Format
249 \end_layout
250
251 \begin_layout Itemize
252
253 \family sans
254 \bar under
255 V
256 \bar default
257 iew\SpecialChar \menuseparator
258
259 \bar under
260 U
261 \bar default
262 pdate\SpecialChar \menuseparator
263
264 \emph on
265 Format
266 \end_layout
267
268 \begin_layout Itemize
269
270 \family sans
271 \bar under
272 F
273 \bar default
274 ile
275 \bar under
276 \SpecialChar \menuseparator
277 P
278 \bar default
279 rint
280 \end_layout
281
282 \begin_layout Itemize
283
284 \family sans
285 \bar under
286 F
287 \bar default
288 ile
289 \bar under
290 \SpecialChar \menuseparator
291 F
292 \bar default
293 ax
294 \end_layout
295
296 \begin_layout Standard
297 They will only invoke LaTeX if the file has changed since the last time
298  LaTeX was run.
299  
300 \end_layout
301
302 \begin_layout Standard
303 When you run LaTeX on the file you're editing, LyX performs these steps:
304 \end_layout
305
306 \begin_layout Enumerate
307 Convert the document to LaTeX and save to a file with the extension 
308 \family typewriter
309 .tex
310 \family default
311  in place of 
312 \family typewriter
313 .lyx
314 \family default
315 .
316 \end_layout
317
318 \begin_layout Enumerate
319 Run LaTeX on the 
320 \family typewriter
321 .tex
322 \family default
323  file (maybe several times).
324 \end_layout
325
326 \begin_layout Enumerate
327 If there are any errors, insert error boxes in the document to mark where
328  they are.
329  These boxes are transient and are not saved along with the document.
330 \end_layout
331
332 \begin_layout Standard
333 If you've run LaTeX using 
334 \family sans
335 View\InsetSpace ~
336 DVI
337 \family default
338 , LyX then executes 
339 \family typewriter
340 xdvi
341 \family default
342  on the Dvi file.
343  If you've used 
344 \family sans
345 View\InsetSpace ~
346 PostScript
347 \family default
348  or 
349 \family sans
350 \bar under
351 P
352 \bar default
353 rint
354 \family default
355 , LyX performs two more steps:
356 \end_layout
357
358 \begin_layout Itemize
359 Run 
360 \family typewriter
361 dvips
362 \family default
363  to convert the Dvi file to PostScript®:
364 \end_layout
365
366 \begin_deeper
367 \begin_layout Itemize
368 For 
369 \family sans
370 View\InsetSpace ~
371 PostScript
372 \family default
373 , the output file has the extension 
374 \family typewriter
375 .ps_tmp
376 \end_layout
377
378 \begin_layout Itemize
379 For 
380 \family sans
381 \bar under
382 P
383 \bar default
384 rint
385 \family default
386 \InsetSpace ~
387 , the output file has the extension 
388 \family typewriter
389 .ps
390 \family default
391 , as expected.
392 \end_layout
393
394 \end_deeper
395 \begin_layout Itemize
396 Execute 
397 \family typewriter
398 ghostview
399 \family default
400  or send the PostScript® file to the printer.
401 \end_layout
402
403 \begin_layout Section
404 \begin_inset Quotes eld
405 \end_inset
406
407 Help! LyX generated an unreadable 
408 \family typewriter
409 .tex
410 \family default
411  file!
412 \begin_inset Quotes erd
413 \end_inset
414
415
416 \end_layout
417
418 \begin_layout Standard
419 Die-hard LaTeX users will scream and howl this into the night, then declare
420  LyX useless, simply because they didn't RTFM.
421 \end_layout
422
423 \begin_layout Standard
424 We're going to set the record straight.
425  LyX produces two kinds of LaTeX files.
426  One is human readable.
427  The other is LyX readable.
428  Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
429  scan for errors.
430  The resulting 
431 \family typewriter
432 .tex
433 \family default
434  file is not human readable.
435  Don't even try to read it.
436  If you want a 
437 \family typewriter
438 .tex
439 \family default
440  file that you can send to a colleague, select 
441 \family sans
442 \bar under
443 E
444 \bar default
445 xport\SpecialChar \menuseparator
446
447 \bar under
448 L
449 \bar default
450 aTeX
451 \family default
452  from the 
453 \family sans
454 \bar under
455 F
456 \bar default
457 ile
458 \family default
459  menu.
460 \end_layout
461
462 \begin_layout Section
463 Translating LaTeX files into LyX
464 \end_layout
465
466 \begin_layout Standard
467 You can import a LaTeX file into LyX by using the 
468 \family sans
469 \bar under
470 F
471 \bar default
472 ile\SpecialChar \menuseparator
473
474 \bar under
475 I
476 \bar default
477 mport\SpecialChar \menuseparator
478
479 \bar under
480 L
481 \bar default
482 aTeX
483 \family default
484  command in LyX.
485  This will call a Perl script named 
486 \family typewriter
487 reLyX
488 \family default
489 ---which will create a file 
490 \family typewriter
491 foo.lyx
492 \family default
493  from the file 
494 \family typewriter
495 foo.tex
496 \family default
497 ---and then open that file.
498  If the translation doesn't work, you can try calling 
499 \family typewriter
500 reLyX
501 \family default
502  from the command line, possibly using fancier options.
503 \end_layout
504
505 \begin_layout Standard
506
507 \family typewriter
508 reLyX
509 \family default
510  will translate most legal LaTeX, but not everything.
511  It will leave things it doesn't understand in TeX mode, so after translating
512  a file with 
513 \family typewriter
514 reLyX
515 \family default
516 , you can look for red text and hand-edit it to look right.
517 \end_layout
518
519 \begin_layout Standard
520
521 \family typewriter
522 reLyX
523 \family default
524  has its own section in the 
525 \emph on
526 Extended Features
527 \emph default
528  manual (as well as a Unix manpage equivalent), which you should read to
529  find out about what LaTeX isn't supported, bugs (and how to get around
530  them), and how to use the various options.
531 \end_layout
532
533 \begin_layout Standard
534 If you can't get 
535 \family typewriter
536 reLyX
537 \family default
538  to work, or you just want to put a piece of LaTeX code into a LyX file,
539  see Section
540 \begin_inset LatexCommand \ref{sec:latexcodes}
541
542 \end_inset
543
544 .
545 \end_layout
546
547 \begin_layout Section
548 Inserting LaTeX Code into LyX Documents 
549 \begin_inset LatexCommand \label{sec:Inserting-LaTeX-Code}
550
551 \end_inset
552
553
554 \end_layout
555
556 \begin_layout Standard
557 \begin_inset LatexCommand \label{sec:latexcodes}
558
559 \end_inset
560
561  This is a rather important point: You can always insert LaTeX code into
562  any LyX document.
563  LyX simply cannot, and will probably never be able to, display every possible
564  LaTeX construct.
565  If ever you need to insert LaTeX commands into your LyX document, you can
566  use the ERT box, which you can insert into your document with 
567 \family sans
568 \bar under
569 I
570 \bar default
571 nsert\SpecialChar \menuseparator
572
573 \bar under
574 T
575 \bar default
576 eX
577 \family default
578 .
579  The ERT box comes in three forms: collapsed, open, and inlined.
580  The first two are used just like any other collapsable (foldable) box (such
581  as footnotes), and are useful for significant amounts of LaTeX commands.
582  An 
583 \begin_inset Quotes eld
584 \end_inset
585
586 inlined
587 \begin_inset Quotes erd
588 \end_inset
589
590  ERT box displays its content as part of the button, and is useful for very
591  short sections of LaTeX commands.
592  
593 \begin_inset ERT
594 status inlined
595
596 \begin_layout Standard
597
598 % like this
599 \end_layout
600
601 \end_inset
602
603
604 \end_layout
605
606 \begin_layout Standard
607 You can switch between all three by right-clicking on the ERT.
608  Note that if you want more than one line of LaTeX commands, you cannot
609  use the inlined mode.
610 \end_layout
611
612 \begin_layout Standard
613 Here's an example of inserting LaTeX commands in a LyX document.
614  The code looks like this:
615 \end_layout
616
617 \begin_layout LyX-Code
618
619 \backslash
620 begin{tabular}{ll}
621 \newline
622
623 \backslash
624 begin{minipage}{5cm}
625 \newline
626 This is an example for a minipage environment.
627  You 
628 \newline
629 can put nearly everything in it, even (non-floating) 
630 \newline
631 figures and tables.
632  
633 \newline
634
635 \backslash
636 end{minipage}
637 \newline
638 &
639 \newline
640
641 \backslash
642 begin{minipage}{5cm}
643 \newline
644
645 \backslash
646 begin{verbatim}
647 \newline
648
649 \backslash
650 begin{minipage}{5cm}
651 \newline
652 This ...
653  
654 \newline
655
656 \backslash
657 end{minipage}
658 \newline
659
660 \backslash
661 end{verbatim}
662 \newline
663
664 \backslash
665 end{minipage}
666 \newline
667
668 \backslash
669 end{tabular}
670 \end_layout
671
672 \begin_layout LyX-Code
673
674 \end_layout
675
676 \begin_layout Standard
677 The ERT box containing this text is directly after this paragraph.
678  Those of you reading the manual online will only see a bunch of funky text
679  in red.
680  Those reading a printed version of the manuals will see the actual results:
681 \end_layout
682
683 \begin_layout Standard
684 \begin_inset ERT
685 status collapsed
686
687 \begin_layout Standard
688
689
690 \backslash
691 begin{tabular}{ll}
692 \end_layout
693
694 \begin_layout Standard
695
696
697 \backslash
698 begin{minipage}{5cm}
699 \end_layout
700
701 \begin_layout Standard
702
703 This is an example for a minipage environment.
704  You can put nearly everything in it, even (non-floating) figures and tables.
705  
706 \end_layout
707
708 \begin_layout Standard
709
710
711 \backslash
712 end{minipage}
713 \end_layout
714
715 \begin_layout Standard
716
717 &
718 \end_layout
719
720 \begin_layout Standard
721
722
723 \backslash
724 begin{minipage}{5cm}
725 \end_layout
726
727 \begin_layout Standard
728
729
730 \backslash
731 begin{verbatim}
732 \end_layout
733
734 \begin_layout Standard
735
736
737 \backslash
738 begin{minipage}{5cm}
739 \end_layout
740
741 \begin_layout Standard
742
743 This ...
744  
745 \end_layout
746
747 \begin_layout Standard
748
749
750 \backslash
751 end{minipage}
752 \end_layout
753
754 \begin_layout Standard
755
756
757 \backslash
758 end{verbatim}
759 \end_layout
760
761 \begin_layout Standard
762
763
764 \backslash
765 end{minipage}
766 \end_layout
767
768 \begin_layout Standard
769
770
771 \backslash
772 end{tabular}
773 \end_layout
774
775 \end_inset
776
777
778 \end_layout
779
780 \begin_layout Standard
781 In addition to these two methods, you can also create a separate file containing
782  some complex LaTeX structure.
783  You can then use 
784 \family sans
785 \bar under
786 I
787 \bar default
788 nsert\SpecialChar \menuseparator
789 Chil
790 \bar under
791 d
792 \bar default
793 \InsetSpace ~
794 Document
795 \family default
796  to include your file (you should select the type 
797 \family sans
798 Input
799 \family default
800 ).
801  We recommend that you only do this if you have a 
802 \family typewriter
803 .tex
804 \family default
805  file which you 
806 \emph on
807 know
808 \emph default
809  works already.
810  Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
811
812 \end_layout
813
814 \begin_layout Standard
815 There are a few last notes to emphasize:
816 \end_layout
817
818 \begin_layout Itemize
819 Inside of LyX, LaTeX code appears 
820 \emph on
821 in red
822 \end_layout
823
824 \begin_layout Itemize
825 LyX 
826 \emph on
827 does not
828 \emph default
829  check if your LaTeX code is correct.
830 \end_layout
831
832 \begin_layout Itemize
833 Beware reinventing the wheel.
834 \end_layout
835
836 \begin_layout Standard
837 That last note refers to two things.
838  First, LyX does have quite a few features tucked into it, and more are
839  coming.
840  Be sure to check the manuals to make sure that LyX doesn't have such-and-such
841  feature before you go off merrily coding LaTeX.
842  Second, there are numerous LaTeX packages out there to do all sorts of
843  things, from labels to envelopes to fancy multipage tables.
844  Check out a CTAN site for details (see Section 
845 \begin_inset Quotes eld
846 \end_inset
847
848 Requirements
849 \begin_inset Quotes erd
850 \end_inset
851
852  of the 
853 \emph on
854 User's Guide
855 \emph default
856 ).
857 \begin_inset Foot
858 status open
859
860 \begin_layout Standard
861 Note from 
862 \noun on
863 John Weiss
864 \noun default
865 : I seem to do this an awful lot.
866  Sat down and merrily began coding something to print out labels, only to
867  learn that there were already 2 different LaTeX packages to do this.
868  Worse yet --- I had them already!
869 \end_layout
870
871 \end_inset
872
873
874 \end_layout
875
876 \begin_layout Standard
877 If you do need to do some wild and fancy things within your document, be
878  sure to check out a good LaTeX book for assistance.
879  There are a number of them listed in the bibliography of the 
880 \emph on
881 User's Guide
882 \emph default
883 .
884 \end_layout
885
886 \begin_layout Standard
887 There are a number of LaTeX commands which have to be placed before the
888  beginning of the actual text.
889  They go into the preamble, and this is explained in the next section.
890 \end_layout
891
892 \begin_layout Section
893 LyX and the LaTeX Preamble
894 \end_layout
895
896 \begin_layout Subsection
897 About the LaTeX Preamble
898 \end_layout
899
900 \begin_layout Standard
901 \begin_inset LatexCommand \label{sec:preamble}
902
903 \end_inset
904
905 If you already know LaTeX, there is no need to explain here what the preamble
906  is good for.
907  If you don't, the following will give you some ideas --- we recommend again
908  that you consult a LaTeX book for further information.
909  In any case, you should read the points below, because they explain what
910  you can do and what you don't need to do in the LaTeX preamble of a LyX
911  document.
912 \end_layout
913
914 \begin_layout Standard
915 The LaTeX preamble comes at the very beginning of a document, 
916 \emph on
917 before 
918 \emph default
919 the text.
920  It serves to:
921 \end_layout
922
923 \begin_layout Itemize
924 declare the document class.
925  LyX already does this for you.
926 \end_layout
927
928 \begin_deeper
929 \begin_layout Standard
930 If you're a seasoned LaTeX-nician, and you have some custom document class
931  you want to use, check out the 
932 \emph on
933 Customization Manual
934 \emph default
935  for information on how to make LyX interface to it.
936  Be sure to submit your efforts to the LyX Team for inclusion in future
937  versions!
938 \end_layout
939
940 \end_deeper
941 \begin_layout Itemize
942 declare the usage of packages.
943  LaTeX packages provide special commands, which are only available within
944  a document when the package has been declared in the preamble.
945  For example, the
946 \family typewriter
947  
948 \family default
949 package 
950 \family typewriter
951 indentfirst
952 \family default
953  forces all paragraphs to be indented.
954  There are other packages for labels, envelopes, margins, etc.
955  
956 \end_layout
957
958 \begin_layout Itemize
959 set counters, variables, lengths and widths.
960  There are several LaTeX counters and variables which 
961 \emph on
962 must
963 \emph default
964  be set globally from within the preamble in order to have the desired effect.
965  [There are other variables which you can set and reset inside the document,
966  too.] Margins are a good example of something which must be set in the preamble.
967  Another example is the label format for lists.
968  You can actually set these just about anywhere, but it's best to do it
969  just once, inside the preamble.
970 \end_layout
971
972 \begin_layout Itemize
973 declare user defined commands [with 
974 \family typewriter
975
976 \backslash
977 newcommand 
978 \family default
979 or 
980 \family typewriter
981
982 \backslash
983 renewcommand
984 \family default
985 ], mostly abbreviations for LaTeX commands which appear very often inside
986  a document.
987  Although the preamble is a good place to declare such commands, they 
988 \emph on
989 can
990 \emph default
991  be declared anywhere else [but 
992 \emph on
993 before
994 \emph default
995  they are used for the first time, of course\SpecialChar \ldots{}
996 ].
997  This can be useful if there is a lot of raw LaTeX code in your document,
998  which normally should not be the case.
999 \end_layout
1000
1001 \begin_layout Standard
1002 LyX adds its own set of definitions to the preamble of the 
1003 \family typewriter
1004 .tex
1005 \family default
1006  file it produces.
1007  This makes LaTeX files generated by LyX portable.
1008 \end_layout
1009
1010 \begin_layout Subsection
1011 Changing the Preamble
1012 \end_layout
1013
1014 \begin_layout Standard
1015 The commands which LyX adds to the preamble of a LaTeX file are fixed; you
1016  can't change them without patching LyX itself.
1017  You can, however, add your own stuff to the preamble.
1018  There are two ways to do this:
1019 \end_layout
1020
1021 \begin_layout Enumerate
1022 Select 
1023 \family sans
1024 \bar under
1025 L
1026 \bar default
1027 aTeX\InsetSpace ~
1028
1029 \bar under
1030 P
1031 \bar default
1032 reamble
1033 \family default
1034  from the 
1035 \family sans
1036 \bar under
1037 D
1038 \bar default
1039 ocument
1040 \family default
1041  menu, or via the 
1042 \family sans
1043 \bar under
1044 D
1045 \bar default
1046 ocument
1047 \family default
1048 \SpecialChar \menuseparator
1049
1050 \family sans
1051 \bar under
1052 S
1053 \bar default
1054 ettings
1055 \family default
1056  dialog, depending on your frontend.
1057  Note that the LyX keybindings will not work in this dialog, alas.
1058 \end_layout
1059
1060 \begin_layout Enumerate
1061 Use the preamble contents you've added as your default template (see 
1062 \begin_inset Quotes eld
1063 \end_inset
1064
1065 Basic LyX Setup
1066 \begin_inset Quotes erd
1067 \end_inset
1068
1069  in the 
1070 \emph on
1071 User's Guide
1072 \emph default
1073 ), so that it will be the default preamble for any file you create.
1074 \end_layout
1075
1076 \begin_layout Standard
1077 LyX adds anything in the 
1078 \family sans
1079 \bar under
1080 P
1081 \bar default
1082 reamble
1083 \family default
1084  dialog to its own built-in preamble.
1085  Before adding your own declarations in the preamble, you should make sure
1086  that LyX doesn't already support what you want to do (remember what we
1087  said about reinventing the wheel?).
1088  Also, 
1089 \emph on
1090 make sure your preamble code is correct
1091 \emph default
1092 .
1093  LyX doesn't check it.
1094 \end_layout
1095
1096 \begin_layout Subsection
1097 Examples
1098 \end_layout
1099
1100 \begin_layout Standard
1101 Here are some examples of what you can add to a preamble, and what they
1102  do:
1103 \end_layout
1104
1105 \begin_layout Subsubsection
1106 Example #1: Offsets
1107 \end_layout
1108
1109 \begin_layout Standard
1110 There are two variables under LaTeX that control page position: 
1111 \family typewriter
1112
1113 \backslash
1114 hoffset
1115 \family default
1116  and 
1117 \family typewriter
1118
1119 \backslash
1120 voffset
1121 \family default
1122 .
1123  Their names should be self-explanatory.
1124  These variables are useful if you think for a moment about computer labels.
1125  Sometimes, the size of a print medium and the area of the medium that you
1126  can actually print on aren't the same.
1127  This is where 
1128 \family typewriter
1129
1130 \backslash
1131 hoffset
1132 \family default
1133  and 
1134 \family typewriter
1135
1136 \backslash
1137 voffset
1138 \family default
1139  come in.
1140 \end_layout
1141
1142 \begin_layout Standard
1143 The default values for 
1144 \family typewriter
1145
1146 \backslash
1147 hoffset
1148 \family default
1149  and 
1150 \family typewriter
1151
1152 \backslash
1153 voffset
1154 \family default
1155  are both 0 pt.,\InsetSpace ~
1156 i.\InsetSpace ~
1157 e.\InsetSpace ~
1158 the page isn't shifted.
1159 \end_layout
1160
1161 \begin_layout Standard
1162 Unfortunately, some DVI drivers always seem to shift the page.
1163  We have no idea why, or why the sysadmin hasn't fixed such behavior.
1164  If you're using LyX on a system that you don't personally maintain, and
1165  your sysadmin is a doofus, 
1166 \family typewriter
1167
1168 \backslash
1169 hoffset
1170 \family default
1171  and 
1172 \family typewriter
1173
1174 \backslash
1175 voffset
1176 \family default
1177  can save the day.
1178  Suppose you're left and top margins are always 0.5 inches too big.
1179  You can add this to the preamble:
1180 \end_layout
1181
1182 \begin_layout LyX-Code
1183
1184 \backslash
1185 setlength{
1186 \backslash
1187 hoffset}{-0.5 in}
1188 \end_layout
1189
1190 \begin_layout LyX-Code
1191
1192 \backslash
1193 setlength{
1194 \backslash
1195 voffset}{-0.5 in}
1196 \end_layout
1197
1198 \begin_layout Standard
1199 \SpecialChar \ldots{}
1200 and your margins should now be correct.
1201 \end_layout
1202
1203 \begin_layout Subsubsection
1204 Example #2: Labels
1205 \end_layout
1206
1207 \begin_layout Standard
1208 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1209  There's a rather nice package, available at your nearest CTAN archive,
1210  for printing sheets of labels, called 
1211 \family typewriter
1212 labels.sty
1213 \family default
1214 .
1215  Now, your system may not have this package installed by default.
1216  We leave that up to you to check.
1217  You'll also want to read the documentation for it; we're not going to do
1218  that for you.
1219  Since this is an example, however, we'll give you an example of how you
1220  use this package.
1221 \end_layout
1222
1223 \begin_layout Standard
1224 First, make sure you're using the 
1225 \family sans
1226 article 
1227 \family default
1228 document class.
1229  Next, you need to put the following in your preamble:
1230 \end_layout
1231
1232 \begin_layout LyX-Code
1233
1234 \backslash
1235 usepackage{labels}
1236 \end_layout
1237
1238 \begin_layout LyX-Code
1239
1240 \backslash
1241 LabelCols=3
1242 \end_layout
1243
1244 \begin_layout LyX-Code
1245
1246 \backslash
1247 LabelRows=7
1248 \end_layout
1249
1250 \begin_layout LyX-Code
1251
1252 \backslash
1253 LeftBorder=8mm
1254 \end_layout
1255
1256 \begin_layout LyX-Code
1257
1258 \backslash
1259 RightBorder=8mm
1260 \end_layout
1261
1262 \begin_layout LyX-Code
1263
1264 \backslash
1265 TopBorder=9mm
1266 \end_layout
1267
1268 \begin_layout LyX-Code
1269
1270 \backslash
1271 BottomBorder=2mm
1272 \end_layout
1273
1274 \begin_layout Standard
1275 This sets things up for Avery® label sheets, stock #5360.
1276  You're now ready to print labels, but you'll need to insert LaTeX code,
1277  placing the commands 
1278 \family typewriter
1279
1280 \backslash
1281 begin{labels}
1282 \family default
1283  and 
1284 \family typewriter
1285
1286 \backslash
1287 end{labels}
1288 \family default
1289  around each label text.
1290  This and other special features of 
1291 \family typewriter
1292 labels.sty
1293 \family default
1294  are explained in its documentation.
1295 \end_layout
1296
1297 \begin_layout Standard
1298 Someday, someone may write a LyX layout file to support this package directly.
1299  Maybe that someone is you.
1300 \end_layout
1301
1302 \begin_layout Subsubsection
1303 Example #3: Paragraph Indentation
1304 \end_layout
1305
1306 \begin_layout Standard
1307 Americans are trained to indent the first line of 
1308 \emph on
1309 every
1310 \emph default
1311  paragraph.
1312  As with all of their other weird quirks, most Americans will whine and
1313  moan until they can have their way and indent the first line of all paragraphs.
1314 \begin_inset Foot
1315 status collapsed
1316
1317 \begin_layout Standard
1318 Note from 
1319 \noun on
1320 John Weiss
1321 \noun default
1322 : This was written by an American --- 
1323 \emph on
1324 me
1325 \emph default
1326 ! It's my perception of my fellow countrymen.
1327  Tough if you don't like it.
1328  Thpbpbpbpbpbpbpbp!
1329 \end_layout
1330
1331 \end_inset
1332
1333
1334 \end_layout
1335
1336 \begin_layout Standard
1337 Of course, this behavior isn't standard typography.
1338  In books, you typically only indent the first line of a paragraph 
1339 \emph on
1340 if
1341 \emph default
1342  it follows another one.
1343  The idea behind indenting the first line of a paragraph is to distinguish
1344  neighboring paragraphs from one another.
1345  If there is no previous paragraph, for example, it follows a figure, or
1346  is the first paragraph in a section, then there is no special indentation.
1347  
1348 \end_layout
1349
1350 \begin_layout Standard
1351 If you're a typical American, though, you don't care about such esoteric
1352  things; you want your indentation! Add this to the preamble:
1353 \end_layout
1354
1355 \begin_layout LyX-Code
1356
1357 \backslash
1358 usepackage{indentfirst}
1359 \end_layout
1360
1361 \begin_layout Standard
1362 If your TeX distribution isn't a braindead one, you'll have this package,
1363  and all of your paragraphs will get the indentation you think they deserve.
1364 \end_layout
1365
1366 \begin_layout Subsubsection
1367 Example #4: This Document
1368 \end_layout
1369
1370 \begin_layout Standard
1371 You can also check out the preamble of this document to get an idea of some
1372  of the advanced things you can do.
1373  You'll probably need to make the 
1374 \family sans
1375 \bar under
1376 P
1377 \bar default
1378 reamble\SpecialChar \ldots{}
1379
1380 \family default
1381  dialog full-screen to see most of it.
1382  Also, there are more examples and an assortment of LaTeX 
1383 \begin_inset Quotes eld
1384 \end_inset
1385
1386 dirty tricks
1387 \begin_inset Quotes erd
1388 \end_inset
1389
1390  given in Chapter\InsetSpace ~
1391
1392 \begin_inset LatexCommand \ref{cha:secrets}
1393
1394 \end_inset
1395
1396 .
1397  
1398 \end_layout
1399
1400 \begin_layout Section
1401 LyX and LaTeX Errors
1402 \end_layout
1403
1404 \begin_layout Standard
1405 When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
1406  going.
1407  It then uses the log-file from the LaTeX run to do a post-mortem.
1408  As we stated earlier in the chapter, LyX generates two kinds of 
1409 \family typewriter
1410 .tex
1411 \family default
1412  files, one of which it uses to locate errors in the document.
1413  If there was an error someplace, LyX will put a box with the word 
1414 \begin_inset Quotes eld
1415 \end_inset
1416
1417 Error
1418 \begin_inset Quotes erd
1419 \end_inset
1420
1421  at the appropriate place in the document.
1422 \begin_inset Foot
1423 status collapsed
1424
1425 \begin_layout Standard
1426 LyX will occasionally misguess where the error was.
1427  This will typically happen with tables, figures, math, and the preamble.
1428 \end_layout
1429
1430 \end_inset
1431
1432  It will also display a message alerting you to the fact that there were
1433  errors.
1434 \end_layout
1435
1436 \begin_layout Standard
1437 You can navigate through the errors by using 
1438 \family sans
1439 \bar under
1440 E
1441 \bar default
1442 rror
1443 \family default
1444  in the 
1445 \family sans
1446 \bar under
1447 N
1448 \bar default
1449 avigate
1450 \family default
1451  menu.
1452  You can 
1453 \begin_inset Quotes eld
1454 \end_inset
1455
1456 open
1457 \begin_inset Quotes erd
1458 \end_inset
1459
1460  the error-boxes and view the error message LaTeX produced by clicking on
1461  it.
1462 \end_layout
1463
1464 \begin_layout Standard
1465 Some folks also like to look at the log file directly, accessible from
1466 \family sans
1467  
1468 \bar under
1469 D
1470 \bar default
1471 ocument\SpecialChar \menuseparator
1472
1473 \bar under
1474 L
1475 \bar default
1476 aTeX\InsetSpace ~
1477 Log\InsetSpace ~
1478 File
1479 \family default
1480 .
1481  There are some fairly common error messages and warnings.
1482  We'll cover those here.
1483  You should look at a good LaTeX book for a complete listing.
1484 \end_layout
1485
1486 \begin_layout Itemize
1487 \begin_inset Quotes eld
1488 \end_inset
1489
1490
1491 \family typewriter
1492 LaTeX Warning:
1493 \family default
1494
1495 \begin_inset Quotes eld
1496 \end_inset
1497
1498
1499 \end_layout
1500
1501 \begin_deeper
1502 \begin_layout Standard
1503 Anything beginning with these word is a warning message for the purpose
1504  of 
1505 \begin_inset Quotes eld
1506 \end_inset
1507
1508 debugging
1509 \begin_inset Quotes erd
1510 \end_inset
1511
1512  the LaTeX code itself.
1513  You'll get messages like this if you added or changed cross-references
1514  or bibliography entries, in which case, LaTeX is trying to tell you that
1515  you need to make another run.
1516 \end_layout
1517
1518 \begin_layout Standard
1519 You can by-and-large ignore these.
1520 \end_layout
1521
1522 \end_deeper
1523 \begin_layout Itemize
1524 \begin_inset Quotes eld
1525 \end_inset
1526
1527
1528 \family typewriter
1529 LaTeX Font Warning:
1530 \family default
1531
1532 \begin_inset Quotes erd
1533 \end_inset
1534
1535
1536 \end_layout
1537
1538 \begin_deeper
1539 \begin_layout Standard
1540 Another warning message, this time about fonts which LaTeX couldn't find.
1541  The rest of the message will often say something about a replacement font
1542  that LaTeX used.
1543 \end_layout
1544
1545 \begin_layout Standard
1546 You can safely ignore these.
1547 \end_layout
1548
1549 \end_deeper
1550 \begin_layout Itemize
1551 \begin_inset Quotes eld
1552 \end_inset
1553
1554
1555 \family typewriter
1556 Overfull 
1557 \backslash
1558 hbox
1559 \family default
1560
1561 \begin_inset Quotes erd
1562 \end_inset
1563
1564
1565 \end_layout
1566
1567 \begin_deeper
1568 \begin_layout Standard
1569 LaTeX absolutely 
1570 \emph on
1571 loves
1572 \emph default
1573  to spew these out.
1574  They are warning you about lines that were too long and run past the right
1575  margin.
1576  Almost always, this is unnoticeable in the final output.
1577  Or, only one or two characters extend past the margin.
1578  LaTeX seems to generate at least one of these messages for just about any
1579  document you write.
1580 \end_layout
1581
1582 \begin_layout Standard
1583 You can ignore these stupid messages.
1584  Your eyes will tell you if there's a problem with something that's too
1585  wide; just look at the output.
1586 \end_layout
1587
1588 \end_deeper
1589 \begin_layout Itemize
1590 \begin_inset Quotes eld
1591 \end_inset
1592
1593
1594 \family typewriter
1595 Underfull 
1596 \backslash
1597 hbox
1598 \family default
1599
1600 \begin_inset Quotes erd
1601 \end_inset
1602
1603
1604 \end_layout
1605
1606 \begin_deeper
1607 \begin_layout Standard
1608 Not quite as common as its cousin.
1609  LaTeX seems to like to print lines that are a bit too wide as opposed to
1610  ones that are a bit too narrow.
1611  We have no idea why.
1612 \end_layout
1613
1614 \begin_layout Standard
1615 You can ignore these, too.
1616 \end_layout
1617
1618 \end_deeper
1619 \begin_layout Itemize
1620 \begin_inset Quotes eld
1621 \end_inset
1622
1623
1624 \family typewriter
1625 Overfull 
1626 \backslash
1627 vbox
1628 \family default
1629
1630 \begin_inset Quotes erd
1631 \end_inset
1632
1633  and 
1634 \begin_inset Quotes eld
1635 \end_inset
1636
1637
1638 \family typewriter
1639 Underfull 
1640 \backslash
1641 vbox
1642 \family default
1643
1644 \begin_inset Quotes erd
1645 \end_inset
1646
1647
1648 \end_layout
1649
1650 \begin_deeper
1651 \begin_layout Standard
1652 Warnings about troubles breaking the page.
1653  Once again, just look at the output.
1654  Your eyes will tell you where something has gone wrong.
1655 \end_layout
1656
1657 \end_deeper
1658 \begin_layout Itemize
1659 \begin_inset Quotes eld
1660 \end_inset
1661
1662  
1663 \family typewriter
1664 LaTeX Error: File 
1665 \begin_inset Quotes els
1666 \end_inset
1667
1668 Xxxx
1669 \begin_inset Quotes ers
1670 \end_inset
1671
1672  not found
1673 \family default
1674
1675 \begin_inset Quotes erd
1676 \end_inset
1677
1678  
1679 \end_layout
1680
1681 \begin_deeper
1682 \begin_layout Standard
1683 The file 
1684 \begin_inset Quotes eld
1685 \end_inset
1686
1687 Xxxx
1688 \begin_inset Quotes erd
1689 \end_inset
1690
1691  isn't installed on this system.
1692  This usually appears because some package your document needs isn't installed.
1693  If you didn't touch the preamble or didn't use the 
1694 \family typewriter
1695
1696 \backslash
1697 usepackage{}
1698 \family default
1699  command, then one of the packages LyX tried to load is missing.
1700  Use 
1701 \family sans
1702 \bar under
1703 H
1704 \bar default
1705 elp\SpecialChar \menuseparator
1706 L
1707 \bar under
1708 a
1709 \bar default
1710 TeX Configuration
1711 \family default
1712 , to get a list of packages that LyX knows about.
1713  This file is updated whenever you reconfigure LyX (using 
1714 \family sans
1715 \bar under
1716 T
1717 \bar default
1718 ools
1719 \bar under
1720 \SpecialChar \menuseparator
1721 R
1722 \bar default
1723 econfigure
1724 \family default
1725 ) and tells you which packages have been detected and what they do.
1726 \end_layout
1727
1728 \begin_layout Standard
1729 If you 
1730 \emph on
1731 did
1732 \emph default
1733  use the 
1734 \family typewriter
1735
1736 \backslash
1737 usepackage{}
1738 \family default
1739  command, and the package in question isn't installed, you'll need to install
1740  it yourself.
1741 \end_layout
1742
1743 \end_deeper
1744 \begin_layout Itemize
1745 \begin_inset Quotes eld
1746 \end_inset
1747
1748
1749 \family typewriter
1750 LaTeX Error: Unknown option
1751 \family default
1752
1753 \begin_inset Quotes erd
1754 \end_inset
1755
1756
1757 \end_layout
1758
1759 \begin_deeper
1760 \begin_layout Standard
1761 Error messages beginning with this are trying to tell you that you specified
1762  a bad or undefined option to a package.
1763  Check the package's documentation.
1764 \end_layout
1765
1766 \end_deeper
1767 \begin_layout Itemize
1768 \begin_inset Quotes eld
1769 \end_inset
1770
1771
1772 \family typewriter
1773 Undefined control sequence
1774 \family default
1775
1776 \begin_inset Quotes erd
1777 \end_inset
1778
1779
1780 \end_layout
1781
1782 \begin_deeper
1783 \begin_layout Standard
1784 If you've inserted LaTeX code into your document, but made a typo, you'll
1785  get one of these.
1786  You may have forgotten to load a package.
1787  In any case, this error message usually means that you used an undefined
1788  command.
1789 \end_layout
1790
1791 \end_deeper
1792 \begin_layout Standard
1793 There are other error and warning messages.
1794  Some are self-explanatory.
1795  These are usually LaTeX messages.
1796  Others are downright cryptic.
1797  These are actually TeX error messages, and we really have 
1798 \emph on
1799 no clue
1800 \emph default
1801  what they mean or how to decipher them.
1802 \end_layout
1803
1804 \begin_layout Standard
1805 There's a general sequence you should follow if you get error messages:
1806 \end_layout
1807
1808 \begin_layout Enumerate
1809 Look at the LaTeX code you inserted for typos.
1810 \end_layout
1811
1812 \begin_layout Enumerate
1813 If there are no typos, check and see that you used the command(s) correctly.
1814 \end_layout
1815
1816 \begin_layout Enumerate
1817 If you get a bunch of error boxes piled up at the very top of the document,
1818  it means that there are errors in the preamble.
1819  Start debugging your preamble.
1820 \end_layout
1821
1822 \begin_layout Enumerate
1823 If you didn't add anything to the preamble and didn't add any LaTeX code
1824  to the document, the first suspect is your LaTeX distribution itself.
1825  Check for missing packages and install them.
1826 \end_layout
1827
1828 \begin_layout Enumerate
1829 Okay, so there are no missing packages.
1830  Did you use any of the fine-tuning options in LyX? Specifically, did you
1831  
1832 \emph on
1833 misuse
1834 \emph default
1835  any of them, like trying to manually insert lots of 
1836 \family sans
1837 Protected\InsetSpace ~
1838 Blank
1839 \family default
1840 s, 
1841 \family sans
1842 Linebreak
1843 \family default
1844 s, or 
1845 \family sans
1846 Pagebreak
1847 \family default
1848 s? Did you try to kludge something together with these instead of using
1849  the appropriate paragraph environment?
1850 \end_layout
1851
1852 \begin_layout Enumerate
1853 All right, you didn't use any of the fine-tuning options, you played by
1854  the rules.
1855  Did you try to pull a fancy maneuver? Did you do something funky inside
1856  a table or an equation, like inserting a graphic into a table cell?
1857 \end_layout
1858
1859 \begin_layout Enumerate
1860 Do you have long sections of text where LaTeX cannot find a place to break
1861  a line? By default, LaTeX is rather strict about how much extra inter-word
1862  spacing it will add in order to break a line.
1863  Preferrably, you should rework the paragraph to avoid the problem.
1864  If this isn't an option, you can wrap your text in 
1865 \family typewriter
1866
1867 \backslash
1868 sloppypar
1869 \family default
1870  to make LaTeX's line breaking more, well, sloppy.
1871 \end_layout
1872
1873 \begin_layout Enumerate
1874 Did you go overboard with the nesting? LyX (currently) doesn't check to
1875  make sure you're in the limits for nesting environments.
1876  If you nested a bunch of environments to the 
1877 \begin_inset Formula $17^{\mathrm{th}}$
1878 \end_inset
1879
1880  level, that's the problem.
1881 \end_layout
1882
1883 \begin_layout Enumerate
1884 Okay, you didn't get any error messages, but your output looks whacked.
1885  If you have a table or figure that's too wide or long for the page, you
1886  need to:
1887 \end_layout
1888
1889 \begin_deeper
1890 \begin_layout Enumerate
1891 rescale the figure so it fits.
1892 \end_layout
1893
1894 \begin_layout Enumerate
1895 trim down the table so it fits.
1896 \end_layout
1897
1898 \begin_layout Standard
1899 If something else is wrong with the output, and you didn't try to pull anything
1900  fancy or kludge the fine-tuning options, we're not sure what's wrong.
1901 \end_layout
1902
1903 \end_deeper
1904 \begin_layout Standard
1905 If all this doesn't help --- well, then 
1906 \emph on
1907 perhaps
1908 \emph default
1909  you might have found a bug in LyX\SpecialChar \ldots{}
1910
1911 \end_layout
1912
1913 \begin_layout Chapter
1914 Supplemental Tools
1915 \end_layout
1916
1917 \begin_layout Section
1918 Preparing a Bibliography with BibTeX
1919 \begin_inset LatexCommand \label{sec:Preparing-a-Bibliography}
1920
1921 \end_inset
1922
1923
1924 \end_layout
1925
1926 \begin_layout Standard
1927 by 
1928 \noun on
1929 Mike Ressler
1930 \noun default
1931  and 
1932 \noun on
1933 Jürgen Spitzmüller
1934 \end_layout
1935
1936 \begin_layout Standard
1937 \begin_inset VSpace bigskip
1938 \end_inset
1939
1940
1941 \end_layout
1942
1943 \begin_layout Standard
1944 \noindent
1945 STOP! If you don't know what BibTeX is, or have a reasonably good idea of
1946  how to use it (
1947 \emph on
1948 e.g.
1949
1950 \emph default
1951  setting up your own bibliographic databases), 
1952 \emph on
1953 run
1954 \emph default
1955 , do not walk, to your nearest copy of the 2nd edition of Lamport's 
1956 \emph on
1957 LaTeX: A Document Preparation System
1958 \emph default
1959 , particularly Appendix B.
1960  The rest of this discussion assumes you have created a correct bibliography
1961  file, that you have all relevant environment variables set correctly (esp.
1962  
1963 \family typewriter
1964 BIBINPUTS
1965 \family default
1966
1967 \family typewriter
1968 BSTINPUTS
1969 \family default
1970 , and 
1971 \family typewriter
1972 TEXINPUTS
1973 \family default
1974 ), and that if sufficiently desperate, you could create and 
1975 \begin_inset Quotes eld
1976 \end_inset
1977
1978 TeX
1979 \begin_inset Quotes erd
1980 \end_inset
1981
1982  a LaTeX file with a BibTeX database.
1983  
1984 \end_layout
1985
1986 \begin_layout Standard
1987 For those who don't know what BibTeX is, it is a system for creating a large
1988  database of your most used journal references.
1989  For all future articles you write, you only need to include this standard
1990  database and reference the appropriate key to each reference.
1991  Even if you write only a few papers with handful of references each, it
1992  is well worth your time to examine BibTeX and decide whether it will be
1993  useful to you.
1994 \end_layout
1995
1996 \begin_layout Standard
1997 To use BibTeX with LyX, first read the 
1998 \emph on
1999 User Guide
2000 \emph default
2001  where it describes how to insert citations.
2002  The basic mechanism for inserting BibTeX references is the same.
2003  Then, at the very end of your document, select 
2004 \family sans
2005 Insert\SpecialChar \menuseparator
2006 List
2007 \family default
2008  / 
2009 \family sans
2010 TOC\SpecialChar \menuseparator
2011 BibTeX Reference
2012 \family default
2013 .
2014  In the resulting dialog, fill out the dialog boxes as follows: 
2015 \end_layout
2016
2017 \begin_layout Description
2018 Database: enter the name of your 
2019 \family typewriter
2020 .bib
2021 \family default
2022  file 
2023 \emph on
2024 without
2025 \emph default
2026  the 
2027 \family typewriter
2028 .bib
2029 \family default
2030  extension.
2031  For searching multiple 
2032 \family typewriter
2033 .bib
2034 \family default
2035  files, just enter them in the desired order, separated by commas.
2036  
2037 \end_layout
2038
2039 \begin_layout Description
2040 Style: enter the name of your BibTeX style file *without* the 
2041 \family typewriter
2042 .bst
2043 \family default
2044  extension.
2045  The default style is 
2046 \family typewriter
2047 plain
2048 \family default
2049  (which should be included in your LaTeX distribution, so you don't have
2050  to worry about creating it).
2051 \end_layout
2052
2053 \begin_layout Standard
2054 For each citation, assuming that the source is in the 
2055 \family typewriter
2056 .bib
2057 \family default
2058  file, just call 
2059 \family sans
2060 \bar under
2061 I
2062 \bar default
2063 nsert\SpecialChar \menuseparator
2064
2065 \bar under
2066 C
2067 \bar default
2068 itation Reference
2069 \family default
2070  at the correct location in the text, and enter the appropriate reference
2071  key.
2072  Nothing else is required; when invoking 
2073 \family sans
2074 \bar under
2075 V
2076 \bar default
2077 iew\SpecialChar \menuseparator
2078
2079 \bar under
2080 D
2081 \bar default
2082 VI
2083 \family default
2084 , for example, you should see that BibTex and LaTeX are invoked as needed,
2085  including multiple invocations of LaTeX.
2086  
2087 \end_layout
2088
2089 \begin_layout Subsection
2090 Alternative Citation Styles
2091 \end_layout
2092
2093 \begin_layout Standard
2094 Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
2095 g.\InsetSpace \space{}
2096
2097 \begin_inset Quotes eld
2098 \end_inset
2099
2100 [12]
2101 \begin_inset Quotes erd
2102 \end_inset
2103
2104 ) to refer to a cited work.
2105  However, in many scientific disciplines, other citation styles are in use.
2106  The most common one is the author-year style (e.\InsetSpace \thinspace{}
2107 g.\InsetSpace \space{}
2108
2109 \begin_inset Quotes eld
2110 \end_inset
2111
2112 Knuth 1984a
2113 \begin_inset Quotes erd
2114 \end_inset
2115
2116 ).
2117  LyX supports two packages that provide this style, 
2118 \family typewriter
2119 natbib
2120 \family default
2121  and 
2122 \family typewriter
2123 jurabib
2124 \family default
2125 .
2126  Both packages have their own pros and cons, which cannot be listed in detail.
2127  If you only want to have simple author-year (or author-numerical) style
2128  or if you want to use one of the countless style files for natbib, than
2129  the established 
2130 \family typewriter
2131 natbib
2132 \family default
2133  package is probably your choice.
2134  If you need special features like short title references, ibidem etc., you
2135  might consider the fairly new 
2136 \family typewriter
2137 jurabib
2138 \family default
2139  package.
2140 \end_layout
2141
2142 \begin_layout Standard
2143 The handling of both packages in LyX is basically the same.
2144  Go to 
2145 \family sans
2146 \bar under
2147 D
2148 \bar default
2149 ocument\SpecialChar \menuseparator
2150
2151 \bar under
2152 S
2153 \bar default
2154 ettings 
2155 \family default
2156 and select the 
2157 \family sans
2158 Bibliography
2159 \family default
2160  pane (with the xforms frontend: the 
2161 \family sans
2162 Extras
2163 \family default
2164  tab).
2165  Then select 
2166 \family sans
2167 Natbib
2168 \family default
2169  or 
2170 \family sans
2171 Jurabib
2172 \family default
2173 .
2174  With both packages, you will get some extra features in the citation dialog
2175  and you can select the style of the reference (
2176 \begin_inset Quotes eld
2177 \end_inset
2178
2179 Knuth 1984
2180 \begin_inset Quotes erd
2181 \end_inset
2182
2183
2184 \begin_inset Quotes eld
2185 \end_inset
2186
2187 Knuth (1984)
2188 \begin_inset Quotes erd
2189 \end_inset
2190
2191
2192 \begin_inset Quotes eld
2193 \end_inset
2194
2195 Knuth, 1984
2196 \begin_inset Quotes erd
2197 \end_inset
2198
2199
2200 \begin_inset Quotes eld
2201 \end_inset
2202
2203 1984
2204 \begin_inset Quotes erd
2205 \end_inset
2206
2207  etc.).
2208  Note that both packages need specifically designed style files (they both
2209  ship their own, while there are lots of additional style files and even
2210  an interactive style file builder
2211 \begin_inset Foot
2212 status collapsed
2213
2214 \begin_layout Standard
2215 See 
2216 \begin_inset LatexCommand \url{ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/}
2217
2218 \end_inset
2219
2220
2221 \end_layout
2222
2223 \end_inset
2224
2225  for 
2226 \family typewriter
2227 natbib
2228 \family default
2229  available).
2230 \end_layout
2231
2232 \begin_layout Subsection
2233 Sectionated Bibliographies
2234 \begin_inset LatexCommand \label{sub:Sectionated-Bibliographies}
2235
2236 \end_inset
2237
2238
2239 \end_layout
2240
2241 \begin_layout Standard
2242 Sometimes you might need to divide your bibliography into several sections.
2243  If you are, for instance, a historian, the possibility to separate sources
2244  and scientific works is most likely a 
2245 \begin_inset Quotes eld
2246 \end_inset
2247
2248 must have
2249 \begin_inset Quotes erd
2250 \end_inset
2251
2252 .
2253  Unfortunately, BibTeX itself does not allow you to do this.
2254  The good news is, though: With the help of some LaTeX packages, BibTeX
2255  can be extended to fit your historical needs.
2256 \end_layout
2257
2258 \begin_layout Standard
2259 As of version 1.4, LyX provides native support for one of these packages,
2260  Stefan Ulrich's 
2261 \family typewriter
2262 bibtopic
2263 \family default
2264 .
2265 \begin_inset Foot
2266 status collapsed
2267
2268 \begin_layout Standard
2269 Available from 
2270 \begin_inset LatexCommand \url{ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/}
2271
2272 \end_inset
2273
2274
2275 \end_layout
2276
2277 \end_inset
2278
2279  The advantage of this package (compared to other packages like 
2280 \family typewriter
2281 multibib
2282 \family default
2283 ) is that you don't need to define new citation commands.
2284  Instead, you need to prepare different bibliographic databases which include
2285  the entries for the different sections of the bibliography.
2286  For example: If you want to divide your bibliography into the sections
2287  
2288 \begin_inset Quotes eld
2289 \end_inset
2290
2291 Sources
2292 \begin_inset Quotes erd
2293 \end_inset
2294
2295  and 
2296 \begin_inset Quotes eld
2297 \end_inset
2298
2299 Scientific works
2300 \begin_inset Quotes erd
2301 \end_inset
2302
2303 , you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
2304 g.\InsetSpace \space{}
2305
2306 \family typewriter
2307 sources.bib
2308 \family default
2309  and 
2310 \family typewriter
2311 scientific.bib
2312 \family default
2313 .
2314  
2315 \end_layout
2316
2317 \begin_layout Standard
2318 In LyX, go to 
2319 \family sans
2320 \bar under
2321 D
2322 \bar default
2323 ocument\SpecialChar \menuseparator
2324
2325 \bar under
2326 S
2327 \bar default
2328 ettings 
2329 \family default
2330 and select the 
2331 \family sans
2332 Bibliography
2333 \family default
2334  pane (with the xforms frontend: the 
2335 \family sans
2336 Extras
2337 \family default
2338  tab).
2339  Check 
2340 \family sans
2341 Sectionated\InsetSpace ~
2342 bibliography
2343 \family default
2344 .
2345  Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
2346
2347 \begin_inset LatexCommand \ref{sec:Preparing-a-Bibliography}
2348
2349 \end_inset
2350
2351 ), one for each section of your bibliography.
2352  Returning to our example: Insert a BibTeX reference for the database 
2353 \family typewriter
2354 sources.bib
2355 \family default
2356  and a second one for the database 
2357 \family typewriter
2358 scientific.bib
2359 \family default
2360 .
2361  You are free to use the same or different styles for each section.
2362  Additionally, you can chose if the bibliography section should contain
2363  
2364 \begin_inset Quotes eld
2365 \end_inset
2366
2367 all cited references
2368 \begin_inset Quotes erd
2369 \end_inset
2370
2371  of the specified database(s) (which is the default), 
2372 \begin_inset Quotes eld
2373 \end_inset
2374
2375 all uncited references
2376 \begin_inset Quotes erd
2377 \end_inset
2378
2379  or even 
2380 \begin_inset Quotes eld
2381 \end_inset
2382
2383 all references
2384 \begin_inset Quotes erd
2385 \end_inset
2386
2387 .
2388  This might be useful if you would like to separate your bibliography into
2389  three sections: 
2390 \begin_inset Quotes eld
2391 \end_inset
2392
2393 Cited sources
2394 \begin_inset Quotes erd
2395 \end_inset
2396
2397
2398 \begin_inset Quotes eld
2399 \end_inset
2400
2401 Uncited sources
2402 \begin_inset Quotes erd
2403 \end_inset
2404
2405 , and 
2406 \begin_inset Quotes eld
2407 \end_inset
2408
2409 Scientific works
2410 \begin_inset Quotes erd
2411 \end_inset
2412
2413 .
2414  The titles for the sections can be added as ordinary sections or subsections.
2415  Since 
2416 \family typewriter
2417 bibtopic
2418 \family default
2419  removes the bibliography title, you have manually re-add that, too (as
2420  a chapter* or section*, for instance).
2421 \end_layout
2422
2423 \begin_layout Subsection
2424 Multiple Bibliographies
2425 \end_layout
2426
2427 \begin_layout Standard
2428 Multiple bibliographies, e.\InsetSpace \thinspace{}
2429 g.\InsetSpace \space{}
2430 a bibliography for each section or chapter of
2431  the document, are not supported by BibTeX itself.
2432  But the 
2433 \family typewriter
2434 bibtopic
2435 \family default
2436  package, which is used for the creation of sectionated bibliographies in
2437  LyX (cf.\InsetSpace ~
2438 section\InsetSpace ~
2439
2440 \begin_inset LatexCommand \ref{sub:Sectionated-Bibliographies}
2441
2442 \end_inset
2443
2444 ), provides an easy way to solve this task, if you are willing to use some
2445  LaTeX-Code (ERT, cf.\InsetSpace ~
2446 section\InsetSpace ~
2447
2448 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
2449
2450 \end_inset
2451
2452 ).
2453 \begin_inset Foot
2454 status collapsed
2455
2456 \begin_layout Standard
2457 An alternative approach is to use the 
2458 \family typewriter
2459 chapterbib
2460 \family default
2461  or 
2462 \family typewriter
2463 bibunits
2464 \family default
2465  package, respectively.
2466 \end_layout
2467
2468 \end_inset
2469
2470
2471 \end_layout
2472
2473 \begin_layout Standard
2474 First, go to 
2475 \family sans
2476 \bar under
2477 D
2478 \bar default
2479 ocument\SpecialChar \menuseparator
2480
2481 \bar under
2482 S
2483 \bar default
2484 ettings 
2485 \family default
2486 and select the 
2487 \family sans
2488 Bibliography
2489 \family default
2490  pane (with the xforms frontend: the 
2491 \family sans
2492 Extras
2493 \family default
2494  tab).
2495  Check 
2496 \family sans
2497 Sectionated\InsetSpace ~
2498 bibliography
2499 \family default
2500 .
2501  In the document, you have to enclose the sections, which shall contain
2502  their own bibliography (including the BibTeX reference itself), between
2503  
2504 \family typewriter
2505
2506 \backslash
2507 begin{btUnit}
2508 \family default
2509  and 
2510 \family typewriter
2511
2512 \backslash
2513 end{btUnit}
2514 \family default
2515  (those commands have to be inserted as ERT).
2516  The bibliography will contain all references which have been cited in the
2517  current btUnit.
2518  N.\InsetSpace \thinspace{}
2519 B.: If you are using this approach, then 
2520 \emph on
2521 every
2522 \emph default
2523  citation reference has to be inside some btUnit.
2524  Also, the btUnits cannot be nested.
2525 \end_layout
2526
2527 \begin_layout Section
2528 Making an Index
2529 \end_layout
2530
2531 \begin_layout Standard
2532 A good index is one of the hardest things to make in a lengthy document,
2533  but LyX helps make things a bit simpler by interfacing to the 
2534 \family typewriter
2535 makeindex
2536 \family default
2537  program which is found in most recent LaTeX distributions.
2538 \begin_inset Foot
2539 status collapsed
2540
2541 \begin_layout Standard
2542
2543 \family roman
2544 \series medium
2545 \shape up
2546 \size normal
2547 \emph off
2548 \bar no
2549 \noun off
2550 \color none
2551 In the 
2552 \family sans
2553 \series default
2554 \shape default
2555 \size default
2556 \emph default
2557 \bar default
2558 \noun default
2559 Outputs\SpecialChar \menuseparator
2560 LaT\SpecialChar \textcompwordmark{}
2561 eX
2562 \family roman
2563 \series medium
2564 \shape up
2565 \size normal
2566 \emph off
2567 \bar no
2568 \noun off
2569  section of the preferences dialog, however, you can customize the index
2570  command, if you prefer an alternative program like 
2571 \family typewriter
2572 \series default
2573 \shape default
2574 \size default
2575 \emph default
2576 \bar default
2577 \noun default
2578 xindy
2579 \family roman
2580 \series medium
2581 \shape up
2582 \size normal
2583 \emph off
2584 \bar no
2585 \noun off
2586 .
2587 \end_layout
2588
2589 \end_inset
2590
2591  Inserting an index and marking words to include in it works much the same
2592  way as preparing a bibliography as mentioned in the last section.
2593 \end_layout
2594
2595 \begin_layout Standard
2596 First, go to the end of your file and select 
2597 \family sans
2598 \bar under
2599 I
2600 \bar default
2601 nsert\SpecialChar \menuseparator
2602 List
2603 \family default
2604 \InsetSpace ~
2605 /\InsetSpace ~
2606
2607 \family sans
2608 T
2609 \bar under
2610 O
2611 \bar default
2612 C\SpecialChar \menuseparator
2613
2614 \bar under
2615 I
2616 \bar default
2617 ndex
2618 \family default
2619 \InsetSpace ~
2620
2621 \family sans
2622 List
2623 \family default
2624 .
2625  Then, for each word you would like to include in the index, go to the end
2626  of that word and click on 
2627 \family sans
2628 \bar under
2629 I
2630 \bar default
2631 nsert\SpecialChar \menuseparator
2632
2633 \bar under
2634 I
2635 \bar default
2636 ndex
2637 \family default
2638 \InsetSpace ~
2639
2640 \family sans
2641 Entry
2642 \family default
2643 .
2644  This will insert a tag showing the word as it will appear in the index.
2645  That's all there is to it; LyX will automatically call 
2646 \family typewriter
2647 makeindex
2648 \family default
2649  for you and create the index itself.
2650  The text in the dialog available from right-clicking on the index button
2651  accepts LaTeX, so you'll need to be careful to avoid using any special
2652  characters.
2653  On the positive side, you can use the advanced options - have a look at
2654  the documentation which comes with your LaTeX distribution to find out
2655  how to do things like 
2656 \begin_inset Quotes eld
2657 \end_inset
2658
2659 nested entries
2660 \begin_inset Quotes erd
2661 \end_inset
2662
2663 , etc.
2664 \end_layout
2665
2666 \begin_layout Standard
2667 Be careful not to put spaces between the word in the text and the index
2668  marker; apparently the wrong page number can be produced if this happens.
2669 \end_layout
2670
2671 \begin_layout Section
2672 Multipart Documents
2673 \end_layout
2674
2675 \begin_layout Subsection
2676 General Operation
2677 \end_layout
2678
2679 \begin_layout Standard
2680 When you are working on a large file with many sections, it is often convenient
2681  to break up the document into several files, or perhaps you have something
2682  where a table may change from time to time, but the preceding text does
2683  not.
2684  In these cases, you should seriously consider using multipart documents.
2685  For example, scientific papers often have five major sections: the introduction
2686 , observations, results, discussion, and conclusion.
2687  Each of these could be its own separate LyX file, with one 
2688 \begin_inset Quotes eld
2689 \end_inset
2690
2691 master
2692 \begin_inset Quotes erd
2693 \end_inset
2694
2695  file which contains the title, authors, abstract, references, etc., plus
2696  the five included files.
2697  It is important to note that each of these files is a full LyX file which
2698  can be formatted and printed on its own, as well as included in a master
2699  file.
2700  Each of these files must have the same document class, however--- don't
2701  attempt to mix book classes with article classes.
2702  You may also include LaTeX files; however, these files must not have their
2703  own preamble 
2704 \emph on
2705 (i.e.
2706
2707 \emph default
2708  everything up to and including the 
2709 \family typewriter
2710
2711 \backslash
2712 begin{document}
2713 \family default
2714  line as well as the 
2715 \family typewriter
2716
2717 \backslash
2718 end{document}
2719 \family default
2720  line must be deleted) or else errors will be generated when you try to
2721  make a DVI file.
2722 \end_layout
2723
2724 \begin_layout Standard
2725 LyX allows you to include files quite easily with 
2726 \family sans
2727 \bar under
2728 I
2729 \bar default
2730 nsert\SpecialChar \menuseparator
2731 ChiI
2732 \bar under
2733 d
2734 \bar default
2735 \InsetSpace ~
2736 Document
2737 \family default
2738 .
2739  When you click on this selection a small box is inserted into the file
2740  at the current cursor location.
2741  Clicking on the box raises a dialog which allows you to select the file
2742  to be included, and the method of its inclusion.
2743  
2744 \end_layout
2745
2746 \begin_layout Standard
2747 The file selection box should by now be obvious.
2748  The three inclusion methods are 
2749 \begin_inset Quotes eld
2750 \end_inset
2751
2752 include
2753 \begin_inset Quotes erd
2754 \end_inset
2755
2756
2757 \begin_inset Quotes eld
2758 \end_inset
2759
2760 input
2761 \begin_inset Quotes erd
2762 \end_inset
2763
2764 , and 
2765 \begin_inset Quotes eld
2766 \end_inset
2767
2768 verbatim
2769 \begin_inset Quotes erd
2770 \end_inset
2771
2772 .
2773  The difference between 
2774 \begin_inset Quotes eld
2775 \end_inset
2776
2777 include
2778 \begin_inset Quotes erd
2779 \end_inset
2780
2781  and 
2782 \begin_inset Quotes eld
2783 \end_inset
2784
2785 input
2786 \begin_inset Quotes erd
2787 \end_inset
2788
2789  is really only meaningful to LaTeXperts, but the practical difference is
2790  that files which are 
2791 \begin_inset Quotes eld
2792 \end_inset
2793
2794 included
2795 \begin_inset Quotes erd
2796 \end_inset
2797
2798  are typeset beginning on a new page, while files which are 
2799 \begin_inset Quotes eld
2800 \end_inset
2801
2802 inputted
2803 \begin_inset Quotes erd
2804 \end_inset
2805
2806  are typeset starting on the current page.
2807  Perhaps the labeling in LyX will be changed someday to reflect this.
2808 \end_layout
2809
2810 \begin_layout Standard
2811 Generally, the master file is converted into a full LaTeX file before typesettin
2812 g, while the included files are converted to LaTeX files which do not have
2813  all the preamble information.
2814  Checking the 
2815 \family sans
2816 Don't
2817 \family default
2818 \InsetSpace ~
2819
2820 \family sans
2821 typeset
2822 \family default
2823  button prevents this conversion.
2824 \end_layout
2825
2826 \begin_layout Standard
2827
2828 \begin_inset Quotes eld
2829 \end_inset
2830
2831 verbatim
2832 \begin_inset Quotes erd
2833 \end_inset
2834
2835  included file allows you to include a file typeset exactly as it appears
2836  in the file, i.e.\InsetSpace ~
2837 verbatim mode, with the characters set in a fixed-width
2838  typewriter font.
2839  Normally, spaces in this file are invisible, though two consecutive spaces
2840  are conserved, unlike LyX's normal treatment of spaces.
2841  However, setting the 
2842 \family sans
2843 \bar under
2844 M
2845 \bar default
2846 ark\InsetSpace ~
2847 spaces\InsetSpace ~
2848 in\InsetSpace ~
2849 output
2850 \family default
2851  checkbox typesets a mark to unambiguously define the presence of a space.
2852
2853 \emph on
2854  
2855 \end_layout
2856
2857 \begin_layout Subsection
2858 Cross-References Between Files
2859 \end_layout
2860
2861 \begin_layout Standard
2862 It is possible to set up cross-references between the different files.
2863  First, open all the files in question: let's call them A and B in a two
2864  file example, where B is included in A.
2865  Let's say you insert a label in A, then want to reference it in B.
2866  Open the cross-reference dialog in whilst in document B, and you can select
2867  the 
2868 \begin_inset Quotes eld
2869 \end_inset
2870
2871 buffer
2872 \begin_inset Quotes erd
2873 \end_inset
2874
2875  to use.
2876 \end_layout
2877
2878 \begin_layout Section
2879 Algorithms
2880 \end_layout
2881
2882 \begin_layout Standard
2883 The package 
2884 \family sans
2885 algorithm
2886 \family default
2887  is needed by LyX to be able to output algorithm floats.
2888  These are useful in placing short algorithms across page breaks and support
2889  an index of algorithms too.
2890 \end_layout
2891
2892 \begin_layout Section
2893 Subfigures
2894 \end_layout
2895
2896 \begin_layout Standard
2897 The package
2898 \family sans
2899  subfigure 
2900 \family default
2901 is used by LyX when you select ``subfigure'' in the graphics dialog and
2902  enter the subfigure caption.
2903  Several figures marked in this way can be packed into a single float with
2904  individual sub-captions.
2905 \end_layout
2906
2907 \begin_layout Section
2908 Fancy Headers and Footers
2909 \end_layout
2910
2911 \begin_layout Standard
2912 The default page layout is rather plain; for an article document class,
2913  all you get is a centered page number at the bottom of the page.
2914  This document is the book class, so it appears to be a bit fancier, but
2915  to really put on a show, you need to set the document page style to 
2916 \begin_inset Quotes eld
2917 \end_inset
2918
2919 fancy
2920 \begin_inset Quotes erd
2921 \end_inset
2922
2923 , as mentioned in the 
2924 \family sans
2925 User\InsetSpace ~
2926 Guide
2927 \family default
2928 .
2929  This section describes the LaTeX codes you need to insert in your LaTeX
2930  preamble or the text in order to get the desired effects.
2931 \end_layout
2932
2933 \begin_layout Standard
2934 The page header is divided into three fields, not surprisingly labeled 
2935 \begin_inset Quotes eld
2936 \end_inset
2937
2938 left
2939 \begin_inset Quotes erd
2940 \end_inset
2941
2942
2943 \begin_inset Quotes eld
2944 \end_inset
2945
2946 center
2947 \begin_inset Quotes erd
2948 \end_inset
2949
2950 , and 
2951 \begin_inset Quotes eld
2952 \end_inset
2953
2954 right
2955 \begin_inset Quotes erd
2956 \end_inset
2957
2958 .
2959  The footer is also divided into these three fields.
2960  The LaTeX commands to set these fields in the simplest manner are 
2961 \family typewriter
2962
2963 \backslash
2964 lhead
2965 \family default
2966
2967 \family typewriter
2968
2969 \backslash
2970 chead
2971 \family default
2972
2973 \family typewriter
2974
2975 \backslash
2976 rhead
2977 \family default
2978
2979 \family typewriter
2980
2981 \backslash
2982 lfoot
2983 \family default
2984 , etc.
2985  Suppose you wish to put your name in the upper left hand corner of each
2986  page.
2987  Simply insert the following command in the preamble: 
2988 \end_layout
2989
2990 \begin_layout Standard
2991
2992 \family typewriter
2993
2994 \backslash
2995 lhead{John Q.
2996  DocWriter}
2997 \end_layout
2998
2999 \begin_layout Standard
3000 You will now see your name in the upper left.
3001  If a field has a default entry that you would like to get rid of (often
3002  the page number appears in the central footer, simply include a command
3003  with a blank argument, e.g.
3004 \end_layout
3005
3006 \begin_layout Standard
3007
3008 \family typewriter
3009
3010 \backslash
3011 cfoot{}
3012 \end_layout
3013
3014 \begin_layout Standard
3015 Let's get really fancy: lets put the section number with the word 
3016 \begin_inset Quotes eld
3017 \end_inset
3018
3019 Section
3020 \begin_inset Quotes erd
3021 \end_inset
3022
3023  (e.g.
3024  Section 3) in the upper left, the page number (e.g.
3025  Page 4) in the upper right, your name in the lower left, and the date in
3026  the lower right.
3027  The following commands should now appear in the preamble:
3028 \end_layout
3029
3030 \begin_layout Standard
3031
3032 \family typewriter
3033
3034 \backslash
3035 lhead{Section 
3036 \backslash
3037 thesection}
3038 \end_layout
3039
3040 \begin_layout Standard
3041
3042 \family typewriter
3043
3044 \backslash
3045 chead{}
3046 \end_layout
3047
3048 \begin_layout Standard
3049
3050 \family typewriter
3051
3052 \backslash
3053 rhead{Page 
3054 \backslash
3055 thepage}
3056 \end_layout
3057
3058 \begin_layout Standard
3059
3060 \family typewriter
3061
3062 \backslash
3063 lfoot{John Q.
3064  DocWriter}
3065 \end_layout
3066
3067 \begin_layout Standard
3068
3069 \family typewriter
3070
3071 \backslash
3072 cfoot{}
3073 \end_layout
3074
3075 \begin_layout Standard
3076
3077 \family typewriter
3078
3079 \backslash
3080 rfoot{
3081 \backslash
3082 today}
3083 \end_layout
3084
3085 \begin_layout Standard
3086 The codes 
3087 \family typewriter
3088
3089 \backslash
3090 thesection
3091 \family default
3092  and 
3093 \family typewriter
3094
3095 \backslash
3096 thepage
3097 \family default
3098  access LaTeX's section and page counters, and so print out the current
3099  section and page numbers.
3100  
3101 \family typewriter
3102
3103 \backslash
3104 today
3105 \family default
3106  simply prints out today's date.
3107 \end_layout
3108
3109 \begin_layout Standard
3110 The thicknesses of the horizontal rules drawn beneath the header and above
3111  the footer can also be modified.
3112  If you don't want one of the headers, set its thickness to 0.
3113  The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3114  Use the commands, e.g.
3115  
3116 \family typewriter
3117
3118 \backslash
3119 renewcommand{
3120 \backslash
3121 headrulewidth}{0.4pt}
3122 \family default
3123  and 
3124 \family typewriter
3125
3126 \backslash
3127 renewcommand{
3128 \backslash
3129 footrulewidth}{0.4pt}
3130 \family default
3131  to set the thicknesses.
3132 \end_layout
3133
3134 \begin_layout Standard
3135 You can switch the header/footer settings on and off for individual pages
3136  using commands like 
3137 \family typewriter
3138
3139 \backslash
3140 thispagestyle{empty}
3141 \family default
3142
3143 \family typewriter
3144
3145 \backslash
3146 thispagestyle{plain}
3147 \family default
3148 , and 
3149 \family typewriter
3150
3151 \backslash
3152 thispagestyle{fancy}
3153 \family default
3154 .
3155  Simply insert them in the text on the page you want changed and mark them
3156  as TeX code.
3157  In fact, title pages are marked as plain by default, while following pages
3158  are marked fancy when using the global fancy setting.
3159 \end_layout
3160
3161 \begin_layout Standard
3162 There are more complex commands which will let you insert things in the
3163  upper left on odd numbered pages, etc., but I will refer you to the 
3164 \family typewriter
3165 fancyhdr
3166 \family default
3167  package documentation for more descriptions.
3168  For example, if you have a teTeX installation, look for 
3169 \family typewriter
3170 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3171 fancyhdr.dvi
3172 \family default
3173 .
3174 \end_layout
3175
3176 \begin_layout Standard
3177 As a final example, it is possible to include an Encapsulated PostScript®
3178  file in the header or footer.
3179  Suppose you want to put a company logo in the upper lefthand corner.
3180  You might try something like
3181 \end_layout
3182
3183 \begin_layout Standard
3184
3185 \family typewriter
3186
3187 \backslash
3188 lhead{
3189 \backslash
3190 resizebox{1in}{!}{
3191 \backslash
3192 includegraphics{logo.eps}}}
3193 \end_layout
3194
3195 \begin_layout Standard
3196 \noindent
3197 (you may need to preface this with 
3198 \family typewriter
3199
3200 \backslash
3201 usepackage{graphics}
3202 \family default
3203  if you don't include EPS files elsewhere in your document).
3204 \end_layout
3205
3206 \begin_layout Section
3207 Minipages
3208 \end_layout
3209
3210 \begin_layout Standard
3211 LaTeX provides a mechanism to produce essentially a page within a page,
3212  called minipages.
3213  Within a minipage, all the usual rules of indentation, line wrapping, etc.\InsetSpace ~
3214 apply.
3215  LyX also provides some of the minipage capability.
3216 \end_layout
3217
3218 \begin_layout Standard
3219 Minipages in LyX have their own collapsable box; insert one via 
3220 \family sans
3221 \bar under
3222 I
3223 \bar default
3224 nsert\SpecialChar \menuseparator
3225 Mini
3226 \bar under
3227 p
3228 \bar default
3229 age
3230 \family default
3231 .
3232  Right-clicking on the box allows you to alter the minipage's width and
3233  alignment within the page.
3234  Warning: if the minipage is too long to fit on a page, it is truncated,
3235  not wrapped onto the next page.
3236 \end_layout
3237
3238 \begin_layout Standard
3239 If you place two minipages side-by-side, you can use 
3240 \family sans
3241 \bar under
3242 I
3243 \bar default
3244 nsert\SpecialChar \menuseparator
3245
3246 \bar under
3247 S
3248 \bar default
3249 pecial\InsetSpace ~
3250 Character
3251 \family default
3252  to insert a special instruction known in the LaTeX world as an 
3253 \family typewriter
3254 hfill
3255 \family default
3256  to put a maximum amount of space between them; it forces one minipage to
3257  the left edge, the other to the right edge.
3258  The examples below show the difference.
3259 \end_layout
3260
3261 \begin_layout Standard
3262 \begin_inset Box Frameless
3263 position "t"
3264 hor_pos "c"
3265 has_inner_box 1
3266 inner_pos "c"
3267 use_parbox 0
3268 width "1.5in"
3269 special "none"
3270 height "1pt"
3271 height_special "totalheight"
3272 status open
3273
3274 \begin_layout Standard
3275 This is a minipage which does not use hfill.
3276  This is the second sentence of a minipage which does not use hfill.
3277 \end_layout
3278
3279 \end_inset
3280
3281
3282 \end_layout
3283
3284 \begin_layout Standard
3285 \begin_inset Box Frameless
3286 position "t"
3287 hor_pos "c"
3288 has_inner_box 1
3289 inner_pos "c"
3290 use_parbox 0
3291 width "1.5in"
3292 special "none"
3293 height "1pt"
3294 height_special "totalheight"
3295 status open
3296
3297 \begin_layout Standard
3298 This is a second minipage which does not use hfill.
3299  This is the second sentence of a second minipage which does not use hfill.
3300 \end_layout
3301
3302 \end_inset
3303
3304
3305 \end_layout
3306
3307 \begin_layout Standard
3308 \begin_inset VSpace medskip
3309 \end_inset
3310
3311
3312 \end_layout
3313
3314 \begin_layout Standard
3315 Here is some normal text to separate the two examples.
3316 \end_layout
3317
3318 \begin_layout Standard
3319 \begin_inset VSpace medskip
3320 \end_inset
3321
3322
3323 \end_layout
3324
3325 \begin_layout Standard
3326 \begin_inset Box Frameless
3327 position "t"
3328 hor_pos "c"
3329 has_inner_box 1
3330 inner_pos "c"
3331 use_parbox 0
3332 width "1.5in"
3333 special "none"
3334 height "1pt"
3335 height_special "totalheight"
3336 status open
3337
3338 \begin_layout Standard
3339 This is a minipage which does use hfill.
3340  This is the second sentence of a minipage which does use hfill.
3341 \end_layout
3342
3343 \end_inset
3344
3345
3346 \hfill
3347
3348 \begin_inset Box Frameless
3349 position "t"
3350 hor_pos "c"
3351 has_inner_box 1
3352 inner_pos "c"
3353 use_parbox 0
3354 width "1.5in"
3355 special "none"
3356 height "1pt"
3357 height_special "totalheight"
3358 status open
3359
3360 \begin_layout Standard
3361 This is a second minipage which does use hfill.
3362  This is the second sentence of a second minipage which does use hfill.
3363 \end_layout
3364
3365 \end_inset
3366
3367
3368 \end_layout
3369
3370 \begin_layout Section
3371 Wrapping Text Around Figures
3372 \begin_inset LatexCommand \label{sec:floatflt}
3373
3374 \end_inset
3375
3376
3377 \end_layout
3378
3379 \begin_layout Standard
3380 \begin_inset Wrap figure
3381 placement r
3382 width "6cm"
3383 status open
3384
3385 \begin_layout Standard
3386 \begin_inset Graphics
3387         filename mobius.eps
3388         display color
3389         width 40col%
3390         rotateOrigin center
3391
3392 \end_inset
3393
3394
3395 \end_layout
3396
3397 \begin_layout Caption
3398 This is a wrapped figure, and this is the brilliant caption that describes
3399  it
3400 \end_layout
3401
3402 \end_inset
3403
3404
3405 \end_layout
3406
3407 \begin_layout Standard
3408 A very frequently asked question is whether text can be made to 
3409 \begin_inset Quotes eld
3410 \end_inset
3411
3412 wrap
3413 \begin_inset Quotes erd
3414 \end_inset
3415
3416  around figures so that a figure occupies some fraction of the column width
3417  and text fills the rest.
3418  If you have the LaTeX package 
3419 \family typewriter
3420 floatflt
3421 \family default
3422  installed (you can find out about it in the 
3423 \emph on
3424 LaTeX Configuration
3425 \emph default
3426  manual) you can do this.
3427 \end_layout
3428
3429 \begin_layout Standard
3430 At the right is a figure of a mobius strip---you should have already seen
3431  this in the 
3432 \emph on
3433 User's Guide
3434 \emph default
3435 .
3436  To wrap the text like this insert a wrap box via 
3437 \family sans
3438 \bar under
3439 I
3440 \bar default
3441 nsert\SpecialChar \menuseparator
3442 Flo
3443 \bar under
3444 a
3445 \bar default
3446 ts\SpecialChar \menuseparator
3447 Floatflt Figure
3448 \family default
3449 .
3450 \end_layout
3451
3452 \begin_layout Standard
3453 Note: this package is very fragile! For example, having a figure too close
3454  to the bottom of the page will mess things up, as will having two figures
3455  close together.
3456  Use this package sparingly and do read the documentation that came with
3457  it (which will also tell you how to wrap text around tables).
3458 \end_layout
3459
3460 \begin_layout Section
3461 Extra Table Options
3462 \end_layout
3463
3464 \begin_layout Standard
3465 While the standard table layout will suffice in 99% of all tables you generate,
3466  occasionally you will run into one which requires a bit of extra tweaking.
3467  The table dialog which appears on a right-click of a table allows these
3468  tweaks to be made.
3469  It will give you access to some extra column alignment parameters.
3470  A little bit of LaTeX background is useful here: when you set up a table
3471  in LaTeX, each column is given an alignment type.
3472  For example, you would give it 
3473 \begin_inset Quotes eld
3474 \end_inset
3475
3476
3477 \family typewriter
3478 l
3479 \family default
3480
3481 \begin_inset Quotes erd
3482 \end_inset
3483
3484
3485 \begin_inset Quotes eld
3486 \end_inset
3487
3488
3489 \family typewriter
3490 c
3491 \family default
3492
3493 \begin_inset Quotes erd
3494 \end_inset
3495
3496 , or 
3497 \begin_inset Quotes eld
3498 \end_inset
3499
3500
3501 \family typewriter
3502 r
3503 \family default
3504
3505 \begin_inset Quotes erd
3506 \end_inset
3507
3508  for left-aligned, centered, and right-aligned columns respectively (which
3509  appear as the left/center/right radio buttons in LyX).
3510  A fourth type is 
3511 \begin_inset Quotes eld
3512 \end_inset
3513
3514
3515 \family typewriter
3516 p
3517 \family default
3518
3519 \begin_inset Quotes erd
3520 \end_inset
3521
3522 , which will make a column of a specified width (the width box in LyX),
3523  and will wrap text within that box.
3524  A fifth type is 
3525 \begin_inset Quotes eld
3526 \end_inset
3527
3528
3529 \family typewriter
3530 |
3531 \family default
3532
3533 \begin_inset Quotes erd
3534 \end_inset
3535
3536  (vertical bar) which rather than making a column will make a vertical rule
3537  at that point; this manifests itself in LyX as the 
3538 \begin_inset Quotes eld
3539 \end_inset
3540
3541 borders
3542 \begin_inset Quotes erd
3543 \end_inset
3544
3545  buttons.
3546  Finally, there is a type 
3547 \begin_inset Quotes eld
3548 \end_inset
3549
3550
3551 \family typewriter
3552 @
3553 \family default
3554
3555 \begin_inset Quotes erd
3556 \end_inset
3557
3558 , which allows you to use whatever is enclosed in the accompanying braces
3559  as the column separator, including a null argument.
3560  The reasons for doing this may not be obvious, but they can be very powerful.
3561  They are best demonstrated by example.
3562 \end_layout
3563
3564 \begin_layout Subsection
3565 Removing Extra Column Space
3566 \end_layout
3567
3568 \begin_layout Standard
3569 Here is a standard table:
3570 \end_layout
3571
3572 \begin_layout Standard
3573 \align center
3574 \begin_inset Tabular
3575 <lyxtabular version="3" rows="3" columns="2">
3576 <features>
3577 <column alignment="left" valignment="top" width="0pt">
3578 <column alignment="left" valignment="top" leftline="true" width="0pt">
3579 <row bottomline="true">
3580 <cell alignment="left" valignment="top" topline="true" usebox="none">
3581 \begin_inset Text
3582
3583 \begin_layout Standard
3584
3585 \family roman
3586 \series medium
3587 \shape up
3588 \size normal
3589 \emph off
3590 \bar no
3591 \noun off
3592 \color none
3593 Type
3594 \end_layout
3595
3596 \end_inset
3597 </cell>
3598 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3599 \begin_inset Text
3600
3601 \begin_layout Standard
3602
3603 \family roman
3604 \series medium
3605 \shape up
3606 \size normal
3607 \emph off
3608 \bar no
3609 \noun off
3610 \color none
3611 Example
3612 \end_layout
3613
3614 \end_inset
3615 </cell>
3616 </row>
3617 <row>
3618 <cell alignment="left" valignment="top" topline="true" usebox="none">
3619 \begin_inset Text
3620
3621 \begin_layout Standard
3622
3623 \family roman
3624 \series medium
3625 \shape up
3626 \size normal
3627 \emph off
3628 \bar no
3629 \noun off
3630 \color none
3631 Rock
3632 \end_layout
3633
3634 \end_inset
3635 </cell>
3636 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3637 \begin_inset Text
3638
3639 \begin_layout Standard
3640
3641 \family roman
3642 \series medium
3643 \shape up
3644 \size normal
3645 \emph off
3646 \bar no
3647 \noun off
3648 \color none
3649 Granite
3650 \end_layout
3651
3652 \end_inset
3653 </cell>
3654 </row>
3655 <row>
3656 <cell alignment="center" valignment="top" topline="true" usebox="none">
3657 \begin_inset Text
3658
3659 \begin_layout Standard
3660
3661 \family roman
3662 \series medium
3663 \shape up
3664 \size normal
3665 \emph off
3666 \bar no
3667 \noun off
3668 \color none
3669 Mineral
3670 \end_layout
3671
3672 \end_inset
3673 </cell>
3674 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3675 \begin_inset Text
3676
3677 \begin_layout Standard
3678
3679 \family roman
3680 \series medium
3681 \shape up
3682 \size normal
3683 \emph off
3684 \bar no
3685 \noun off
3686 \color none
3687 Quartz
3688 \end_layout
3689
3690 \end_inset
3691 </cell>
3692 </row>
3693 </lyxtabular>
3694
3695 \end_inset
3696
3697
3698 \end_layout
3699
3700 \begin_layout Standard
3701 Notice that the horizontal rule extends a bit past the text on both sides.
3702  If you wanted the line to end even with the text, we can put a null separator
3703  on the ends to get rid of the bit of extra space LaTeX adds by default.
3704  Here is the example:
3705 \end_layout
3706
3707 \begin_layout Standard
3708 \align center
3709 \begin_inset Tabular
3710 <lyxtabular version="3" rows="3" columns="2">
3711 <features>
3712 <column alignment="left" valignment="top" width="0pt" special="@{} l">
3713 <column alignment="left" valignment="top" leftline="true" width="0pt" special="l @{}">
3714 <row bottomline="true">
3715 <cell alignment="left" valignment="top" topline="true" usebox="none">
3716 \begin_inset Text
3717
3718 \begin_layout Standard
3719
3720 \family roman
3721 \series medium
3722 \shape up
3723 \size normal
3724 \emph off
3725 \bar no
3726 \noun off
3727 \color none
3728 Type
3729 \end_layout
3730
3731 \end_inset
3732 </cell>
3733 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3734 \begin_inset Text
3735
3736 \begin_layout Standard
3737
3738 \family roman
3739 \series medium
3740 \shape up
3741 \size normal
3742 \emph off
3743 \bar no
3744 \noun off
3745 \color none
3746 Example
3747 \end_layout
3748
3749 \end_inset
3750 </cell>
3751 </row>
3752 <row>
3753 <cell alignment="left" valignment="top" topline="true" usebox="none">
3754 \begin_inset Text
3755
3756 \begin_layout Standard
3757
3758 \family roman
3759 \series medium
3760 \shape up
3761 \size normal
3762 \emph off
3763 \bar no
3764 \noun off
3765 \color none
3766 Rock
3767 \end_layout
3768
3769 \end_inset
3770 </cell>
3771 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3772 \begin_inset Text
3773
3774 \begin_layout Standard
3775
3776 \family roman
3777 \series medium
3778 \shape up
3779 \size normal
3780 \emph off
3781 \bar no
3782 \noun off
3783 \color none
3784 Granite
3785 \end_layout
3786
3787 \end_inset
3788 </cell>
3789 </row>
3790 <row>
3791 <cell alignment="center" valignment="top" topline="true" usebox="none">
3792 \begin_inset Text
3793
3794 \begin_layout Standard
3795
3796 \family roman
3797 \series medium
3798 \shape up
3799 \size normal
3800 \emph off
3801 \bar no
3802 \noun off
3803 \color none
3804 Mineral
3805 \end_layout
3806
3807 \end_inset
3808 </cell>
3809 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3810 \begin_inset Text
3811
3812 \begin_layout Standard
3813
3814 \family roman
3815 \series medium
3816 \shape up
3817 \size normal
3818 \emph off
3819 \bar no
3820 \noun off
3821 \color none
3822 Quartz
3823 \end_layout
3824
3825 \end_inset
3826 </cell>
3827 </row>
3828 </lyxtabular>
3829
3830 \end_inset
3831
3832
3833 \end_layout
3834
3835 \begin_layout Standard
3836 In this case, the column specifier for the left column was set to 
3837 \begin_inset Quotes eld
3838 \end_inset
3839
3840
3841 \family typewriter
3842 @{} l
3843 \family default
3844
3845 \begin_inset Quotes erd
3846 \end_inset
3847
3848 , while the right column was set to 
3849 \begin_inset Quotes eld
3850 \end_inset
3851
3852
3853 \family typewriter
3854 l @{}
3855 \family default
3856
3857 \begin_inset Quotes erd
3858 \end_inset
3859
3860 , in order to put the null characters on the edges.
3861  
3862 \end_layout
3863
3864 \begin_layout Subsection
3865 Changing the Column Separator Character
3866 \end_layout
3867
3868 \begin_layout Standard
3869 Now suppose you really wanted, for reasons that are completely opaque, to
3870  use 
3871 \begin_inset Formula $\sqrt{\pi}$
3872 \end_inset
3873
3874  with some space around it for the column separator.
3875  Simply turn off the vertical border, then set the right column specifier
3876  to 
3877 \begin_inset Quotes eld
3878 \end_inset
3879
3880
3881 \family typewriter
3882 @{~$
3883 \backslash
3884 sqrt{
3885 \backslash
3886 pi}$~} l
3887 \family default
3888
3889 \begin_inset Quotes erd
3890 \end_inset
3891
3892 .
3893  You could now make a table like this:
3894 \end_layout
3895
3896 \begin_layout Standard
3897 \align center
3898 \begin_inset Tabular
3899 <lyxtabular version="3" rows="3" columns="2">
3900 <features>
3901 <column alignment="left" valignment="top" width="0pt">
3902 <column alignment="left" valignment="top" width="0in" special="@{~$\sqrt{\pi}$~}l">
3903 <row bottomline="true">
3904 <cell alignment="left" valignment="top" topline="true" usebox="none">
3905 \begin_inset Text
3906
3907 \begin_layout Standard
3908
3909 \family roman
3910 \series medium
3911 \shape up
3912 \size normal
3913 \emph off
3914 \bar no
3915 \noun off
3916 \color none
3917 Type
3918 \end_layout
3919
3920 \end_inset
3921 </cell>
3922 <cell alignment="left" valignment="top" topline="true" usebox="none">
3923 \begin_inset Text
3924
3925 \begin_layout Standard
3926
3927 \family roman
3928 \series medium
3929 \shape up
3930 \size normal
3931 \emph off
3932 \bar no
3933 \noun off
3934 \color none
3935 Example
3936 \end_layout
3937
3938 \end_inset
3939 </cell>
3940 </row>
3941 <row>
3942 <cell alignment="left" valignment="top" topline="true" usebox="none">
3943 \begin_inset Text
3944
3945 \begin_layout Standard
3946
3947 \family roman
3948 \series medium
3949 \shape up
3950 \size normal
3951 \emph off
3952 \bar no
3953 \noun off
3954 \color none
3955 Rock
3956 \end_layout
3957
3958 \end_inset
3959 </cell>
3960 <cell alignment="center" valignment="top" topline="true" usebox="none">
3961 \begin_inset Text
3962
3963 \begin_layout Standard
3964
3965 \family roman
3966 \series medium
3967 \shape up
3968 \size normal
3969 \emph off
3970 \bar no
3971 \noun off
3972 \color none
3973 Granite
3974 \end_layout
3975
3976 \end_inset
3977 </cell>
3978 </row>
3979 <row>
3980 <cell alignment="center" valignment="top" topline="true" usebox="none">
3981 \begin_inset Text
3982
3983 \begin_layout Standard
3984
3985 \family roman
3986 \series medium
3987 \shape up
3988 \size normal
3989 \emph off
3990 \bar no
3991 \noun off
3992 \color none
3993 Mineral
3994 \end_layout
3995
3996 \end_inset
3997 </cell>
3998 <cell alignment="center" valignment="top" topline="true" usebox="none">
3999 \begin_inset Text
4000
4001 \begin_layout Standard
4002
4003 \family roman
4004 \series medium
4005 \shape up
4006 \size normal
4007 \emph off
4008 \bar no
4009 \noun off
4010 \color none
4011 Quartz
4012 \end_layout
4013
4014 \end_inset
4015 </cell>
4016 </row>
4017 </lyxtabular>
4018
4019 \end_inset
4020
4021
4022 \end_layout
4023
4024 \begin_layout Subsection
4025 Making a Decimal Point Aligned Column
4026 \end_layout
4027
4028 \begin_layout Standard
4029 Okay, that last example was very silly, but here is one that is not.
4030  Suppose you want to make a table that has a column which is aligned on
4031  a decimal point.
4032  A standard LaTeX trick to do this is to set the whole number part in a
4033  right-aligned column, use a decimal point for the column separator, then
4034  set the fractional part as a left-aligned column.
4035  A variation on this is to include the decimal point explicitly with the
4036  whole part, then use just a null separator in between.
4037  The latter variation is demonstrated here:
4038 \end_layout
4039
4040 \begin_layout Standard
4041 \align center
4042 \begin_inset Tabular
4043 <lyxtabular version="3" rows="5" columns="3">
4044 <features>
4045 <column alignment="center" valignment="top" width="0pt">
4046 <column alignment="right" valignment="top" leftline="true" width="0pt">
4047 <column alignment="center" valignment="top" width="0pt" special="@{} l">
4048 <row bottomline="true">
4049 <cell alignment="center" valignment="top" topline="true" usebox="none">
4050 \begin_inset Text
4051
4052 \begin_layout Standard
4053
4054 \family roman
4055 \series medium
4056 \shape up
4057 \size normal
4058 \emph off
4059 \bar no
4060 \noun off
4061 \color none
4062 Expression
4063 \end_layout
4064
4065 \end_inset
4066 </cell>
4067 <cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
4068 \begin_inset Text
4069
4070 \begin_layout Standard
4071
4072 \family roman
4073 \series medium
4074 \shape up
4075 \size normal
4076 \emph off
4077 \bar no
4078 \noun off
4079 \color none
4080 Value 
4081 \end_layout
4082
4083 \end_inset
4084 </cell>
4085 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
4086 \begin_inset Text
4087
4088 \begin_layout Standard
4089
4090 \end_layout
4091
4092 \end_inset
4093 </cell>
4094 </row>
4095 <row>
4096 <cell alignment="center" valignment="top" topline="true" usebox="none">
4097 \begin_inset Text
4098
4099 \begin_layout Standard
4100
4101 \family roman
4102 \series medium
4103 \shape up
4104 \size normal
4105 \emph off
4106 \bar no
4107 \noun off
4108 \color none
4109 \begin_inset Formula $\pi$
4110 \end_inset
4111
4112
4113 \end_layout
4114
4115 \end_inset
4116 </cell>
4117 <cell alignment="right" valignment="top" topline="true" leftline="true" usebox="none">
4118 \begin_inset Text
4119
4120 \begin_layout Standard
4121
4122 \family roman
4123 \series medium
4124 \shape up
4125 \size normal
4126 \emph off
4127 \bar no
4128 \noun off
4129 \color none
4130 3.
4131 \end_layout
4132
4133 \end_inset
4134 </cell>
4135 <cell alignment="center" valignment="top" topline="true" usebox="none">
4136 \begin_inset Text
4137
4138 \begin_layout Standard
4139
4140 \family roman
4141 \series medium
4142 \shape up
4143 \size normal
4144 \emph off
4145 \bar no
4146 \noun off
4147 \color none
4148 1416
4149 \end_layout
4150
4151 \end_inset
4152 </cell>
4153 </row>
4154 <row>
4155 <cell alignment="center" valignment="top" topline="true" usebox="none">
4156 \begin_inset Text
4157
4158 \begin_layout Standard
4159
4160 \family roman
4161 \series medium
4162 \shape up
4163 \size normal
4164 \emph off
4165 \bar no
4166 \noun off
4167 \color none
4168 \begin_inset Formula $\pi^{\pi}$
4169 \end_inset
4170
4171
4172 \end_layout
4173
4174 \end_inset
4175 </cell>
4176 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4177 \begin_inset Text
4178
4179 \begin_layout Standard
4180
4181 \family roman
4182 \series medium
4183 \shape up
4184 \size normal
4185 \emph off
4186 \bar no
4187 \noun off
4188 \color none
4189 36.
4190 \end_layout
4191
4192 \end_inset
4193 </cell>
4194 <cell alignment="center" valignment="top" topline="true" usebox="none">
4195 \begin_inset Text
4196
4197 \begin_layout Standard
4198
4199 \family roman
4200 \series medium
4201 \shape up
4202 \size normal
4203 \emph off
4204 \bar no
4205 \noun off
4206 \color none
4207 462
4208 \end_layout
4209
4210 \end_inset
4211 </cell>
4212 </row>
4213 <row>
4214 <cell alignment="center" valignment="top" topline="true" usebox="none">
4215 \begin_inset Text
4216
4217 \begin_layout Standard
4218
4219 \family roman
4220 \series medium
4221 \shape up
4222 \size normal
4223 \emph off
4224 \bar no
4225 \noun off
4226 \color none
4227 \begin_inset Formula $(\pi^{\pi})^{\pi}$
4228 \end_inset
4229
4230
4231 \end_layout
4232
4233 \end_inset
4234 </cell>
4235 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4236 \begin_inset Text
4237
4238 \begin_layout Standard
4239
4240 \family roman
4241 \series medium
4242 \shape up
4243 \size normal
4244 \emph off
4245 \bar no
4246 \noun off
4247 \color none
4248 80663.
4249 \end_layout
4250
4251 \end_inset
4252 </cell>
4253 <cell alignment="center" valignment="top" topline="true" usebox="none">
4254 \begin_inset Text
4255
4256 \begin_layout Standard
4257
4258 \end_layout
4259
4260 \end_inset
4261 </cell>
4262 </row>
4263 <row>
4264 <cell alignment="center" valignment="top" topline="true" usebox="none">
4265 \begin_inset Text
4266
4267 \begin_layout Standard
4268
4269 \family roman
4270 \series medium
4271 \shape up
4272 \size normal
4273 \emph off
4274 \bar no
4275 \noun off
4276 \color none
4277 \begin_inset Formula $\pi^{\pi^{\pi}}$
4278 \end_inset
4279
4280
4281 \end_layout
4282
4283 \end_inset
4284 </cell>
4285 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4286 \begin_inset Text
4287
4288 \begin_layout Standard
4289
4290 \family roman
4291 \series medium
4292 \shape up
4293 \size normal
4294 \emph off
4295 \bar no
4296 \noun off
4297 \color none
4298 1.
4299 \end_layout
4300
4301 \end_inset
4302 </cell>
4303 <cell alignment="center" valignment="top" topline="true" usebox="none">
4304 \begin_inset Text
4305
4306 \begin_layout Standard
4307
4308 \family roman
4309 \series medium
4310 \shape up
4311 \size normal
4312 \emph off
4313 \bar no
4314 \noun off
4315 \color none
4316 3402
4317 \begin_inset Formula $\times10^{18}$
4318 \end_inset
4319
4320
4321 \end_layout
4322
4323 \end_inset
4324 </cell>
4325 </row>
4326 </lyxtabular>
4327
4328 \end_inset
4329
4330
4331 \end_layout
4332
4333 \begin_layout Standard
4334 Though it appears a bit funny in LyX, on paper it will produce what appears
4335  to be a 2-column table in which the right column is aligned on the decimal
4336  point and the header appears to be centered over it.
4337 \end_layout
4338
4339 \begin_layout Standard
4340 Perhaps it is best if I described just what I did: first, create a 3
4341 \begin_inset Formula $\times$
4342 \end_inset
4343
4344 3 table and remove all the borders.
4345  Then re-add a bottom border to the top row, and a right border to the first
4346  column.
4347  Type in the values for the first column and set its alignment to 
4348 \family sans
4349 center
4350 \family default
4351 .
4352  Type in the 
4353 \family typewriter
4354 3.
4355 \family default
4356
4357 \family typewriter
4358 36.
4359 \family default
4360
4361 \family typewriter
4362 80663.
4363 \family default
4364 , and 
4365 \family typewriter
4366 1.
4367
4368 \family default
4369  and set that column's alignment to 
4370 \family sans
4371 right
4372 \family default
4373 .
4374  Type in the 
4375 \family typewriter
4376 1416
4377 \family default
4378
4379 \family typewriter
4380 462
4381 \family default
4382 , and 
4383 \family typewriter
4384 3402
4385 \begin_inset Formula $\times10^{18}$
4386 \end_inset
4387
4388
4389 \family default
4390  and set the extra column alignment to 
4391 \family typewriter
4392 @{} l
4393 \family default
4394 .
4395  Finally type in the word 
4396 \family typewriter
4397 Value
4398 \family default
4399  in the middle column, highlight it and the blank entry to its right, and
4400  check the 
4401 \family sans
4402 Special Cell
4403 \family default
4404  entry 
4405 \family sans
4406 multicolumn
4407 \family default
4408 .
4409  Easy, right? 
4410 \end_layout
4411
4412 \begin_layout Subsection
4413 A Better Decimal-Alignment Solution
4414 \end_layout
4415
4416 \begin_layout Standard
4417 An alternative way to have decimal alignment in tables is through the 
4418 \family typewriter
4419 dcolumn
4420 \family default
4421  package.
4422  Add the following to the LateX preamble:
4423 \end_layout
4424
4425 \begin_layout LyX-Code
4426
4427 \backslash
4428 usepackage{dcolumn}
4429 \end_layout
4430
4431 \begin_layout LyX-Code
4432
4433 \backslash
4434 newcolumntype{d}[1]{D{.}{.}{#1}}
4435 \end_layout
4436
4437 \begin_layout Standard
4438 To have a column decimally aligned, enter in the 
4439 \family sans
4440 Special Column Alignment
4441 \family default
4442  box of the 
4443 \family sans
4444 Table
4445 \family default
4446  dialog the following:
4447 \end_layout
4448
4449 \begin_layout LyX-Code
4450 d{number of decimals of the data}
4451 \end_layout
4452
4453 \begin_layout Standard
4454 To create extra column space just increase the number of decimals in 
4455 \family typewriter
4456 d{}
4457 \family default
4458 .
4459  Setting the multicolumn attribute for a single cell makes it insensitive
4460  to the decimal alignment which comes in handy as well.
4461  A drawback of this method is that math mode is not allowed in a column
4462  with decimal alignment except if the multicolumn attribute is set.
4463 \end_layout
4464
4465 \begin_layout Standard
4466 This method offers the same flexibility as the 
4467 \family typewriter
4468 dcolumn
4469 \family default
4470  package.
4471  One could, for example, change the alignment separator, and have different
4472  alignment separators for different columns by defining multiple column
4473  types in the preamble.
4474  The syntax is as follows: 
4475 \end_layout
4476
4477 \begin_layout LyX-Code
4478 D{inputsep}{outputsep}{decimal places}
4479 \end_layout
4480
4481 \begin_layout Standard
4482 The interested reader is directed towards the 
4483 \family typewriter
4484 dcolumn
4485 \family default
4486  package documentation for more details.
4487 \end_layout
4488
4489 \begin_layout Section
4490 Itemize Bullet Selection
4491 \begin_inset LatexCommand \label{sec:bullet}
4492
4493 \end_inset
4494
4495
4496 \end_layout
4497
4498 \begin_layout Standard
4499 by
4500 \noun on
4501  Allan Rae
4502 \end_layout
4503
4504 \begin_layout Subsection
4505 Introduction
4506 \end_layout
4507
4508 \begin_layout Standard
4509 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
4510  Using this dialog you can easily specify what bullet shape to use at each
4511  level of an itemized list.
4512  These settings are document-wide so you won't be able to specify different
4513  sets of bullets for different paragraphs
4514 \begin_inset Foot
4515 status collapsed
4516
4517 \begin_layout Standard
4518 Well, actually you can but you'll have to do it by hand.
4519 \end_layout
4520
4521 \end_inset
4522
4523 .
4524 \end_layout
4525
4526 \begin_layout Subsection
4527 How it looks
4528 \end_layout
4529
4530 \begin_layout Standard
4531 Open the dialog by selecting the 
4532 \family sans
4533 \bar under
4534 D
4535 \bar default
4536 ocument\SpecialChar \menuseparator
4537
4538 \bar under
4539 S
4540 \bar default
4541 ettings
4542 \family default
4543  menu item and then select the 
4544 \family sans
4545 \bar under
4546 B
4547 \bar default
4548 ullets
4549 \family default
4550  tab.
4551 \end_layout
4552
4553 \begin_layout Standard
4554 The dialog provides you with a table of bullet shapes.
4555  A column of buttons on the left of the table provides access to the six
4556  different panels of bullet shapes.
4557  The row of buttons across the top is used to select which bullet depth
4558  you are changing.
4559  A text entry under the table shows the currently selected bullet shape's
4560  LaTeX equivalent and this can be edited if desired.
4561  If you do modify the text you will also need to specify any needed packages
4562  in the LaTeX preamble.
4563 \end_layout
4564
4565 \begin_layout Standard
4566 The six panels are divided up by the packages they require.
4567  The following table shows the mappings from button name to LaTeX packages.
4568 \end_layout
4569
4570 \begin_layout Standard
4571 \align center
4572 \begin_inset Tabular
4573 <lyxtabular version="3" rows="7" columns="2">
4574 <features>
4575 <column alignment="center" valignment="top" leftline="true" width="0pt">
4576 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
4577 <row topline="true" bottomline="true">
4578 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4579 \begin_inset Text
4580
4581 \begin_layout Standard
4582
4583 \family roman
4584 \series medium
4585 \shape up
4586 \size normal
4587 \emph off
4588 \bar no
4589 \noun off
4590 \color none
4591 Button
4592 \end_layout
4593
4594 \end_inset
4595 </cell>
4596 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4597 \begin_inset Text
4598
4599 \begin_layout Standard
4600
4601 \family roman
4602 \series medium
4603 \shape up
4604 \size normal
4605 \emph off
4606 \bar no
4607 \noun off
4608 \color none
4609 Packages Required
4610 \end_layout
4611
4612 \end_inset
4613 </cell>
4614 </row>
4615 <row topline="true">
4616 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4617 \begin_inset Text
4618
4619 \begin_layout Standard
4620
4621 \family sans
4622 \series medium
4623 \shape up
4624 \size normal
4625 \emph off
4626 \bar no
4627 \noun off
4628 \color none
4629 Standard
4630 \end_layout
4631
4632 \end_inset
4633 </cell>
4634 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4635 \begin_inset Text
4636
4637 \begin_layout Standard
4638
4639 \series medium
4640 \shape up
4641 \size normal
4642 \emph off
4643 \bar no
4644 \noun off
4645 \color none
4646 base LaTeX
4647 \end_layout
4648
4649 \end_inset
4650 </cell>
4651 </row>
4652 <row topline="true">
4653 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4654 \begin_inset Text
4655
4656 \begin_layout Standard
4657
4658 \family sans
4659 \series medium
4660 \shape up
4661 \size normal
4662 \emph off
4663 \bar no
4664 \noun off
4665 \color none
4666 Maths
4667 \end_layout
4668
4669 \end_inset
4670 </cell>
4671 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4672 \begin_inset Text
4673
4674 \begin_layout Standard
4675
4676 \family typewriter
4677 \series medium
4678 \shape up
4679 \size normal
4680 \emph off
4681 \bar no
4682 \noun off
4683 \color none
4684 amssymb.sty
4685 \end_layout
4686
4687 \end_inset
4688 </cell>
4689 </row>
4690 <row topline="true">
4691 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4692 \begin_inset Text
4693
4694 \begin_layout Standard
4695
4696 \family sans
4697 \series medium
4698 \shape up
4699 \size normal
4700 \emph off
4701 \bar no
4702 \noun off
4703 \color none
4704 Ding1
4705 \end_layout
4706
4707 \end_inset
4708 </cell>
4709 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4710 \begin_inset Text
4711
4712 \begin_layout Standard
4713
4714 \family typewriter
4715 \series medium
4716 \shape up
4717 \size normal
4718 \emph off
4719 \bar no
4720 \noun off
4721 \color none
4722 pifont.sty
4723 \end_layout
4724
4725 \end_inset
4726 </cell>
4727 </row>
4728 <row topline="true">
4729 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4730 \begin_inset Text
4731
4732 \begin_layout Standard
4733
4734 \family sans
4735 \series medium
4736 \shape up
4737 \size normal
4738 \emph off
4739 \bar no
4740 \noun off
4741 \color none
4742 Ding2
4743 \end_layout
4744
4745 \end_inset
4746 </cell>
4747 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4748 \begin_inset Text
4749
4750 \begin_layout Standard
4751
4752 \family typewriter
4753 \series medium
4754 \shape up
4755 \size normal
4756 \emph off
4757 \bar no
4758 \noun off
4759 \color none
4760 pifont.sty
4761 \end_layout
4762
4763 \end_inset
4764 </cell>
4765 </row>
4766 <row topline="true">
4767 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4768 \begin_inset Text
4769
4770 \begin_layout Standard
4771
4772 \family sans
4773 \series medium
4774 \shape up
4775 \size normal
4776 \emph off
4777 \bar no
4778 \noun off
4779 \color none
4780 Ding3
4781 \end_layout
4782
4783 \end_inset
4784 </cell>
4785 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4786 \begin_inset Text
4787
4788 \begin_layout Standard
4789
4790 \family typewriter
4791 \series medium
4792 \shape up
4793 \size normal
4794 \emph off
4795 \bar no
4796 \noun off
4797 \color none
4798 pifont.sty
4799 \end_layout
4800
4801 \end_inset
4802 </cell>
4803 </row>
4804 <row topline="true" bottomline="true">
4805 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4806 \begin_inset Text
4807
4808 \begin_layout Standard
4809
4810 \family sans
4811 \series medium
4812 \shape up
4813 \size normal
4814 \emph off
4815 \bar no
4816 \noun off
4817 \color none
4818 Ding4
4819 \end_layout
4820
4821 \end_inset
4822 </cell>
4823 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4824 \begin_inset Text
4825
4826 \begin_layout Standard
4827
4828 \family typewriter
4829 \series medium
4830 \shape up
4831 \size normal
4832 \emph off
4833 \bar no
4834 \noun off
4835 \color none
4836 pifont.sty
4837 \end_layout
4838
4839 \end_inset
4840 </cell>
4841 </row>
4842 </lyxtabular>
4843
4844 \end_inset
4845
4846
4847 \end_layout
4848
4849 \begin_layout Standard
4850 LyX doesn't stop you using bullets from packages you don't have.
4851  If you get errors from LaTeX when you try to view or print the file then
4852  its likely you are missing a package.
4853  LyX doesn't restrict your use since you may be editing locally and exporting
4854  elsewhere.
4855 \end_layout
4856
4857 \begin_layout Subsection
4858 How to use it
4859 \end_layout
4860
4861 \begin_layout Standard
4862 Select which bullet depth you want to change then select the bullet shape
4863  and size.
4864
4865 \family sans
4866  
4867 \family default
4868 Any changes will not be visible in LyX, but are visible when viewing the
4869  document using xdvi or ghostview.
4870 \end_layout
4871
4872 \begin_layout Standard
4873 You can reset a bullet shape to the default simply by clicking your right
4874  mouse button on the appropriate bullet depth button.
4875 \end_layout
4876
4877 \begin_layout Standard
4878 If you 
4879 \emph on
4880 really
4881 \emph default
4882  want to have multiple sets of paragraphs with different sets of bullets
4883  in each then you're going to have to get your hands dirty.
4884  The itemize bullet selection dialog can help though because it provides
4885  you with the LaTeX code for a wide range of bullet shapes.
4886  To make your own custom paragraphs you have the following options:
4887 \end_layout
4888
4889 \begin_layout Standard
4890 \begin_inset ERT
4891 status inlined
4892
4893 \begin_layout Standard
4894
4895
4896 \backslash
4897 let
4898 \backslash
4899 savelabelitemi=
4900 \backslash
4901 labelitemi
4902 \end_layout
4903
4904 \end_inset
4905
4906
4907 \end_layout
4908
4909 \begin_layout Standard
4910 \begin_inset ERT
4911 status inlined
4912
4913 \begin_layout Standard
4914
4915
4916 \backslash
4917 renewcommand
4918 \backslash
4919 labelitemi[0]{
4920 \backslash
4921 small
4922 \backslash
4923 (
4924 \backslash
4925 sharp
4926 \backslash
4927 )}
4928 \end_layout
4929
4930 \end_inset
4931
4932
4933 \end_layout
4934
4935 \begin_layout Itemize
4936 Use the LaTeX command 
4937 \family typewriter
4938
4939 \backslash
4940 renewcommand{}{}
4941 \family default
4942  to specify a new bullet shape for a given depth.
4943  You'll also need to save the current bullet shape so you can restore it
4944  again afterwards.
4945  In this itemized list the following LaTeX code was used to change the bullet
4946  used for the first depth.
4947 \newline
4948
4949 \family typewriter
4950
4951 \backslash
4952 let
4953 \backslash
4954 savelabelitemi=
4955 \backslash
4956 labelitemi
4957 \family default
4958  
4959 \family typewriter
4960
4961 \newline
4962
4963 \backslash
4964 renewcommand
4965 \backslash
4966 labelitemi[0]{
4967 \backslash
4968 small
4969 \backslash
4970 (
4971 \backslash
4972 sharp
4973 \backslash
4974 )}
4975 \newline
4976
4977 \family default
4978 Note that the itemize depth is specified in Roman numerals as part of the
4979  
4980 \family typewriter
4981
4982 \backslash
4983 labelitem
4984 \family default
4985  command.
4986 \end_layout
4987
4988 \begin_layout Itemize
4989 \begin_inset ERT
4990 status inlined
4991
4992 \begin_layout Standard
4993
4994 [
4995 \backslash
4996 (
4997 \backslash
4998 star
4999 \backslash
5000 )]
5001 \end_layout
5002
5003 \end_inset
5004
5005  Specify each individual entry by starting each item with the bullet shape
5006  enclosed in square brackets and set as TeX.
5007  For example, this item was started with 
5008 \family typewriter
5009 [
5010 \backslash
5011 (
5012 \backslash
5013 star
5014 \backslash
5015 )]
5016 \family default
5017 .
5018 \end_layout
5019
5020 \begin_layout Standard
5021 \begin_inset ERT
5022 status inlined
5023
5024 \begin_layout Standard
5025
5026
5027 \backslash
5028 renewcommand
5029 \backslash
5030 labelitemi[0]{
5031 \backslash
5032 savelabelitemi}
5033 \end_layout
5034
5035 \end_inset
5036
5037
5038 \end_layout
5039
5040 \begin_layout Standard
5041 You'll also need to revert the labelitem back to its previous setting for
5042  the global bullet shape settings to remain in effect.
5043  The way used here was:
5044 \newline
5045
5046 \family typewriter
5047
5048 \backslash
5049 renewcommand
5050 \backslash
5051 labelitemi[0]{
5052 \backslash
5053 savelabelitemi}
5054 \end_layout
5055
5056 \begin_layout Chapter
5057 Special Document Classes
5058 \end_layout
5059
5060 \begin_layout Section
5061 AMS LaTeX
5062 \end_layout
5063
5064 \begin_layout Standard
5065 by 
5066 \noun on
5067 David Johnson
5068 \end_layout
5069
5070 \begin_layout Standard
5071 \begin_inset VSpace bigskip
5072 \end_inset
5073
5074
5075 \end_layout
5076
5077 \begin_layout Standard
5078 \noindent
5079 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
5080  papers to be submitted to American Mathematical Society publications.
5081  The layouts are not tailored to a specific journal, but easily can be.
5082  You should refer to the AMS documentation for specific instructions for
5083  each journal (usually it will entail only changing a single line in the
5084  TeX output).
5085  That documentation is available on the Web at 
5086 \begin_inset LatexCommand \url{http://www.ams.org}
5087
5088 \end_inset
5089
5090  or by ftp at 
5091 \begin_inset LatexCommand \url{ftp://ftp.ams.org/pub/tex/amslatex/}
5092
5093 \end_inset
5094
5095 .These layouts are appropriate, and useful, for any mathematical writing.
5096  There are currently 4 distinct AMS LaTeX layouts: 
5097 \end_layout
5098
5099 \begin_layout Enumerate
5100 amsart: The standard AMS-article format.
5101  All results and similar statements are numbered as 
5102 \begin_inset Formula $(n.m)$
5103 \end_inset
5104
5105 , where the first number refers to the section, and the second refers to
5106  the total number of results (Theorems, Corollaries, Propositions, Definitions
5107  and Remarks, etc.) in that section.
5108  There are also many (but not all) environments available unnumbered, which
5109  is occasionally needed.
5110  Unnumbered environments indicated by an asterisk at the end.
5111 \end_layout
5112
5113 \begin_layout Enumerate
5114 amsart-seq: Here, numbering for each type of statement is in its own sequence,
5115  with no reference to the section number.
5116  There are also many (but not all) environments available unnumbered, which
5117  is occasionally needed.
5118  Unnumbered environments indicated by an asterisk at the end.
5119 \end_layout
5120
5121 \begin_layout Enumerate
5122 amsart-plain: This one is even more terse, since all the environments are
5123  unnumbered.
5124 \end_layout
5125
5126 \begin_layout Enumerate
5127 amsbook: the standard AMS book (really, monograph) format.
5128  Numbering is similar to the amsart layout, except that all numbering is
5129  by 
5130 \begin_inset Formula $(n.m.p)$
5131 \end_inset
5132
5133 , where the first number refers to the chapter, the second to the section,
5134  and the third is the number of the results (Theorems, Corollaries, Propositions
5135 , Definitions and Remarks, etc.) in that section.
5136  There are also many (but not all) environments available unnumbered, which
5137  is occasionally needed.
5138  Unnumbered environments indicated by an asterisk at the end.
5139 \end_layout
5140
5141 \begin_layout Standard
5142 Any AMS LyX file can be converted to either of the numbering schemes by
5143  simply changing the document class in the 
5144 \family sans
5145 \bar under
5146 D
5147 \bar default
5148 ocument\SpecialChar \menuseparator
5149
5150 \bar under
5151 S
5152 \bar default
5153 ettings
5154 \family default
5155  dialog.
5156  
5157 \end_layout
5158
5159 \begin_layout Subsection
5160 What these layouts provide
5161 \end_layout
5162
5163 \begin_layout Standard
5164 There is a long list of included environments provided by these layouts.
5165  Most mathematical papers or books will set as special statements most of
5166  these environments, in AMS-LaTeX there is an opportunity to define an unlimited
5167  variety of such declarations.
5168  However, the AMS recommends the environments that are available in LyX.
5169  The list of environments (not counting the standard environments such as
5170  
5171 \family sans
5172 sections, bibliography, title, author, date
5173 \family default
5174 ), is:
5175 \end_layout
5176
5177 \begin_layout Description
5178 Theorem This is typically used for the statements of major results.
5179  The word 
5180 \begin_inset Quotes eld
5181 \end_inset
5182
5183
5184 \family sans
5185 Theorem
5186 \family default
5187
5188 \begin_inset Quotes erd
5189 \end_inset
5190
5191  appears in bold type, along with an automatically-determined number (an
5192  unnumbered version, 
5193 \family sans
5194 Theorem*
5195 \family default
5196 , is also available).
5197  The text is italicized.
5198 \end_layout
5199
5200 \begin_layout Description
5201 Corollary This is used for statements which follow fairly directly from
5202  previous statements.
5203  Again, these can be major results.
5204  Unnumbered version 
5205 \family sans
5206 Corollary*
5207 \family default
5208  is available.
5209 \end_layout
5210
5211 \begin_layout Description
5212 Lemma These are smaller results needed to prove other statements.
5213 \end_layout
5214
5215 \begin_layout Description
5216 Proposition These are less major results which (hopefully) add to the general
5217  theory being discussed.
5218 \end_layout
5219
5220 \begin_layout Description
5221 Conjecture These are statements provided without justification, which the
5222  author does not know how to prove, but which seem to be true (to the author,
5223  at least).
5224 \end_layout
5225
5226 \begin_layout Description
5227 Criterion A required condition.
5228 \end_layout
5229
5230 \begin_layout Description
5231 Algorithm A general procedure to be used.
5232 \end_layout
5233
5234 \begin_layout Description
5235 Axiom This is a property or statement taken as true within the system being
5236  discussed.
5237 \end_layout
5238
5239 \begin_layout Description
5240 Definition Guess what this is for.
5241  The font, both on-screen and in the output, is different for this environment
5242  than for the previous ones.
5243  The heading (
5244 \begin_inset Quotes eld
5245 \end_inset
5246
5247 definition
5248 \begin_inset Quotes erd
5249 \end_inset
5250
5251 ) is still set in boldface, along with the number, if any, but the rest
5252  is set upright.
5253 \end_layout
5254
5255 \begin_layout Description
5256 Example Typeset similarly to Definition.
5257 \end_layout
5258
5259 \begin_layout Description
5260 Condition
5261 \end_layout
5262
5263 \begin_layout Description
5264 Problem
5265 \end_layout
5266
5267 \begin_layout Description
5268 Exercise
5269 \end_layout
5270
5271 \begin_layout Description
5272 Remark This environment is also a new type of theorem.
5273  This is set with the word Remark in italics, and the rest upright.
5274 \end_layout
5275
5276 \begin_layout Description
5277 Note Set similarly to the Remark environment.
5278 \end_layout
5279
5280 \begin_layout Description
5281 Notation
5282 \end_layout
5283
5284 \begin_layout Description
5285 Claim
5286 \end_layout
5287
5288 \begin_layout Description
5289 Summary
5290 \end_layout
5291
5292 \begin_layout Description
5293 Acknowledgement
5294 \end_layout
5295
5296 \begin_layout Description
5297 Case Generally, these are used to break up long arguments, using specific
5298  instances of some condition.
5299  The numbering scheme for cases is on its own, not together with other numbered
5300  statements.
5301  
5302 \end_layout
5303
5304 \begin_layout Description
5305 Conclusion
5306 \end_layout
5307
5308 \begin_layout Description
5309 Fact 
5310 \end_layout
5311
5312 \begin_layout Description
5313 Proof The word 
5314 \begin_inset Quotes eld
5315 \end_inset
5316
5317
5318 \shape italic
5319 Proof
5320 \shape default
5321
5322 \begin_inset Quotes erd
5323 \end_inset
5324
5325  is set in italics, but the rest is set upright.
5326  At the end of this environment (other environments can be nested within
5327  this one, of course) a QED symbol (usually a square, but it can vary with
5328  different styles) is placed.
5329 \end_layout
5330
5331 \begin_layout Description
5332 Address This should be the author's permanent address.
5333 \end_layout
5334
5335 \begin_layout Description
5336 Current\InsetSpace ~
5337 Address This should be the author's temporary address at the time
5338  of submission, if different from the Address.
5339 \end_layout
5340
5341 \begin_layout Description
5342 Email Author's e-mail address
5343 \end_layout
5344
5345 \begin_layout Description
5346 URL Author's Web address, if desired.
5347 \end_layout
5348
5349 \begin_layout Description
5350 Keywords Key words or phrases used to identify specific topics discussed
5351  in the paper.
5352 \end_layout
5353
5354 \begin_layout Description
5355 Subjectclass These refer to the AMS Subject Classifications, published and
5356  described in 
5357 \emph on
5358 Mathematical Reviews
5359 \emph default
5360 .
5361  These are also available online at the AMS cites listed above.
5362 \end_layout
5363
5364 \begin_layout Description
5365 Thanks
5366 \end_layout
5367
5368 \begin_layout Description
5369 Dedicatory
5370 \end_layout
5371
5372 \begin_layout Description
5373 Translator
5374 \end_layout
5375
5376 \begin_layout Standard
5377 In addition, these environments automatically provide the AMS LaTeX and
5378  AMS fonts packages.
5379  They need to be available on your system in order to use these environments.
5380 \end_layout
5381
5382 \begin_layout Section
5383 Dinbrief
5384 \end_layout
5385
5386 \begin_layout Standard
5387 The document class 
5388 \family sans
5389 dinbrief
5390 \family default
5391  can be used to type letters according to German conventions.
5392  A template file is included in 
5393 \family typewriter
5394 .../lyx/share/templates
5395 \family default
5396  for you to use as a starting point.
5397 \end_layout
5398
5399 \begin_layout Section
5400 Paper
5401 \end_layout
5402
5403 \begin_layout Standard
5404 The document class 
5405 \family sans
5406 paper
5407 \family default
5408  provides an alternative to the standard 
5409 \family sans
5410 article
5411 \family default
5412  class.
5413  It provides similar functionality, but you might prefer this layout with
5414  sans serif sections, headings, and more.
5415 \end_layout
5416
5417 \begin_layout Section
5418 A&A Paper
5419 \end_layout
5420
5421 \begin_layout Standard
5422 by 
5423 \noun on
5424 Peter Sütterlin
5425 \end_layout
5426
5427 \begin_layout Subsection
5428 Introduction
5429 \end_layout
5430
5431 \begin_layout Standard
5432 This section describes how LyX can be used to write articles for submission
5433  to the scientific journal 
5434 \emph on
5435 Astronomy and Astrophysics
5436 \emph default
5437  (
5438 \begin_inset LatexCommand \url[www.edpsciences.fr/aa/]{http://www.edpsciences.fr/aa/}
5439
5440 \end_inset
5441
5442 )
5443 \emph on
5444  
5445 \emph default
5446 using
5447 \emph on
5448  
5449 \emph default
5450 Version 5.01 of the document class 
5451 \family typewriter
5452 aa.cls
5453 \family default
5454 .
5455  This package can be downloaded from the ftp site
5456 \end_layout
5457
5458 \begin_layout Standard
5459 \begin_inset VSpace medskip
5460 \end_inset
5461
5462
5463 \end_layout
5464
5465 \begin_layout Standard
5466 \align center
5467 \begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
5468
5469 \end_inset
5470
5471
5472 \end_layout
5473
5474 \begin_layout Standard
5475 \begin_inset VSpace medskip
5476 \end_inset
5477
5478
5479 \end_layout
5480
5481 \begin_layout Standard
5482 A manual comes together with that package, and this text is not meant to
5483  replace the original manual but merely a short guide how to realize the
5484  correct form of your paper.
5485  
5486 \end_layout
5487
5488 \begin_layout Standard
5489 Please note that the publisher of the journal was changed from Springer
5490  to EDP Sciences starting January 1, 2001.
5491  That change implicated also some slight changes of the style files, namely
5492  the removal of the thesaurus command.
5493  The LyX class aa supports the newest version of these style files, V 5.01.
5494  If you have an older version installed, please upgrade.
5495  For compatibility, the old (version 4) layout has been kept as 
5496 \family sans
5497 article (A&A V4)
5498 \family default
5499 .
5500  Please refer to the comments in 
5501 \family typewriter
5502 LyXDir/layouts/aapaper.layout
5503 \family default
5504 .
5505 \end_layout
5506
5507 \begin_layout Subsection
5508 Getting started
5509 \end_layout
5510
5511 \begin_layout Standard
5512 It is recommended you start from the example template distributed with LyX.
5513  If you are not using a template, note the following settings:
5514 \end_layout
5515
5516 \begin_layout Itemize
5517 Select 
5518 \family sans
5519 article (A&A)
5520 \family default
5521  in the 
5522 \family sans
5523 \bar under
5524 D
5525 \bar default
5526 ocument\SpecialChar \menuseparator
5527
5528 \bar under
5529 S
5530 \bar default
5531 ettings
5532 \family default
5533  dialog (OK, that one was obvious).
5534 \end_layout
5535
5536 \begin_layout Itemize
5537 Don't change the option 
5538 \family sans
5539 Page\InsetSpace ~
5540 style
5541 \family default
5542 : Leave it set to 
5543 \family sans
5544 default
5545 \family default
5546 .
5547  The whole layout is done by the macros, you shouldn't change anything.
5548 \end_layout
5549
5550 \begin_layout Subsection
5551 The header block
5552 \end_layout
5553
5554 \begin_layout Standard
5555 First thing to enter is the header information.
5556  It consists of seven entries, of which some are optional.
5557  They are
5558 \end_layout
5559
5560 \begin_layout Itemize
5561
5562 \family sans
5563 Title
5564 \family default
5565 : [required] 
5566 \end_layout
5567
5568 \begin_layout Itemize
5569
5570 \family sans
5571 Subtitle
5572 \family default
5573 : [optional] 
5574 \end_layout
5575
5576 \begin_layout Itemize
5577
5578 \family sans
5579 Author
5580 \family default
5581 : [required]
5582 \end_layout
5583
5584 \begin_layout Itemize
5585
5586 \family sans
5587 Address
5588 \family default
5589 : [required]
5590 \end_layout
5591
5592 \begin_layout Itemize
5593
5594 \family sans
5595 Offprints
5596 \family default
5597 : [optional] if more than one author: whom to contact for offprint requests.
5598 \end_layout
5599
5600 \begin_layout Itemize
5601
5602 \family sans
5603 Mail
5604 \family default
5605 : [optional] mail address for contacts.
5606 \end_layout
5607
5608 \begin_layout Itemize
5609
5610 \family sans
5611 Date
5612 \family default
5613 : [required].
5614  Suggested format is 
5615 \family typewriter
5616 Received: <date>; Accepted <date> 
5617 \end_layout
5618
5619 \begin_layout Standard
5620 There is no need to issue the 
5621 \family typewriter
5622
5623 \backslash
5624 maketitle
5625 \family default
5626  command, this is done automatically by LyX when the header is finished.
5627  Although the order of the single header entries doesn't matter it is advised
5628  to keep the above sequence, just to get the best optics and meets the layout
5629  of the real document.
5630 \end_layout
5631
5632 \begin_layout Standard
5633 If you want to place footnotes in the header block, e.g.
5634 \begin_inset ERT
5635 status collapsed
5636
5637 \begin_layout Standard
5638
5639
5640 \backslash
5641  
5642 \end_layout
5643
5644 \end_inset
5645
5646 to state your present address, just use the standard footnote via 
5647 \family sans
5648 \bar under
5649 I
5650 \bar default
5651 nsert\SpecialChar \menuseparator
5652
5653 \bar under
5654 F
5655 \bar default
5656 ootnote.
5657  
5658 \family default
5659 LyX will automagically use the term 
5660 \family typewriter
5661
5662 \backslash
5663 thanks{}
5664 \family default
5665  in that case.
5666 \end_layout
5667
5668 \begin_layout Standard
5669 In addition to these topics, the macros use three additional LaTeX commands
5670  that have no counterpart in LyX:
5671 \end_layout
5672
5673 \begin_layout Itemize
5674
5675 \family typewriter
5676
5677 \backslash
5678 and
5679 \family default
5680  to separate different names for more than one author and institute, respectivel
5681 y.
5682 \end_layout
5683
5684 \begin_layout Itemize
5685
5686 \family typewriter
5687
5688 \backslash
5689 inst{<nr>}
5690 \family default
5691 to mark corresponding author/institute pairs.
5692  The institutes are numbered sequentially as they appear in the 
5693 \family sans
5694 Address
5695 \family default
5696  field, so you have to put a marker to each author.
5697 \end_layout
5698
5699 \begin_layout Itemize
5700
5701 \family typewriter
5702
5703 \backslash
5704 email{address}
5705 \family default
5706  to supply an email address for fast contact.
5707 \end_layout
5708
5709 \begin_layout Standard
5710 In all cases, the appropriate command has to be entered in LyX an marked
5711  as LaTeX code.
5712  See the examples.
5713  
5714 \end_layout
5715
5716 \begin_layout Subsection
5717 The abstract
5718 \end_layout
5719
5720 \begin_layout Standard
5721 The abstract should immediately follow the header block.
5722  With version 5 the abstract environment was changed to a command, and there
5723  is now a resctriction to only one paragraph.
5724  In addition, it should contain an entry with the keywords.
5725  This is not yet implemented for LyX, therefore you have to enter the LaTeX
5726  command 
5727 \family typewriter
5728
5729 \backslash
5730 keywords{}
5731 \family default
5732  by hand and mark it as LaTeX code.
5733  Refer to the example paper.
5734 \end_layout
5735
5736 \begin_layout Subsection
5737 Supported environments
5738 \end_layout
5739
5740 \begin_layout Standard
5741 The A&A paper layout supports the following environments for structuring
5742  your text:
5743 \end_layout
5744
5745 \begin_layout Itemize
5746
5747 \family sans
5748 Standard
5749 \end_layout
5750
5751 \begin_layout Itemize
5752
5753 \family sans
5754 Section
5755 \end_layout
5756
5757 \begin_layout Itemize
5758
5759 \family sans
5760 Subsection
5761 \end_layout
5762
5763 \begin_layout Itemize
5764
5765 \family sans
5766 Subsubsection
5767 \end_layout
5768
5769 \begin_layout Itemize
5770
5771 \family sans
5772 Itemize
5773 \end_layout
5774
5775 \begin_layout Itemize
5776
5777 \family sans
5778 Enumerate
5779 \end_layout
5780
5781 \begin_layout Itemize
5782
5783 \family sans
5784 Description
5785 \end_layout
5786
5787 \begin_layout Itemize
5788
5789 \family sans
5790 Caption
5791 \end_layout
5792
5793 \begin_layout Itemize
5794
5795 \family sans
5796 Abstract
5797 \end_layout
5798
5799 \begin_layout Itemize
5800
5801 \family sans
5802 Acknowledgment
5803 \end_layout
5804
5805 \begin_layout Itemize
5806
5807 \family sans
5808 Bibliography
5809 \end_layout
5810
5811 \begin_layout Itemize
5812
5813 \family sans
5814 LaTeX
5815 \end_layout
5816
5817 \begin_layout Subsection
5818 Commands not supported by LyX
5819 \end_layout
5820
5821 \begin_layout Standard
5822 Some commands are not yet supported by the 
5823 \family sans
5824 paper (A&A)
5825 \family default
5826  layout for LyX.
5827  Some have already been mentioned.
5828  For the sake of completeness, they are listed all together here:
5829 \end_layout
5830
5831 \begin_layout Itemize
5832
5833 \family typewriter
5834
5835 \backslash
5836 and
5837 \end_layout
5838
5839 \begin_layout Itemize
5840
5841 \family typewriter
5842
5843 \backslash
5844 email
5845 \end_layout
5846
5847 \begin_layout Itemize
5848
5849 \family typewriter
5850
5851 \backslash
5852 appendix
5853 \end_layout
5854
5855 \begin_layout Itemize
5856
5857 \family typewriter
5858
5859 \backslash
5860 authorrunning
5861 \end_layout
5862
5863 \begin_layout Itemize
5864
5865 \family typewriter
5866
5867 \backslash
5868 inst{}
5869 \end_layout
5870
5871 \begin_layout Itemize
5872
5873 \family typewriter
5874
5875 \backslash
5876 keywords{}
5877 \end_layout
5878
5879 \begin_layout Itemize
5880
5881 \family typewriter
5882
5883 \backslash
5884 object{}
5885 \end_layout
5886
5887 \begin_layout Itemize
5888
5889 \family typewriter
5890
5891 \backslash
5892 titlerunning{}
5893 \end_layout
5894
5895 \begin_layout Standard
5896 If you want to use any of these commands, you have to enter them yourself.
5897  
5898 \series bold
5899 Do not forget to mark them as LaTeX code!
5900 \end_layout
5901
5902 \begin_layout Subsection
5903 Figure and Table Floats
5904 \end_layout
5905
5906 \begin_layout Standard
5907 LyX provides support for the necessary float environments 
5908 \family sans
5909 figure, figure*, table 
5910 \family default
5911 and 
5912 \family sans
5913 table*
5914 \family default
5915 , therefore we won't tell much about it here.
5916  Refer to the 
5917 \emph on
5918 User's\InsetSpace ~
5919 Guide
5920 \emph default
5921 .
5922  Just remember that tables should be left-aligned.
5923  For that, select the table and change the alignment in 
5924 \family sans
5925 \bar under
5926 E
5927 \bar default
5928 dit\SpecialChar \menuseparator
5929
5930 \bar under
5931 P
5932 \bar default
5933 aragraph\InsetSpace ~
5934 Settings.
5935 \end_layout
5936
5937 \begin_layout Standard
5938 There is
5939 \family sans
5940  
5941 \family default
5942 only one special thing: the figures with caption besides the figure.
5943  To create such a figure, you have to do the following:
5944 \end_layout
5945
5946 \begin_layout Enumerate
5947 Create a wide figure float: 
5948 \family sans
5949 \bar under
5950 I
5951 \bar default
5952 nsert\SpecialChar \menuseparator
5953 Flo
5954 \bar under
5955 a
5956 \bar default
5957 t\SpecialChar \menuseparator
5958 Figure
5959 \family default
5960 , then right click in the figure and select
5961 \family sans
5962  
5963 \bar under
5964 S
5965 \bar default
5966 pan\InsetSpace ~
5967 columns
5968 \family default
5969 .
5970 \end_layout
5971
5972 \begin_layout Enumerate
5973 Enter your caption text.
5974 \end_layout
5975
5976 \begin_layout Enumerate
5977 Press 
5978 \family sans
5979 Return
5980 \family default
5981  to move the cursor above the caption.
5982 \end_layout
5983
5984 \begin_layout Enumerate
5985 Insert your figure
5986 \end_layout
5987
5988 \begin_layout Enumerate
5989 Position the cursor behind the figure and insert a horizontal fill: 
5990 \family sans
5991 \bar under
5992 I
5993 \bar default
5994 nsert\SpecialChar \menuseparator
5995
5996 \bar under
5997 S
5998 \bar default
5999 pecial\InsetSpace ~
6000 Character
6001 \bar under
6002 \SpecialChar \menuseparator
6003 H
6004 \bar default
6005 orizontal\InsetSpace ~
6006 Fill
6007 \family default
6008 .
6009 \end_layout
6010
6011 \begin_layout Enumerate
6012 Switch to LaTeX mode: 
6013 \family sans
6014 M-c\InsetSpace ~
6015 t
6016 \family default
6017 .
6018 \end_layout
6019
6020 \begin_layout Enumerate
6021 Enter 
6022 \family typewriter
6023
6024 \backslash
6025 parbox[b]{55mm}{
6026 \family default
6027 .
6028  
6029 \series bold
6030 Do not close the brace!
6031 \end_layout
6032
6033 \begin_layout Enumerate
6034 Position the cursor behind the caption text, switch to LaTeX mode and insert
6035  the closing brace: 
6036 \family sans
6037 M-c\InsetSpace ~
6038
6039 \family typewriter
6040 }
6041 \family default
6042 .
6043 \end_layout
6044
6045 \begin_layout Standard
6046 Also, refer to the figures in the example paper.
6047 \end_layout
6048
6049 \begin_layout Subsection
6050 Referee layout
6051 \end_layout
6052
6053 \begin_layout Standard
6054 For submission, the paper has to be formated in a special double-spacing
6055  layout.
6056  For this purpose, you have to give the option 
6057 \family typewriter
6058 referee
6059 \family default
6060  to the documentclass.
6061  This must be done using the extra class options field in the 
6062 \family sans
6063 \bar under
6064 D
6065 \bar default
6066 ocument\SpecialChar \menuseparator
6067
6068 \bar under
6069 S
6070 \bar default
6071 ettings
6072 \family default
6073  dialog.
6074  Just enter the string 
6075 \family typewriter
6076 referee
6077 \family default
6078  there.
6079 \end_layout
6080
6081 \begin_layout Subsection
6082 The example paper
6083 \end_layout
6084
6085 \begin_layout Standard
6086 The 
6087 \family sans
6088 Examples
6089 \family default
6090  directory contains an example paper written with LyX.
6091  It is the example paper from the original macro package, translated to
6092  LyX.
6093  Use it for inspiration, and compare the original LaTeX code with LyX way
6094  of writing.
6095 \end_layout
6096
6097 \begin_layout Section
6098 AASTeX
6099 \end_layout
6100
6101 \begin_layout Standard
6102 by 
6103 \noun on
6104 Mike Ressler
6105 \end_layout
6106
6107 \begin_layout Subsection
6108 Introduction
6109 \end_layout
6110
6111 \begin_layout Standard
6112 AASTeX is a set of macros produced by the American Astronomical Society
6113  to facilitate electronic manuscript submission to the three journals they
6114  publish: the Astrophysical Journal (including the Letters and Supplement),
6115  the Astronomical Journal, and the Publications of the Astronomical Society
6116  of the Pacific.
6117  LyX has proven to be an excellent tool for generating these documents,
6118  especially given its equation, citation, and figure handling capabilities.
6119  LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6120  is the version described here, or higher.
6121  Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6122  incompatible with LyX.
6123  The AASTeX package may be downloaded from the AASTeX Web site
6124 \end_layout
6125
6126 \begin_layout Standard
6127 \begin_inset VSpace medskip
6128 \end_inset
6129
6130
6131 \end_layout
6132
6133 \begin_layout Standard
6134 \align center
6135 \begin_inset LatexCommand \url{http://www.journals.uchicago.edu/AAS/AASTeX}
6136
6137 \end_inset
6138
6139
6140 \end_layout
6141
6142 \begin_layout Standard
6143 \begin_inset VSpace medskip
6144 \end_inset
6145
6146
6147 \end_layout
6148
6149 \begin_layout Standard
6150 A complete user guide is contained in that package and you should familiarize
6151  yourself with it thoroughly before embarking on writing a paper in LyX.
6152  LyX will not reduce the need to figure out all the AASTeX commands, it
6153  will only reduce the drudgery of typing everything in.
6154  It is your responsibility to ensure that the final exported LaTeX document
6155  conforms completely to the requirements of the journal to which you are
6156  submitting your paper.
6157 \end_layout
6158
6159 \begin_layout Subsection
6160 Starting a New Paper
6161 \end_layout
6162
6163 \begin_layout Standard
6164 I strongly suggest that you start with the AASTeX template file.
6165  Click on 
6166 \family sans
6167 \bar under
6168 F
6169 \bar default
6170 ile\SpecialChar \menuseparator
6171 New from 
6172 \bar under
6173 T
6174 \bar default
6175 emplate
6176 \family default
6177 , enter the new file name, then choose the 
6178 \family typewriter
6179 aastex.lyx
6180 \family default
6181  template.
6182  This will show the most common fields found in a manuscript.
6183  Simply overwrite the existing text (including the brackets, 
6184 \family typewriter
6185 <>
6186 \family default
6187 ) with the correct information.
6188  Many of the AASTeX commands and environments can be implemented directly
6189  in LyX, but some cannot: most noticeably 
6190 \family typewriter
6191
6192 \backslash
6193 altaffilmark
6194 \family default
6195  and 
6196 \family typewriter
6197
6198 \backslash
6199 altaffiltext
6200 \family default
6201 , which should stick out like a sore thumb if you actually just opened the
6202  template file.
6203  For commands such as these, the LaTeX code must be entered directly and
6204  marked as such.
6205  Such commands are referred to as ERT, or Evil Red Text.
6206  I tried to minimize the amount of ERT needed in an AASTeX document, but
6207  there is still a bit more required than any of us would like.
6208 \end_layout
6209
6210 \begin_layout Subsection
6211 Finishing Your Paper
6212 \end_layout
6213
6214 \begin_layout Standard
6215 When the paper is finished to your satisfaction and previews/prints correctly,
6216  there are a few 
6217 \begin_inset Quotes eld
6218 \end_inset
6219
6220 postprocessing
6221 \begin_inset Quotes erd
6222 \end_inset
6223
6224  actions which need to be done before you submit it to the journals.
6225  
6226 \end_layout
6227
6228 \begin_layout Enumerate
6229 Export your paper as a LaTeX file (
6230 \family sans
6231 \bar under
6232 F
6233 \bar default
6234 ile\SpecialChar \menuseparator
6235
6236 \bar under
6237 E
6238 \bar default
6239 xport\SpecialChar \menuseparator
6240
6241 \bar under
6242 L
6243 \bar default
6244 aTeX
6245 \family default
6246 ).
6247  
6248 \end_layout
6249
6250 \begin_layout Enumerate
6251 Edit the resulting 
6252 \family typewriter
6253 .tex
6254 \family default
6255  file with your favorite text editor
6256 \end_layout
6257
6258 \begin_deeper
6259 \begin_layout Enumerate
6260 remove the comment lines before the 
6261 \family typewriter
6262
6263 \backslash
6264 documentclass
6265 \family default
6266  command
6267 \end_layout
6268
6269 \begin_layout Enumerate
6270 remove the 
6271 \family typewriter
6272
6273 \backslash
6274 usepackage...{fontenc}
6275 \family default
6276  line if it appears (usually just after 
6277 \family typewriter
6278
6279 \backslash
6280 documentclass
6281 \family default
6282 }; also remove the 
6283 \family typewriter
6284
6285 \backslash
6286 secnumdepth
6287 \family default
6288  line if it appears.
6289 \end_layout
6290
6291 \begin_layout Enumerate
6292 remove everything between (and including) the 
6293 \family typewriter
6294
6295 \backslash
6296 makeatletter
6297 \family default
6298  and 
6299 \family typewriter
6300
6301 \backslash
6302 makeatother
6303 \family default
6304  commands, except for any commands you specifically put into the LaTeX preamble
6305  (which should appear immediately after the 
6306 \begin_inset Quotes eld
6307 \end_inset
6308
6309 User specified LaTeX commands
6310 \begin_inset Quotes erd
6311 \end_inset
6312
6313  comment in the 
6314 \family typewriter
6315 .tex
6316 \family default
6317  file).
6318 \end_layout
6319
6320 \end_deeper
6321 \begin_layout Enumerate
6322 Run the resulting file through LaTeX to make sure it still processes correctly.
6323 \end_layout
6324
6325 \begin_layout Enumerate
6326 Reread the journal requirements to make sure your filenames and formats
6327  are correct.
6328 \end_layout
6329
6330 \begin_layout Enumerate
6331 Submit it.
6332 \end_layout
6333
6334 \begin_layout Subsection
6335 Comments On Specific Commands
6336 \end_layout
6337
6338 \begin_layout Standard
6339 I will not describe the detailed usage of the individual AASTeX commands:
6340  the AASTeX User Guide (
6341 \family typewriter
6342 aasguide.tex
6343 \family default
6344 ) gives a good description of each.
6345  Thus it's probably easiest for me to go down the list as found in the guide
6346  and offer comments where necessary.
6347  So let's begin \SpecialChar \ldots{}
6348
6349 \end_layout
6350
6351 \begin_layout Subsubsection
6352 Things that work as expected
6353 \end_layout
6354
6355 \begin_layout Standard
6356 \begin_inset ERT
6357 status inlined
6358
6359 \begin_layout Standard
6360
6361
6362 \backslash
6363 begin{sloppypar}
6364 \end_layout
6365
6366 \end_inset
6367
6368
6369 \end_layout
6370
6371 \begin_layout Standard
6372 Because they work as you might expect, I simply list them and the section
6373  they are found in: 
6374 \family typewriter
6375
6376 \backslash
6377 documentclass
6378 \family default
6379  (2.1.1), 
6380 \family typewriter
6381
6382 \backslash
6383 begin{document}
6384 \family default
6385  (2.2), 
6386 \family typewriter
6387
6388 \backslash
6389 title
6390 \family default
6391  (2.3), 
6392 \family typewriter
6393
6394 \backslash
6395 author
6396 \family default
6397  (2.3), 
6398 \family typewriter
6399
6400 \backslash
6401 affil
6402 \family default
6403  (2.3), 
6404 \family typewriter
6405
6406 \backslash
6407 abstract
6408 \family default
6409  (2.4), 
6410 \family typewriter
6411
6412 \backslash
6413 keywords
6414 \family default
6415  (2.5), 
6416 \family typewriter
6417
6418 \backslash
6419 section
6420 \family default
6421  (2.7), 
6422 \family typewriter
6423
6424 \backslash
6425 subsection
6426 \family default
6427  (2.7), 
6428 \family typewriter
6429
6430 \backslash
6431 subsubsection
6432 \family default
6433  (2.7), 
6434 \family typewriter
6435
6436 \backslash
6437 paragraph
6438 \family default
6439  (2.7),
6440 \family typewriter
6441  
6442 \backslash
6443 facility
6444 \family default
6445  (2.10), 
6446 \family typewriter
6447
6448 \backslash
6449 begin{displaymath}
6450 \family default
6451  (2.12), 
6452 \family typewriter
6453
6454 \backslash
6455 begin{equation}
6456 \family default
6457  (2.12), 
6458 \family typewriter
6459
6460 \backslash
6461 begin{eqnarray}
6462 \family default
6463  (2.12), 
6464 \family typewriter
6465
6466 \backslash
6467 begin{mathletters}
6468 \family default
6469  (2.12), 
6470 \family typewriter
6471
6472 \backslash
6473 begin{thebibliography}
6474 \family default
6475  (2.13.1), 
6476 \family typewriter
6477
6478 \backslash
6479 bibitem
6480 \family default
6481  (2.13.2), all the cite commands and their variations (2.13.2), the generic
6482  graphicx figure commands (2.14.1),
6483 \family typewriter
6484  
6485 \backslash
6486 begin{table}
6487 \family default
6488  (2.15.4), 
6489 \family typewriter
6490
6491 \backslash
6492 begin{tabular}
6493 \family default
6494  (2.15.4), 
6495 \family typewriter
6496
6497 \backslash
6498 caption
6499 \family default
6500  (2.15.4), 
6501 \family typewriter
6502
6503 \backslash
6504 label
6505 \family default
6506  (2.15.4, amongst other places), 
6507 \family typewriter
6508
6509 \backslash
6510 tablerefs
6511 \family default
6512  (2.15.5), 
6513 \family typewriter
6514
6515 \backslash
6516 tablecomments
6517 \family default
6518  (2.15.5), 
6519 \family typewriter
6520
6521 \backslash
6522 url
6523 \family default
6524  (2.17.4), 
6525 \family typewriter
6526
6527 \backslash
6528 end{document}
6529 \family default
6530  (2.18).
6531 \end_layout
6532
6533 \begin_layout Standard
6534 The following style options also work correctly: 
6535 \family typewriter
6536 longabstract
6537 \family default
6538  (2.4), 
6539 \family typewriter
6540 preprint
6541 \family default
6542  (3.2.1), 
6543 \family typewriter
6544 preprint2
6545 \family default
6546  (3.2.2), 
6547 \family typewriter
6548 eqsecnum
6549 \family default
6550  (3.3), 
6551 \family typewriter
6552 flushrt
6553 \family default
6554  (3.4).
6555  Simply put them in the 
6556 \family sans
6557 Options
6558 \family default
6559  box in 
6560 \family sans
6561 Layout\SpecialChar \menuseparator
6562 Document
6563 \family default
6564 .
6565 \end_layout
6566
6567 \begin_layout Standard
6568 \begin_inset ERT
6569 status inlined
6570
6571 \begin_layout Standard
6572
6573
6574 \backslash
6575 end{sloppypar}
6576 \end_layout
6577
6578 \end_inset
6579
6580
6581 \end_layout
6582
6583 \begin_layout Subsubsection
6584 Things that work, but require more comment
6585 \end_layout
6586
6587 \begin_layout Standard
6588 The following items work, but require a little more discussion:
6589 \end_layout
6590
6591 \begin_layout Itemize
6592 These items are reserved for use by the journal editors, but you can put
6593  them into the LaTeX preamble if you feel compelled to do so: 
6594 \family typewriter
6595
6596 \backslash
6597 received
6598 \family default
6599
6600 \family typewriter
6601
6602 \backslash
6603 revised
6604 \family default
6605
6606 \family typewriter
6607
6608 \backslash
6609 accepted
6610 \family default
6611
6612 \family typewriter
6613
6614 \backslash
6615 ccc
6616 \family default
6617
6618 \family typewriter
6619
6620 \backslash
6621 cpright
6622 \family default
6623  (all from 2.1.3)
6624 \end_layout
6625
6626 \begin_layout Itemize
6627 These items may be placed in the LaTeX preamble, and are included as blanks
6628  in the template file: 
6629 \family typewriter
6630
6631 \backslash
6632 slugcomment
6633 \family default
6634  (2.1.4), 
6635 \family typewriter
6636
6637 \backslash
6638 shorttitle
6639 \family default
6640  (2.1.5), 
6641 \family typewriter
6642
6643 \backslash
6644 shortauthors
6645 \family default
6646  (2.1.5)
6647 \end_layout
6648
6649 \begin_layout Itemize
6650
6651 \family typewriter
6652
6653 \backslash
6654 email
6655 \family default
6656  (2.3) -- can only be used 
6657 \begin_inset Quotes eld
6658 \end_inset
6659
6660 standalone
6661 \begin_inset Quotes erd
6662 \end_inset
6663
6664 , not in the middle of a paragraph.
6665  Use ERT if you need to embed it.
6666 \end_layout
6667
6668 \begin_layout Itemize
6669
6670 \family typewriter
6671
6672 \backslash
6673 and
6674 \family default
6675  (2.3) -- will have extra {} after it.
6676  This should not cause an error.
6677 \end_layout
6678
6679 \begin_layout Itemize
6680
6681 \family typewriter
6682
6683 \backslash
6684 notetoeditor
6685 \family default
6686  (2.6) -- can only be used 
6687 \begin_inset Quotes eld
6688 \end_inset
6689
6690 standalone
6691 \begin_inset Quotes erd
6692 \end_inset
6693
6694 , not in the middle of a paragraph.
6695  Use ERT if you need to embed it.
6696 \end_layout
6697
6698 \begin_layout Itemize
6699
6700 \family typewriter
6701
6702 \backslash
6703 placetable
6704 \family default
6705  (2.8) -- can't insert a cross-reference tag, you must type the tag name
6706  by hand
6707 \end_layout
6708
6709 \begin_layout Itemize
6710
6711 \family typewriter
6712
6713 \backslash
6714 placefigure
6715 \family default
6716  (2.8) -- same as for 
6717 \family typewriter
6718
6719 \backslash
6720 placetable
6721 \end_layout
6722
6723 \begin_layout Itemize
6724
6725 \family typewriter
6726
6727 \backslash
6728 acknowledgements
6729 \family default
6730  (2.9) -- will have extra {} after it.
6731  This should not cause an error.
6732 \end_layout
6733
6734 \begin_layout Itemize
6735
6736 \family typewriter
6737
6738 \backslash
6739 appendix
6740 \family default
6741  (2.11) -- will have extra {} after it.
6742  This should not cause an error.
6743 \end_layout
6744
6745 \begin_layout Itemize
6746
6747 \family typewriter
6748
6749 \backslash
6750 figcaption
6751 \family default
6752  (2.14.2) -- you can insert an optional filename argument by placing the cursor
6753  at the beginning of the text and selecting 
6754 \family sans
6755 Insert\SpecialChar \menuseparator
6756 Short Title
6757 \family default
6758 .
6759  
6760 \begin_inset Quotes eld
6761 \end_inset
6762
6763 Short Title
6764 \begin_inset Quotes erd
6765 \end_inset
6766
6767  inserts an optional argument of the type needed by 
6768 \family typewriter
6769
6770 \backslash
6771 figcaption
6772 \family default
6773 .
6774  Hopefully it will be renamed someday.
6775 \end_layout
6776
6777 \begin_layout Itemize
6778
6779 \family typewriter
6780
6781 \backslash
6782 objectname
6783 \family default
6784  (2.17.1) -- same as 
6785 \family typewriter
6786
6787 \backslash
6788 figcaption
6789 \family default
6790  for the catalog ID optional parameter
6791 \end_layout
6792
6793 \begin_layout Itemize
6794
6795 \family typewriter
6796
6797 \backslash
6798 dataset
6799 \family default
6800  (2.17.1) -- same as 
6801 \family typewriter
6802
6803 \backslash
6804 figcaption
6805 \family default
6806  for the catalog ID optional parameter
6807 \end_layout
6808
6809 \begin_layout Subsubsection
6810 Things not implemented, use ERT
6811 \end_layout
6812
6813 \begin_layout Standard
6814 \begin_inset ERT
6815 status inlined
6816
6817 \begin_layout Standard
6818
6819
6820 \backslash
6821 begin{sloppypar}
6822 \end_layout
6823
6824 \end_inset
6825
6826
6827 \end_layout
6828
6829 \begin_layout Standard
6830
6831 \family typewriter
6832
6833 \backslash
6834 altaffilmark
6835 \family default
6836  (2.3), 
6837 \family typewriter
6838
6839 \backslash
6840 altaffiltext
6841 \family default
6842  (2.3), 
6843 \family typewriter
6844
6845 \backslash
6846 eqnum
6847 \family default
6848  (2.12), 
6849 \family typewriter
6850
6851 \backslash
6852 setcounter{equation}
6853 \family default
6854  (2.12), Journal name abbreviations (2.13.4), 
6855 \family typewriter
6856
6857 \backslash
6858 figurenum
6859 \family default
6860  (2.14.1), 
6861 \family typewriter
6862
6863 \backslash
6864 epsscale
6865 \family default
6866  (2.14.1), 
6867 \family typewriter
6868
6869 \backslash
6870 plotone
6871 \family default
6872  (2.14.1), 
6873 \family typewriter
6874
6875 \backslash
6876 plottwo
6877 \family default
6878  (2.14.1), 
6879 \family typewriter
6880
6881 \backslash
6882 tablenum
6883 \family default
6884  (2.15.4), 
6885 \family typewriter
6886
6887 \backslash
6888 tableline
6889 \family default
6890  (2.15.4, insert it as the first element in the lefthand cell after where
6891  you want it.
6892  Don't use any of LyX's rules in the table), 
6893 \family typewriter
6894
6895 \backslash
6896 tablenotemark
6897 \family default
6898  (2.15.5), 
6899 \family typewriter
6900
6901 \backslash
6902 tablenotetext
6903 \family default
6904  (2.15.5), much of Misc (2.17, except 
6905 \family typewriter
6906
6907 \backslash
6908 objectname
6909 \family default
6910 ,
6911 \family typewriter
6912  
6913 \backslash
6914 dataset
6915 \family default
6916 ,
6917 \family typewriter
6918  
6919 \backslash
6920 url
6921 \family default
6922 , and 
6923 \family typewriter
6924
6925 \backslash
6926 email
6927 \family default
6928 ; see above), 
6929 \family typewriter
6930
6931 \backslash
6932 singlespace
6933 \family default
6934  (3.1), 
6935 \family typewriter
6936
6937 \backslash
6938 doublespace
6939 \family default
6940  (3.1), 
6941 \family typewriter
6942
6943 \backslash
6944 onecolumn
6945 \family default
6946  (3.2), 
6947 \family typewriter
6948
6949 \backslash
6950 twocolumn
6951 \family default
6952  (3.2)
6953 \end_layout
6954
6955 \begin_layout Standard
6956 \begin_inset ERT
6957 status inlined
6958
6959 \begin_layout Standard
6960
6961
6962 \backslash
6963 end{sloppypar}
6964 \end_layout
6965
6966 \end_inset
6967
6968
6969 \end_layout
6970
6971 \begin_layout Subsubsection
6972 Things that cannot be implemented
6973 \end_layout
6974
6975 \begin_layout Standard
6976 \SpecialChar \ldots{}
6977  at least in any meaningful sort of way, so I suggest ignoring them.
6978  They are the references environment (2.13.3), and the deluxetable environment
6979  (2.15).
6980  If you really, really need to use deluxetable, I suggest editing it in
6981  a separate file with a text editor, then using 
6982 \family sans
6983 \bar under
6984 I
6985 \bar default
6986 nsert\SpecialChar \menuseparator
6987 Chil
6988 \bar under
6989 d
6990 \bar default
6991 \InsetSpace ~
6992 Document
6993 \family default
6994  to include it in your LyX document.
6995  See the 
6996 \family typewriter
6997 aas_sample.lyx
6998 \family default
6999  file to see an example of this.
7000 \end_layout
7001
7002 \begin_layout Subsection
7003 FAQs, Tips, Tricks, and Other Ruminations
7004 \end_layout
7005
7006 \begin_layout Subsubsection
7007 Getting LyX and AASTeX to cooperate
7008 \end_layout
7009
7010 \begin_layout Standard
7011 It can be a bit tricky to get LyX to recognize a new layout and document
7012  class.
7013  When all else fails, do this:
7014 \end_layout
7015
7016 \begin_layout Enumerate
7017 Make certain that LaTeX can find AASTeX.
7018  Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
7019  a directory completely unrelated to LaTeX or AASTeX and run LaTeX on 
7020 \family typewriter
7021 sample.tex
7022 \family default
7023 .
7024 \end_layout
7025
7026 \begin_layout Enumerate
7027 Make certain that 
7028 \family typewriter
7029 aastex.layout
7030 \family default
7031  appears in 
7032 \family typewriter
7033 /usr/.../share/lyx/layouts
7034 \family default
7035  or 
7036 \family typewriter
7037 ~/.lyx/layouts
7038 \family default
7039 .
7040 \end_layout
7041
7042 \begin_layout Enumerate
7043 Rerun 
7044 \family sans
7045 \bar under
7046 T
7047 \bar default
7048 ools\SpecialChar \menuseparator
7049
7050 \bar under
7051 R
7052 \bar default
7053 econfigure
7054 \family default
7055  in LyX, then restart LyX.
7056 \end_layout
7057
7058 \begin_layout Enumerate
7059 Open a regular new file, not from a template.
7060  Does AASTeX appear in the class list in 
7061 \family sans
7062 \bar under
7063 D
7064 \bar default
7065 ocument\SpecialChar \menuseparator
7066
7067 \bar under
7068 S
7069 \bar default
7070 ettings
7071 \family default
7072 ?
7073 \end_layout
7074
7075 \begin_layout Standard
7076 If you get a warning from an existing AASTeX document about not being able
7077  to find the AASTeX layout or a message about 
7078 \begin_inset Quotes eld
7079 \end_inset
7080
7081 You should not mix title layouts with normal ones
7082 \begin_inset Quotes erd
7083 \end_inset
7084
7085 , things haven't been installed correctly.
7086 \end_layout
7087
7088 \begin_layout Subsubsection
7089 LaTeX error processing a table 
7090 \end_layout
7091
7092 \begin_layout Standard
7093 LyX, by default, attempts to center the table caption/title.
7094  This seems to produce a bad interaction in AASTeX so you should click somewhere
7095  in the caption/title, then select 
7096 \family sans
7097 \bar under
7098 E
7099 \bar default
7100 dit\SpecialChar \menuseparator
7101
7102 \bar under
7103 P
7104 \bar default
7105 aragraph\InsetSpace ~
7106 Settings
7107 \family default
7108 , then set the 
7109 \family sans
7110 Alignment
7111 \family default
7112  to 
7113 \family sans
7114 \bar under
7115 B
7116 \bar default
7117 lock
7118 \family default
7119 .
7120  This took care of it for me.
7121 \end_layout
7122
7123 \begin_layout Subsubsection
7124 References
7125 \begin_inset LatexCommand \label{cite}
7126
7127 \end_inset
7128
7129
7130 \end_layout
7131
7132 \begin_layout Standard
7133 A couple of things: 1) I have noticed some funny spacing in the reference
7134  entries in the text.
7135  When you enter the bibliography item data, make sure their is 
7136 \emph on
7137 no
7138 \emph default
7139  space between the last author and the parenthesis setting off the year;
7140  
7141 \emph on
7142 e.g.
7143  
7144 \emph default
7145 type
7146 \family typewriter
7147  Ressler(1992)
7148 \family default
7149 , not 
7150 \family typewriter
7151 Ressler (1992)
7152 \family default
7153 .
7154  2) Entering the references at all is not obvious.
7155  The easiest thing is to start typing your first reference at the end of
7156  the document, then mark it as type 
7157 \family sans
7158 References
7159 \family default
7160 .
7161  That will put a small gray box in front of what you just typed.
7162  Click on the box to fill in the rest of the information.
7163  For new references, go to the end of an existing reference and press return.
7164  That will create a new line with its own box, etc.
7165 \end_layout
7166
7167 \begin_layout Subsubsection
7168 Including EPS files
7169 \end_layout
7170
7171 \begin_layout Standard
7172 Even though AASTeX provides its own figure commands (
7173 \family typewriter
7174
7175 \backslash
7176 plotone
7177 \family default
7178 , for example), I much prefer LaTeX's standard figure commands (with the
7179  default graphicx).
7180  You can insert the 
7181 \family typewriter
7182
7183 \backslash
7184 plotone
7185 \family default
7186 , etc.\InsetSpace ~
7187 commands as ERT into a Figure Float box if you desire, but I never
7188  have much luck getting the layout right.
7189  With the standard graphics, LyX will insert a 
7190 \family typewriter
7191
7192 \backslash
7193 usepackage{graphicx}
7194 \family default
7195  command into the LaTeX preamble and handle the figures in the standard
7196  LaTeX2e way, interspersing the figures in the text.
7197  I believe ApJ accepts figures exactly this way now; AJ might still use
7198  the 
7199 \begin_inset Quotes eld
7200 \end_inset
7201
7202 stack everything at the end
7203 \begin_inset Quotes erd
7204 \end_inset
7205
7206  technique.
7207 \end_layout
7208
7209 \begin_layout Subsubsection
7210 Things I could have done, but didn't
7211 \end_layout
7212
7213 \begin_layout Standard
7214 There are a few 
7215 \begin_inset Quotes eld
7216 \end_inset
7217
7218 pretty
7219 \begin_inset Quotes erd
7220 \end_inset
7221
7222  things I could have implemented, but chose not to.
7223  For instance, I saw no point in double-spacing the text in the LyX window,
7224  even though it is double-spaced in the paper manuscript.
7225  Also, I chose not to make separate layouts for the preprint and preprint2
7226  styles.
7227  Since I assume you will spend most of your time in the plain manuscript
7228  mode anyway, I decided not to chew up more disk space with this.
7229  
7230 \end_layout
7231
7232 \begin_layout Subsection
7233 Final Caveat
7234 \end_layout
7235
7236 \begin_layout Standard
7237 Your mileage may vary.
7238  I've now had papers published by both ApJ and AJ that have had 98% of the
7239  effort done in LyX; the last 2% was the LaTeX post-processing and a few
7240  cleanups.
7241  I have had no trouble with the submission process, and I'm sure the journals
7242  were never aware that there might be a difference.
7243  So, go forth and publish!
7244 \end_layout
7245
7246 \begin_layout Section
7247 qijmpc and ijmpd
7248 \end_layout
7249
7250 \begin_layout Standard
7251 by 
7252 \noun on
7253 Panayotis Papasotiriou
7254 \end_layout
7255
7256 \begin_layout Subsection
7257 Overview
7258 \end_layout
7259
7260 \begin_layout Standard
7261 The ijmpc package is a set of macros that facilitates electronic manuscript
7262  submission to the 
7263 \emph on
7264 International Journal of Modern Physics C
7265 \emph default
7266 .
7267  Similarly, the ijmpd package is for creating manuscripts to be submitted
7268  to the 
7269 \emph on
7270 International Journal of Modern Physics D
7271 \emph default
7272 .
7273  Both journals are published by World Scientific.
7274  The corresponding document classes are named 
7275 \family typewriter
7276 ws-ijmpc.cls
7277 \family default
7278  and 
7279 \family typewriter
7280 ws-ijmpd.cls
7281 \family default
7282 , respectively.
7283  These files, together with instructions for the authors, can be downloaded
7284  from the sites 
7285 \begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml}
7286
7287 \end_inset
7288
7289  and 
7290 \begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml}
7291
7292 \end_inset
7293
7294 .
7295  Both packages are modified versions of the standard 
7296 \begin_inset Quotes eld
7297 \end_inset
7298
7299 article
7300 \begin_inset Quotes erd
7301 \end_inset
7302
7303  package, and they are almost (but not exactly) identical.
7304  Most of their features are supported by LyX.
7305  I have used LyX successfully to write articles submitted to both journals
7306  without any problem.
7307 \end_layout
7308
7309 \begin_layout Subsection
7310 Writing a paper
7311 \end_layout
7312
7313 \begin_layout Standard
7314 As usual, the easiest way to write a paper is to start with a template.
7315  Click on 
7316 \family sans
7317 \bar under
7318 F
7319 \bar default
7320 ile\SpecialChar \menuseparator
7321 New from 
7322 \bar under
7323 T
7324 \bar default
7325 emplate
7326 \family default
7327 , then choose the 
7328 \family typewriter
7329 ijmpc.lyx
7330 \family default
7331  or 
7332 \family typewriter
7333 ijmpd.lyx
7334 \family default
7335  template.
7336  This will give an (almost) empty document that includes the most common
7337  fields found in a manuscript.
7338  Simply overwrite the existing text (including the brackets, 
7339 \family typewriter
7340 <>
7341 \family default
7342 ) with your text.
7343  You should keep in mind the following remarks.
7344 \end_layout
7345
7346 \begin_layout Enumerate
7347 LyX won't let you change the font size and the page style of the document,
7348  because such modifications are not allowed by both packages.
7349 \end_layout
7350
7351 \begin_layout Enumerate
7352 The language of the document should not be changed.
7353  Before previewing your paper, be sure that the babel package is not used.
7354  To do this, click on 
7355 \family sans
7356 \bar under
7357 T
7358 \bar default
7359 ools\SpecialChar \menuseparator
7360
7361 \bar under
7362 P
7363 \bar default
7364 references
7365 \family default
7366 , select the 
7367 \family sans
7368 Lang Opts
7369 \family default
7370  tab, deselect the 
7371 \family sans
7372 \bar under
7373 U
7374 \bar default
7375 se babel
7376 \family default
7377  checkbox in the language settings, and click on 
7378 \family sans
7379 \bar under
7380 A
7381 \bar default
7382 pply
7383 \family default
7384  (or 
7385 \family sans
7386 Save
7387 \family default
7388 , if you wish to make this change permanent).
7389 \end_layout
7390
7391 \begin_layout Enumerate
7392 The 
7393 \begin_inset Quotes eld
7394 \end_inset
7395
7396 Keywords
7397 \begin_inset Quotes erd
7398 \end_inset
7399
7400  style must be used to define keywords.
7401 \end_layout
7402
7403 \begin_layout Enumerate
7404 The ijmpc package provides a style named 
7405 \begin_inset Quotes eld
7406 \end_inset
7407
7408 Classification Codes
7409 \begin_inset Quotes erd
7410 \end_inset
7411
7412 , which can be used to define classification codes, such as PACS numbers.
7413  Note that this facility is not supported by the ijmpd package.
7414 \end_layout
7415
7416 \begin_layout Enumerate
7417 Several new environments are available: 
7418 \begin_inset Quotes eld
7419 \end_inset
7420
7421 Definition
7422 \begin_inset Quotes erd
7423 \end_inset
7424
7425
7426 \begin_inset Quotes eld
7427 \end_inset
7428
7429 Step
7430 \begin_inset Quotes erd
7431 \end_inset
7432
7433
7434 \begin_inset Quotes eld
7435 \end_inset
7436
7437 Example
7438 \begin_inset Quotes erd
7439 \end_inset
7440
7441
7442 \begin_inset Quotes eld
7443 \end_inset
7444
7445 Remark
7446 \begin_inset Quotes erd
7447 \end_inset
7448
7449
7450 \begin_inset Quotes eld
7451 \end_inset
7452
7453 Notation
7454 \begin_inset Quotes erd
7455 \end_inset
7456
7457
7458 \begin_inset Quotes eld
7459 \end_inset
7460
7461 Theorem
7462 \begin_inset Quotes erd
7463 \end_inset
7464
7465
7466 \begin_inset Quotes eld
7467 \end_inset
7468
7469 Proof
7470 \begin_inset Quotes erd
7471 \end_inset
7472
7473
7474 \begin_inset Quotes eld
7475 \end_inset
7476
7477 Corollary
7478 \begin_inset Quotes erd
7479 \end_inset
7480
7481
7482 \begin_inset Quotes eld
7483 \end_inset
7484
7485 Lemma
7486 \begin_inset Quotes erd
7487 \end_inset
7488
7489
7490 \begin_inset Quotes eld
7491 \end_inset
7492
7493 Proposition
7494 \begin_inset Quotes erd
7495 \end_inset
7496
7497
7498 \begin_inset Quotes eld
7499 \end_inset
7500
7501 Prop
7502 \begin_inset Quotes erd
7503 \end_inset
7504
7505
7506 \begin_inset Quotes eld
7507 \end_inset
7508
7509 Question
7510 \begin_inset Quotes erd
7511 \end_inset
7512
7513
7514 \begin_inset Quotes eld
7515 \end_inset
7516
7517 Claim
7518 \begin_inset Quotes erd
7519 \end_inset
7520
7521 , and 
7522 \begin_inset Quotes eld
7523 \end_inset
7524
7525 Conjecture
7526 \begin_inset Quotes erd
7527 \end_inset
7528
7529 .
7530  Their use is more or less obvious.
7531  LyX supports all these environments; it will use the proper label, text
7532  style, and numbering scheme for each of them.
7533 \end_layout
7534
7535 \begin_layout Enumerate
7536 Both packages use basic citations; the natbib package should not be used.
7537  In LyX, citation references are shown as usual; in the output, citations
7538  are shown as superscripts.
7539  If you want to use a citation as normal text, you should use the 
7540 \family typewriter
7541 refcite
7542 \family default
7543  command, e.g., 
7544 \begin_inset Quotes eld
7545 \end_inset
7546
7547 See Ref.\InsetSpace ~
7548
7549 \family typewriter
7550
7551 \backslash
7552 refcite{key}
7553 \family default
7554
7555 \begin_inset Quotes erd
7556 \end_inset
7557
7558 .
7559 \end_layout
7560
7561 \begin_layout Enumerate
7562 There is no 
7563 \begin_inset Quotes eld
7564 \end_inset
7565
7566 Acknowledgments
7567 \begin_inset Quotes erd
7568 \end_inset
7569
7570  section in both packages.
7571  To put acknowledgments, just use the 
7572 \begin_inset Quotes eld
7573 \end_inset
7574
7575 Section*
7576 \begin_inset Quotes erd
7577 \end_inset
7578
7579  environment.
7580 \end_layout
7581
7582 \begin_layout Enumerate
7583 Appendices may be added to the paper, 
7584 \emph on
7585 after
7586 \emph default
7587  the Acknowledgments and 
7588 \shape italic
7589 before
7590 \shape default
7591  the References.
7592  LyX provides a special environment, called 
7593 \begin_inset Quotes eld
7594 \end_inset
7595
7596 Appendices Section
7597 \begin_inset Quotes erd
7598 \end_inset
7599
7600  which marks the beginning of the appendices.
7601  This environment should be left blank; it just sends a LaTeX command, but
7602  nothing is really printed.
7603  In LyX, the word 
7604 \begin_inset Quotes eld
7605 \end_inset
7606
7607 Appendix
7608 \begin_inset Quotes erd
7609 \end_inset
7610
7611  is printed with blue letters, as a signal that all sections after that
7612  point are appendices.
7613  To write an appendix, use the 
7614 \begin_inset Quotes eld
7615 \end_inset
7616
7617 Appendix
7618 \begin_inset Quotes erd
7619 \end_inset
7620
7621  environment.
7622  LyX will number each appendix with capital letters, as required by both
7623  journals.
7624  Note that 
7625 \begin_inset Quotes eld
7626 \end_inset
7627
7628 Appendices Section
7629 \begin_inset Quotes erd
7630 \end_inset
7631
7632  
7633 \emph on
7634 must
7635 \emph default
7636  be present before the first appendix; if not, all appendices will be numbered
7637  as normal sections in the output.
7638 \end_layout
7639
7640 \begin_layout Enumerate
7641 The ijmpc and the ijmpd packages use the 
7642 \family typewriter
7643 tbl
7644 \family default
7645  command to implement table captions.
7646  As a result, a table created by LyX is printed correctly, but its caption
7647  is ignored.
7648  However, you can use some ERT to overpass this problem, so that captions
7649  are printed as expected.
7650  To do so, create a float table as usual, remove the caption, and replace
7651  it with the ERT 
7652 \family typewriter
7653
7654 \backslash
7655 tbl{
7656 \emph on
7657 your table caption
7658 \emph default
7659 }{
7660 \family default
7661  (sic); you must also the ERT 
7662 \family typewriter
7663 }
7664 \family default
7665  immediately after the tabular material.
7666  Study the example table included in the template files to see how this
7667  trick is implemented.
7668  Alternatively, If you need table captions, you should implement the whole
7669  table float in a 
7670 \family typewriter
7671 .tex
7672 \family default
7673  file, then include this file to the LyX document (
7674 \family sans
7675 \bar under
7676 I
7677 \bar default
7678 nsert\SpecialChar \menuseparator
7679 Fil
7680 \bar under
7681 e
7682 \bar default
7683 \SpecialChar \menuseparator
7684 Chil
7685 \bar under
7686 d
7687 \bar default
7688 \InsetSpace ~
7689 Document
7690 \family default
7691 ).
7692  Details on how to create a table float can be found in the files 
7693 \family typewriter
7694 ws-ijmpc.tex
7695 \family default
7696  and 
7697 \family typewriter
7698 ws-ijmpd.tex
7699 \family default
7700 , included in the corresponding packages.
7701 \end_layout
7702
7703 \begin_layout Subsection
7704 Preparing a paper for submission
7705 \end_layout
7706
7707 \begin_layout Standard
7708 Before you submit your paper you must export the LyX document as a LaTeX
7709  file (
7710 \family sans
7711 \bar under
7712 F
7713 \bar default
7714 ile\SpecialChar \menuseparator
7715
7716 \bar under
7717 E
7718 \bar default
7719 xport\SpecialChar \menuseparator
7720
7721 \bar under
7722 L
7723 \bar default
7724 ateX
7725 \family default
7726 ), then make the following changes to the resulting 
7727 \family typewriter
7728 .tex
7729 \family default
7730  file.
7731 \end_layout
7732
7733 \begin_layout Enumerate
7734 Remove the comment lines before the 
7735 \family typewriter
7736
7737 \backslash
7738 documentclass
7739 \family default
7740  command.
7741 \end_layout
7742
7743 \begin_layout Enumerate
7744 Remove everything between (and including) the 
7745 \family typewriter
7746
7747 \backslash
7748 makeatletter
7749 \family default
7750  and 
7751 \family typewriter
7752
7753 \backslash
7754 makeatother
7755 \family default
7756  commands, except for any commands you specifically put into the LaTeX preamble.
7757 \end_layout
7758
7759 \begin_layout Standard
7760 The modified 
7761 \family typewriter
7762 .tex
7763 \family default
7764  file should be saved and processed through LaTeX as many times as necessary.
7765  You may also want to check the resulting 
7766 \family typewriter
7767 .dvi
7768 \family default
7769  document.
7770 \end_layout
7771
7772 \begin_layout Subsection
7773 Use of ERT
7774 \end_layout
7775
7776 \begin_layout Standard
7777 The use of ERT is reduced to two commands, which must be placed at the top
7778  of the document.
7779  If you started writing your paper by using the 
7780 \family typewriter
7781 ijmpc.lyx
7782 \family default
7783  or the 
7784 \family typewriter
7785 ijmpd.lyx
7786 \family default
7787  template, the ERT needed is already in its place; you usually don't need
7788  to delete it.
7789  You may only modify the first ERT to specify the information printed to
7790  the top of odd and even pages (authors' names and short paper's title,
7791  respectively).
7792  This ERT must have the form 
7793 \family typewriter
7794
7795 \backslash
7796 markboth{Authors' Names}{Short Paper's Title}
7797 \family default
7798 .
7799 \end_layout
7800
7801 \begin_layout Section
7802 Kluwer
7803 \end_layout
7804
7805 \begin_layout Standard
7806 by 
7807 \noun on
7808 Panayotis Papasotiriou
7809 \end_layout
7810
7811 \begin_layout Subsection
7812 Overview
7813 \end_layout
7814
7815 \begin_layout Standard
7816 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
7817  that facilitates electronic manuscript submission to the journals they
7818  publish.
7819  Most known of them (at least in my domain of interest) are 
7820 \emph on
7821 Astrophysics and Space Science
7822 \emph default
7823  and 
7824 \emph on
7825 Solar Physics
7826 \emph default
7827 , but there are many others (see a complete list at 
7828 \begin_inset LatexCommand \url{http://www.wkap.nl/jrnllist.htm/JRNLHOME}
7829
7830 \end_inset
7831
7832 ).
7833  The Kluwer package may be downloaded from the site 
7834 \begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
7835
7836 \end_inset
7837
7838 .
7839  A complete user guide is contained in that package (but it can also be
7840  downloaded separately).
7841 \end_layout
7842
7843 \begin_layout Standard
7844 LyX supports many features of the package but not everything.
7845  However, the ERT needed is reduced to some 
7846 \begin_inset Quotes eld
7847 \end_inset
7848
7849 peculiar
7850 \begin_inset Quotes erd
7851 \end_inset
7852
7853  commands of the package (see\InsetSpace ~
7854
7855 \begin_inset LatexCommand \ref{subsec:kluwer_peculiarities}
7856
7857 \end_inset
7858
7859 ).
7860  I have recently used LyX to write an article submitted to the 
7861 \emph on
7862 Astrophysics and Space Science
7863 \emph default
7864  without any problem.
7865 \end_layout
7866
7867 \begin_layout Subsection
7868 Writing a paper
7869 \end_layout
7870
7871 \begin_layout Standard
7872 The easiest way to write a paper is to start with the Kluwer template file.
7873  Click on 
7874 \family sans
7875 File\SpecialChar \menuseparator
7876 New from 
7877 \bar under
7878 T
7879 \bar default
7880 emplate
7881 \family default
7882 , then choose the 
7883 \family typewriter
7884 kluwer.lyx
7885 \family default
7886  template.
7887  This will give an (almost) empty document that includes the most common
7888  fields found in a manuscript and a short description of their use.
7889  As in most templates, simply overwrite the existing text (including the
7890  brackets, 
7891 \family typewriter
7892 <>
7893 \family default
7894 ) with the correct information.
7895 \end_layout
7896
7897 \begin_layout Subsection
7898 Preparing a paper for submission
7899 \end_layout
7900
7901 \begin_layout Standard
7902 As in the AASTeX package, before you submit your paper to a journal you
7903  must 
7904 \begin_inset Quotes eld
7905 \end_inset
7906
7907 postprocess
7908 \begin_inset Quotes erd
7909 \end_inset
7910
7911  it as follows.
7912 \end_layout
7913
7914 \begin_layout Enumerate
7915 Export your paper as a LaTeX file.
7916  To do this, click on 
7917 \family sans
7918 \bar under
7919 F
7920 \bar default
7921 ile\SpecialChar \menuseparator
7922
7923 \bar under
7924 E
7925 \bar default
7926 xport\SpecialChar \menuseparator
7927
7928 \bar under
7929 L
7930 \bar default
7931 ateX
7932 \family default
7933 .
7934  
7935 \end_layout
7936
7937 \begin_layout Enumerate
7938 Edit the resulting 
7939 \family typewriter
7940 .tex
7941 \family default
7942  file with a text editor and make the following changes
7943 \end_layout
7944
7945 \begin_deeper
7946 \begin_layout Enumerate
7947 remove the comment lines before the 
7948 \family typewriter
7949
7950 \backslash
7951 documentclass
7952 \family default
7953  command,
7954 \end_layout
7955
7956 \begin_layout Enumerate
7957 remove everything between (and including) the 
7958 \family typewriter
7959
7960 \backslash
7961 makeatletter
7962 \family default
7963  and 
7964 \family typewriter
7965
7966 \backslash
7967 makeatother
7968 \family default
7969  commands, except for any commands you specifically put into the LaTeX preamble.
7970 \end_layout
7971
7972 \begin_layout Standard
7973 Save the resulting 
7974 \family typewriter
7975 .tex
7976 \family default
7977  file.
7978 \end_layout
7979
7980 \end_deeper
7981 \begin_layout Enumerate
7982 Run the 
7983 \family typewriter
7984 .tex
7985 \family default
7986  file through LaTeX as many times as necessary (usually up to three).
7987 \end_layout
7988
7989 \begin_layout Enumerate
7990 View the resulting 
7991 \family typewriter
7992 .dvi
7993 \family default
7994  document using, e.g., 
7995 \family sans
7996 xdvi
7997 \family default
7998 , and check if everything is ok (it should, if you didn't make any mistake).
7999 \end_layout
8000
8001 \begin_layout Subsection
8002 \begin_inset Quotes eld
8003 \end_inset
8004
8005 Peculiarities
8006 \begin_inset Quotes erd
8007 \end_inset
8008
8009  of the Kluwer package
8010 \begin_inset LatexCommand \label{subsec:kluwer_peculiarities}
8011
8012 \end_inset
8013
8014
8015 \end_layout
8016
8017 \begin_layout Standard
8018 The Kluwer package has the following 
8019 \begin_inset Quotes eld
8020 \end_inset
8021
8022 peculiarities
8023 \begin_inset Quotes erd
8024 \end_inset
8025
8026 .
8027 \end_layout
8028
8029 \begin_layout Enumerate
8030 It is possible to write multiple articles in the same LaTeX file
8031 \begin_inset Foot
8032 status collapsed
8033
8034 \begin_layout Standard
8035 I can't imagine any good reason to do this.
8036 \end_layout
8037
8038 \end_inset
8039
8040 .
8041  Each article must be included in the environment 
8042 \begin_inset Quotes eld
8043 \end_inset
8044
8045 article
8046 \begin_inset Quotes erd
8047 \end_inset
8048
8049 .
8050  Unfortunately, this environment cannot be omitted, even if you write just
8051  one article.
8052  Therefore, each article starts with the command 
8053 \family typewriter
8054
8055 \backslash
8056 begin{article}
8057 \family default
8058  and, obviously, ends with the command 
8059 \family typewriter
8060
8061 \backslash
8062 end{article}
8063 \family default
8064 .
8065  Although this can be implemented in LyX, I didn't included it, since it
8066  looks ugly and can confuse the novice user.
8067  Therefore, you need to enter them directly and mark them as LaTeX code
8068  (the well-known 
8069 \begin_inset Quotes eld
8070 \end_inset
8071
8072 ERT
8073 \begin_inset Quotes erd
8074 \end_inset
8075
8076 ).
8077 \end_layout
8078
8079 \begin_layout Enumerate
8080 Information given at the beginning of the article (i.e., title, subtitle,
8081  author, institution, running title, running author, abstract and keywords)
8082  must be included in an environment called 
8083 \begin_inset Quotes eld
8084 \end_inset
8085
8086 opening
8087 \begin_inset Quotes erd
8088 \end_inset
8089
8090 .
8091  This is not implemented in LyX, so you must enter title, subtitle etc.
8092  between two ERT lines (
8093 \family typewriter
8094
8095 \backslash
8096 begin{opening}
8097 \family default
8098  and 
8099 \family typewriter
8100
8101 \backslash
8102 end{opening}
8103 \family default
8104 ).
8105 \end_layout
8106
8107 \begin_layout Enumerate
8108 According to the user manual, the label of each bibliography item must be
8109  written as 
8110 \family typewriter
8111
8112 \backslash
8113 protect
8114 \backslash
8115 citeauthoryear{
8116 \family default
8117 \emph on
8118 author(s)
8119 \family typewriter
8120 \emph default
8121 }{
8122 \family default
8123 \emph on
8124 year
8125 \family typewriter
8126 \emph default
8127 }
8128 \family default
8129 .
8130 \end_layout
8131
8132 \begin_layout Standard
8133 The 
8134 \family typewriter
8135 kluwer.lyx
8136 \family default
8137  template takes care of all these 
8138 \begin_inset Quotes eld
8139 \end_inset
8140
8141 peculiarities
8142 \begin_inset Quotes erd
8143 \end_inset
8144
8145 .
8146  If you start a new paper using this template you don't need to do anything
8147  special.
8148  Just 
8149 \end_layout
8150
8151 \begin_layout Enumerate
8152 don't delete the ERT included in the template, and
8153 \end_layout
8154
8155 \begin_layout Enumerate
8156 copy the example bibliography item included in the template and modify it
8157  as necessary to enter new bibliography items.
8158 \end_layout
8159
8160 \begin_layout Section
8161 Koma-Script
8162 \end_layout
8163
8164 \begin_layout Standard
8165 by 
8166 \noun on
8167 Bernd Rellermeyer
8168 \end_layout
8169
8170 \begin_layout Subsection
8171 Overview
8172 \end_layout
8173
8174 \begin_layout Standard
8175 The LyX document classes
8176 \emph on
8177  article (koma-script)
8178 \emph default
8179
8180 \emph on
8181 report (koma-script)
8182 \emph default
8183
8184 \emph on
8185 book
8186 \emph default
8187  
8188 \emph on
8189 (koma-script)
8190 \emph default
8191 , and 
8192 \emph on
8193 letter
8194 \emph default
8195  
8196 \emph on
8197 (koma-script)
8198 \emph default
8199  correspond to the LaTeX document classes 
8200 \family typewriter
8201 scrartcl.cls
8202 \family default
8203
8204 \family typewriter
8205 scrreprt.cls
8206 \family default
8207
8208 \family typewriter
8209 scrbook.cls
8210 \family default
8211 , and 
8212 \family typewriter
8213 scrlettr.cls
8214 \family default
8215 , resp.
8216  of the Koma-Script family.
8217  They are replacements for the standard document classes 
8218 \family typewriter
8219 article.cls
8220 \family default
8221
8222 \family typewriter
8223 report.cls
8224 \family default
8225
8226 \family typewriter
8227 book.cls
8228 \family default
8229  and 
8230 \family typewriter
8231 letter.cls
8232 \family default
8233 , resp., and fit better to European typography conventions in a number of
8234  points.
8235 \end_layout
8236
8237 \begin_layout Itemize
8238 Standard character size is 11pt in 
8239 \emph on
8240 article (koma-script)
8241 \emph default
8242
8243 \emph on
8244 report (koma-script)
8245 \emph default
8246 , and 
8247 \emph on
8248 book (koma-script)
8249 \emph default
8250 , and 12pt in 
8251 \emph on
8252 letter (koma-script)
8253 \emph default
8254 .
8255 \end_layout
8256
8257 \begin_layout Itemize
8258 Headings, labels of the description environment, and a number of elements
8259  of the 
8260 \emph on
8261 letter (koma-script) 
8262 \emph default
8263 document class are set in a bold sans serif font.
8264 \begin_inset Foot
8265 status collapsed
8266
8267 \begin_layout Standard
8268 There is a big difference between the bold sans serif old cm fonts and new
8269  ec fonts, especially in the appearance of headings.
8270  In comparison, the ec bold sans serif fonts look a bit thin.
8271  Here the LaTeX package 
8272 \family typewriter
8273 cmsd.sty by 
8274 \family default
8275 \shape smallcaps
8276 Walter Schmidt
8277 \shape default
8278  helps to produce the 
8279 \begin_inset Quotes eld
8280 \end_inset
8281
8282 usual
8283 \begin_inset Quotes erd
8284 \end_inset
8285
8286  appearance when using the ec fonts.
8287 \end_layout
8288
8289 \end_inset
8290
8291  The numbering of chapter headings is made in the same way as the numbering
8292  of section headings, that is without the extra line 
8293 \begin_inset Quotes eld
8294 \end_inset
8295
8296 Chapter\SpecialChar \ldots{}
8297
8298 \begin_inset Quotes erd
8299 \end_inset
8300
8301 .
8302  In addition, the appearance of the headings can be modified by using a
8303  number of options (in LyX to be entered in the field 
8304 \family sans
8305 E
8306 \bar under
8307 x
8308 \bar default
8309 tra\InsetSpace ~
8310 Options
8311 \family default
8312  of the dialog 
8313 \family sans
8314 \bar under
8315 L
8316 \bar default
8317 ayout\SpecialChar \menuseparator
8318
8319 \bar under
8320 D
8321 \bar default
8322 ocument
8323 \family default
8324 ).
8325  A detailed German description of these options can be found in the Koma-Script
8326  documentation 
8327 \emph on
8328 scrguide
8329 \emph default
8330 .
8331 \end_layout
8332
8333 \begin_layout Itemize
8334 The main means in the Koma-Script document classes to design the type area
8335  are the options 
8336 \family sans
8337 BCOR
8338 \family default
8339  and 
8340 \family sans
8341 DIV
8342 \family default
8343  (in LyX to be entered in the extra class options field in the dialog 
8344 \family sans
8345 \bar under
8346 D
8347 \bar default
8348 ocument\SpecialChar \menuseparator
8349
8350 \bar under
8351 S
8352 \bar default
8353 ettings
8354 \family default
8355 ).
8356  They make a clearer modification of page margins possible as do the options
8357  of the dialog 
8358 \family sans
8359 \bar under
8360 D
8361 \bar default
8362 ocument\SpecialChar \menuseparator
8363
8364 \bar under
8365 S
8366 \bar default
8367 ettings
8368 \family default
8369 .
8370  A detailed German description of these and other type area options can
8371  be found in the Koma-Script documentation 
8372 \emph on
8373 scrguide
8374 \emph default
8375 .
8376 \end_layout
8377
8378 \begin_layout Itemize
8379 The LaTeX document classes of the Koma-Script family define a number of
8380  additional commands.
8381  Those part of it which makes sense in LyX is implemented in corresponding
8382  paragraph types.
8383 \end_layout
8384
8385 \begin_layout Standard
8386 A detailed German description of the LaTeX document classes of the Koma-Script
8387  family can be found in the Koma-Script documentation 
8388 \emph on
8389 scrguide
8390 \emph default
8391 .
8392 \begin_inset Foot
8393 status collapsed
8394
8395 \begin_layout Standard
8396 There is an English translation 
8397 \emph on
8398 screnggu
8399 \emph default
8400 , but it is not a complete one.
8401 \end_layout
8402
8403 \end_inset
8404
8405  The following sections describe only those aspects, which are relevant
8406  in LyX.
8407 \end_layout
8408
8409 \begin_layout Subsection
8410 article (koma-script), report (koma-script), and book (koma-script)
8411 \end_layout
8412
8413 \begin_layout Standard
8414 The document classes 
8415 \emph on
8416 article (koma-script)
8417 \emph default
8418
8419 \emph on
8420 report (koma-script)
8421 \emph default
8422 , and 
8423 \emph on
8424 book
8425 \emph default
8426  
8427 \emph on
8428 (koma-script)
8429 \emph default
8430  are implemented in the layout files 
8431 \family typewriter
8432 scrartcl.layout
8433 \family default
8434
8435 \family typewriter
8436 scrreprt.layout
8437 \family default
8438 , and 
8439 \family typewriter
8440 scrbook.layout
8441 \family default
8442 , resp.
8443  They contain all the paragraph types of the corresponding standard document
8444  classes 
8445 \emph on
8446 article
8447 \emph default
8448
8449 \emph on
8450 report
8451 \emph default
8452 , and 
8453 \emph on
8454 book
8455 \emph default
8456 , resp., partly modified, with the exception of the LyX specific 
8457 \family sans
8458 List
8459 \family default
8460 -type, which is replaced by the new 
8461 \family sans
8462 Labeling
8463 \family default
8464 -type having the same functionality.
8465  Beside the 
8466 \family sans
8467 Labeling
8468 \family default
8469 -Type there is a number of new paragraph types added.
8470  They are 
8471 \emph on
8472 not
8473 \emph default
8474  part of 
8475 \emph on
8476 letter (koma-script)
8477 \emph default
8478 .
8479 \end_layout
8480
8481 \begin_layout Itemize
8482
8483 \family sans
8484 Addpart, Addchap
8485 \family default
8486
8487 \family sans
8488 Addsec
8489 \family default
8490 : are equivalents to 
8491 \family sans
8492 Part*, Chapter*
8493 \family default
8494  and 
8495 \family sans
8496 Section*
8497 \family default
8498 , resp., additionally inserting an entry in the table of contents.
8499  
8500 \family sans
8501 Addpart 
8502 \family default
8503 and
8504 \family sans
8505  Addchap
8506 \family default
8507  are not contained in 
8508 \emph on
8509 article (koma-script)
8510 \emph default
8511 .
8512 \end_layout
8513
8514 \begin_layout Itemize
8515
8516 \family sans
8517 Addchap*
8518 \family default
8519
8520 \family sans
8521 Addsec*
8522 \family default
8523 : behave exactly as 
8524 \family sans
8525 Addchap
8526 \family default
8527  and 
8528 \family sans
8529 Addsec
8530 \family default
8531 , resp., additionally clearing running heads.
8532
8533 \family sans
8534  Addchap*
8535 \family default
8536  is not contained in 
8537 \emph on
8538 article (koma-script)
8539 \emph default
8540 .
8541 \begin_inset Foot
8542 status collapsed
8543
8544 \begin_layout Standard
8545 There is also an 
8546 \family typewriter
8547
8548 \backslash
8549 addpart*
8550 \family default
8551  command in 
8552 \emph on
8553 book (koma-script)
8554 \emph default
8555  and in 
8556 \emph on
8557 report (koma-script)
8558 \emph default
8559 , but since this is identical to 
8560 \family sans
8561 Part*
8562 \family default
8563 , is has not been implemented in LyX.
8564 \end_layout
8565
8566 \end_inset
8567
8568
8569 \end_layout
8570
8571 \begin_layout Itemize
8572
8573 \family sans
8574 Minisec
8575 \family default
8576 : generates a heading directly above the following paragraph in the standard
8577  character size without affecting the structure of the document.
8578 \end_layout
8579
8580 \begin_layout Itemize
8581
8582 \family sans
8583 Captionabove
8584 \family default
8585  and 
8586 \family sans
8587 Captionbelow 
8588 \family default
8589 are special captions which respect the different space settings needed for
8590  captions placed above or below an element (if you follow strict typographic
8591  rules, you might want to place table captions always above the table).
8592  You can also use the class option 
8593 \family typewriter
8594 tablecaptionsabove
8595 \family default
8596 , which will switch 
8597 \family sans
8598 caption
8599 \family default
8600  to 
8601 \family sans
8602 captionabove
8603 \family default
8604  for tables and 
8605 \family sans
8606 captionbelow
8607 \family default
8608  for figures.
8609  You need at least Koma-Script version 2.8q to use this.
8610 \end_layout
8611
8612 \begin_layout Itemize
8613
8614 \family sans
8615 Dictum
8616 \family default
8617 : can be used to set a bonmot, e.
8618 \begin_inset ERT
8619 status collapsed
8620
8621 \begin_layout Standard
8622
8623
8624 \backslash
8625 ,
8626 \end_layout
8627
8628 \end_inset
8629
8630 g.
8631 \begin_inset ERT
8632 status collapsed
8633
8634 \begin_layout Standard
8635
8636
8637 \backslash
8638  
8639 \end_layout
8640
8641 \end_inset
8642
8643 at the beginning of a chapter.
8644  If you use the optional argument (
8645 \family sans
8646 \bar under
8647 I
8648 \bar default
8649 nsert\SpecialChar \menuseparator
8650 Short\InsetSpace ~
8651 Title
8652 \family default
8653 ), you can insert the dictum's author there.
8654  Dictum and author are separated by a line.
8655  You need at least Koma-Script version 2.8q to use this.
8656  
8657 \family sans
8658 Dictum
8659 \family default
8660  is not contained in 
8661 \emph on
8662 article (koma-script)
8663 \emph default
8664 .
8665 \end_layout
8666
8667 \begin_layout Standard
8668 The following types, together with the standard types 
8669 \family sans
8670 Title
8671 \family default
8672
8673 \family sans
8674 Author
8675 \family default
8676 , and 
8677 \family sans
8678 Date
8679 \family default
8680 , form the title area of the document.
8681  They must be entered ahead of the first 
8682 \begin_inset Quotes eld
8683 \end_inset
8684
8685 ordinary
8686 \begin_inset Quotes erd
8687 \end_inset
8688
8689  paragraph.
8690 \begin_inset Foot
8691 status collapsed
8692
8693 \begin_layout Standard
8694 The corresponding LaTeX commands must appear before the 
8695 \family typewriter
8696
8697 \backslash
8698 maketitle
8699 \family default
8700  command.
8701 \end_layout
8702
8703 \end_inset
8704
8705  When such a type is used more than once, the latter usage overwrites the
8706  former one, that means, for every type only the latest usage is valid.
8707  The order of the different types however has, like 
8708 \family sans
8709 Title
8710 \family default
8711
8712 \family sans
8713 Author
8714 \family default
8715 , and 
8716 \family sans
8717 Date
8718 \family default
8719 , no effect on the appearance of the produced document.
8720 \end_layout
8721
8722 \begin_layout Itemize
8723
8724 \family sans
8725 Subject
8726 \family default
8727 : produces a centered paragraph above the ordinary title (
8728 \family sans
8729 Title
8730 \family default
8731
8732 \family sans
8733 Author
8734 \family default
8735
8736 \family sans
8737 Date
8738 \family default
8739 ) for the subject of the document.
8740 \end_layout
8741
8742 \begin_layout Itemize
8743
8744 \family sans
8745 Publishers
8746 \family default
8747 : produces a centered paragraph below the ordinary title (
8748 \family sans
8749 Title
8750 \family default
8751
8752 \family sans
8753 Author
8754 \family default
8755
8756 \family sans
8757 Date
8758 \family default
8759 ) for the publishers' name.
8760 \end_layout
8761
8762 \begin_layout Itemize
8763
8764 \family sans
8765 Dedication
8766 \family default
8767 : in 
8768 \emph on
8769 report (koma-script)
8770 \emph default
8771  and 
8772 \emph on
8773 book (koma-script)
8774 \emph default
8775  produces a centered paragraph on its own page behind the title page, or
8776  in 
8777 \emph on
8778 article (koma-script)
8779 \emph default
8780  produces a centered paragraph below the ordinary title (
8781 \family sans
8782 Title
8783 \family default
8784
8785 \family sans
8786 Author
8787 \family default
8788
8789 \family sans
8790 Date
8791 \family default
8792
8793 \family sans
8794 Publishers
8795 \family default
8796 ) for a dedication.
8797 \end_layout
8798
8799 \begin_layout Itemize
8800
8801 \family sans
8802 Titlehead
8803 \family default
8804 : produces a left aligned paragraph above the ordinary title (
8805 \family sans
8806 Title
8807 \family default
8808
8809 \family sans
8810 Author
8811 \family default
8812
8813 \family sans
8814 Date
8815 \family default
8816
8817 \family sans
8818 Subject
8819 \family default
8820 ) for a document`s head.
8821 \end_layout
8822
8823 \begin_layout Itemize
8824
8825 \family sans
8826 Uppertitleback
8827 \family default
8828 : produces in a double-sided print in 
8829 \emph on
8830 report (koma-script)
8831 \emph default
8832  and 
8833 \emph on
8834 book (koma-script)
8835 \emph default
8836  a left-aligned paragraph at the top of the title page`s back or has no
8837  effect in a single-sided print or in 
8838 \emph on
8839 article (koma-script)
8840 \emph default
8841 .
8842 \end_layout
8843
8844 \begin_layout Itemize
8845
8846 \family sans
8847 Lowertitleback
8848 \family default
8849 : produces in a double-sided print in 
8850 \emph on
8851 report (koma-script)
8852 \emph default
8853  and 
8854 \emph on
8855 book (koma-script)
8856 \emph default
8857  a left-aligned paragraph at the bottom of the title page`s back or has
8858  no effect in a single-sided print or in 
8859 \emph on
8860 article (koma-script)
8861 \emph default
8862 .
8863 \end_layout
8864
8865 \begin_layout Itemize
8866
8867 \family sans
8868 Extratitle
8869 \family default
8870 : produces a special 
8871 \begin_inset Quotes eld
8872 \end_inset
8873
8874 dirty
8875 \begin_inset Quotes erd
8876 \end_inset
8877
8878  page ahead of the actual document containing a paragraph without special
8879  formatting.
8880 \end_layout
8881
8882 \begin_layout Standard
8883 The layout files for the document classes 
8884 \emph on
8885 article (koma-script)
8886 \emph default
8887
8888 \emph on
8889 report (koma-script)
8890 \emph default
8891 , and 
8892 \emph on
8893 book (koma-script)
8894 \emph default
8895  do include the file 
8896 \family typewriter
8897 scrmacros.inc
8898 \family default
8899 .
8900  This is thought of as a place to define your own types.
8901  Copy s
8902 \family typewriter
8903 crmacros.inc
8904 \family default
8905  in your personal layout directory and edit the file!
8906 \end_layout
8907
8908 \begin_layout Subsection
8909 letter (koma-script)
8910 \end_layout
8911
8912 \begin_layout Standard
8913 \begin_inset ERT
8914 status inlined
8915
8916 \begin_layout Standard
8917
8918
8919 \backslash
8920 begin{sloppypar}
8921 \end_layout
8922
8923 \end_inset
8924
8925
8926 \end_layout
8927
8928 \begin_layout Standard
8929 \noindent
8930 The document class 
8931 \emph on
8932 letter (koma-script)
8933 \emph default
8934  is implemented in the layout file 
8935 \family typewriter
8936 scrlettr.layout
8937 \family default
8938 .
8939  It contains all the paragraph types of the corresponding standard document
8940  class 
8941 \emph on
8942 letter
8943 \emph default
8944 , partly modified, with the exception of the LyX specific types 
8945 \family sans
8946 LyX-Code
8947 \family default
8948  and 
8949 \family sans
8950 Comment
8951 \family default
8952  and the 
8953 \family sans
8954 List
8955 \family default
8956  type, which is replaced by the new 
8957 \family sans
8958 Labeling
8959 \family default
8960  type.
8961  In addition, it contains, in contrast to the standard document class, the
8962  standard types 
8963 \family sans
8964 LaTeX
8965 \family default
8966
8967 \family sans
8968 Quotation
8969 \family default
8970
8971 \family sans
8972 Quote
8973 \family default
8974 , and 
8975 \family sans
8976 Verse
8977 \family default
8978 .
8979  Furthermore, there are a number of new letter specific types.
8980 \end_layout
8981
8982 \begin_layout Standard
8983 \begin_inset ERT
8984 status inlined
8985
8986 \begin_layout Standard
8987
8988
8989 \backslash
8990 end{sloppypar}
8991 \end_layout
8992
8993 \end_inset
8994
8995
8996 \end_layout
8997
8998 \begin_layout Standard
8999 The appearance of the letter produced by this document class can be controlled
9000  by a number of LaTeX commands, which you can put in the LaTeX preamble.
9001 \begin_inset Foot
9002 status collapsed
9003
9004 \begin_layout Standard
9005 For example, the standard appearance of the letter`s heading, consisting
9006  of name and address, is quite self-willed.
9007  An 
9008 \begin_inset Quotes eld
9009 \end_inset
9010
9011 ordinary
9012 \begin_inset Quotes erd
9013 \end_inset
9014
9015  heading is produced by the following LaTeX commands in the preamble:
9016 \end_layout
9017
9018 \begin_layout LyX-Code
9019
9020 \backslash
9021 firsthead{
9022 \backslash
9023 parbox[b]{
9024 \backslash
9025 textwidth}
9026 \end_layout
9027
9028 \begin_layout LyX-Code
9029   {
9030 \backslash
9031 ignorespaces 
9032 \backslash
9033 fromname
9034 \backslash
9035
9036 \backslash
9037  
9038 \backslash
9039 ignorespaces 
9040 \backslash
9041 fromaddress}} 
9042 \end_layout
9043
9044 \begin_layout LyX-Code
9045
9046 \backslash
9047 nexthead{
9048 \backslash
9049 parbox[b]{
9050 \backslash
9051 textwidth}
9052 \end_layout
9053
9054 \begin_layout LyX-Code
9055   {
9056 \backslash
9057 ignorespaces 
9058 \backslash
9059 fromname 
9060 \backslash
9061 hfill 
9062 \backslash
9063 ignorespaces 
9064 \backslash
9065 pagename
9066 \backslash
9067  
9068 \backslash
9069 thepage}}
9070 \end_layout
9071
9072 \end_inset
9073
9074  A detailed German description of such LaTeX commands can be found in the
9075  Koma-Script documentation 
9076 \emph on
9077 scrguide
9078 \emph default
9079 .
9080  With it, the letter's author can produce his personal letter layout.
9081 \end_layout
9082
9083 \begin_layout Standard
9084 The types 
9085 \family sans
9086 Letter 
9087 \family default
9088 and 
9089 \family sans
9090 Opening
9091 \family default
9092  define the beginning of the letter and must be used in every letter.
9093  To emphasize them in the LyX document class, they are marked with the letter
9094  
9095 \shape italic
9096 L
9097 \shape default
9098  or 
9099 \shape italic
9100 O
9101 \shape default
9102 , resp.
9103  in the left margin.
9104  It is possible to write any number of letters in one file.
9105  An 
9106 \family sans
9107 Opening
9108 \family default
9109  type produces a new letter using the same addressee and a 
9110 \family sans
9111 Letter
9112 \family default
9113  type produces a new addressee.
9114  The types 
9115 \family sans
9116 Closing
9117 \family default
9118
9119 \family sans
9120 PS
9121 \family default
9122
9123 \family sans
9124 CC
9125 \family default
9126 , and 
9127 \family sans
9128 Encl
9129 \family default
9130  are ordinary paragraph types and can also be used several times in one
9131  and the same letter.
9132 \end_layout
9133
9134 \begin_layout Itemize
9135
9136 \family sans
9137 Letter
9138 \family default
9139 : produces a paragraph for the addressee and implicitly defines the beginning
9140  of the letter.
9141 \end_layout
9142
9143 \begin_layout Itemize
9144
9145 \family sans
9146 Opening
9147 \family default
9148 : produces a paragraph for the form of address and implicitly produces a
9149  new letter.
9150 \end_layout
9151
9152 \begin_layout Itemize
9153
9154 \family sans
9155 Closing
9156 \family default
9157 : produces a paragraph for a close.
9158 \end_layout
9159
9160 \begin_layout Itemize
9161
9162 \family sans
9163 PS
9164 \family default
9165 : produces a paragraph for a postscript.
9166 \end_layout
9167
9168 \begin_layout Itemize
9169
9170 \family sans
9171 CC
9172 \family default
9173 : produces a paragraph for a distribution list.
9174 \end_layout
9175
9176 \begin_layout Itemize
9177
9178 \family sans
9179 Encl
9180 \family default
9181 : produces a paragraph for enclosures.
9182 \end_layout
9183
9184 \begin_layout Standard
9185 The types 
9186 \family sans
9187 Name
9188 \family default
9189
9190 \family sans
9191 Signature
9192 \family default
9193
9194 \family sans
9195 Address
9196 \family default
9197 ,
9198 \family sans
9199  Telephone
9200 \family default
9201
9202 \family sans
9203 Place
9204 \family default
9205
9206 \family sans
9207 Backaddress
9208 \family default
9209
9210 \family sans
9211 Specialmail
9212 \family default
9213
9214 \family sans
9215 Location
9216 \family default
9217
9218 \family sans
9219 Title
9220 \family default
9221 , and 
9222 \family sans
9223 Subject
9224 \family default
9225  are input types provided with a label to enter information, which will
9226  be processed by the document class.
9227 \begin_inset Foot
9228 status collapsed
9229
9230 \begin_layout Standard
9231 It could be seen as a matter of inconsequence, that the types 
9232 \family sans
9233 Letter
9234 \family default
9235  and 
9236 \family sans
9237 Opening
9238 \family default
9239  described above are not such input types as well.
9240  Because of the special meaning of those types, however, I have implemented
9241  them as ordinary paragraph types with a one letter mark in the left margin.
9242  Moreover, it would affect my feeling of symmetry, if the 
9243 \family sans
9244 Opening
9245 \family default
9246  type and the 
9247 \family sans
9248 Closing
9249 \family default
9250  type had such a serious different appearance.
9251 \end_layout
9252
9253 \end_inset
9254
9255  The types must be used ahead of the corresponding 
9256 \family sans
9257 Opening
9258 \family default
9259  type.
9260 \end_layout
9261
9262 \begin_layout Standard
9263 An implementation of these types in a WYSIWYG fashion does not seem to make
9264  sense, because the real appearance of the produced letter does not only
9265  depend on the usage of the particular type, but also on other factors.
9266  For example, a signature entered in the 
9267 \family sans
9268 Signature
9269 \family default
9270  type will in the standard behavior appear in the produced letter only,
9271  when in the same letter also a 
9272 \family sans
9273 Closing
9274 \family default
9275  type is used.
9276  The entered value of the 
9277 \family sans
9278 Telephone
9279 \family default
9280  type will in the standard behavior not appear in the produced letter at
9281  all.
9282  The possibility to design the letter`s heading freely is already indicated
9283  in a footnote above.
9284 \end_layout
9285
9286 \begin_layout Standard
9287 The input types can also be used as empty paragraphs.
9288  This makes sense e.\InsetSpace ~
9289 g.
9290  for the 
9291 \family sans
9292 Signature
9293 \family default
9294  type.
9295  If the 
9296 \family sans
9297 Signature
9298 \family default
9299  type is not used at all, in the standard behavior the value of the 
9300 \family sans
9301 Name
9302 \family default
9303  type is used as signature, whereas if an empty 
9304 \family sans
9305 Signature
9306 \family default
9307  type is used, no signature value is defined.
9308 \end_layout
9309
9310 \begin_layout Standard
9311 By using the input types it is possible to write a letter template, containing
9312  filled input types with your personal dates (name, address, etc.) and empty
9313  input types for other dates you want to enter.
9314 \end_layout
9315
9316 \begin_layout Itemize
9317
9318 \family sans
9319 Name
9320 \family default
9321 : sender's name, in the standard behavior appears as a centered paragraph
9322  in small caps in the letter`s heading.
9323 \end_layout
9324
9325 \begin_layout Itemize
9326
9327 \family sans
9328 Signature
9329 \family default
9330 : sender's signature, in the standard behavior appears below the 
9331 \family sans
9332 Closing
9333 \family default
9334  type.
9335  If no 
9336 \family sans
9337 Signature
9338 \family default
9339  type is used, the value of the 
9340 \family sans
9341 Name
9342 \family default
9343  type appears instead.
9344 \end_layout
9345
9346 \begin_layout Itemize
9347
9348 \family sans
9349 Address
9350 \family default
9351 : sender's address, in the standard behavior appears in a centered paragraph
9352  in the letter`s heading below the sender's name.
9353 \end_layout
9354
9355 \begin_layout Itemize
9356
9357 \family sans
9358 Telephone
9359 \family default
9360 : sender's telephone number, in the standard behavior only sets the LaTeX
9361  variable 
9362 \family typewriter
9363
9364 \backslash
9365 telephonenum
9366 \family default
9367 .
9368 \end_layout
9369
9370 \begin_layout Itemize
9371
9372 \family sans
9373 Place
9374 \family default
9375 : place of the letter`s making.
9376 \end_layout
9377
9378 \begin_layout Itemize
9379
9380 \family sans
9381 Date
9382 \family default
9383 : date of the letter`s making.
9384  
9385 \family sans
9386 Place
9387 \family default
9388  and 
9389 \family sans
9390 Date
9391 \family default
9392 , in the standard behavior, produce the place and the date in a right-aligned
9393  line below the addressee's field.
9394  If an empty 
9395 \family sans
9396 Date
9397 \family default
9398  type is used, neither place nor date appear, independent of the value of
9399  the 
9400 \family sans
9401 Place
9402 \family default
9403  type.
9404  If no 
9405 \family sans
9406 Date
9407 \family default
9408  type is used, the date of the letter `s production is used.
9409 \end_layout
9410
9411 \begin_layout Itemize
9412
9413 \family sans
9414 Backaddress
9415 \family default
9416 : sender`s back address, in the standard behavior appears above the addressee's
9417  field in a small sans serif font.
9418 \end_layout
9419
9420 \begin_layout Itemize
9421
9422 \family sans
9423 Specialmail
9424 \family default
9425 : special mail information, in the standard behavior appears underlined
9426  above the addressee's field below the back address.
9427 \end_layout
9428
9429 \begin_layout Itemize
9430
9431 \family sans
9432 Location
9433 \family default
9434 : additional information, in the standard behavior appears on right side
9435  below the addressee`s field.
9436 \end_layout
9437
9438 \begin_layout Itemize
9439
9440 \family sans
9441 Title
9442 \family default
9443 : the letter's title, in the standard behavior appears in a big, bold, sans
9444  serif font above the subject.
9445 \end_layout
9446
9447 \begin_layout Itemize
9448
9449 \family sans
9450 Subject
9451 \family default
9452 : the letter's subject, in the standard behavior appears in a bold font
9453  above the 
9454 \family sans
9455 Opening
9456 \family default
9457  paragraph.
9458 \end_layout
9459
9460 \begin_layout Standard
9461 The types 
9462 \family sans
9463 Yourref
9464 \family default
9465
9466 \family sans
9467 Yourmail
9468 \family default
9469
9470 \family sans
9471 Myref
9472 \family default
9473
9474 \family sans
9475 Customer
9476 \family default
9477 , and 
9478 \family sans
9479 Invoice
9480 \family default
9481  produce a business letter like line above the 
9482 \family sans
9483 Title
9484 \family default
9485  line containing the fields 
9486 \begin_inset Quotes eld
9487 \end_inset
9488
9489 Your ref.
9490 \begin_inset Quotes erd
9491 \end_inset
9492
9493
9494 \begin_inset Quotes eld
9495 \end_inset
9496
9497 Your letter of
9498 \begin_inset Quotes erd
9499 \end_inset
9500
9501
9502 \begin_inset Quotes eld
9503 \end_inset
9504
9505 Our ref.
9506 \begin_inset Quotes erd
9507 \end_inset
9508
9509
9510 \begin_inset Quotes eld
9511 \end_inset
9512
9513 Customer no.
9514 \begin_inset Quotes erd
9515 \end_inset
9516
9517
9518 \begin_inset Quotes eld
9519 \end_inset
9520
9521 Invoice no.
9522 \begin_inset Quotes erd
9523 \end_inset
9524
9525 , and 
9526 \begin_inset Quotes eld
9527 \end_inset
9528
9529 Date
9530 \begin_inset Quotes erd
9531 \end_inset
9532
9533 .
9534  For the date field, the value of the 
9535 \family sans
9536 Date
9537 \family default
9538  type is used.
9539  If one of these 
9540 \begin_inset Quotes eld
9541 \end_inset
9542
9543 business letter types
9544 \begin_inset Quotes erd
9545 \end_inset
9546
9547  is used, the value of the 
9548 \family sans
9549 Place
9550 \family default
9551  type however does not appear, but only the LaTeX variable 
9552 \family typewriter
9553
9554 \backslash
9555 fromplace
9556 \family default
9557  is set.
9558  The ordinary output of place and date in a right-aligned line below the
9559  addressee`s field is suppressed.
9560  The types are implemented as input types provided with a label and must
9561  be used ahead of the corresponding 
9562 \family sans
9563 Opening
9564 \family default
9565  type.
9566 \end_layout
9567
9568 \begin_layout Itemize
9569
9570 \family sans
9571 Yourref
9572 \family default
9573 : Your ref.
9574 \end_layout
9575
9576 \begin_layout Itemize
9577
9578 \family sans
9579 Yourmail
9580 \family default
9581 : Your letter of.
9582 \end_layout
9583
9584 \begin_layout Itemize
9585
9586 \family sans
9587 Myref
9588 \family default
9589 : Our ref.
9590 \end_layout
9591
9592 \begin_layout Itemize
9593
9594 \family sans
9595 Customer
9596 \family default
9597 : Customer no.
9598 \end_layout
9599
9600 \begin_layout Itemize
9601
9602 \family sans
9603 Invoice
9604 \family default
9605 : Invoice no.
9606 \end_layout
9607
9608 \begin_layout Subsection
9609 The new letter class: letter (koma-script v.2)
9610 \end_layout
9611
9612 \begin_layout Standard
9613 by 
9614 \noun on
9615 Jürgen Spitzmüller
9616 \end_layout
9617
9618 \begin_layout Standard
9619 \begin_inset VSpace medskip
9620 \end_inset
9621
9622
9623 \end_layout
9624
9625 \begin_layout Standard
9626 \noindent
9627 Koma-Script version 2.8 has introduced a new letter class 
9628 \family typewriter
9629 scrlttr2
9630 \family default
9631  which superceeds the now unsupported 
9632 \family typewriter
9633 scrlettr
9634 \family default
9635 .
9636  It has --- on the LaTeX side --- a completely new interface and is not
9637  compatible with the old class.
9638  Therefore, LyX supports both, though it is recommended to use the new class.
9639 \end_layout
9640
9641 \begin_layout Standard
9642 This class covers the same functionality as 
9643 \emph on
9644 letter (koma-script),
9645 \emph default
9646  and a few more.
9647  The basic items are 
9648 \family sans
9649 Address
9650 \family default
9651  (receiver's address, same as 
9652 \family sans
9653 Letter
9654 \family default
9655  in the old layout), 
9656 \family sans
9657 Opening
9658 \family default
9659 , and 
9660 \family sans
9661 Closing
9662 \family default
9663 .
9664  
9665 \family sans
9666 NextAddress
9667 \family default
9668  will start a new letter (i.
9669 \begin_inset ERT
9670 status collapsed
9671
9672 \begin_layout Standard
9673
9674
9675 \backslash
9676 ,
9677 \end_layout
9678
9679 \end_inset
9680
9681 e.
9682 \begin_inset ERT
9683 status collapsed
9684
9685 \begin_layout Standard
9686
9687
9688 \backslash
9689  
9690 \end_layout
9691
9692 \end_inset
9693
9694 you can write several letters per document).
9695  New elements are sender's 
9696 \family sans
9697 E-Mail
9698 \family default
9699
9700 \family sans
9701 URL
9702 \family default
9703
9704 \family sans
9705 Fax
9706 \family default
9707
9708 \family sans
9709 Bank
9710 \family default
9711  and the possibility to use a 
9712 \family sans
9713 Logo
9714 \family default
9715  (via 
9716 \family sans
9717 \bar under
9718 I
9719 \bar default
9720 nsert\SpecialChar \menuseparator
9721
9722 \bar under
9723 G
9724 \bar default
9725 raphics
9726 \family default
9727 ) in the header.
9728 \end_layout
9729
9730 \begin_layout Standard
9731 The biggest improvement is, though, that the letter's layout is configurable
9732  at almost any needs.
9733  This can be done via the preamble or with a special style file (Letter
9734  Class Option, extension 
9735 \family typewriter
9736 *.lco
9737 \family default
9738 ), that will be read in as a class option.
9739 \begin_inset Foot
9740 status collapsed
9741
9742 \begin_layout Standard
9743 The KOMA package comes with some default 
9744 \family typewriter
9745 *.lco
9746 \family default
9747  files.
9748  There is, for instance, a 
9749 \family typewriter
9750 DIN.lco
9751 \family default
9752  file that follows german typesetting rules, or a 
9753 \family typewriter
9754 KOMAold.lco
9755 \family default
9756  that provides the default layout of the old 
9757 \family typewriter
9758 scrlettr
9759 \family default
9760  class.
9761  The latter can be loaded with the class option 
9762 \family typewriter
9763 KOMAold
9764 \family default
9765 , inserted via the 
9766 \family sans
9767 \bar under
9768 L
9769 \bar default
9770 ayout\SpecialChar \menuseparator
9771
9772 \bar under
9773 D
9774 \bar default
9775 ocument\SpecialChar \menuseparator
9776 Extra Options 
9777 \family default
9778 field.
9779 \end_layout
9780
9781 \end_inset
9782
9783  Have a look at the 
9784 \emph on
9785 koma-letter2
9786 \emph default
9787  template that is included in LyX for examples.
9788  A detailed description is to be found in the Koma-Script documentation
9789  (
9790 \emph on
9791 scrguide
9792 \emph default
9793 ).
9794 \end_layout
9795
9796 \begin_layout Subsection
9797 Problems
9798 \end_layout
9799
9800 \begin_layout Standard
9801 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
9802  some problems.
9803 \end_layout
9804
9805 \begin_layout Itemize
9806 The chapter number of a 
9807 \family sans
9808 Chapter
9809 \family default
9810  type appears on a line of its own above the chapter heading instead of
9811  appearing in the same line ahead of it.
9812  The cause for that is the LyX internal behavior for the labeltype 
9813 \family sans
9814 Counter_Chapter
9815 \family default
9816  in the layout file.
9817 \end_layout
9818
9819 \begin_layout Itemize
9820 The headings of the types 
9821 \family sans
9822 Addchap
9823 \family default
9824  and 
9825 \family sans
9826 Addsec
9827 \family default
9828  are only put in the 
9829 \begin_inset Quotes eld
9830 \end_inset
9831
9832 true
9833 \begin_inset Quotes erd
9834 \end_inset
9835
9836  LaTeX table of contents, but not in the LyX table of contents (
9837 \family sans
9838 \bar under
9839 D
9840 \bar default
9841 ocument\SpecialChar \menuseparator
9842
9843 \bar under
9844 T
9845 \bar default
9846 able\InsetSpace ~
9847 of\InsetSpace ~
9848 Contents
9849 \family default
9850 ).
9851 \end_layout
9852
9853 \begin_layout Itemize
9854 The paragraphs in a 
9855 \emph on
9856 letter
9857 \emph default
9858  document class appear in a skip separation mode, not indented.
9859  This is the standard behavior, no special LaTeX commands are needed for
9860  that.
9861  But in the 
9862 \family sans
9863 \bar under
9864 D
9865 \bar default
9866 ocument\SpecialChar \menuseparator
9867
9868 \bar under
9869 S
9870 \bar default
9871 ettings
9872 \family default
9873  dialog the corresponding radio button indicates 
9874 \family sans
9875 \bar under
9876 I
9877 \bar default
9878 ndent
9879 \family default
9880 .
9881  A 
9882 \family sans
9883 S
9884 \bar under
9885 k
9886 \bar default
9887 ip
9888 \family default
9889  value always has the effect that extra LaTeX commands are inserted in the
9890  document to produce the gap, which is not what is wanted in this case.
9891 \end_layout
9892
9893 \begin_layout Section
9894 Springer Journals (
9895 \family sans
9896 svjour
9897 \family default
9898 )
9899 \end_layout
9900
9901 \begin_layout Standard
9902 by 
9903 \noun on
9904 Martin Vermeer
9905 \end_layout
9906
9907 \begin_layout Subsection
9908 Description
9909 \end_layout
9910
9911 \begin_layout Standard
9912 These are the layout files for some of the journal formats used by Springer
9913  Verlag and listed on 
9914 \begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
9915
9916 \end_inset
9917
9918 , where you should also go to fetch the class files (yes, these are LaTeX2e
9919  now!).
9920  It is a modular system: the things common to all journals are implemented
9921  in 
9922 \family typewriter
9923 svjour.inc
9924 \family default
9925 , which journal-specific layout files (such as, e.g., 
9926 \family typewriter
9927 svjog.layout
9928 \family default
9929  for Journal of Geodesy) can include.
9930 \end_layout
9931
9932 \begin_layout Standard
9933 This means that implementing support for any other Springer journal on this
9934  list is as simple as writing your own 
9935 \family typewriter
9936 sv
9937 \family default
9938 <myjournal>
9939 \family typewriter
9940 .layout
9941 \family default
9942  file following the outline given in 
9943 \family typewriter
9944 svjog.layout
9945 \family default
9946 .
9947  
9948 \end_layout
9949
9950 \begin_layout Standard
9951 It is reasonably well tested only for the Journal of Geodesy.
9952  
9953 \family typewriter
9954 svjour
9955 \family default
9956  and 
9957 \family typewriter
9958 svjog
9959 \family default
9960  come with the standard LyX distribution.
9961  Install the relevant class file (downloaded from Springer) in a proper
9962  directory, reconfigure LaTeX (in the teTeX case by running 
9963 \family typewriter
9964 texhash
9965 \family default
9966 , as root if necessary --- doesn't LyX take care of this?), reconfigure
9967  LyX and it should work.
9968 \end_layout
9969
9970 \begin_layout Subsection
9971 New styles
9972 \end_layout
9973
9974 \begin_layout Standard
9975 A large number of theorem-like styles --- 
9976 \family sans
9977 Claim, Conjecture,
9978 \family default
9979  
9980 \family sans
9981 \SpecialChar \ldots{}
9982 Theorem
9983 \family default
9984 .
9985 \end_layout
9986
9987 \begin_layout Standard
9988
9989 \family sans
9990 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
9991  Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
9992 \family default
9993 .
9994  See the Springer class file documentation for details.
9995 \end_layout
9996
9997 \begin_layout Subsection
9998 Supported journals
9999 \end_layout
10000
10001 \begin_layout Itemize
10002
10003 \emph on
10004 Journal of Geodesy
10005 \emph default
10006
10007 \family typewriter
10008 svjog.layout 
10009 \family default
10010 --- Martin Vermeer
10011 \end_layout
10012
10013 \begin_layout Itemize
10014
10015 \emph on
10016 Probability Theory and Related Fields
10017 \emph default
10018
10019 \family typewriter
10020 svprobth.layout
10021 \family default
10022  --- Jean-Marc Lasgouttes
10023 \end_layout
10024
10025 \begin_layout Standard
10026 Add your own, it isn't so hard!
10027 \end_layout
10028
10029 \begin_layout Subsection
10030 Credits
10031 \end_layout
10032
10033 \begin_layout Standard
10034 These files are partly based on the older 
10035 \family typewriter
10036 ejour2.layout
10037 \family default
10038 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
10039  file from Springer.
10040  All this, and the 
10041 \family typewriter
10042 ejour2
10043 \family default
10044  layout, are now defunct.
10045  Jean-Marc Lasgouttes helped out big in making me find my way around the
10046  LyX layout file mechanism.
10047 \end_layout
10048
10049 \begin_layout Subsection
10050 Bugs
10051 \end_layout
10052
10053 \begin_layout Standard
10054 Probably.
10055  But probably less than in the old hacked-LaTeX 
10056 \family typewriter
10057 ejour2
10058 \family default
10059 .
10060 \end_layout
10061
10062 \begin_layout Standard
10063 Limitations e.g.: does not display the number for theorem-like layouts, just
10064  #.
10065 \end_layout
10066
10067 \begin_layout Section
10068 AGU journals (
10069 \family sans
10070 aguplus
10071 \family default
10072 )
10073 \end_layout
10074
10075 \begin_layout Standard
10076 by 
10077 \shape smallcaps
10078 Martin Vermeer
10079 \end_layout
10080
10081 \begin_layout Subsection
10082 Description
10083 \end_layout
10084
10085 \begin_layout Standard
10086 These are the layout files for some of the journals of the American Geophysical
10087  Society.
10088  It is assumed that you have both the AGU's own class files and AGUplus
10089  installed (everything to be found at
10090 \begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
10091
10092 \end_inset
10093
10094 ).
10095 \end_layout
10096
10097 \begin_layout Subsection
10098 New styles
10099 \end_layout
10100
10101 \begin_layout Standard
10102 Redefined are 
10103 \family sans
10104 Paragraph
10105 \family default
10106
10107 \family sans
10108 Paragraph*
10109 \family default
10110 .
10111  They are still called this in the LyX GUI, though their LaTeX equivalents
10112  in the AGU classes are 
10113 \family sans
10114 Subsubsubsection
10115 \family default
10116  and 
10117 \family sans
10118 Subsubsubsection*
10119 \family default
10120 .
10121 \end_layout
10122
10123 \begin_layout Standard
10124 Newly defined styles are 
10125 \family sans
10126 Left_Header
10127 \family default
10128
10129 \family sans
10130 Right_Header
10131 \family default
10132
10133 \family sans
10134 Received
10135 \family default
10136
10137 \family sans
10138 Revised
10139 \family default
10140
10141 \family sans
10142 Accepted
10143 \family default
10144
10145 \family sans
10146 CCC
10147 \family default
10148
10149 \family sans
10150 PaperId
10151 \family default
10152
10153 \family sans
10154 AuthorAddr
10155 \family default
10156
10157 \family sans
10158 SlugComment
10159 \family default
10160 .
10161  These are mostly manuscript attributes and defined in the AGU class documentati
10162 on.
10163 \end_layout
10164
10165 \begin_layout Standard
10166 I suspect this is still badly incomplete.
10167 \end_layout
10168
10169 \begin_layout Subsection
10170 New floats
10171 \end_layout
10172
10173 \begin_layout Standard
10174
10175 \family sans
10176 Planotable
10177 \family default
10178  and 
10179 \family sans
10180 Plate
10181 \family default
10182 .
10183  We also have a new 
10184 \family sans
10185 Table_Caption
10186 \family default
10187 .
10188 \end_layout
10189
10190 \begin_layout Subsection
10191 Supported journals
10192 \end_layout
10193
10194 \begin_layout Itemize
10195
10196 \emph on
10197 Journal of Geophysical Research
10198 \emph default
10199
10200 \family typewriter
10201 jgrga.layout 
10202 \family default
10203 --- Martin Vermeer
10204 \end_layout
10205
10206 \begin_layout Standard
10207 Add your own, it isn't so hard! Look at the 
10208 \family typewriter
10209 jgrga.layout
10210 \family default
10211  example and 
10212 \family typewriter
10213 aguplus.inc
10214 \family default
10215 .
10216 \end_layout
10217
10218 \begin_layout Subsection
10219 Bugs and things to remember
10220 \end_layout
10221
10222 \begin_layout Standard
10223 In order to use the new layouts, you must remember to do the following for
10224  a new document:
10225 \end_layout
10226
10227 \begin_layout Enumerate
10228
10229 \emph on
10230 Turn off babel
10231 \emph default
10232 .
10233  This can be done in the 
10234 \family sans
10235 layout\SpecialChar \menuseparator
10236 document
10237 \family default
10238  or 
10239 \family sans
10240 document\SpecialChar \menuseparator
10241 settings
10242 \family default
10243  menu item.
10244  (AGU articles are always in English, right? So 
10245 \emph on
10246 don't
10247 \emph default
10248  choose a language.)
10249 \end_layout
10250
10251 \begin_layout Enumerate
10252 Enter 
10253 \family typewriter
10254 jgrga
10255 \family default
10256  into the document's 
10257 \family sans
10258 Extra Options
10259 \family default
10260  field.
10261  (Yes, this is a bug.)
10262 \end_layout
10263
10264 \begin_layout Enumerate
10265 Make sure you use the 
10266 \family typewriter
10267 agu.bst
10268 \family default
10269  bibliography style, by entering 
10270 \family sans
10271 agu
10272 \family default
10273  into the second field of the BibTeX inset.
10274  None of the standard styles will do.
10275 \end_layout
10276
10277 \begin_layout Section
10278 EGS journals (
10279 \family sans
10280 egs
10281 \family default
10282 )
10283 \end_layout
10284
10285 \begin_layout Standard
10286 by 
10287 \shape smallcaps
10288 Martin Vermeer
10289 \end_layout
10290
10291 \begin_layout Subsection
10292 Description
10293 \end_layout
10294
10295 \begin_layout Standard
10296 This is the layout file for the European Geophysical Society journals.
10297  The needed 
10298 \family typewriter
10299 egs.cls
10300 \family default
10301  can be downloaded from the web site of the EGS under 
10302 \begin_inset LatexCommand \url{www.copernicus.org}
10303
10304 \end_inset
10305
10306 .
10307 \end_layout
10308
10309 \begin_layout Subsection
10310 New styles
10311 \end_layout
10312
10313 \begin_layout Standard
10314
10315 \family sans
10316 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10317  Accepted
10318 \family default
10319
10320 \family sans
10321 Offsets
10322 \family default
10323 .
10324  The current layout file is unfortunately very unmodular and would benefit
10325  from using the various 
10326 \family typewriter
10327 std*.inc
10328 \family default
10329  file inclusions.
10330 \end_layout
10331
10332 \begin_layout Section
10333 Slides [aka 
10334 \noun on
10335 Sli
10336 \noun default
10337 TeX]
10338 \begin_inset LatexCommand \label{sec:slitex}
10339
10340 \end_inset
10341
10342
10343 \end_layout
10344
10345 \begin_layout Standard
10346 by 
10347 \noun on
10348 John Weiss
10349 \noun default
10350  
10351 \end_layout
10352
10353 \begin_layout Subsection
10354 Introduction
10355 \end_layout
10356
10357 \begin_layout Standard
10358 This section describes how to use LyX to make slides for overhead projectors.
10359  There are two document classes that can do this: the default slides class
10360  and the 
10361 \family sans
10362 Foil
10363 \family default
10364 TeX slides class.
10365  This section documents the former.
10366 \end_layout
10367
10368 \begin_layout Standard
10369 I'm going to say this again, nice and clear, so that there's no misunderstanding
10370 :
10371 \end_layout
10372
10373 \begin_layout Standard
10374 \begin_inset VSpace bigskip
10375 \end_inset
10376
10377
10378 \end_layout
10379
10380 \begin_layout Standard
10381 \align center
10382
10383 \size large
10384 This section documents the class 
10385 \begin_inset Quotes eld
10386 \end_inset
10387
10388
10389 \family sans
10390 slides (default)
10391 \family default
10392
10393 \begin_inset Quotes erd
10394 \end_inset
10395
10396  
10397 \emph on
10398 only.
10399 \end_layout
10400
10401 \begin_layout Standard
10402 \begin_inset VSpace bigskip
10403 \end_inset
10404
10405
10406 \end_layout
10407
10408 \begin_layout Standard
10409 If you're looking for the documentation for 
10410 \begin_inset Quotes eld
10411 \end_inset
10412
10413
10414 \family sans
10415 slides (FoilTeX)
10416 \family default
10417
10418 \begin_inset Quotes erd
10419 \end_inset
10420
10421 , check out section\InsetSpace ~
10422
10423 \begin_inset LatexCommand \ref{sec:foiltex}
10424
10425 \end_inset
10426
10427 .
10428  The 
10429 \family sans
10430 foils 
10431 \family default
10432 class [
10433 \begin_inset Quotes eld
10434 \end_inset
10435
10436
10437 \family sans
10438 slides (FoilTeX)
10439 \family default
10440
10441 \begin_inset Quotes erd
10442 \end_inset
10443
10444 ] is actually somewhat better than the default 
10445 \family sans
10446 slides
10447 \family default
10448  class,
10449 \begin_inset Foot
10450 status collapsed
10451
10452 \begin_layout Standard
10453 \SpecialChar \ldots{}
10454 or so I've been told repeatedly by its advocates.
10455  Having never used it, I have no idea if this claim is true or not.
10456 \end_layout
10457
10458 \end_inset
10459
10460  which this section documents.
10461 \end_layout
10462
10463 \begin_layout Standard
10464 This class is the LaTeX2e improvement of the old 
10465 \noun on
10466 Sli
10467 \noun default
10468 TeX package.
10469  Every LaTeX2e distribution includes this class [which I'll just refer to
10470  as 
10471 \begin_inset Quotes eld
10472 \end_inset
10473
10474
10475 \family sans
10476 slides
10477 \family default
10478
10479 \begin_inset Quotes erd
10480 \end_inset
10481
10482  from now on], so you're bound to have it.
10483  As I noted earlier, there are other classes, such as 
10484 \family sans
10485 foils
10486 \family default
10487 , which also produce slides for overhead projectors and do a better job
10488  at it.
10489  However, there are some things which 
10490 \family sans
10491 slides
10492 \family default
10493  can do which the others can't, such as generate overlays.
10494  Read on to learn more!
10495 \end_layout
10496
10497 \begin_layout Subsection
10498 Getting Started
10499 \begin_inset LatexCommand \label{sec:slidesetup}
10500
10501 \end_inset
10502
10503
10504 \end_layout
10505
10506 \begin_layout Standard
10507 Obviously, to use this document class, you need to select 
10508 \begin_inset Quotes eld
10509 \end_inset
10510
10511
10512 \family sans
10513 slides (default)
10514 \family default
10515
10516 \begin_inset Quotes erd
10517 \end_inset
10518
10519  from the class list in the 
10520 \family sans
10521 \bar under
10522 D
10523 \bar default
10524 ocument\SpecialChar \menuseparator
10525
10526 \bar under
10527 S
10528 \bar default
10529 ettings
10530 \family default
10531  dialog.
10532  There are some other special things you should know about this class:
10533 \end_layout
10534
10535 \begin_layout Itemize
10536 Don't bother changing the options 
10537 \family sans
10538 Sides and Columns
10539 \family default
10540 .
10541  They're not supported by the 
10542 \family sans
10543 slides
10544 \family default
10545  class, anyways.
10546 \end_layout
10547
10548 \begin_layout Itemize
10549 The option 
10550 \family sans
10551 \bar under
10552 P
10553 \bar default
10554 age\InsetSpace ~
10555 style
10556 \family default
10557  behaves a bit differently for this class.
10558  The possible choices and what they do are as follows:
10559 \end_layout
10560
10561 \begin_deeper
10562 \begin_layout Description
10563
10564 \family sans
10565 plain
10566 \family default
10567  The final output contains page numbers in the lower right corner.
10568 \end_layout
10569
10570 \begin_layout Description
10571
10572 \family sans
10573 headings
10574 \family default
10575  Like 
10576 \family sans
10577 plain
10578 \family default
10579 , but also prints out any time markers you've put in.
10580  This is the default.
10581 \end_layout
10582
10583 \begin_layout Description
10584
10585 \family sans
10586 empty
10587 \family default
10588  The final output contains no page numbers, time markers, or alignment markers.
10589 \end_layout
10590
10591 \end_deeper
10592 \begin_layout Itemize
10593 The 
10594 \family sans
10595 slides
10596 \family default
10597  class has an extra option: 
10598 \family typewriter
10599 clock
10600 \family default
10601 .
10602  To use it, put 
10603 \begin_inset Quotes eld
10604 \end_inset
10605
10606
10607 \family typewriter
10608 clock
10609 \family default
10610
10611 \begin_inset Quotes erd
10612 \end_inset
10613
10614  in the extra class options.
10615 \end_layout
10616
10617 \begin_deeper
10618 \begin_layout Standard
10619 Using this options allows you to add time markers to 
10620 \family sans
10621 Note
10622 \family default
10623 s.
10624  See section\InsetSpace ~
10625
10626 \begin_inset LatexCommand \ref{sec:slideNote}
10627
10628 \end_inset
10629
10630  for more details.
10631 \end_layout
10632
10633 \end_deeper
10634 \begin_layout Standard
10635 You can also use the template file 
10636 \begin_inset Quotes eld
10637 \end_inset
10638
10639
10640 \family typewriter
10641 slides.lyx
10642 \family default
10643
10644 \begin_inset Quotes erd
10645 \end_inset
10646
10647  to automatically set up a document to use the 
10648 \family sans
10649 slides 
10650 \family default
10651 class [using 
10652 \family sans
10653 \bar under
10654 F
10655 \bar default
10656 ile\SpecialChar \menuseparator
10657 New\InsetSpace ~
10658 from\InsetSpace ~
10659
10660 \bar under
10661 T
10662 \bar default
10663 emplate
10664 \family default
10665  to open your new document].
10666  The template file also contains some examples of the special paragraph
10667  environments used by this class.
10668  I'll describe those next.
10669 \end_layout
10670
10671 \begin_layout Subsection
10672 Paragraph Environments
10673 \end_layout
10674
10675 \begin_layout Subsubsection
10676 Supported Environments
10677 \end_layout
10678
10679 \begin_layout Standard
10680 The first thing you'll notice when you start up a new 
10681 \family sans
10682 slides 
10683 \family default
10684 document is the font size and type: it's the equivalent of the size 
10685 \begin_inset Quotes eld
10686 \end_inset
10687
10688
10689 \family sans
10690 Largest
10691 \family default
10692
10693 \begin_inset Quotes erd
10694 \end_inset
10695
10696  in the 
10697 \family sans
10698 Sans\InsetSpace ~
10699 Serif
10700 \family default
10701  font.
10702  This is also what's used in the output.
10703  Think of this as a 
10704 \begin_inset Quotes eld
10705 \end_inset
10706
10707 visual cue
10708 \begin_inset Quotes erd
10709 \end_inset
10710
10711  to remind you that this is a slide.
10712  Your final slides will use a larger font; ergo, you'll have less space.
10713  Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10714 \end_layout
10715
10716 \begin_layout Standard
10717 The next thing that becomes obvious is the changes to the paragraph environment
10718  pull-down box [at the far-left end of the toolbar].
10719  Most of the paragraph environments you're used to seeing are missing.
10720  There are also five new ones.
10721  That's because the 
10722 \family sans
10723 slides
10724 \family default
10725  class itself only supports certain paragraph environments:
10726 \end_layout
10727
10728 \begin_layout Itemize
10729
10730 \family sans
10731 Standard
10732 \end_layout
10733
10734 \begin_layout Itemize
10735
10736 \family sans
10737 Itemize
10738 \end_layout
10739
10740 \begin_layout Itemize
10741
10742 \family sans
10743 Enumerate
10744 \end_layout
10745
10746 \begin_layout Itemize
10747
10748 \family sans
10749 Description
10750 \end_layout
10751
10752 \begin_layout Itemize
10753
10754 \family sans
10755 List
10756 \end_layout
10757
10758 \begin_layout Itemize
10759
10760 \family sans
10761 Quotation
10762 \end_layout
10763
10764 \begin_layout Itemize
10765
10766 \family sans
10767 Quote
10768 \end_layout
10769
10770 \begin_layout Itemize
10771
10772 \family sans
10773 Verse
10774 \end_layout
10775
10776 \begin_layout Itemize
10777
10778 \family sans
10779 Caption
10780 \end_layout
10781
10782 \begin_layout Itemize
10783
10784 \family sans
10785 LyX-Code
10786 \end_layout
10787
10788 \begin_layout Itemize
10789
10790 \family sans
10791 Comment
10792 \end_layout
10793
10794 \begin_layout Standard
10795 All of the other standard environments, including the section-heading environmen
10796 ts, aren't used in the 
10797 \family sans
10798 slides
10799 \family default
10800  class.
10801 \end_layout
10802
10803 \begin_layout Standard
10804 On the other hand, you'll notice the following new environments:
10805 \end_layout
10806
10807 \begin_layout Itemize
10808
10809 \family sans
10810 Slide
10811 \end_layout
10812
10813 \begin_layout Itemize
10814
10815 \family sans
10816 Overlay
10817 \end_layout
10818
10819 \begin_layout Itemize
10820
10821 \family sans
10822 Note
10823 \end_layout
10824
10825 \begin_layout Itemize
10826
10827 \family sans
10828 InvisibleText
10829 \end_layout
10830
10831 \begin_layout Itemize
10832
10833 \family sans
10834 VisibleText
10835 \end_layout
10836
10837 \begin_layout Standard
10838 These five are kind of quirky, due to a 
10839 \begin_inset Quotes eld
10840 \end_inset
10841
10842 feature
10843 \begin_inset Quotes erd
10844 \end_inset
10845
10846  in LyX.
10847  You see, LyX doesn't permit you to nest any other paragraph environment
10848  into an empty environment.
10849  Now, that's fine and dandy, but it means that you wouldn't be able to start
10850  a slide with anything except plain text.
10851  To deal with this, I've performed a little 
10852 \begin_inset Quotes eld
10853 \end_inset
10854
10855 LaTeX magic.
10856 \begin_inset Quotes erd
10857 \end_inset
10858
10859  
10860 \end_layout
10861
10862 \begin_layout Subsubsection
10863 Quirks of the New Environments
10864 \begin_inset LatexCommand \label{sec:slideQuirk}
10865
10866 \end_inset
10867
10868
10869 \end_layout
10870
10871 \begin_layout Standard
10872 All five of the new paragraph environments are somewhat quirky due to inherent
10873  limitiations in the current version of LyX.
10874  As I just mentioned, LyX forbids environments that begin with another environme
10875 nt.
10876  To get around this, the 
10877 \family sans
10878 Slide
10879 \family default
10880  environment isn't a paragraph environment as described in the 
10881 \emph on
10882 User's Guide
10883 \emph default
10884 .
10885  
10886 \end_layout
10887
10888 \begin_layout Standard
10889 You should consider 
10890 \family sans
10891 Slide
10892 \family default
10893
10894 \family sans
10895 Overlay
10896 \family default
10897 , and 
10898 \family sans
10899 Note
10900 \family default
10901  to be 
10902 \begin_inset Quotes eld
10903 \end_inset
10904
10905 pseudo-environments.
10906 \begin_inset Quotes erd
10907 \end_inset
10908
10909  They look like a section heading or a 
10910 \begin_inset Quotes eld
10911 \end_inset
10912
10913
10914 \family sans
10915 Caption
10916 \family default
10917 ,
10918 \begin_inset Quotes erd
10919 \end_inset
10920
10921  but really begin a [and, if necessary, end the previous] paragraph environment.
10922  Likewise, treat 
10923 \family sans
10924 InvisibleText
10925 \family default
10926  and 
10927 \family sans
10928 VisibleText
10929 \family default
10930  as 
10931 \begin_inset Quotes eld
10932 \end_inset
10933
10934 pseudo-commands.
10935 \begin_inset Quotes erd
10936 \end_inset
10937
10938  These two perform some action.
10939 \end_layout
10940
10941 \begin_layout Standard
10942 A common feature of all five environments, 
10943 \family sans
10944 Slide
10945 \family default
10946
10947 \family sans
10948 Overlay
10949 \family default
10950
10951 \family sans
10952 Note
10953 \family default
10954
10955 \family sans
10956 InvisibleText
10957 \family default
10958  and 
10959 \family sans
10960 VisibleText
10961 \family default
10962 , is a rather long-ish label.
10963  The text following this label --- ordinarily the contents of the paragraph
10964  environment --- is utterly irrelevant for 
10965 \family sans
10966 Slide
10967 \family default
10968
10969 \family sans
10970 Overlay
10971 \family default
10972
10973 \family sans
10974 Note
10975 \family default
10976
10977 \family sans
10978 InvisibleText
10979 \family default
10980  and 
10981 \family sans
10982 VisibleText
10983 \family default
10984 .
10985  LyX completely ignores it.
10986  In fact, you can leave these five environments completely empty.
10987  
10988 \end_layout
10989
10990 \begin_layout Standard
10991 While you don't 
10992 \emph on
10993 have
10994 \emph default
10995  to put any text after the rather long-ish label, you might want to.
10996  This could be a short description of the contents of the 
10997 \family sans
10998 Slide
10999 \family default
11000 , for example.
11001  In that case, enter in your descriptive comment and hit 
11002 \family sans
11003 Return
11004 \family default
11005  as you normally would.
11006 \end_layout
11007
11008 \begin_layout Standard
11009 If, on the other hand, you don't want to enter in any descriptive text,
11010  you'll hit another LyX quirk.
11011  LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
11012  environment until you put something in the old one.
11013  So, do this:
11014 \end_layout
11015
11016 \begin_layout Itemize
11017 Start entering the text that will 
11018 \emph on
11019 follow
11020 \emph default
11021  the new 
11022 \family sans
11023 Slide
11024 \family default
11025
11026 \family sans
11027 Overlay
11028 \family default
11029
11030 \family sans
11031 Note
11032 \family default
11033
11034 \family sans
11035 InvisibleText
11036 \family default
11037  or 
11038 \family sans
11039 VisibleText
11040 \family default
11041 .
11042  
11043 \end_layout
11044
11045 \begin_layout Itemize
11046 Now move to the beginning of that paragraph.
11047  
11048 \end_layout
11049
11050 \begin_layout Itemize
11051 Next, hit 
11052 \family sans
11053 Return
11054 \family default
11055 .
11056  
11057 \end_layout
11058
11059 \begin_layout Itemize
11060 Finally, change this new, empty paragraph to a 
11061 \family sans
11062 Slide
11063 \family default
11064
11065 \family sans
11066 Overlay
11067 \family default
11068
11069 \family sans
11070 Note
11071 \family default
11072
11073 \family sans
11074 InvisibleText
11075 \family default
11076  or 
11077 \family sans
11078 VisibleText
11079 \family default
11080 .
11081  
11082 \end_layout
11083
11084 \begin_layout Standard
11085 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
11086
11087 \end_layout
11088
11089 \begin_layout Subsection
11090 Making a Presentation with 
11091 \family sans
11092 Slide
11093 \family default
11094 ,
11095 \family sans
11096  Overlay
11097 \family default
11098  and 
11099 \family sans
11100 Note
11101 \end_layout
11102
11103 \begin_layout Subsubsection
11104 Using the 
11105 \family sans
11106 Slide
11107 \family default
11108  Environment
11109 \end_layout
11110
11111 \begin_layout Standard
11112 If you're expecting this section to teach you how to actually make a presentatio
11113 n, you'll be sorely disappointed.
11114  Naturally, I'll describe all of the ways the 
11115 \family sans
11116 slides
11117 \family default
11118  class can assist you in preparing the materials for a presentation.
11119  Filling in the contents, however, is up to you.
11120  [Then again, that 
11121 \emph on
11122 is
11123 \emph default
11124  the LyX philosophy.]
11125 \end_layout
11126
11127 \begin_layout Standard
11128 Choosing the 
11129 \family sans
11130 Slide
11131 \family default
11132  environment [in the manner described in section\InsetSpace ~
11133
11134 \begin_inset LatexCommand \ref{sec:slideQuirk}
11135
11136 \end_inset
11137
11138 ] tells LyX to begin a new slide [duh].
11139  The label for this environment/
11140 \begin_inset Quotes erd
11141 \end_inset
11142
11143 pseudo-command
11144 \begin_inset Quotes erd
11145 \end_inset
11146
11147  is an 
11148 \begin_inset Quotes eld
11149 \end_inset
11150
11151 ASCII line,
11152 \begin_inset Quotes erd
11153 \end_inset
11154
11155  in cool blue, followed by the label, 
11156 \begin_inset Quotes eld
11157 \end_inset
11158
11159 NewSlide:
11160 \begin_inset Quotes erd
11161 \end_inset
11162
11163 .
11164  Any text or paragraph environments that follow this one go on the new slide.
11165  It's that simple.
11166 \end_layout
11167
11168 \begin_layout Standard
11169 Slides are probably the only time you'll need to forcibly end pages in LyX
11170  (this can be specified in the 
11171 \family sans
11172 Paragraph Layout
11173 \family default
11174  dialog).
11175  In fact, you'll want to, once you finish entering the contents of one slide.
11176  If you've entered more text than can physically fit on a slide, the extra
11177  overflows onto a new slide.
11178  I don't recommend doing this, however, since the overflow slide won't have
11179  any page number on it.
11180  Furthermore, it may interfere with any 
11181 \family sans
11182 Overlay
11183 \family default
11184  you've made to accompany the oversized 
11185 \family sans
11186 Slide
11187 \family default
11188 .
11189 \end_layout
11190
11191 \begin_layout Standard
11192 The 
11193 \family sans
11194 Overlay
11195 \family default
11196  and 
11197 \family sans
11198 Note
11199 \family default
11200  environments work the same way as the 
11201 \family sans
11202 Slide 
11203 \family default
11204 environment.
11205  They both create an 
11206 \begin_inset Quotes eld
11207 \end_inset
11208
11209 ASCII line
11210 \begin_inset Quotes erd
11211 \end_inset
11212
11213  followed by a label [
11214 \begin_inset Quotes eld
11215 \end_inset
11216
11217 NewOverlay:
11218 \begin_inset Quotes erd
11219 \end_inset
11220
11221  and 
11222 \begin_inset Quotes eld
11223 \end_inset
11224
11225 NewNote:
11226 \begin_inset Quotes erd
11227 \end_inset
11228
11229 , respectively].
11230  The color is a stunning magenta instead of blue, and the 
11231 \begin_inset Quotes eld
11232 \end_inset
11233
11234 ASCII line
11235 \begin_inset Quotes erd
11236 \end_inset
11237
11238  will look different, in style and in length.
11239  The label fonts of all three also differ from one another.
11240 \end_layout
11241
11242 \begin_layout Standard
11243 As with a 
11244 \family sans
11245 Slide
11246 \family default
11247 , if the contents of a 
11248 \family sans
11249 Note
11250 \family default
11251  or 
11252 \family sans
11253 Overlay
11254 \family default
11255  exceed the physical size of a slide or sheet of paper, the extra will overflow
11256  onto a new sheet.
11257  Again, you should avoid this.
11258  It defeats the whole purpose of 
11259 \family sans
11260 Note
11261 \family default
11262 s and 
11263 \family sans
11264 Overlay
11265 \family default
11266 s.
11267 \end_layout
11268
11269 \begin_layout Subsubsection
11270 Using 
11271 \family sans
11272 Overlay
11273 \family default
11274  with 
11275 \family sans
11276 Slide
11277 \end_layout
11278
11279 \begin_layout Standard
11280 The idea behind an 
11281 \family sans
11282 Overlay
11283 \family default
11284  is a slide that sits atop another slide.
11285  Perhaps you wish to discuss a figure on the main 
11286 \family sans
11287 Slide
11288 \family default
11289  before displaying the text associated with it.
11290  One way to accomplish this is tape a flap of dark paper over the part of
11291  the 
11292 \family sans
11293 Slide
11294 \family default
11295  you want to display later.
11296  This method fails, however, if you wish to overlap one graph with another,
11297  for example.
11298  You would then have to fumble while speaking to align the two separate,
11299  overlapping 
11300 \family sans
11301 Slide
11302 \family default
11303 s to align the two graphs.
11304  The use of an 
11305 \family sans
11306 Overlay
11307 \family default
11308  environment in both cases makes life much easier.
11309 \end_layout
11310
11311 \begin_layout Standard
11312 Each 
11313 \family sans
11314 Overlay
11315 \family default
11316  receives the page number of its 
11317 \begin_inset Quotes eld
11318 \end_inset
11319
11320 parent
11321 \begin_inset Quotes erd
11322 \end_inset
11323
11324  
11325 \family sans
11326 Slide
11327 \family default
11328 , appended by 
11329 \begin_inset Quotes eld
11330 \end_inset
11331
11332
11333 \family typewriter
11334 -a
11335 \family default
11336
11337 \begin_inset Quotes erd
11338 \end_inset
11339
11340 .
11341 \begin_inset Foot
11342 status collapsed
11343
11344 \begin_layout Standard
11345 Presumably, mutliple 
11346 \family sans
11347 Overlay
11348 \family default
11349 s would have 
11350 \begin_inset Quotes eld
11351 \end_inset
11352
11353
11354 \family typewriter
11355 -a
11356 \family default
11357
11358 \begin_inset Quotes erd
11359 \end_inset
11360
11361
11362 \begin_inset Quotes eld
11363 \end_inset
11364
11365
11366 \family typewriter
11367 -b
11368 \family default
11369
11370 \begin_inset Quotes erd
11371 \end_inset
11372
11373
11374 \begin_inset Quotes eld
11375 \end_inset
11376
11377
11378 \family typewriter
11379 -c
11380 \family default
11381
11382 \begin_inset Quotes erd
11383 \end_inset
11384
11385 , etc.\InsetSpace ~
11386 appended to the page number of the parent 
11387 \family sans
11388 Slide
11389 \family default
11390 .
11391  
11392 \end_layout
11393
11394 \end_inset
11395
11396  Clearly, you want the contents of both the 
11397 \family sans
11398 Slide
11399 \family default
11400  and the 
11401 \family sans
11402 Overlay
11403 \family default
11404  to each fit on a single physical slide! You should probably consider an
11405  
11406 \family sans
11407 Overlay
11408 \family default
11409  as 
11410 \begin_inset Quotes eld
11411 \end_inset
11412
11413 part of
11414 \begin_inset Quotes erd
11415 \end_inset
11416
11417  a 
11418 \family sans
11419 Slide
11420 \family default
11421 .
11422  Indeed, the LyX 
11423 \family sans
11424 slides
11425 \family default
11426  class provides a visual cue for this: the label at the start of an 
11427 \family sans
11428 Overlay
11429 \family default
11430  is shorter than that at the start of a 
11431 \family sans
11432 Slide
11433 \family default
11434 .
11435  Lastly, when you generate printable output, you'll find alignment markers
11436  in all four corners of both the 
11437 \family sans
11438 Overlay
11439 \family default
11440  page and its parent 
11441 \family sans
11442 Slide
11443 \family default
11444 .
11445  These will assist you in lining up the two physical slides.
11446 \end_layout
11447
11448 \begin_layout Standard
11449 The major problem in overlaying two slides is aligning the contents of the
11450  two transparencies.
11451  How much space should you leave for that graph on the second slide? Worse
11452  still, what if you want a graph and a sentence on second slide, but there
11453  is text on the main transparency that goes in between them? You could try
11454  and insert vertical space of the right size.
11455  The better way is to use 
11456 \family sans
11457 InvisibleText
11458 \family default
11459  and 
11460 \family sans
11461 VisibleText
11462 \family default
11463 .
11464 \end_layout
11465
11466 \begin_layout Standard
11467 As their names imply, 
11468 \family sans
11469 InvisibleText
11470 \family default
11471  and 
11472 \family sans
11473 VisibleText
11474 \family default
11475  are two command-like paragraph environments that make all subsequent text
11476  invisible and visible, respectively.
11477  Note from section\InsetSpace ~
11478
11479 \begin_inset LatexCommand \ref{sec:slideQuirk}
11480
11481 \end_inset
11482
11483  that you don't place anything 
11484 \emph on
11485 into
11486 \emph default
11487  these two environments, however.
11488  When you create an 
11489 \family sans
11490 InvisibleText
11491 \family default
11492 , it inserts a centered, sky-blue label into the page reading 
11493 \begin_inset Quotes eld
11494 \end_inset
11495
11496 <Invisible Text Follows>
11497 \begin_inset Quotes erd
11498 \end_inset
11499
11500 .
11501  For paragraphs following this label, the parts of the 
11502 \family sans
11503 Slide
11504 \family default
11505  [or 
11506 \family sans
11507 Overlay
11508 \family default
11509 ; it doesn't matter which] where they would be contain instead blank space.
11510  
11511 \end_layout
11512
11513 \begin_layout Standard
11514 For 
11515 \family sans
11516 VisibleText
11517 \family default
11518 , the corresponding centered label is 
11519 \begin_inset Quotes eld
11520 \end_inset
11521
11522 <Visible Text Follows>
11523 \begin_inset Quotes erd
11524 \end_inset
11525
11526  in blazing green.
11527  Paragraphs following this label behave normally.
11528  Note that the beginning of a new 
11529 \family sans
11530 Slide
11531 \family default
11532
11533 \family sans
11534 Overlay
11535 \family default
11536 , or 
11537 \family sans
11538 Note
11539 \family default
11540  automatically shuts off an 
11541 \family sans
11542 InvisibleText
11543 \family default
11544 .
11545  It's therefore not necessary to use 
11546 \family sans
11547 VisibleText
11548 \family default
11549  at the end of a 
11550 \family sans
11551 Slide
11552 \family default
11553 .
11554 \end_layout
11555
11556 \begin_layout Standard
11557 By now, it should be obvious how to create overlay transparencies using
11558  the proper combination of 
11559 \family sans
11560 InvisibleText
11561 \family default
11562  and 
11563 \family sans
11564 VisibleText
11565 \family default
11566  on a 
11567 \family sans
11568 Slide
11569 \family default
11570  and 
11571 \family sans
11572 Overlay
11573 \family default
11574 :
11575 \end_layout
11576
11577 \begin_layout Enumerate
11578 Create a 
11579 \family sans
11580 Slide
11581 \family default
11582 , including everything that will appear on it, whether on the main slide
11583  or on the 
11584 \family sans
11585 Overlay
11586 \family default
11587 .
11588 \end_layout
11589
11590 \begin_layout Enumerate
11591 Before each figure or paragraph that will appear only on the 
11592 \family sans
11593 Overlay
11594 \family default
11595 , insert an 
11596 \family sans
11597 InvisibleText
11598 \family default
11599  environment.
11600  If necessary, insert a 
11601 \family sans
11602 VisibleText
11603 \family default
11604  environment after the 
11605 \family sans
11606 Overlay
11607 \family default
11608 -only text.
11609 \end_layout
11610
11611 \begin_layout Enumerate
11612 Start an 
11613 \family sans
11614 Overlay
11615 \family default
11616  immediately following the 
11617 \family sans
11618 Slide
11619 \family default
11620 .
11621 \end_layout
11622
11623 \begin_layout Enumerate
11624 Copy the contents of this 
11625 \family sans
11626 Slide
11627 \family default
11628  into the 
11629 \family sans
11630 Overlay
11631 \family default
11632 .
11633 \end_layout
11634
11635 \begin_layout Enumerate
11636 Within the 
11637 \family sans
11638 Overlay
11639 \family default
11640 , change all of the 
11641 \family sans
11642 InvisibleText
11643 \family default
11644  lines to 
11645 \family sans
11646 VisibleText
11647 \family default
11648  and vice-versa.
11649 \end_layout
11650
11651 \begin_layout Standard
11652 That's it.
11653  You've just made an 
11654 \family sans
11655 Overlay
11656 \family default
11657 .
11658 \end_layout
11659
11660 \begin_layout Standard
11661 There's one problem with the way I've designed the LyX 
11662 \family sans
11663 slides
11664 \family default
11665  class: you can't make text in the middle of a paragraph invisible, nor
11666  make text in the middle of an invisible paragraph visible again.
11667  To accomplish this feat, you'll need to use some inlined LaTeX codes.
11668 \begin_inset Foot
11669 status collapsed
11670
11671 \begin_layout Standard
11672 The commands of interest are: 
11673 \end_layout
11674
11675 \begin_layout Itemize
11676
11677 \family typewriter
11678 {
11679 \backslash
11680 invisible \SpecialChar \ldots{}
11681  }
11682 \end_layout
11683
11684 \begin_layout Itemize
11685
11686 \family typewriter
11687 {
11688 \backslash
11689 visible \SpecialChar \ldots{}
11690  }
11691 \end_layout
11692
11693 \begin_layout Standard
11694 \SpecialChar \ldots{}
11695 and need to be marked as TeX.
11696  The text whose 
11697 \begin_inset Quotes eld
11698 \end_inset
11699
11700 visibility
11701 \begin_inset Quotes erd
11702 \end_inset
11703
11704  you wish to change goes in between the brackets [and after the 
11705 \family typewriter
11706
11707 \backslash
11708 invisible
11709 \family default
11710  or 
11711 \family typewriter
11712
11713 \backslash
11714 visible
11715 \family default
11716  command].
11717  If you don't know how to mark text as TeX, see the apprpriate section of
11718  the 
11719 \emph on
11720 User's Guide
11721 \emph default
11722 .
11723 \end_layout
11724
11725 \end_inset
11726
11727
11728 \end_layout
11729
11730 \begin_layout Subsubsection
11731 Using 
11732 \family sans
11733 Note
11734 \family default
11735  with 
11736 \family sans
11737 Slide
11738 \family default
11739
11740 \begin_inset LatexCommand \label{sec:slideNote}
11741
11742 \end_inset
11743
11744
11745 \end_layout
11746
11747 \begin_layout Standard
11748 Like an 
11749 \family sans
11750 Overlay
11751 \family default
11752 , a 
11753 \family sans
11754 Note
11755 \family default
11756  is associated with a 
11757 \begin_inset Quotes eld
11758 \end_inset
11759
11760 parent
11761 \begin_inset Quotes erd
11762 \end_inset
11763
11764  
11765 \family sans
11766 Slide
11767 \family default
11768 .
11769  Here, too, the LyX 
11770 \family sans
11771 slides
11772 \family default
11773  class provides visual cues.
11774  The label for a 
11775 \family sans
11776 Note
11777 \family default
11778  is shorter than that of a 
11779 \family sans
11780 Slide
11781 \family default
11782  [yet longer than that of an 
11783 \family sans
11784 Overlay
11785 \family default
11786 ] and, like the label of an 
11787 \family sans
11788 Overlay
11789 \family default
11790  is shockingly magenta.
11791  Additionally, the printed 
11792 \family sans
11793 Note
11794 \family default
11795  has the page number of its 
11796 \begin_inset Quotes eld
11797 \end_inset
11798
11799 parent
11800 \begin_inset Quotes erd
11801 \end_inset
11802
11803  
11804 \family sans
11805 Slide
11806 \family default
11807 , appended by 
11808 \begin_inset Quotes eld
11809 \end_inset
11810
11811
11812 \family typewriter
11813 -
11814 \family default
11815 1
11816 \begin_inset Quotes erd
11817 \end_inset
11818
11819
11820 \begin_inset Quotes eld
11821 \end_inset
11822
11823
11824 \family typewriter
11825 -
11826 \family default
11827 2
11828 \begin_inset Quotes erd
11829 \end_inset
11830
11831
11832 \begin_inset Quotes eld
11833 \end_inset
11834
11835
11836 \family typewriter
11837 -
11838 \family default
11839 3
11840 \begin_inset Quotes erd
11841 \end_inset
11842
11843 , etc.
11844  You can have multiple 
11845 \family sans
11846 Note
11847 \family default
11848 s associated with a single 
11849 \family sans
11850 Slide
11851 \family default
11852 , and, as with 
11853 \family sans
11854 Slide
11855 \family default
11856  and 
11857 \family sans
11858 Overlay
11859 \family default
11860 , you'll probably want to break up long 
11861 \family sans
11862 Note
11863 \family default
11864 s so that they fit on a single sheet of paper.
11865 \end_layout
11866
11867 \begin_layout Standard
11868 The purpose of a 
11869 \family sans
11870 Note
11871 \family default
11872  is obvious: it contains anything additional you might want to say about
11873  a 
11874 \family sans
11875 Slide
11876 \family default
11877 .
11878  It could also be used as a sheet of reminders for a particular 
11879 \family sans
11880 Slide
11881 \family default
11882 .
11883  In the case of the latter, you might want to make use of time markers.
11884  Currently, the LyX 
11885 \family sans
11886 slides
11887 \family default
11888  class has no 
11889 \begin_inset Quotes eld
11890 \end_inset
11891
11892 native
11893 \begin_inset Quotes erd
11894 \end_inset
11895
11896  support for time markers, a 
11897 \noun on
11898 Sli
11899 \noun default
11900 TeX feature.
11901  So, you'll have to resort to using the LaTeX codes.
11902 \end_layout
11903
11904 \begin_layout Standard
11905 To use time markers, you'll need to specify the extra class option 
11906 \begin_inset Quotes eld
11907 \end_inset
11908
11909
11910 \family typewriter
11911 clock
11912 \family default
11913
11914 \begin_inset Quotes erd
11915 \end_inset
11916
11917  [see section\InsetSpace ~
11918
11919 \begin_inset LatexCommand \ref{sec:slidesetup}
11920
11921 \end_inset
11922
11923 ].
11924  This option turns on timing marks, which will appear in the lower-left-hand
11925  corner of every 
11926 \family sans
11927 Note
11928 \family default
11929  you generate.
11930  To set what appears in the time marker, you use the LaTeX commands 
11931 \begin_inset Quotes eld
11932 \end_inset
11933
11934
11935 \family typewriter
11936
11937 \backslash
11938 settime{}
11939 \family default
11940
11941 \begin_inset Quotes erd
11942 \end_inset
11943
11944  and 
11945 \begin_inset Quotes eld
11946 \end_inset
11947
11948
11949 \family typewriter
11950
11951 \backslash
11952 addtime{}
11953 \family default
11954
11955 \begin_inset Quotes erd
11956 \end_inset
11957
11958 .
11959  The arguments of both commands are time measured in seconds.
11960  
11961 \begin_inset Quotes eld
11962 \end_inset
11963
11964
11965 \family typewriter
11966
11967 \backslash
11968 settime{}
11969 \family default
11970
11971 \begin_inset Quotes erd
11972 \end_inset
11973
11974  sets the time marker to a given time.
11975  
11976 \begin_inset Quotes eld
11977 \end_inset
11978
11979
11980 \family typewriter
11981
11982 \backslash
11983 addtime{}
11984 \family default
11985
11986 \begin_inset Quotes erd
11987 \end_inset
11988
11989  increments the time marker by the specified amount.
11990  Using time markers and 
11991 \family sans
11992 Note
11993 \family default
11994 s in this fashion, you can remind yourself how much time to spend on a particula
11995
11996 \family sans
11997 Slide
11998 \family default
11999 .
12000 \end_layout
12001
12002 \begin_layout Standard
12003 There's one last feature to describe.
12004  Clearly, you'd like to print out all of your 
12005 \family sans
12006 Slide
12007 \family default
12008 s and 
12009 \family sans
12010 Overlay
12011 \family default
12012 s on transparencies while printing all of your 
12013 \family sans
12014 Note
12015 \family default
12016 s on plain paper.
12017  However, a 
12018 \family sans
12019 Note
12020 \family default
12021  
12022 \emph on
12023 must
12024 \emph default
12025  follow the 
12026 \family sans
12027 Slide
12028 \family default
12029  with which it is associated.
12030  What's a person to do?
12031 \end_layout
12032
12033 \begin_layout Standard
12034 Luckily, there are two LaTeX commands that allow you to select what to print
12035  out.
12036  Both must be placed into the preamble of your document.
12037  The command 
12038 \begin_inset Quotes eld
12039 \end_inset
12040
12041
12042 \family typewriter
12043
12044 \backslash
12045 onlyslides{
12046 \backslash
12047 slides}
12048 \family default
12049
12050 \begin_inset Quotes erd
12051 \end_inset
12052
12053  will cause the output to contain only the 
12054 \family sans
12055 Slide
12056 \family default
12057 s and 
12058 \family sans
12059 Overlay
12060 \family default
12061 s.
12062  Correspondingly, the command 
12063 \begin_inset Quotes eld
12064 \end_inset
12065
12066
12067 \family typewriter
12068
12069 \backslash
12070 onlynotes{
12071 \backslash
12072 notes}
12073 \family default
12074
12075 \begin_inset Quotes erd
12076 \end_inset
12077
12078  prevents the output of anything but 
12079 \family sans
12080 Note
12081 \family default
12082 s.
12083  I'd advise placing both commands in the preamble and initially comment
12084  both out.
12085  You can then preview your entire presentation as you write.
12086  When you're done writing, you can then uncomment one of the two to select
12087  what you want to print.
12088  I like to uncomment 
12089 \begin_inset Quotes eld
12090 \end_inset
12091
12092
12093 \family typewriter
12094
12095 \backslash
12096 onlyslides{
12097 \backslash
12098 slides}
12099 \family default
12100
12101 \begin_inset Quotes erd
12102 \end_inset
12103
12104  , print to a file with 
12105 \begin_inset Quotes eld
12106 \end_inset
12107
12108
12109 \family typewriter
12110 -slides
12111 \family default
12112
12113 \begin_inset Quotes erd
12114 \end_inset
12115
12116  in its name, comment it back out, then uncomment 
12117 \begin_inset Quotes eld
12118 \end_inset
12119
12120
12121 \family typewriter
12122
12123 \backslash
12124 onlynotes{
12125 \backslash
12126 notes}
12127 \family default
12128
12129 \begin_inset Quotes erd
12130 \end_inset
12131
12132  and print to a 
12133 \begin_inset Quotes eld
12134 \end_inset
12135
12136
12137 \family typewriter
12138 *-notes.ps
12139 \family default
12140
12141 \begin_inset Quotes erd
12142 \end_inset
12143
12144  file.
12145  I can then send either file to a printer, loading transparencies or plain
12146  paper as appropriate.
12147 \end_layout
12148
12149 \begin_layout Standard
12150 You can also provide other arguments to the 
12151 \begin_inset Quotes eld
12152 \end_inset
12153
12154
12155 \family typewriter
12156
12157 \backslash
12158 onlyslides{}
12159 \family default
12160
12161 \begin_inset Quotes erd
12162 \end_inset
12163
12164  and 
12165 \begin_inset Quotes eld
12166 \end_inset
12167
12168
12169 \family typewriter
12170
12171 \backslash
12172 onlynotes{}
12173 \family default
12174
12175 \begin_inset Quotes erd
12176 \end_inset
12177
12178  commands.
12179  See a good LaTeX book for details.
12180 \end_layout
12181
12182 \begin_layout Subsection
12183 The 
12184 \family sans
12185 slides
12186 \family default
12187  Class Template File
12188 \end_layout
12189
12190 \begin_layout Standard
12191 I have also provided a template file, 
12192 \begin_inset Quotes eld
12193 \end_inset
12194
12195
12196 \family typewriter
12197 slides.lyx
12198 \family default
12199
12200 \begin_inset Quotes erd
12201 \end_inset
12202
12203 , with the 
12204 \family sans
12205 slides
12206 \family default
12207  class.
12208  To use it, begin your new presentation with 
12209 \family sans
12210 \bar under
12211 F
12212 \bar default
12213 ile\SpecialChar \menuseparator
12214 New\InsetSpace ~
12215 from\InsetSpace ~
12216
12217 \bar under
12218 T
12219 \bar default
12220 emplate
12221 \family default
12222 .
12223  Your new LyX presentation file will contain an example 
12224 \family sans
12225 Slide
12226 \family default
12227  -- 
12228 \family sans
12229 Overlay
12230 \family default
12231  --
12232 \family sans
12233  Note
12234 \family default
12235  triplet.
12236  The 
12237 \family sans
12238 Slide
12239 \family default
12240  and 
12241 \family sans
12242 Overlay
12243 \family default
12244  additionally contain an example of the use of 
12245 \family sans
12246 InvisibleText
12247 \family default
12248  and 
12249 \family sans
12250 VisibleText
12251 \family default
12252 .
12253  Lastly, the preamble will contain:
12254 \end_layout
12255
12256 \begin_layout LyX-Code
12257 % Uncomment to print out only slides and overlays
12258 \end_layout
12259
12260 \begin_layout LyX-Code
12261 %
12262 \end_layout
12263
12264 \begin_layout LyX-Code
12265 %
12266 \backslash
12267 onlyslides{
12268 \backslash
12269 slides}
12270 \newline
12271  
12272 \end_layout
12273
12274 \begin_layout LyX-Code
12275 % Uncomment to print out only notes
12276 \end_layout
12277
12278 \begin_layout LyX-Code
12279 %
12280 \end_layout
12281
12282 \begin_layout LyX-Code
12283 %
12284 \backslash
12285 onlynotes{
12286 \backslash
12287 notes}
12288 \end_layout
12289
12290 \begin_layout Standard
12291 One final thing: I created this class to support the LaTeX2e 
12292 \begin_inset Quotes eld
12293 \end_inset
12294
12295
12296 \noun on
12297 Sli
12298 \noun default
12299 TeX emulation
12300 \begin_inset Quotes erd
12301 \end_inset
12302
12303  class, one of the built-in LaTeX2e classes.
12304  Neither I nor the rest of the LyX Team endorse or oppose the use of this
12305  built-in slide class.
12306  It's here if you want it or need it.
12307  There exist other LaTeX2e classes for creating presentations, such as the
12308  
12309 \family sans
12310 Foils
12311 \family default
12312  class [see section\InsetSpace ~
12313
12314 \begin_inset LatexCommand \ref{sec:foiltex}
12315
12316 \end_inset
12317
12318 ] or the 
12319 \begin_inset Quotes eld
12320 \end_inset
12321
12322
12323 \family typewriter
12324 seminar
12325 \family default
12326
12327 \begin_inset Quotes erd
12328 \end_inset
12329
12330  package [present on some TeX distributions].
12331  The latter is not yet supported under LyX.
12332 \begin_inset Foot
12333 status collapsed
12334
12335 \begin_layout Standard
12336 Perhaps you can take on the task\SpecialChar \ldots{}
12337
12338 \end_layout
12339
12340 \end_inset
12341
12342  I know nothing about these other classes.
12343  Try them out to see what sort of alternative they provide.
12344 \end_layout
12345
12346 \begin_layout Section
12347 Foils [aka 
12348 \family sans
12349 Foil
12350 \family default
12351 \noun on
12352 TeX
12353 \noun default
12354 ]
12355 \begin_inset LatexCommand \label{sec:foiltex}
12356
12357 \end_inset
12358
12359
12360 \end_layout
12361
12362 \begin_layout Standard
12363 by 
12364 \noun on
12365 Allan Rae
12366 \end_layout
12367
12368 \begin_layout Subsection
12369 Introduction
12370 \end_layout
12371
12372 \begin_layout Standard
12373 This section describes how to use LyX to make slides for overhead projectors.
12374  There are two document classes that can do this: the default slides class
12375  and the 
12376 \family sans
12377 Foil
12378 \family default
12379 TeX slides class.
12380  This section documents the latter.
12381 \end_layout
12382
12383 \begin_layout Standard
12384 I'm going to say this again, nice and clear, so that there's no misunderstanding
12385 :
12386 \end_layout
12387
12388 \begin_layout Standard
12389 \begin_inset VSpace bigskip
12390 \end_inset
12391
12392
12393 \end_layout
12394
12395 \begin_layout Standard
12396 \align center
12397
12398 \size large
12399 This section documents the class 
12400 \begin_inset Quotes eld
12401 \end_inset
12402
12403
12404 \family sans
12405 slides (FoilTeX)
12406 \family default
12407
12408 \begin_inset Quotes erd
12409 \end_inset
12410
12411  
12412 \emph on
12413 only.
12414 \end_layout
12415
12416 \begin_layout Standard
12417 \begin_inset VSpace bigskip
12418 \end_inset
12419
12420
12421 \end_layout
12422
12423 \begin_layout Standard
12424 If you're looking for the documentation for 
12425 \begin_inset Quotes eld
12426 \end_inset
12427
12428
12429 \family sans
12430 slides (default)
12431 \family default
12432
12433 \begin_inset Quotes erd
12434 \end_inset
12435
12436 , check out section\InsetSpace ~
12437
12438 \begin_inset LatexCommand \ref{sec:slitex}
12439
12440 \end_inset
12441
12442 .
12443  If your machine doesn't have the 
12444 \family sans
12445 foils 
12446 \family default
12447 class [
12448 \begin_inset Quotes eld
12449 \end_inset
12450
12451
12452 \family sans
12453 slides (FoilTeX)
12454 \family default
12455
12456 \begin_inset Quotes erd
12457 \end_inset
12458
12459 ] installed, you'll probably have to use the default 
12460 \family sans
12461 slides
12462 \family default
12463  class, which isn't quite as good as 
12464 \family sans
12465 foils.
12466 \end_layout
12467
12468 \begin_layout Standard
12469 The 
12470 \family sans
12471 foils
12472 \family default
12473  class is designed for use with version 2.1 of the 
12474 \family sans
12475 foils.cls
12476 \family default
12477  LaTeX class file which is now an integral part of LaTeX2e.
12478 \end_layout
12479
12480 \begin_layout Subsection
12481 Getting Started
12482 \end_layout
12483
12484 \begin_layout Standard
12485 Obviously, to use this document class, you need to select 
12486 \begin_inset Quotes eld
12487 \end_inset
12488
12489
12490 \family sans
12491 slides (FoilTeX)
12492 \family default
12493
12494 \begin_inset Quotes erd
12495 \end_inset
12496
12497  from the 
12498 \family sans
12499 \bar under
12500 C
12501 \bar default
12502 lass
12503 \family default
12504  entry in the 
12505 \family sans
12506 Document\InsetSpace ~
12507 Layout
12508 \family default
12509  dialog.
12510  There are some settings in the 
12511 \family sans
12512 Document\InsetSpace ~
12513 Layout
12514 \family default
12515  dialog that you should know about that are specific to this class:
12516 \end_layout
12517
12518 \begin_layout Itemize
12519 Don't change the options 
12520 \family sans
12521 Sides
12522 \family default
12523  and 
12524 \family sans
12525 Columns
12526 \family default
12527  on the 
12528 \family sans
12529 Document\InsetSpace ~
12530 Layout
12531 \family default
12532  dialog.
12533  They're ignored by the 
12534 \family sans
12535 foils
12536 \family default
12537  class.
12538 \end_layout
12539
12540 \begin_layout Itemize
12541 The default font size is 20pt with the other options being 17pt, 25pt and
12542  30pt.
12543 \end_layout
12544
12545 \begin_layout Itemize
12546 The default font is 
12547 \family sans
12548 sans
12549 \family default
12550  
12551 \family sans
12552 serif
12553 \family default
12554  but all math equations are still typeset in the usual roman font.
12555 \end_layout
12556
12557 \begin_layout Itemize
12558
12559 \family sans
12560 Foil
12561 \family default
12562 TeX supports A4 and Letter paper sizes as well as a special size for working
12563  with 35mm slides.
12564  It doesn't support A5, B5, legal or executive paper sizes.
12565 \end_layout
12566
12567 \begin_layout Itemize
12568 Don't bother changing the 
12569 \family sans
12570 Float Placement
12571 \family default
12572  settings because they are ignored anyway.
12573  All floats appear where they are defined in the text.
12574 \end_layout
12575
12576 \begin_layout Itemize
12577 The 
12578 \family sans
12579 \bar under
12580 P
12581 \bar default
12582 agestyle
12583 \family default
12584  setting behaves a bit differently for this class.
12585  
12586 \family sans
12587 Foil
12588 \family default
12589 TeX provides extensive footer and header capabilities including a user-defined
12590  logo.
12591  See section\InsetSpace ~
12592
12593 \begin_inset LatexCommand \ref{sec:foilfoot}
12594
12595 \end_inset
12596
12597  for more details.
12598  The title page is treated differently to all other pages in the document
12599  and is 
12600 \emph on
12601 always
12602 \emph default
12603  unnumbered and 
12604 \emph on
12605 always
12606 \emph default
12607  has the logo centered at the bottom of the page (if one is defined).
12608  The possible page style choices and what they do are as follows:
12609 \end_layout
12610
12611 \begin_deeper
12612 \begin_layout List
12613 \labelwidthstring MMMMMMM
12614
12615 \family sans
12616 \series bold
12617 empty
12618 \family default
12619 \series default
12620  The final output contains no page numbers, or other headers or footers
12621  (except footnotes of course).
12622  
12623 \end_layout
12624
12625 \begin_layout List
12626 \labelwidthstring MMMMMMM
12627
12628 \family sans
12629 \series bold
12630 plain
12631 \family default
12632 \series default
12633  The final output contains page numbers centered at the bottom of the page.
12634  No other headings or footers (other than footnotes).
12635 \end_layout
12636
12637 \begin_layout List
12638 \labelwidthstring MMMMMMM
12639
12640 \series bold
12641 foilheadings
12642 \series default
12643  Page numbers in lower right corner.
12644  Additional headers and footers are also shown.
12645  This is also the default.
12646 \end_layout
12647
12648 \begin_layout List
12649 \labelwidthstring MMMMMMM
12650
12651 \series bold
12652 fancy
12653 \series default
12654  Gives you access to the 
12655 \family sans
12656 fancyheadings
12657 \family default
12658  package although its use with 
12659 \family sans
12660 Foil
12661 \family default
12662 TeX is discouraged by the writer of the 
12663 \family sans
12664 Foil
12665 \family default
12666 TeX package because of some potential page layout clashes.
12667 \end_layout
12668
12669 \end_deeper
12670 \begin_layout Subsubsection
12671 Extra Options
12672 \end_layout
12673
12674 \begin_layout Standard
12675 The following options may be used in the extra class options in the 
12676 \family sans
12677 \bar under
12678 D
12679 \bar default
12680 ocument\SpecialChar \menuseparator
12681
12682 \bar under
12683 S
12684 \bar default
12685 ettings
12686 \family default
12687  dialog.
12688 \end_layout
12689
12690 \begin_layout List
12691 \labelwidthstring MMMMMMx
12692
12693 \series bold
12694 35mmSlide
12695 \series default
12696  This sets up the page layout for 7.33in by 11in paper, which is about the
12697  same aspect ratio as a 35mm slide, making it a bit easier to work with
12698  this medium.
12699 \end_layout
12700
12701 \begin_layout List
12702 \labelwidthstring MMMMMMx
12703
12704 \series bold
12705 headrule
12706 \series default
12707  Places a rule across the page below the header on every page except the
12708  title page.
12709 \end_layout
12710
12711 \begin_layout List
12712 \labelwidthstring MMMMMMx
12713
12714 \series bold
12715 footrule
12716 \series default
12717  Places a rule across the page above the footer on every page except the
12718  title page.
12719 \end_layout
12720
12721 \begin_layout List
12722 \labelwidthstring MMMMMMx
12723
12724 \series bold
12725 dvips
12726 \series default
12727  This is automatically set each time you create a new 
12728 \family sans
12729 foils
12730 \family default
12731  document.
12732  This option tells 
12733 \family sans
12734 Foil
12735 \family default
12736 TeX to use the dvips driver to rotate those pages that are set as landscape
12737  foils.
12738 \end_layout
12739
12740 \begin_layout List
12741 \labelwidthstring MMMMMMx
12742
12743 \series bold
12744 landscape
12745 \series default
12746  Simply changes the page dimensions to those of a landscape page but doesn't
12747  do any rotation.
12748  Thus if you use this option you need to use an external program to rotate
12749  each page or feed your paper through your printer as landscape.
12750  Note that this option effectively reverses the roles of the 
12751 \family sans
12752 Foilhead
12753 \family default
12754  and 
12755 \family sans
12756 Rotatefoilhead
12757 \family default
12758  environments (don't worry these are described in the next section).
12759 \end_layout
12760
12761 \begin_layout List
12762 \labelwidthstring MMMMMMx
12763
12764 \series bold
12765 leqno
12766 \series default
12767  Equation numbers on the left.
12768 \end_layout
12769
12770 \begin_layout List
12771 \labelwidthstring MMMMMMx
12772
12773 \series bold
12774 fleqn
12775 \series default
12776  Flush-left equations.
12777 \end_layout
12778
12779 \begin_layout Subsection
12780 Supported Environments
12781 \end_layout
12782
12783 \begin_layout Standard
12784 Most of the environments commonly supported in other classes are also supported
12785  by the 
12786 \family sans
12787 foils
12788 \family default
12789  class.
12790  There are several additional environments provided by 
12791 \family sans
12792 Foil
12793 \family default
12794 TeX as well as a couple added by LyX.
12795  The following environments are shared with other classes:
12796 \end_layout
12797
12798 \begin_layout Standard
12799 \begin_inset ERT
12800 status inlined
12801
12802 \begin_layout Standard
12803
12804
12805 \backslash
12806 begin{multicols}{2}
12807 \end_layout
12808
12809 \end_inset
12810
12811
12812 \end_layout
12813
12814 \begin_layout Itemize
12815
12816 \family sans
12817 Standard
12818 \end_layout
12819
12820 \begin_layout Itemize
12821
12822 \family sans
12823 Itemize
12824 \end_layout
12825
12826 \begin_layout Itemize
12827
12828 \family sans
12829 Enumerate
12830 \end_layout
12831
12832 \begin_layout Itemize
12833
12834 \family sans
12835 Description
12836 \end_layout
12837
12838 \begin_layout Itemize
12839
12840 \family sans
12841 List
12842 \end_layout
12843
12844 \begin_layout Itemize
12845
12846 \family sans
12847 LyX-Code
12848 \end_layout
12849
12850 \begin_layout Itemize
12851
12852 \family sans
12853 Verse
12854 \end_layout
12855
12856 \begin_layout Itemize
12857
12858 \family sans
12859 Quote
12860 \end_layout
12861
12862 \begin_layout Itemize
12863
12864 \family sans
12865 Quotation
12866 \end_layout
12867
12868 \begin_layout Itemize
12869
12870 \family sans
12871 Title
12872 \end_layout
12873
12874 \begin_layout Itemize
12875
12876 \family sans
12877 Author
12878 \end_layout
12879
12880 \begin_layout Itemize
12881
12882 \family sans
12883 Date
12884 \end_layout
12885
12886 \begin_layout Itemize
12887
12888 \family sans
12889 Abstract
12890 \end_layout
12891
12892 \begin_layout Itemize
12893
12894 \family sans
12895 Bibliography
12896 \end_layout
12897
12898 \begin_layout Itemize
12899
12900 \family sans
12901 Address
12902 \end_layout
12903
12904 \begin_layout Itemize
12905
12906 \family sans
12907 RightAddress
12908 \end_layout
12909
12910 \begin_layout Itemize
12911
12912 \family sans
12913 Caption
12914 \end_layout
12915
12916 \begin_layout Itemize
12917
12918 \family sans
12919 Comment
12920 \end_layout
12921
12922 \begin_layout Standard
12923 \begin_inset ERT
12924 status inlined
12925
12926 \begin_layout Standard
12927
12928
12929 \backslash
12930 end{multicols}
12931 \end_layout
12932
12933 \end_inset
12934
12935
12936 \end_layout
12937
12938 \begin_layout Standard
12939 That is, all the major environments apart from the sectioning environments.
12940  Since foils are essentially self-contained sections, with a title and body,
12941  
12942 \family sans
12943 Foil
12944 \family default
12945 TeX provides specific commands for starting new foils and these are:
12946 \end_layout
12947
12948 \begin_layout Itemize
12949
12950 \family sans
12951 Foilhead
12952 \end_layout
12953
12954 \begin_layout Itemize
12955
12956 \family sans
12957 Rotatefoilhead
12958 \end_layout
12959
12960 \begin_layout Standard
12961 LyX also provides slightly modified versions of these two environments called:
12962 \end_layout
12963
12964 \begin_layout Itemize
12965
12966 \family sans
12967 ShortFoilhead
12968 \end_layout
12969
12970 \begin_layout Itemize
12971
12972 \family sans
12973 ShortRotatefoilhead
12974 \end_layout
12975
12976 \begin_layout Standard
12977 and the differences will be explained in the next section.
12978 \end_layout
12979
12980 \begin_layout Standard
12981 Since foils are often used in presenting ideas or new theorems and such
12982  
12983 \family sans
12984 Foil
12985 \family default
12986 TeX also provides a comprehensive box of goodies for presenting them:
12987 \end_layout
12988
12989 \begin_layout Standard
12990 \begin_inset ERT
12991 status inlined
12992
12993 \begin_layout Standard
12994
12995
12996 \backslash
12997 begin{multicols}{2}
12998 \end_layout
12999
13000 \end_inset
13001
13002
13003 \end_layout
13004
13005 \begin_layout Itemize
13006
13007 \family sans
13008 Theorem
13009 \end_layout
13010
13011 \begin_layout Itemize
13012
13013 \family sans
13014 Lemma
13015 \end_layout
13016
13017 \begin_layout Itemize
13018
13019 \family sans
13020 Corollary
13021 \end_layout
13022
13023 \begin_layout Itemize
13024
13025 \family sans
13026 Proposition
13027 \end_layout
13028
13029 \begin_layout Itemize
13030
13031 \family sans
13032 Definition
13033 \end_layout
13034
13035 \begin_layout Itemize
13036
13037 \family sans
13038 Proof
13039 \end_layout
13040
13041 \begin_layout Itemize
13042
13043 \family sans
13044 Theorem*
13045 \end_layout
13046
13047 \begin_layout Itemize
13048
13049 \family sans
13050 Lemma*
13051 \end_layout
13052
13053 \begin_layout Itemize
13054
13055 \family sans
13056 Corollary*
13057 \end_layout
13058
13059 \begin_layout Itemize
13060
13061 \family sans
13062 Proposition*
13063 \end_layout
13064
13065 \begin_layout Itemize
13066
13067 \family sans
13068 Definition*
13069 \end_layout
13070
13071 \begin_layout Standard
13072 \begin_inset ERT
13073 status inlined
13074
13075 \begin_layout Standard
13076
13077
13078 \backslash
13079 end{multicols}
13080 \end_layout
13081
13082 \end_inset
13083
13084
13085 \end_layout
13086
13087 \begin_layout Standard
13088 The starred versions are unnumbered while the unstarred versions are numbered.
13089  There are also two list environments added by LyX and these are:
13090 \end_layout
13091
13092 \begin_layout Itemize
13093
13094 \family sans
13095 TickList
13096 \end_layout
13097
13098 \begin_layout Itemize
13099
13100 \family sans
13101 CrossList
13102 \end_layout
13103
13104 \begin_layout Standard
13105
13106 \family sans
13107 Foil
13108 \family default
13109 TeX provides some powerful header and footer capabilities that are best
13110  set in the preamble although they may be set at any point in a document.
13111  If you want to change these settings in your document the best place to
13112  do so is at the very top of a foil, 
13113 \emph on
13114 i.e.
13115
13116 \emph default
13117  straight after the foilhead.
13118 \end_layout
13119
13120 \begin_layout Standard
13121 For this purpose, the following command styles are provided [
13122 \shape smallcaps
13123 Martin Vermeer
13124 \shape default
13125 ]:
13126 \end_layout
13127
13128 \begin_layout Standard
13129 \begin_inset ERT
13130 status inlined
13131
13132 \begin_layout Standard
13133
13134
13135 \backslash
13136 begin{multicols}{2}
13137 \end_layout
13138
13139 \end_inset
13140
13141
13142 \end_layout
13143
13144 \begin_layout Itemize
13145
13146 \family sans
13147 My\InsetSpace ~
13148 Logo
13149 \end_layout
13150
13151 \begin_layout Itemize
13152
13153 \family sans
13154 Restriction
13155 \end_layout
13156
13157 \begin_layout Itemize
13158
13159 \family sans
13160 Right\InsetSpace ~
13161 Footer
13162 \end_layout
13163
13164 \begin_layout Itemize
13165
13166 \family sans
13167 Right\InsetSpace ~
13168 Header
13169 \end_layout
13170
13171 \begin_layout Itemize
13172
13173 \family sans
13174 Left\InsetSpace ~
13175 Header
13176 \end_layout
13177
13178 \begin_deeper
13179 \begin_layout Standard
13180 \InsetSpace ~
13181
13182 \end_layout
13183
13184 \end_deeper
13185 \begin_layout Standard
13186 \begin_inset ERT
13187 status inlined
13188
13189 \begin_layout Standard
13190
13191
13192 \backslash
13193 end{multicols}
13194 \end_layout
13195
13196 \end_inset
13197
13198
13199 \end_layout
13200
13201 \begin_layout Standard
13202 There are also a few commands provided by 
13203 \family sans
13204 Foil
13205 \family default
13206 TeX that aren't directly supported by LyX but I'll tell you what they do
13207  and how to use them in section\InsetSpace ~
13208
13209 \begin_inset LatexCommand \ref{sec:unsuppfoils}
13210
13211 \end_inset
13212
13213 .
13214 \end_layout
13215
13216 \begin_layout Subsection
13217 Building a Set of Foils
13218 \end_layout
13219
13220 \begin_layout Standard
13221 This section will give a simple introduction to using the different environments
13222  to build a set of foils.
13223  If you want to see an example set of foils take a look at the 
13224 \family typewriter
13225 Foils.lyx
13226 \family default
13227  file accessible from the 
13228 \family sans
13229 \bar under
13230 F
13231 \bar default
13232 ile\SpecialChar \menuseparator
13233
13234 \bar under
13235 O
13236 \bar default
13237 pen\SpecialChar \ldots{}
13238
13239 \family default
13240  dialog under the 
13241 \family sans
13242 Examples
13243 \family default
13244  button.
13245  
13246 \end_layout
13247
13248 \begin_layout Subsubsection
13249 Give It a Title Page
13250 \end_layout
13251
13252 \begin_layout Standard
13253 Unlike other classes that provide 
13254 \family sans
13255 Title
13256 \family default
13257
13258 \family sans
13259 Author
13260 \family default
13261
13262 \family sans
13263 Date
13264 \family default
13265  and 
13266 \family sans
13267 Abstract
13268 \family default
13269  environments, 
13270 \family sans
13271 foils
13272 \family default
13273  creates the title on a page of its own.
13274  If you leave out the 
13275 \family sans
13276 Date
13277 \family default
13278  environment LaTeX will substitute the current date (every time you regenerate
13279  the output).
13280 \end_layout
13281
13282 \begin_layout Subsubsection
13283 Start a New Foil
13284 \end_layout
13285
13286 \begin_layout Standard
13287 As I mentioned earlier, there are four ways of starting a new foil.
13288  For portrait foils you should use 
13289 \family sans
13290 Foilhead
13291 \family default
13292  or 
13293 \family sans
13294 ShortFoilhead.
13295
13296 \family default
13297  The difference between these two environments is the amount of space between
13298  the title of the foil (the foilhead) and the body of the foil.
13299 \end_layout
13300
13301 \begin_layout Standard
13302 Landscape foils are generated using the 
13303 \family sans
13304 Rotatefoilhead
13305 \family default
13306  and 
13307 \family sans
13308 ShortRotatefoilhead
13309 \family default
13310  environments.
13311  Again the only difference is the spacing between foilhead and body.
13312  Both of the short versions have 0.5 inches less separation between the foilhead
13313  and the body.
13314  
13315 \end_layout
13316
13317 \begin_layout Standard
13318 One problem with the support for landscape foils is the requirement that
13319  you have to use the 
13320 \family typewriter
13321 dvips
13322 \family default
13323  driver to generate the PostScript® output otherwise the foils won't be
13324  rotated.
13325  It is possible to get landscape foils even if you haven't got the 
13326 \family typewriter
13327 dvips
13328 \family default
13329  driver provided you can feed your foils sideways through your printer ;-)
13330 \end_layout
13331
13332 \begin_layout Subsubsection
13333 Theorems, Lemmas, Proofs and more
13334 \end_layout
13335
13336 \begin_layout Standard
13337 Due to a small bug in LyX you can't have two of the same type of these environme
13338 nts directly following each other.
13339  They must be separated by something.
13340  If you try, you will just be extending the previous environment as if you
13341  had merged the two environments together.
13342  So, how do you get around this problem? The simplest option is to insert
13343  some text between the two environments or add a 
13344 \family sans
13345 LaTeX
13346 \family default
13347  environment between the two with just a 
13348 \begin_inset Quotes eld
13349 \end_inset
13350
13351
13352 \family typewriter
13353 %
13354 \family default
13355
13356 \begin_inset Quotes erd
13357 \end_inset
13358
13359  in it.
13360  This will force LyX to produce two separate environments and hence the
13361  correct LaTeX output.
13362  An example is provided in the example file included with the LyX distribution.
13363  Remember, this problem only occurs if you are trying to place two of the
13364  same type of theorem-like environments one directly after the other.
13365 \end_layout
13366
13367 \begin_layout Subsubsection
13368 Lists
13369 \end_layout
13370
13371 \begin_layout Standard
13372 You get all the commonly supported list styles found in other classes as
13373  well as two new ones.
13374  I'll only describe the new ones here.
13375  If you want to find out more about the other list environments check out
13376  the 
13377 \emph on
13378 User's Guide.
13379
13380 \emph default
13381  If you intend to use itemized lists you might also want to read about the
13382  
13383 \family sans
13384 Itemize\InsetSpace ~
13385 Bullet\InsetSpace ~
13386 Selection
13387 \family default
13388  dialog described above in section\InsetSpace ~
13389
13390 \begin_inset LatexCommand \ref{sec:bullet}
13391
13392 \end_inset
13393
13394 .
13395 \end_layout
13396
13397 \begin_layout Standard
13398 The two new list styles, 
13399 \family sans
13400 TickList 
13401 \family default
13402 and 
13403 \family sans
13404 CrossList
13405 \family default
13406 , are designed to make it easier for you to create lists of do's and don'ts
13407  or right and wrong by providing dedicated environments that use a tick
13408  or a cross as the label of the list.
13409  These lists are in fact dedicated variants of the 
13410 \family sans
13411 Itemize
13412 \family default
13413  environment.
13414  They do however require that you have the 
13415 \family typewriter
13416 psnfss
13417 \family default
13418  packages installed.
13419 \end_layout
13420
13421 \begin_layout Subsubsection
13422 Figures and Tables
13423 \end_layout
13424
13425 \begin_layout Standard
13426
13427 \family sans
13428 Foil
13429 \family default
13430 TeX redefines the floating tables and figures so that they appear exactly
13431  where they are in the text rather than pushing them to the top of the page
13432  or to some user specified location.
13433  In fact if you change the float placement settings they are simply ignored.
13434 \end_layout
13435
13436 \begin_layout Subsubsection
13437 Page Headers and Footers
13438 \begin_inset LatexCommand \label{sec:foilfoot}
13439
13440 \end_inset
13441
13442
13443 \end_layout
13444
13445 \begin_layout Standard
13446
13447 \family sans
13448 My\InsetSpace ~
13449 Logo
13450 \family default
13451  and 
13452 \family sans
13453 Restriction
13454 \family default
13455  are two commands used to control the left-footer text string.
13456  The first is meant to allow you to include a graphic logo on your foils
13457  and defaults to 
13458 \begin_inset Quotes eld
13459 \end_inset
13460
13461 -Typeset by 
13462 \family sans
13463 Foil
13464 \family default
13465 TeX-
13466 \begin_inset Quotes erd
13467 \end_inset
13468
13469 .
13470  While the second is meant to provide a classification for the audience,
13471  
13472 \emph on
13473 e.g.
13474
13475 \emph default
13476  Confidential.
13477  It is empty by default.
13478 \end_layout
13479
13480 \begin_layout Standard
13481 The remaining page corners can be filled by
13482 \family sans
13483  Right\InsetSpace ~
13484 Footer
13485 \family default
13486  (which defaults to page numbers), 
13487 \family sans
13488 Right\InsetSpace ~
13489 Header
13490 \family default
13491  (top right) and 
13492 \family sans
13493 Left\InsetSpace ~
13494 Header
13495 \family default
13496  (top left).
13497 \end_layout
13498
13499 \begin_layout Subsection
13500 Unsupported 
13501 \family sans
13502 Foil
13503 \family default
13504 TeX Goodies
13505 \begin_inset LatexCommand \label{sec:unsuppfoils}
13506
13507 \end_inset
13508
13509
13510 \end_layout
13511
13512 \begin_layout Standard
13513 All the commands mentioned below need to be set in a 
13514 \family sans
13515 LaTeX
13516 \family default
13517  environment or as 
13518 \family sans
13519 TeX
13520 \family default
13521  within another environment.
13522 \end_layout
13523
13524 \begin_layout Subsubsection
13525 Lengths
13526 \end_layout
13527
13528 \begin_layout Standard
13529 All lengths are adjusted using the 
13530 \family typewriter
13531
13532 \backslash
13533 setlength{
13534 \family default
13535 \emph on
13536 lengthname
13537 \family typewriter
13538 \emph default
13539 }{
13540 \family default
13541 \emph on
13542 newlength
13543 \family typewriter
13544 \emph default
13545 }
13546 \family default
13547  command.
13548  Where 
13549 \emph on
13550 lengthname
13551 \emph default
13552  should be replaced by the name given to the length you want to change and
13553  
13554 \emph on
13555 newlength
13556 \emph default
13557  is the length value.
13558  All lengths should be specified in units of length such as inches (
13559 \family typewriter
13560 in
13561 \family default
13562 ), millimeters (
13563 \family typewriter
13564 mm
13565 \family default
13566 ) or points (
13567 \family typewriter
13568 pt
13569 \family default
13570 ) or relative to some document or font-based length such as 
13571 \family typewriter
13572
13573 \backslash
13574 textwidth
13575 \family default
13576 .
13577  
13578 \end_layout
13579
13580 \begin_layout Standard
13581 It's possible to change the spacing between a foilhead and the body of the
13582  foil by adjusting the length specified by 
13583 \family typewriter
13584
13585 \backslash
13586 foilheadskip
13587 \family default
13588 .
13589  For example, to make 
13590 \emph on
13591 all
13592 \emph default
13593  foilheads 0.5 inches closer to their bodies put the following in the preamble:
13594  
13595 \family typewriter
13596
13597 \backslash
13598 setlength{
13599 \backslash
13600 foilheadskip}{-0.5in}
13601 \end_layout
13602
13603 \begin_layout Standard
13604 The spacings around floats can be adjusted by setting these lengths:
13605 \end_layout
13606
13607 \begin_layout List
13608 \labelwidthstring MMMMMMMMMMM
13609
13610 \family typewriter
13611
13612 \backslash
13613 abovefloatskip 
13614 \family default
13615 Separation between the text and the top of the float
13616 \end_layout
13617
13618 \begin_layout List
13619 \labelwidthstring MMMMMMMMMMM
13620
13621 \family typewriter
13622
13623 \backslash
13624 abovecaptionskip 
13625 \family default
13626 Separation between the float and the caption
13627 \end_layout
13628
13629 \begin_layout List
13630 \labelwidthstring MMMMMMMMMMM
13631
13632 \family typewriter
13633
13634 \backslash
13635 belowcaptionskip 
13636 \family default
13637 Separation between the caption and the following text
13638 \end_layout
13639
13640 \begin_layout List
13641 \labelwidthstring MMMMMMMMMMM
13642
13643 \family typewriter
13644
13645 \backslash
13646 captionwidth
13647 \family default
13648  You can make the captions narrower than the surrounding text by adjusting
13649  this length.
13650  Best done relative to 
13651 \family typewriter
13652
13653 \backslash
13654 textwidth
13655 \family default
13656 .
13657 \end_layout
13658
13659 \begin_layout Standard
13660 There are also several title page related lengths that you may find useful
13661  if you have a long title or several authors:
13662 \end_layout
13663
13664 \begin_layout List
13665 \labelwidthstring MMMMMMMMMMM
13666
13667 \family typewriter
13668
13669 \backslash
13670 abovetitleskip
13671 \family default
13672  Separation from headers to 
13673 \family sans
13674 Title
13675 \end_layout
13676
13677 \begin_layout List
13678 \labelwidthstring MMMMMMMMMMM
13679
13680 \family typewriter
13681
13682 \backslash
13683 titleauthorskip
13684 \family default
13685  between 
13686 \family sans
13687 Title
13688 \family default
13689  and 
13690 \family sans
13691 Author
13692 \family default
13693  environments
13694 \end_layout
13695
13696 \begin_layout List
13697 \labelwidthstring MMMMMMMMMMM
13698
13699 \family typewriter
13700
13701 \backslash
13702 authorauthorskip
13703 \family default
13704  between multiple 
13705 \family sans
13706 Author
13707 \family default
13708  lines
13709 \end_layout
13710
13711 \begin_layout List
13712 \labelwidthstring MMMMMMMMMMM
13713
13714 \family typewriter
13715
13716 \backslash
13717 authordateskip
13718 \family default
13719  between the 
13720 \family sans
13721 Author
13722 \family default
13723  and the 
13724 \family sans
13725 Date
13726 \end_layout
13727
13728 \begin_layout List
13729 \labelwidthstring MMMMMMMMMMM
13730
13731 \family typewriter
13732
13733 \backslash
13734 dateabstractskip
13735 \family default
13736  between the 
13737 \family sans
13738 Date
13739 \family default
13740  and the 
13741 \family sans
13742 Abstract
13743 \end_layout
13744
13745 \begin_layout Standard
13746 The last length related command affects all the list environments.
13747  If you place
13748 \family typewriter
13749  
13750 \backslash
13751 zerolistvertdimens
13752 \family default
13753  
13754 \emph on
13755 inside
13756 \emph default
13757  a list environment then all the vertical spacing between the list items
13758  is removed.
13759  Note that this is a command not a length so it doesn't require 
13760 \family typewriter
13761
13762 \backslash
13763 setlength
13764 \family default
13765  like the stuff mentioned above.
13766 \end_layout
13767
13768 \begin_layout Subsubsection
13769 Headers and Footers
13770 \end_layout
13771
13772 \begin_layout Standard
13773 The 
13774 \family typewriter
13775
13776 \backslash
13777 LogoOn
13778 \family default
13779  and 
13780 \family typewriter
13781
13782 \backslash
13783 LogoOff
13784 \family default
13785  commands control whether the logo in the 
13786 \family sans
13787 MyLogo
13788 \family default
13789  definition appear on a given page.
13790  If you put 
13791 \family typewriter
13792
13793 \backslash
13794 LogoOff
13795 \family default
13796  in the preamble then none of the foils will have the logo on them.
13797  If you don't want the logo on a particular page place the 
13798 \family typewriter
13799
13800 \backslash
13801 LogoOff
13802 \family default
13803  directly after the foilhead of that page and the 
13804 \family typewriter
13805
13806 \backslash
13807 LogoOn
13808 \family default
13809  directly after the next foilhead.
13810 \end_layout
13811
13812 \begin_layout Standard
13813 If you decide to use the 
13814 \family sans
13815 fancy
13816 \family default
13817  page style setting in the 
13818 \family sans
13819 Document\InsetSpace ~
13820 Layout
13821 \family default
13822  dialog you should probably add 
13823 \family typewriter
13824
13825 \backslash
13826 let
13827 \backslash
13828 headwidth
13829 \backslash
13830 textwidth
13831 \family default
13832  to your preamble so headers and footers on landscape pages are correctly
13833  placed when rotated.
13834  This is due to some clashes between the page layouts provided by the 
13835 \family sans
13836 fancyheadings
13837 \family default
13838  package and the 
13839 \family sans
13840 foils
13841 \family default
13842  class.
13843 \end_layout
13844
13845 \begin_layout Section
13846 Latex8 (IEEE Conference Papers)
13847 \end_layout
13848
13849 \begin_layout Standard
13850 by 
13851 \noun on
13852 Allan Rae
13853 \end_layout
13854
13855 \begin_layout Subsection
13856 Introduction
13857 \end_layout
13858
13859 \begin_layout Standard
13860 Since this class is specifically for writing submissions to IEEE sponsored
13861  conferences I strongly recommend that you get a copy of their Authors Kit.
13862  The 
13863 \family sans
13864 latex.sty
13865 \family default
13866  package and associated bibliography style file is included in the kit.
13867  The Authors Kit is usually sent out by email once your initial submission
13868  has been accepted.
13869  There is a lot of useful information in the Authors Kit explaining formatting
13870  restrictions and so on and I will assume you have read this since that
13871  means I don't have to repeat it all here.
13872 \end_layout
13873
13874 \begin_layout Subsection
13875 Getting Started
13876 \end_layout
13877
13878 \begin_layout Standard
13879 [AR\SpecialChar \@.
13880  more to come]
13881 \end_layout
13882
13883 \begin_layout Subsection
13884 Supported Environments
13885 \end_layout
13886
13887 \begin_layout Itemize
13888
13889 \family sans
13890 Standard
13891 \end_layout
13892
13893 \begin_layout Itemize
13894
13895 \family sans
13896 Title
13897 \end_layout
13898
13899 \begin_layout Itemize
13900
13901 \family sans
13902 Author
13903 \end_layout
13904
13905 \begin_layout Itemize
13906
13907 \family sans
13908 E-mail
13909 \end_layout
13910
13911 \begin_layout Itemize
13912
13913 \family sans
13914 Affiliation
13915 \end_layout
13916
13917 \begin_layout Itemize
13918
13919 \family sans
13920 Abstract
13921 \end_layout
13922
13923 \begin_layout Itemize
13924
13925 \family sans
13926 Section
13927 \end_layout
13928
13929 \begin_layout Itemize
13930
13931 \family sans
13932 SubSection
13933 \end_layout
13934
13935 \begin_layout Itemize
13936
13937 \family sans
13938 Caption
13939 \end_layout
13940
13941 \begin_layout Subsection
13942 Differences Between Screen and Paper
13943 \end_layout
13944
13945 \begin_layout Standard
13946 There are slight differences in appearance mainly with the presentation
13947  of section counters.
13948  On screen the trailing period of the section counter is missing but it
13949  will appear in the output so don't let this worry you.
13950 \end_layout
13951
13952 \begin_layout Section
13953 Hollywood (Hollywood spec scripts)
13954 \end_layout
13955
13956 \begin_layout Standard
13957 by 
13958 \shape smallcaps
13959 Garst Reese
13960 \end_layout
13961
13962 \begin_layout Subsection
13963 Introduction
13964 \end_layout
13965
13966 \begin_layout Standard
13967 Getting the format of a Hollywood script right is a 
13968 \begin_inset Quotes eld
13969 \end_inset
13970
13971 rite of passage.
13972 \begin_inset Quotes erd
13973 \end_inset
13974
13975  It is designed to make the readers focus on content and to be easy and
13976  familiar for the actors to read.
13977  Each page of a script should be one minute of film.
13978  Nothing goes in a script that you cannot see or hear on screen.
13979  The courier 12 pt font should be used throughout.
13980  No italics.
13981 \end_layout
13982
13983 \begin_layout Subsection
13984 Special problems
13985 \end_layout
13986
13987 \begin_layout Standard
13988 Speakers' lines should NEVER break in mid-sentence.
13989  If a speaker's lines continue over a page break, repeat the 
13990 \family sans
13991 Speaker
13992 \family default
13993  title followed by (Cont'd).
13994 \end_layout
13995
13996 \begin_layout Subsection
13997 Special features
13998 \end_layout
13999
14000 \begin_layout Standard
14001 Insert the 
14002 \family sans
14003 Speaker
14004 \family default
14005  names as labels then cross-reference the label to insert the name.
14006  The cross-reference dialog will show the current cast of characters.
14007  You can use this to insert the speaker name in narratives also.
14008 \end_layout
14009
14010 \begin_layout Subsection
14011 Paper size and Margins
14012 \end_layout
14013
14014 \begin_layout Standard
14015 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
14016 \end_layout
14017
14018 \begin_layout Subsection
14019 Environments
14020 \end_layout
14021
14022 \begin_layout Standard
14023 The following environments are available.
14024  You can use hollywood.bind to get the bind keys shown at the right.
14025 \end_layout
14026
14027 \begin_layout Itemize
14028
14029 \family sans
14030 Standard
14031 \newline
14032
14033 \family default
14034 Used where nothing else works.
14035  Try to avoid it.
14036 \end_layout
14037
14038 \begin_layout Itemize
14039
14040 \family sans
14041 FADE_IN
14042 \family default
14043 :
14044 \hfill
14045
14046 \family sans
14047 M-z S-I
14048 \family default
14049
14050 \newline
14051 Usually followed by something like 
14052 \begin_inset Quotes eld
14053 \end_inset
14054
14055 on Sally waking up.
14056 \begin_inset Quotes erd
14057 \end_inset
14058
14059
14060 \end_layout
14061
14062 \begin_layout Itemize
14063
14064 \family sans
14065 INT:
14066 \hfill
14067 M-z i
14068 \newline
14069
14070 \family default
14071 Introduces a new INTERIOR camera set-up.
14072  Always followed by DAY or NIGHT, or something similar to define the lighting
14073  required.
14074  Everthing on this line in CAPS.
14075 \end_layout
14076
14077 \begin_layout Itemize
14078
14079 \family sans
14080 EXT:
14081 \hfill
14082 M-z e
14083 \newline
14084
14085 \family default
14086 Introduces a new EXTERIOR camera set-up.
14087  Everthing on this line in CAPS.
14088 \end_layout
14089
14090 \begin_layout Itemize
14091
14092 \family sans
14093 Speaker
14094 \hfill
14095 M-z s
14096 \newline
14097
14098 \family default
14099 The character speaking.
14100 \end_layout
14101
14102 \begin_layout Itemize
14103
14104 \family sans
14105 Parenthetical
14106 \hfill
14107 M-z p
14108 \newline
14109
14110 \family default
14111 Instructions to the speaker.
14112  The () are automatically inserted, but only the ( will show in LyX.
14113  Both will be printed.
14114 \end_layout
14115
14116 \begin_layout Itemize
14117
14118 \family sans
14119 Dialogue
14120 \hfill
14121 M-z d
14122 \newline
14123
14124 \family default
14125 What the 
14126 \family sans
14127 Speaker
14128 \family default
14129  says.
14130 \end_layout
14131
14132 \begin_layout Itemize
14133
14134 \family sans
14135 Transition
14136 \hfill
14137 M-z t
14138 \newline
14139
14140 \family default
14141 Camera movement instruction.
14142  e.g.
14143  CUT TO:
14144 \end_layout
14145
14146 \begin_layout Itemize
14147
14148 \family sans
14149 FADE OUT:
14150 \hfill
14151 M-z S-I
14152 \end_layout
14153
14154 \begin_layout Itemize
14155
14156 \family sans
14157 Author
14158 \hfill
14159 M-z S-A
14160 \end_layout
14161
14162 \begin_layout Itemize
14163
14164 \family sans
14165 Title
14166 \hfill
14167 M-z S-T
14168 \end_layout
14169
14170 \begin_layout Itemize
14171
14172 \family sans
14173 Right_Address
14174 \hfill
14175 M-z r
14176 \end_layout
14177
14178 \begin_layout Subsection
14179 Script jargon
14180 \end_layout
14181
14182 \begin_layout Itemize
14183 (O.S) --- off screen
14184 \end_layout
14185
14186 \begin_layout Itemize
14187 (V.0) --- voice over
14188 \end_layout
14189
14190 \begin_layout Itemize
14191 b.g.
14192  --- background
14193 \end_layout
14194
14195 \begin_layout Itemize
14196 C.U.
14197  --- close-up
14198 \end_layout
14199
14200 \begin_layout Itemize
14201 PAN --- camera movement
14202 \end_layout
14203
14204 \begin_layout Itemize
14205 INSERT --- cut to close-up of
14206 \end_layout
14207
14208 \begin_layout Section
14209 Broadway
14210 \end_layout
14211
14212 \begin_layout Standard
14213 by 
14214 \shape smallcaps
14215 Garst Reese
14216 \end_layout
14217
14218 \begin_layout Subsection
14219 Introduction
14220 \end_layout
14221
14222 \begin_layout Standard
14223 Broadway is for writing plays.
14224  The format is more decorative than Hollywood, and much less standardized.
14225  This format should be suitable for workshops.
14226 \end_layout
14227
14228 \begin_layout Subsection
14229 Special problems
14230 \end_layout
14231
14232 \begin_layout Standard
14233 The same as in Hollywood.
14234 \end_layout
14235
14236 \begin_layout Subsection
14237 Special features
14238 \end_layout
14239
14240 \begin_layout Standard
14241 Insert the 
14242 \family sans
14243 Speaker
14244 \family default
14245  names as labels then cross-reference the label to insert the name.
14246  The cross-reference dialog will show the current cast of characters.
14247 \end_layout
14248
14249 \begin_layout Subsection
14250 Paper size and Margins
14251 \end_layout
14252
14253 \begin_layout Standard
14254 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
14255 \end_layout
14256
14257 \begin_layout Subsection
14258 Environments
14259 \end_layout
14260
14261 \begin_layout Standard
14262 The following environments are available.
14263  You can use broadway.bind to get the bind keys shown at the right.
14264 \end_layout
14265
14266 \begin_layout Itemize
14267
14268 \family sans
14269 Standard
14270 \newline
14271
14272 \family default
14273 You should not have to use this, but it is here for anything that does not
14274  fit otherwise.
14275 \end_layout
14276
14277 \begin_layout Itemize
14278
14279 \family sans
14280 Narrative
14281 \hfill
14282 M-z n
14283 \newline
14284
14285 \family default
14286 Used to describe stage setting and the action.
14287  First use of speaker names in all CAPs.
14288 \end_layout
14289
14290 \begin_layout Itemize
14291
14292 \family sans
14293 ACT
14294 \hfill
14295 M-z a
14296 \newline
14297
14298 \family default
14299 Automatically numbered.
14300  On screen it will be arabic, but will print as Roman.
14301 \end_layout
14302
14303 \begin_layout Itemize
14304
14305 \family sans
14306 ACT*
14307 \hfill
14308 M-z S at
14309 \newline
14310
14311 \family default
14312 Subtitle for 
14313 \family sans
14314 ACT.
14315  
14316 \family default
14317 It is just centered text.
14318 \end_layout
14319
14320 \begin_layout Itemize
14321
14322 \family sans
14323 SCENE
14324 \hfill
14325 M-z S-S
14326 \newline
14327
14328 \family default
14329 Not automatically numbered.
14330  You supply the number.
14331  This is because I couldn't figure out how.
14332 \end_layout
14333
14334 \begin_layout Itemize
14335
14336 \family sans
14337 AT_RISE:
14338 \hfill
14339 M-z S-R
14340 \newline
14341
14342 \family default
14343 A special case of Narrative to describe the setting and action as the curtain
14344  rises.
14345 \end_layout
14346
14347 \begin_layout Itemize
14348
14349 \family sans
14350 Speaker
14351 \hfill
14352 M-z s
14353 \newline
14354
14355 \family default
14356 The speaker's (actor's) title, centered in all CAPS.
14357 \end_layout
14358
14359 \begin_layout Itemize
14360
14361 \family sans
14362 Parenthetical
14363 \hfill
14364 M-z p
14365 \newline
14366
14367 \family default
14368 Instructions to the speaker.
14369  The parentheses are automatically inserted.
14370  The ( will appear on screen, but both will be in the printed play.
14371  This environment is only used within 
14372 \family sans
14373 Dialogue
14374 \family default
14375 .
14376 \end_layout
14377
14378 \begin_layout Itemize
14379
14380 \family sans
14381 Dialogue
14382 \hfill
14383 M-z d
14384 \newline
14385
14386 \family default
14387 What the Speaker says.
14388 \end_layout
14389
14390 \begin_layout Itemize
14391
14392 \family sans
14393 CURTAIN
14394 \hfill
14395 M-z S-C
14396 \newline
14397
14398 \family default
14399 The curtain comes down.
14400 \end_layout
14401
14402 \begin_layout Itemize
14403
14404 \family sans
14405 Title
14406 \hfill
14407 M-z S-T
14408 \end_layout
14409
14410 \begin_layout Itemize
14411
14412 \family sans
14413 Author
14414 \hfill
14415 M-z S-A
14416 \end_layout
14417
14418 \begin_layout Itemize
14419
14420 \family sans
14421 Right_Address
14422 \hfill
14423 M-z r
14424 \end_layout
14425
14426 \begin_layout Standard
14427 Hello there.
14428 \end_layout
14429
14430 \begin_layout Section
14431 RevTeX4
14432 \end_layout
14433
14434 \begin_layout Standard
14435 by 
14436 \noun on
14437 Amir Karger
14438 \end_layout
14439
14440 \begin_layout Standard
14441 \begin_inset VSpace bigskip
14442 \end_inset
14443
14444
14445 \end_layout
14446
14447 \begin_layout Standard
14448 \noindent
14449 The 
14450 \family sans
14451 Revtex\InsetSpace ~
14452 4
14453 \family default
14454  textclass works with the American Physical Sociey's RevTeX 4.0 (the 
14455 \begin_inset Formula $\beta$
14456 \end_inset
14457
14458  release of May, 1999) class.
14459 \end_layout
14460
14461 \begin_layout Standard
14462 LyX has a 
14463 \family sans
14464 Revtex
14465 \family default
14466  textclass, which works with RevTeX 3.1.
14467  However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14468  That means that it doesn't interact very well with LyX, which requires
14469  LaTeX2e, although it has been kludged to work.
14470  Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14471  LyX with the 
14472 \family sans
14473 RevTeX\InsetSpace ~
14474 4
14475 \family default
14476  textclass should also be pretty easy to use.
14477 \end_layout
14478
14479 \begin_layout Standard
14480 These documents are supposed to be used in 
14481 \emph on
14482 addition
14483 \emph default
14484  to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14485  macros, and assume you'll know what to put in the preamble if necessary.
14486 \end_layout
14487
14488 \begin_layout Subsection
14489 Installation
14490 \end_layout
14491
14492 \begin_layout Standard
14493 All you need to do is install RevTeX 4, as described in the package's README
14494  file.
14495  the package can be found at 
14496 \begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
14497
14498 \end_inset
14499
14500 .
14501  Install it somewhere that LaTeX can see it.
14502  Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14503  (i.e., not the directory where you installed the class file.) Then, if you
14504  reconfigure LyX, it will find the class file and let you use the RevTeX4
14505  textclass.
14506 \end_layout
14507
14508 \begin_layout Standard
14509 Probably the easiest way to get started is either to import a RevTeX 4 document
14510  using 
14511 \family typewriter
14512 reLyX
14513 \family default
14514 , or to use the 
14515 \family sans
14516 Revtex\InsetSpace ~
14517 4
14518 \family default
14519  template, found in the templates directory.
14520 \end_layout
14521
14522 \begin_layout Subsection
14523 Preamble Matter
14524 \end_layout
14525
14526 \begin_layout Standard
14527 Optional arguments to 
14528 \family typewriter
14529
14530 \backslash
14531 documentclass
14532 \family default
14533 , like 
14534 \begin_inset Quotes eld
14535 \end_inset
14536
14537 preprint
14538 \begin_inset Quotes erd
14539 \end_inset
14540
14541  and 
14542 \begin_inset Quotes eld
14543 \end_inset
14544
14545 aps
14546 \begin_inset Quotes erd
14547 \end_inset
14548
14549 , go in the 
14550 \family sans
14551 E
14552 \bar under
14553 x
14554 \bar default
14555 tra\InsetSpace ~
14556 Options
14557 \family default
14558  field in the 
14559 \family sans
14560 Document\InsetSpace ~
14561 Layout
14562 \family default
14563  dialog, as usual.
14564  Remember that in RevTeX, at least one optional argument is required! 
14565 \end_layout
14566
14567 \begin_layout Standard
14568 Other preamble matter, like 
14569 \family typewriter
14570
14571 \backslash
14572 draft
14573 \family default
14574  etc.
14575  goes in the 
14576 \family sans
14577 Latex\InsetSpace ~
14578 Preamble
14579 \family default
14580  dialog, also as usual.
14581 \end_layout
14582
14583 \begin_layout Subsection
14584 Layouts
14585 \end_layout
14586
14587 \begin_layout Standard
14588 The layouts basically correspond to the commands in RevTeX4.0.
14589  For example, the Email layout corresponds to 
14590 \family typewriter
14591
14592 \backslash
14593 email{}
14594 \family default
14595 .
14596  Note that (at least as of RevTeX 4.0 Beta), the 
14597 \family sans
14598 Address
14599 \family default
14600  and 
14601 \family sans
14602 Affiliation
14603 \family default
14604  layouts are exactly equivalent, so you shouldn't need to use both.
14605 \begin_inset Foot
14606 status collapsed
14607
14608 \begin_layout Standard
14609 In case you're curious, both were included so that 
14610 \family typewriter
14611 reLyX
14612 \family default
14613  would be able to translate both 
14614 \family typewriter
14615
14616 \backslash
14617 address
14618 \family default
14619  and 
14620 \family typewriter
14621
14622 \backslash
14623 affiliation
14624 \family default
14625 .
14626 \end_layout
14627
14628 \end_inset
14629
14630
14631 \end_layout
14632
14633 \begin_layout Subsection
14634 Important Notes
14635 \end_layout
14636
14637 \begin_layout Standard
14638 There are a couple of important unique aspects of RevTeX 4 which might cause
14639  bugs that will be even more confusing in LyX.
14640 \end_layout
14641
14642 \begin_layout Standard
14643 In RevTeX, the 
14644 \family typewriter
14645
14646 \backslash
14647 thanks
14648 \family default
14649  command goes 
14650 \emph on
14651 outside
14652 \emph default
14653  the 
14654 \family typewriter
14655
14656 \backslash
14657 author
14658 \family default
14659  command.
14660  The LyX equivalent is that there is a separate Thanks layout.
14661  Do 
14662 \emph on
14663 not
14664 \emph default
14665  write footnotes in the 
14666 \family sans
14667 Author
14668 \family default
14669  layout, or weird things may happen.
14670  See the RevTeX 4 documentation for more details.
14671 \end_layout
14672
14673 \begin_layout Standard
14674 Also, the 
14675 \family sans
14676 Author\InsetSpace ~
14677 Email
14678 \family default
14679
14680 \family sans
14681 Author\InsetSpace ~
14682 URL
14683 \family default
14684 , and 
14685 \family sans
14686 Thanks
14687 \family default
14688  layouts must be placed 
14689 \emph on
14690 in between
14691 \emph default
14692  the 
14693 \family sans
14694 Author
14695 \family default
14696  layout and the corresponding 
14697 \family sans
14698 Address
14699 \family default
14700  (or equivalent 
14701 \family sans
14702 Affiliation
14703 \family default
14704 ) layout.
14705  If you put the 
14706 \family sans
14707 Thanks
14708 \family default
14709  after the 
14710 \family sans
14711 Address
14712 \family default
14713 , the LaTeX won't compile.
14714 \end_layout
14715
14716 \begin_layout Subsection
14717 Drawbacks
14718 \end_layout
14719
14720 \begin_layout Standard
14721 The main problem with this layout is that you can't use the optional arguments
14722  to layouts like Email and Title.
14723  (The problem is not unique to this layout; you can't use optional arguments
14724  to the Section layouts either.) This means that after you export that file
14725  to LaTeX (which you'll need to do eventually to send it in to APS), you'll
14726  need to edit the LaTeX file with a text editor to add the optional arguments
14727  to set, e.g., the running title for the page headers.
14728  Lacking these layouts makes the 
14729 \family typewriter
14730
14731 \backslash
14732 altaffiliation
14733 \family default
14734  (and the equivalent 
14735 \family typewriter
14736
14737 \backslash
14738 altaddress
14739 \family default
14740 ) useless, so the corresponding layouts don't exist, and will have to be
14741  added by hand.
14742 \begin_inset Foot
14743 status collapsed
14744
14745 \begin_layout Standard
14746
14747 \emph on
14748 Note from JMarc:
14749 \emph default
14750  actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
14751  has not been updated yet to take advantage of it.
14752 \end_layout
14753
14754 \end_inset
14755
14756  
14757 \end_layout
14758
14759 \begin_layout Section
14760 Article (mwart), book (mwbk) and report (mwrep)
14761 \begin_inset OptArg
14762 status collapsed
14763
14764 \begin_layout Standard
14765 The 
14766 \family typewriter
14767 mw
14768 \family default
14769  Classes
14770 \end_layout
14771
14772 \end_inset
14773
14774
14775 \end_layout
14776
14777 \begin_layout Standard
14778 by 
14779 \noun on
14780 Tomasz Luczak
14781 \end_layout
14782
14783 \begin_layout Standard
14784 The LyX document classes
14785 \emph on
14786  article (mwart)
14787 \emph default
14788
14789 \emph on
14790 report (mwrep)
14791 \emph default
14792  and 
14793 \emph on
14794 book
14795 \emph default
14796  
14797 \emph on
14798 (mwbk)
14799 \emph default
14800  correspond to the LaTeX document classes 
14801 \family typewriter
14802 mwart.cls
14803 \family default
14804
14805 \family typewriter
14806 mwrep.cls
14807 \family default
14808  and 
14809 \family typewriter
14810 mwbk.cls
14811 \family default
14812 , resp.
14813  They are replacements for the standard document classes 
14814 \family typewriter
14815 article.cls
14816 \family default
14817
14818 \family typewriter
14819 report.cls
14820 \family default
14821  and 
14822 \family typewriter
14823 book.cls
14824 \family default
14825 , resp., and fit better to Polish typography conventions in a number of points.
14826  
14827 \end_layout
14828
14829 \begin_layout Standard
14830 Basic differences:
14831 \end_layout
14832
14833 \begin_layout Itemize
14834 Unnumbered titles (with star, eg.
14835  
14836 \family sans
14837 Section*
14838 \family default
14839 ) are added into table of contents,
14840 \end_layout
14841
14842 \begin_layout Itemize
14843 Additional page styles:
14844 \end_layout
14845
14846 \begin_deeper
14847 \begin_layout Description
14848 uheadings header with separated lines,
14849 \end_layout
14850
14851 \begin_layout Description
14852 myheadings custom header, contents headers via commands: 
14853 \family typewriter
14854
14855 \backslash
14856 markright
14857 \family default
14858  and 
14859 \family typewriter
14860
14861 \backslash
14862 markboth
14863 \family default
14864 ,
14865 \end_layout
14866
14867 \begin_layout Description
14868 myuheadings custom header with separated lines,
14869 \end_layout
14870
14871 \begin_layout Description
14872 outer page number is placed on outer side of page
14873 \end_layout
14874
14875 \end_deeper
14876 \begin_layout Itemize
14877 Options 
14878 \end_layout
14879
14880 \begin_deeper
14881 \begin_layout Description
14882 rmheadings serif titles --- default,
14883 \end_layout
14884
14885 \begin_layout Description
14886 sfheadings sansserif titles,
14887 \end_layout
14888
14889 \begin_layout Description
14890 authortitle on title page first placed is author next title --- default,
14891 \end_layout
14892
14893 \begin_layout Description
14894 titleauthor on title page first placed is title next author,
14895 \end_layout
14896
14897 \begin_layout Description
14898 withmarginpar reserve place on page for margins.
14899 \end_layout
14900
14901 \end_deeper
14902 \begin_layout Section
14903 Elsevier Journals
14904 \end_layout
14905
14906 \begin_layout Standard
14907 By 
14908 \noun on
14909 Rod Pinna
14910 \end_layout
14911
14912 \begin_layout Standard
14913 Elsevier Science Publishers B.V.
14914  provides a standard LaTeX document class (
14915 \family typewriter
14916 elsart.cls
14917 \family default
14918 ) for submitting articles to their various journals.
14919  The style file can be downloaded directly from their web site: 
14920 \begin_inset LatexCommand \url{http://authors.elsevier.com/}
14921
14922 \end_inset
14923
14924 .
14925  Instructions are supplied along with the class file, which details the
14926  requirements of the publishers.
14927  LyX includes package that allows for the use of this class, by a layout
14928  and a template file.
14929  Installation of the class file is the same as for any other LaTeX package;
14930  instructions are provided in the Elsevier documentation.
14931 \end_layout
14932
14933 \begin_layout Standard
14934 To make use of 
14935 \family typewriter
14936 elsart.cls
14937 \family default
14938 , a file 
14939 \family typewriter
14940 elsart.layout
14941 \family default
14942  is supplied.
14943  As the Elsevier class file is based mainly on the standard article class,
14944  most of the normal functionality is provided.
14945  The Elsevier class defines a number of mathematical environments, which
14946  are similar to the AMS environments.
14947  These commands are all described in the Elsevier documentation, and are
14948  available in LyX.
14949 \end_layout
14950
14951 \begin_layout Standard
14952 The easiest way to use the Elsevier style is to base documents on the included
14953  template file.
14954  It is best not to use options such as fancy headings or the geometry package,
14955  as elements such as these are defined by Elsevier in their style file.
14956  Ideally, no extra packages except those mentioned in the Elsevier documentation
14957  should be used.
14958  Essentially, Elsevier require as 
14959 \begin_inset Quotes eld
14960 \end_inset
14961
14962 clean
14963 \begin_inset Quotes erd
14964 \end_inset
14965
14966  a 
14967 \begin_inset ERT
14968 status collapsed
14969
14970 \begin_layout Standard
14971
14972
14973 \backslash
14974 LaTeX
14975 \end_layout
14976
14977 \end_inset
14978
14979  file as possible, as their intention is to take the supplied file and replace
14980  the class file with one for the particular journal to which the paper has
14981  been submitted.
14982  This also means that not too much time should be spent on the formating
14983  of the document.
14984  When it comes to be published, this will change anyway.
14985  The rest of the usage for this layout is substantially the same as for
14986  the normal article class.
14987  For details of what Elsevier do and don't allow, refer to their documentation.
14988 \end_layout
14989
14990 \begin_layout Section
14991 Memoir
14992 \end_layout
14993
14994 \begin_layout Standard
14995 By 
14996 \noun on
14997 Jürgen Spitzmüller
14998 \end_layout
14999
15000 \begin_layout Subsection
15001 Overview
15002 \end_layout
15003
15004 \begin_layout Standard
15005 Memoir is a very powerful and constantly evolving class.
15006  It has been designed with regard to fictional and non-fictional literature.
15007  Its aim is to let the user have maximum control over the typesetting of
15008  his document.
15009  Memoir is based on the standard book class, but it can also emulate the
15010  article class (see below).
15011 \end_layout
15012
15013 \begin_layout Standard
15014 Peter Wilson, the developer of Memoir, is known as the author of lots of
15015  useful packages in the LaTeX world.
15016  Most of them have been merged with Memoir.
15017  Therefore, it is much easier to layout the table of contents, appendices,
15018  chapter designs and such.
15019  LyX, though, does not support all of these goodies natively.
15020  Some of them might be added to forthcoming releases
15021 \begin_inset Foot
15022 status collapsed
15023
15024 \begin_layout Standard
15025 You are invited to send suggestions to 
15026 \begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
15027
15028 \end_inset
15029
15030 .
15031 \end_layout
15032
15033 \end_inset
15034
15035 , lots will probably never, due to the limitations of LyX's framework.
15036  Of course you can still use all features with the help of some native LaTeX
15037  commands (ERT
15038 \begin_inset Foot
15039 status collapsed
15040
15041 \begin_layout Standard
15042 Cf.
15043 \begin_inset ERT
15044 status collapsed
15045
15046 \begin_layout Standard
15047
15048
15049 \backslash
15050  
15051 \end_layout
15052
15053 \end_inset
15054
15055 section\InsetSpace ~
15056
15057 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
15058
15059 \end_inset
15060
15061  for details.
15062 \end_layout
15063
15064 \end_inset
15065
15066 ).
15067  In this section, we can only list those features which are natively supported
15068  by LyX.
15069  For detailed descriptions (and for the rest of features) we are recommending
15070  to have a look at the detailed manual of the Memoir class
15071 \begin_inset Foot
15072 status collapsed
15073
15074 \begin_layout Standard
15075 Cf.
15076 \begin_inset ERT
15077 status collapsed
15078
15079 \begin_layout Standard
15080
15081
15082 \backslash
15083  
15084 \end_layout
15085
15086 \end_inset
15087
15088
15089 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
15090
15091 \end_inset
15092
15093 .
15094 \end_layout
15095
15096 \end_inset
15097
15098 , which is not only a user guide for the class, but also both a comprehensive
15099  description on good typesetting and a superb example for good typesetting
15100  itself.
15101 \end_layout
15102
15103 \begin_layout Subsection
15104 Basic features and restrictions
15105 \end_layout
15106
15107 \begin_layout Standard
15108 Memoir supports basically all features of the standard book classes.
15109  There are, however, some differences, as follows:
15110 \end_layout
15111
15112 \begin_layout Description
15113 Font\InsetSpace ~
15114 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
15115  17
15116 \end_layout
15117
15118 \begin_layout Description
15119 Page\InsetSpace ~
15120 style: The fancy page style is not supported, due to a command clash
15121  between Memoir and the fancyhdr package (they are both defining a command
15122  with the same name, which confuses LaTeX).
15123  Instead, Memoir comes with a bunch of own page styles (see 
15124 \family sans
15125 Layout\SpecialChar \menuseparator
15126 Document\SpecialChar \menuseparator
15127 Page\InsetSpace ~
15128 Style
15129 \family default
15130 ).
15131  If you want to use these for the chapter pages, you have to use the command
15132  
15133 \family typewriter
15134
15135 \backslash
15136 chapterstyle
15137 \family default
15138  in the main text or in preamble (e.
15139 \begin_inset ERT
15140 status collapsed
15141
15142 \begin_layout Standard
15143
15144
15145 \backslash
15146 ,
15147 \end_layout
15148
15149 \end_inset
15150
15151 g.
15152 \begin_inset ERT
15153 status collapsed
15154
15155 \begin_layout Standard
15156
15157
15158 \backslash
15159  
15160 \end_layout
15161
15162 \end_inset
15163
15164
15165 \family typewriter
15166
15167 \backslash
15168 chapterstyle{companion}
15169 \family default
15170 ).
15171 \end_layout
15172
15173 \begin_layout Description
15174 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
15175  an optional argument in the standard classes.
15176  With this, you can specify an alternative version of the title for the
15177  table of contents and the headers (for instance, if the title is too long).
15178  In LyX, you can do this via 
15179 \family sans
15180 Insert\SpecialChar \menuseparator
15181 Short\InsetSpace ~
15182 Title
15183 \family default
15184  at the beginning of a chapter/section.
15185  Memoir features a second optional argument and thus separates the table
15186  of contents from the header.
15187  You can define three variants of a title with this: one for the main text,
15188  one for the table of contents, and one for the headers.
15189  Simply insert two optional arguments if you need this feature, the first
15190  one containing the short title for the Table of Contents, the second one
15191  containing an alternative short title for the headers.
15192 \end_layout
15193
15194 \begin_layout Description
15195 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15196  of contents, the list of figures and the list of table start a new page
15197  automatically.
15198  Memoir does not follow this route.
15199  You have to insert a page break yourself, if you want to have one.
15200 \end_layout
15201
15202 \begin_layout Description
15203 Titlepage: For some unknown reason, Memoir uses pagination on the title
15204  page (in the standard classes, title pages are 
15205 \begin_inset Quotes eld
15206 \end_inset
15207
15208 empty
15209 \begin_inset Quotes erd
15210 \end_inset
15211
15212 , i.
15213 \begin_inset ERT
15214 status collapsed
15215
15216 \begin_layout Standard
15217
15218
15219 \backslash
15220 ,
15221 \end_layout
15222
15223 \end_inset
15224
15225 e.
15226 \begin_inset ERT
15227 status collapsed
15228
15229 \begin_layout Standard
15230
15231
15232 \backslash
15233  
15234 \end_layout
15235
15236 \end_inset
15237
15238 without pagina).
15239  If you want an empty title page, type 
15240 \family typewriter
15241
15242 \backslash
15243 aliaspagestyle{title}{empty} 
15244 \family default
15245 in the preamble.
15246 \end_layout
15247
15248 \begin_layout Description
15249 Article: With the class option 
15250 \emph on
15251 article 
15252 \emph default
15253 (to be inserted in 
15254 \family sans
15255 Layout\SpecialChar \menuseparator
15256 Document\SpecialChar \menuseparator
15257 Extra\InsetSpace ~
15258 Options
15259 \family default
15260 ), you can emulate article style.
15261  That is, counters (footnotes, figures, tables etc.) will not be reset on
15262  new chapters, chapters don't start a new page (but are---in contrary to
15263  
15264 \begin_inset Quotes eld
15265 \end_inset
15266
15267 real
15268 \begin_inset Quotes erd
15269 \end_inset
15270
15271  article classes---still allowed), parts, though, use their own page, as
15272  in book.
15273 \end_layout
15274
15275 \begin_layout Description
15276 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15277  font commands, which have been used in the old LaTeX version 2.09 (e.
15278 \begin_inset ERT
15279 status collapsed
15280
15281 \begin_layout Standard
15282
15283
15284 \backslash
15285 ,
15286 \end_layout
15287
15288 \end_inset
15289
15290 g.
15291 \begin_inset ERT
15292 status collapsed
15293
15294 \begin_layout Standard
15295
15296
15297 \backslash
15298  
15299 \end_layout
15300
15301 \end_inset
15302
15303
15304 \family typewriter
15305
15306 \backslash
15307 rm
15308 \family default
15309
15310 \family typewriter
15311
15312 \backslash
15313 it
15314 \family default
15315 ).
15316  It produces an error and stops LaTeX whenever such a command appears.
15317  The class option 
15318 \emph on
15319 oldfontcommands
15320 \emph default
15321  reallows the commands and spits out warnings instead (which does at least
15322  not stop LaTeX).
15323  Since a lot of packages and particularly BibTeX style files are still using
15324  those commands, we have decided to use this option by default.
15325 \end_layout
15326
15327 \begin_layout Subsection
15328 Extra features
15329 \end_layout
15330
15331 \begin_layout Standard
15332 We will only describe the features supported by LyX (which is not much currently
15333 ).
15334  Please consult the Memoir manual
15335 \begin_inset Foot
15336 status collapsed
15337
15338 \begin_layout Standard
15339 Cf.
15340 \begin_inset ERT
15341 status collapsed
15342
15343 \begin_layout Standard
15344
15345
15346 \backslash
15347  
15348 \end_layout
15349
15350 \end_inset
15351
15352
15353 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
15354
15355 \end_inset
15356
15357 .
15358 \end_layout
15359
15360 \end_inset
15361
15362  for details.
15363 \end_layout
15364
15365 \begin_layout Description
15366 Abstract: You may wonder why an abstract is an extra feature.
15367  Well, it is in book class.
15368  Usually books don't have abstracts.
15369  Memoir, however, has.
15370  You can use it whereever and how often you like.
15371 \end_layout
15372
15373 \begin_layout Description
15374 Chapterprecis: You may know this from belletristic: The contents of a chapter
15375  is shortly described below the title and also in the table of contents
15376  (e.
15377 \begin_inset ERT
15378 status collapsed
15379
15380 \begin_layout Standard
15381
15382
15383 \backslash
15384 ,
15385 \end_layout
15386
15387 \end_inset
15388
15389 g.
15390 \begin_inset ERT
15391 status collapsed
15392
15393 \begin_layout Standard
15394
15395
15396 \backslash
15397  
15398 \end_layout
15399
15400 \end_inset
15401
15402
15403 \emph on
15404 Our hero arrives in Troia; he loses some friends; he finds others
15405 \emph default
15406 ).
15407  Chapterprecis does exactly this.
15408  It is therefore only sensible below a chapter.
15409 \end_layout
15410
15411 \begin_layout Description
15412 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15413  The epigraph environment provides an elegant way of typesetting such a
15414  motto.
15415  The motto itself (text) and its author (source) are divided by a short
15416  line.
15417  Unfortunately, we have to fool LyX a bit here again, since the environment
15418  needs two arguments (text and source).
15419  In this case, we have to use curly brackets (in TeX mode) between the two
15420  arguments: 
15421 \emph on
15422 <smart slogan>
15423 \emph default
15424  
15425 \family typewriter
15426 }{
15427 \family default
15428  
15429 \emph on
15430 <author of the slogan>.
15431 \end_layout
15432
15433 \begin_layout Description
15434 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15435  complex figurative poems).
15436  Lyx can only support a few of them.
15437  One is poemtitle, which is a centered title for poems, which will also
15438  be added to the table of contents (verse is the standard environment for
15439  poems.
15440  Memoir has some enhanced versions of verse, but you need to use ERT, because
15441  they have to be nested inside regular verse environments, which is not
15442  possible with LyX).
15443 \end_layout
15444
15445 \begin_layout Description
15446 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15447 \end_layout
15448
15449 \begin_layout Chapter
15450 Importing and Exporting Alternate File Formats
15451 \begin_inset OptArg
15452 status collapsed
15453
15454 \begin_layout Standard
15455 Importing and Exporting
15456 \end_layout
15457
15458 \end_inset
15459
15460
15461 \end_layout
15462
15463 \begin_layout Section
15464 Considerations
15465 \end_layout
15466
15467 \begin_layout Standard
15468 Importing and exporting LyX documents from/to other formats has been touched
15469  on briefly in the 
15470 \emph on
15471 User Guide
15472 \emph default
15473 .
15474  Here we describe more of the gory details needed to understand just what
15475  is going on when you click on the 
15476 \family sans
15477 \bar under
15478 F
15479 \bar default
15480 ile\SpecialChar \menuseparator
15481
15482 \bar under
15483 I
15484 \bar default
15485 mport
15486 \family default
15487  and 
15488 \family sans
15489 \bar under
15490 F
15491 \bar default
15492 ile\SpecialChar \menuseparator
15493 E
15494 \bar under
15495 x
15496 \bar default
15497 port
15498 \family default
15499  menu items.
15500  
15501 \end_layout
15502
15503 \begin_layout Section
15504 Importing Other Formats
15505 \end_layout
15506
15507 \begin_layout Subsection
15508 LaTeX
15509 \end_layout
15510
15511 \begin_layout Standard
15512 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
15513  Although it is a standalone program which can be called from the command
15514  line, LyX will call it automatically when a LaTeX document is imported.
15515  See section\InsetSpace ~
15516
15517 \begin_inset LatexCommand \ref{sec:reLyX}
15518
15519 \end_inset
15520
15521  for a complete description.
15522  There are no user tunable parameters for reLyX within LyX.
15523 \end_layout
15524
15525 \begin_layout Subsection
15526 ASCII Text
15527 \end_layout
15528
15529 \begin_layout Standard
15530 When importing plain ASCII text, there are two methods of reading the file.
15531  Importing 
15532 \begin_inset Quotes eld
15533 \end_inset
15534
15535 as lines
15536 \begin_inset Quotes erd
15537 \end_inset
15538
15539  preserves all the linebreaks in the ASCII; to LyX, then, each line looks
15540  like a paragraph.
15541  Importing 
15542 \begin_inset Quotes eld
15543 \end_inset
15544
15545 as paragraphs
15546 \begin_inset Quotes erd
15547 \end_inset
15548
15549  assumes that consecutive lines separated by only a single linebreak form
15550  a single paragraph.
15551  Successive linebreaks with no intervening text are thus assumed to be paragraph
15552  delimiters.
15553 \end_layout
15554
15555 \begin_layout Subsection
15556 Noweb
15557 \end_layout
15558
15559 \begin_layout Standard
15560
15561 \emph on
15562 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
15563 \end_layout
15564
15565 \begin_layout Section
15566 Exporting Other Formats
15567 \end_layout
15568
15569 \begin_layout Subsection
15570 LaTeX
15571 \end_layout
15572
15573 \begin_layout Standard
15574 LyX generates two types of LaTeX files: stripped down versions for the normal
15575  processing (
15576 \family sans
15577 View DVI
15578 \family default
15579 , etc.) which one normally never sees
15580 \begin_inset Foot
15581 status collapsed
15582
15583 \begin_layout Standard
15584 The resulting file is a perfectly valid LaTeX file, though the preamble
15585  might look a bit strange since it includes some definitions used by LyX
15586  which wouldn't show up in most human-written files.
15587 \end_layout
15588
15589 \end_inset
15590
15591 , and human readable forms which are suitable for exchanging with your colleague
15592 s.
15593  The only settable option for the translation is the line length of the
15594  output file.
15595  The default is 65 characters, but it can be set in 
15596 \family sans
15597 \bar under
15598 T
15599 \bar default
15600 ools
15601 \family default
15602 \SpecialChar \menuseparator
15603
15604 \family sans
15605 \bar under
15606 P
15607 \bar default
15608 references
15609 \family default
15610  using the 
15611 \family sans
15612 \bar under
15613 A
15614 \bar default
15615 scii\InsetSpace ~
15616 line\InsetSpace ~
15617 length
15618 \family default
15619  field.
15620  
15621 \end_layout
15622
15623 \begin_layout Subsection
15624 Device Independent Files
15625 \end_layout
15626
15627 \begin_layout Standard
15628 Device Independent files (DVI files) are produced by running LaTeX on your
15629  document.
15630  There are no user settable options.
15631 \end_layout
15632
15633 \begin_layout Subsection
15634 PostScript®
15635 \end_layout
15636
15637 \begin_layout Standard
15638 The next step in the conversion chain is converting a DVI file into Postscript®.
15639  You can either use 
15640 \family sans
15641 \bar under
15642 F
15643 \bar default
15644 ile
15645 \family default
15646 \SpecialChar \menuseparator
15647
15648 \family sans
15649 \bar under
15650 E
15651 \bar default
15652 xport
15653 \family default
15654 \SpecialChar \menuseparator
15655
15656 \family sans
15657 Pos
15658 \bar under
15659 t
15660 \bar default
15661 script
15662 \family default
15663  or, if you need more control on the result, 
15664 \family sans
15665 \bar under
15666 F
15667 \bar default
15668 ile
15669 \family default
15670 \SpecialChar \menuseparator
15671
15672 \family sans
15673 \bar under
15674 P
15675 \bar default
15676 rint
15677 \family default
15678 .
15679  If you use the later, note that it is possible to configure, in 
15680 \family sans
15681 \bar under
15682 T
15683 \bar default
15684 ools
15685 \family default
15686 \SpecialChar \menuseparator
15687
15688 \family sans
15689 \bar under
15690 P
15691 \bar default
15692 references
15693 \family default
15694 , the options passed to the dvips program to achieve different effects.
15695 \end_layout
15696
15697 \begin_layout Subsection
15698 ASCII text
15699 \end_layout
15700
15701 \begin_layout Standard
15702 Exporting as ASCII attempts to preserve the 
15703 \begin_inset Quotes eld
15704 \end_inset
15705
15706 shape
15707 \begin_inset Quotes erd
15708 \end_inset
15709
15710  of the document as well as possible, but things like centering and indentation
15711  are thrown out; paragraphs are separated by blank lines.
15712  Section numbering and cross-references are done correctly, so the resulting
15713  text files is remarkably readable.
15714  The only changeable option is the length of lines, as for LaTeX output.
15715 \end_layout
15716
15717 \begin_layout Subsection
15718 HTML
15719 \end_layout
15720
15721 \begin_layout Standard
15722 LyX documents can be converted to hypertext markup, usually by converting
15723  to LaTeX first, then converting that to HTML\SpecialChar \@.
15724  Three LaTeX
15725 \begin_inset Formula $\rightarrow$
15726 \end_inset
15727
15728 HTML converters are currently known to LyX: 
15729 \family typewriter
15730 tth
15731 \family default
15732
15733 \family typewriter
15734 latex2html
15735 \family default
15736 , and 
15737 \family typewriter
15738 hevea
15739 \family default
15740 .
15741  Though they are autodetected, you can overide the selection in preferences.
15742  You can also include further command line options in this dialog.
15743  
15744 \end_layout
15745
15746 \begin_layout Subsection
15747 PDF
15748 \end_layout
15749
15750 \begin_layout Standard
15751 by 
15752 \noun on
15753 Dekel Tsur
15754 \noun default
15755  (mostly)
15756 \end_layout
15757
15758 \begin_layout Standard
15759 \begin_inset VSpace bigskip
15760 \end_inset
15761
15762
15763 \end_layout
15764
15765 \begin_layout Standard
15766 The fastest way to generate a basic PDF file (no tags, links, etc.) with
15767  any version of LyX is to save the document as a Postscript® file, then
15768  run the 
15769 \family typewriter
15770 ps2pdf
15771 \family default
15772  command on it.
15773  Starting with version 1.1.6, the menu item 
15774 \family sans
15775 File->Export->PDF
15776 \family default
15777  will do all this for you.
15778  There are some issues with fonts that you need to pay attention to: see
15779  Section\InsetSpace ~
15780
15781 \begin_inset LatexCommand \ref{sec:badfonts}
15782
15783 \end_inset
15784
15785 .
15786  Also, as of version 1.1.6, there is a better method that will generate much
15787  more sophisticated files.
15788 \end_layout
15789
15790 \begin_layout Subsubsection
15791 Use pdfLaTeX
15792 \end_layout
15793
15794 \begin_layout Standard
15795 With pdfLaTeX you need to convert your eps figures to PDF (see Section\InsetSpace ~
15796
15797 \begin_inset LatexCommand \ref{sec:pdfeps}
15798
15799 \end_inset
15800
15801 ), and you cannot use pstricks.
15802  On the other hand, with pdfLaTeX it is possible to insert directly images
15803  in JPEG or PNG format, use TrueType fonts, and more.
15804 \end_layout
15805
15806 \begin_layout Subsubsection
15807 Why does the text look so bad when viewed with Acrobat Reader?
15808 \begin_inset LatexCommand \label{sec:badfonts}
15809
15810 \end_inset
15811
15812
15813 \begin_inset OptArg
15814 status collapsed
15815
15816 \begin_layout Standard
15817 Bad Fonts in Acrobat Reader
15818 \end_layout
15819
15820 \end_inset
15821
15822
15823 \end_layout
15824
15825 \begin_layout Standard
15826 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
15827  When creating a PDF from the LyX file, you need to use outline font instead
15828  of the default bitmap fonts (in fact, you should also use outline fonts
15829  for Postscript files).
15830  Recent LaTeX distributions come with Postscript® Type 1 version of the
15831  standard (Computer Modern) fonts.
15832  pdfLaTeX uses these font by default.
15833  Dvips doesn't use these fonts by default, so to make it use them, add the
15834  following to lines to your 
15835 \family typewriter
15836 ~/.dvipsrc
15837 \family default
15838  file
15839 \end_layout
15840
15841 \begin_layout LyX-Code
15842 p+ psfonts.cmz
15843 \end_layout
15844
15845 \begin_layout LyX-Code
15846 p+ psfonts.amz
15847 \end_layout
15848
15849 \begin_layout Standard
15850 If the default LaTeX font encoding (OT1) is used, nothing else need to be
15851  done.
15852  However, if the T1 font encoding is used, then LaTeX uses the newer EC
15853  fonts, for which there are no Type1 version.
15854  The solution is to use the ae package which emulates T1 coded fonts using
15855  the standard CM fonts.
15856  This is done by adding 
15857 \family typewriter
15858
15859 \backslash
15860 usepackage{ae,aecompl}
15861 \family default
15862  to the preamble of the LyX file.
15863  However, some glyphs are missing from the CM fonts (e.g.
15864  eth, thorn), and they are taken from the EC fonts.
15865  Therefore you get these glyphs as bitmaps.
15866 \end_layout
15867
15868 \begin_layout Standard
15869 Note: LyX uses by default the T1 font encoding.
15870  If you wish to use the default font encoding (this is not recommended,
15871  unless you only write English documents), clear the field 
15872 \family sans
15873 \bar under
15874 T
15875 \bar default
15876 eX\InsetSpace ~
15877 encoding
15878 \family default
15879  in preferences (tabs 
15880 \family sans
15881 Outputs
15882 \family default
15883
15884 \family sans
15885 Misc
15886 \family default
15887 ).
15888  
15889 \end_layout
15890
15891 \begin_layout Standard
15892 An alternate option is to use the standard Postscript® fonts instead of
15893  the Computer Modern fonts.
15894  To do that, you need to select 
15895 \family sans
15896 pslatex
15897 \family default
15898  as the global font in the document layout dialog.
15899  When using the Postscript® fonts, the result PDF file is smaller as the
15900  fonts are not saved into the file.
15901  Furthermore, the Postscript® fonts include all T1 glyphs.
15902  On the other hand, the Postscript® fonts have no bold symbol font, so poor
15903  man's bold must be used (see Section\InsetSpace ~
15904
15905 \begin_inset LatexCommand \ref{sec:pdfbold}
15906
15907 \end_inset
15908
15909 ).
15910  The Postscript® fonts also look different from the Computer Modern fonts.
15911 \end_layout
15912
15913 \begin_layout Standard
15914 To sum up, both the Computer Modern and the Postscript® fonts gives good
15915  results (with few exceptions).
15916  The decision of which one to use is a matter of taste.
15917 \end_layout
15918
15919 \begin_layout Subsubsection
15920 Why doesn't the 
15921 \backslash
15922 boldsymbol{} command work when I use pslatex?
15923 \begin_inset LatexCommand \label{sec:pdfbold}
15924
15925 \end_inset
15926
15927
15928 \begin_inset OptArg
15929 status collapsed
15930
15931 \begin_layout Standard
15932
15933 \family typewriter
15934
15935 \backslash
15936 boldsymbol{}
15937 \family default
15938  and 
15939 \family typewriter
15940 pslatex
15941 \end_layout
15942
15943 \end_inset
15944
15945
15946 \end_layout
15947
15948 \begin_layout Standard
15949 The Postscript® fonts do not have a bold symbol font.
15950  The solution is to use the 
15951 \family typewriter
15952
15953 \backslash
15954 pmb{}
15955 \family default
15956  (poor man's bold) command.
15957 \end_layout
15958
15959 \begin_layout Standard
15960 It is possible to redefine the 
15961 \family typewriter
15962
15963 \backslash
15964 boldsymbol
15965 \family default
15966  command to use 
15967 \family typewriter
15968
15969 \backslash
15970 pmb
15971 \family default
15972  by putting
15973 \end_layout
15974
15975 \begin_layout LyX-Code
15976
15977 \backslash
15978 renewcommand{
15979 \backslash
15980 boldsymbol}[1]{
15981 \backslash
15982 pmb{#1}}
15983 \end_layout
15984
15985 \begin_layout Standard
15986 in the preamble.
15987 \end_layout
15988
15989 \begin_layout Subsubsection
15990 Is it possible to do write latex code which is processed only when running
15991  pdfLaTeX?
15992 \begin_inset OptArg
15993 status collapsed
15994
15995 \begin_layout Standard
15996 Conditionals with pdfLaTeX
15997 \end_layout
15998
15999 \end_inset
16000
16001
16002 \end_layout
16003
16004 \begin_layout Standard
16005 Yes.
16006  Here is an example:
16007 \end_layout
16008
16009 \begin_layout LyX-Code
16010
16011 \backslash
16012 newif 
16013 \backslash
16014 ifpdf
16015 \end_layout
16016
16017 \begin_layout LyX-Code
16018    
16019 \backslash
16020 ifx 
16021 \backslash
16022 pdfoutput 
16023 \backslash
16024 undefined
16025 \end_layout
16026
16027 \begin_layout LyX-Code
16028       
16029 \backslash
16030 pdffalse
16031 \end_layout
16032
16033 \begin_layout LyX-Code
16034    
16035 \backslash
16036 else
16037 \end_layout
16038
16039 \begin_layout LyX-Code
16040       
16041 \backslash
16042 pdftrue
16043 \end_layout
16044
16045 \begin_layout LyX-Code
16046
16047 \backslash
16048 fi
16049 \end_layout
16050
16051 \begin_layout LyX-Code
16052
16053 \end_layout
16054
16055 \begin_layout LyX-Code
16056
16057 \backslash
16058 ifpdf
16059 \end_layout
16060
16061 \begin_layout LyX-Code
16062    
16063 \backslash
16064 pdfinfo { /Author (your name and e-mail address)
16065 \end_layout
16066
16067 \begin_layout LyX-Code
16068       /Title (official title -- i.e., title element)
16069 \end_layout
16070
16071 \begin_layout LyX-Code
16072       /Subject (one line description of the document)
16073 \end_layout
16074
16075 \begin_layout LyX-Code
16076    }
16077 \end_layout
16078
16079 \begin_layout LyX-Code
16080    
16081 \backslash
16082 pdfcatalog { /PageMode (/UseNone)
16083 \end_layout
16084
16085 \begin_layout LyX-Code
16086    % /OpenAction (fitbh)
16087 \end_layout
16088
16089 \begin_layout LyX-Code
16090    }
16091 \end_layout
16092
16093 \begin_layout LyX-Code
16094    
16095 \backslash
16096 usepackage[pdftex]{hyperref}
16097 \end_layout
16098
16099 \begin_layout LyX-Code
16100
16101 \backslash
16102 else
16103 \end_layout
16104
16105 \begin_layout LyX-Code
16106    
16107 \backslash
16108 usepackage[ps2pdf]{hyperref}
16109 \end_layout
16110
16111 \begin_layout LyX-Code
16112
16113 \backslash
16114 fi
16115 \end_layout
16116
16117 \begin_layout Subsubsection
16118 How can I make URLs clickable ?
16119 \end_layout
16120
16121 \begin_layout Standard
16122 See the references here :
16123 \end_layout
16124
16125 \begin_layout Standard
16126 \begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
16127
16128 \end_inset
16129
16130
16131 \end_layout
16132
16133 \begin_layout Subsection
16134 Custom
16135 \end_layout
16136
16137 \begin_layout Standard
16138 Custom exports are possible if you have some particularly weird format you
16139  wish to convert to, assuming you have the relevant converter, of course.
16140  The format of the 
16141 \emph on
16142 input
16143 \emph default
16144  file can be chosen in the 
16145 \family sans
16146 \bar under
16147 F
16148 \bar default
16149 ile\SpecialChar \menuseparator
16150
16151 \bar under
16152 E
16153 \bar default
16154 xport\SpecialChar \menuseparator
16155
16156 \bar under
16157 C
16158 \bar default
16159 ustom 
16160 \family default
16161 dialog; LyX will automatically convert the file to this point, then feed
16162  it to your custom converter.
16163  The possible values are all formats that LyX can produce from its own documents.
16164  
16165 \end_layout
16166
16167 \begin_layout Standard
16168 The converter command is also specified in the dialog.It should be a completely
16169  qualified command line which uses the variable 
16170 \family typewriter
16171 $$FName
16172 \family default
16173  to specify the name of the file.
16174  If this variable is not given, then the file will be sent to the standard
16175  input of your command.
16176  You may have to apply a bit of ingenuity to escape this sequence correctly
16177  so that it is compatible with your shell.
16178  
16179 \end_layout
16180
16181 \begin_layout Standard
16182 While it is not possible to save this command using the 
16183 \family sans
16184 Preferences 
16185 \family default
16186 dialog, you can manually edit your 
16187 \family typewriter
16188 .lyx/preferences
16189 \family default
16190  to add a line like
16191 \end_layout
16192
16193 \begin_layout LyX-Code
16194
16195 \backslash
16196 custom_export_command "mycommand $$FName"
16197 \end_layout
16198
16199 \begin_layout Section
16200 The Complete reLyX Description
16201 \begin_inset LatexCommand \label{sec:reLyX}
16202
16203 \end_inset
16204
16205
16206 \end_layout
16207
16208 \begin_layout Subsection
16209 Synopsis
16210 \end_layout
16211
16212 \begin_layout Standard
16213 The simplest way to use reLyX is via the 
16214 \family sans
16215 \bar under
16216 F
16217 \bar default
16218 ile\SpecialChar \menuseparator
16219
16220 \bar under
16221 I
16222 \bar default
16223 mport
16224 \family default
16225  command in LyX.
16226  That runs reLyX on the given file and loads the resulting file into LyX.
16227  You should try that first, and call it from the command line only if you
16228  need to use more complicated options.
16229 \end_layout
16230
16231 \begin_layout Standard
16232
16233 \series bold
16234 reLyX
16235 \series default
16236  [ 
16237 \series bold
16238 -c
16239 \series default
16240  
16241 \shape italic
16242 textclass
16243 \shape default
16244  ] [ 
16245 \series bold
16246 -df
16247 \series default
16248  ] [ 
16249 \series bold
16250 -o
16251 \series default
16252  
16253 \shape italic
16254 outputdir
16255 \shape default
16256  ] [
16257 \series bold
16258  -r
16259 \series default
16260 \shape italic
16261  renv1
16262 \shape default
16263 [,
16264 \shape italic
16265 renv2
16266 \shape default
16267 ...]] [
16268 \series bold
16269  -s
16270 \series default
16271 \shape italic
16272  sfile1
16273 \shape default
16274 [,
16275 \shape italic
16276 sfile2
16277 \shape default
16278 ...]] 
16279 \emph on
16280 inputfile
16281 \end_layout
16282
16283 \begin_layout Standard
16284
16285 \series bold
16286 reLyX
16287 \series default
16288  
16289 \series bold
16290 -p
16291 \series default
16292  
16293 \series bold
16294 -c
16295 \series default
16296  
16297 \shape italic
16298 textclass
16299 \shape default
16300  [ 
16301 \series bold
16302 -df
16303 \series default
16304  ] [ 
16305 \series bold
16306 -o
16307 \series default
16308  
16309 \shape italic
16310 outputdir
16311 \shape default
16312  ] [
16313 \series bold
16314  -r
16315 \series default
16316 \shape italic
16317  renv1
16318 \shape default
16319 [,
16320 \shape italic
16321 renv2
16322 \shape default
16323 ...]] [
16324 \series bold
16325  -s
16326 \series default
16327 \shape italic
16328  sfile1
16329 \shape default
16330 [,
16331 \shape italic
16332 sfile2
16333 \shape default
16334 ...]] 
16335 \emph on
16336 inputfiles
16337 \end_layout
16338
16339 \begin_layout Standard
16340
16341 \series bold
16342 reLyX
16343 \series default
16344  
16345 \series bold
16346 -h
16347 \end_layout
16348
16349 \begin_layout Subsection
16350 Options
16351 \end_layout
16352
16353 \begin_layout Description
16354
16355 \series bold
16356 -c
16357 \series default
16358  Class.
16359  By default, when reLyX sees a 
16360 \family typewriter
16361
16362 \backslash
16363 documentclass{foo}
16364 \family default
16365  command, it creates a file of textclass 
16366 \begin_inset Quotes eld
16367 \end_inset
16368
16369 foo
16370 \begin_inset Quotes erd
16371 \end_inset
16372
16373  and reads the LyX layout file for that class.
16374   Use 
16375 \series bold
16376 -c
16377 \series default
16378  to declare a different textclass (and read a different layout file).
16379 \end_layout
16380
16381 \begin_layout Description
16382
16383 \series bold
16384 -d
16385 \series default
16386  Debug.
16387  By default, reLyX gives sparse output and deletes the temporary files which
16388  were created during translation.
16389  Using the 
16390 \series bold
16391 -d
16392 \series default
16393  flag will create much more output (both to stdout and stderr) and leave
16394  the temporary files around.
16395 \end_layout
16396
16397 \begin_layout Description
16398
16399 \series bold
16400 -f
16401 \series default
16402  Force.
16403  reLyX will not run if the 
16404 \family typewriter
16405 .lyx
16406 \family default
16407  file it would generate already exists Use the 
16408 \series bold
16409 -f
16410 \series default
16411  option (carefully) to clobber any existing files.
16412 \end_layout
16413
16414 \begin_layout Description
16415
16416 \series bold
16417 -h
16418 \series default
16419  Help.
16420  Print out usage information and quit
16421 \end_layout
16422
16423 \begin_layout Description
16424
16425 \series bold
16426 -o
16427 \series default
16428  Output directory.
16429  With this option, all temporary files and LyX output files (for the given
16430  input file, for any included files, or for any file fragments given with
16431  the 
16432 \series bold
16433 -p
16434 \series default
16435  option) will be put into 
16436 \shape italic
16437 outputdir
16438 \shape default
16439 .
16440  Otherwise, for each file 
16441 \emph on
16442 dir/foo.tex
16443 \emph default
16444 , the temporary files and the LyX output file will be created in 
16445 \emph on
16446 dir
16447 \emph default
16448 .
16449  This can be useful if a file includes files from other directories which
16450  you want to consolidate in one directory, or if you don't have write permission
16451  on the directory the LaTeX files are in.
16452 \end_layout
16453
16454 \begin_layout Description
16455
16456 \series bold
16457 -p
16458 \series default
16459  Partial file.
16460  The input files are LaTeX fragments, with no preamble matter or 
16461 \family typewriter
16462
16463 \backslash
16464 begin{document}
16465 \family default
16466  commands.
16467  This option requires the 
16468 \series bold
16469 -c
16470 \series default
16471  option, since there are no 
16472 \family typewriter
16473
16474 \backslash
16475 documentclass
16476 \family default
16477  commands in the files reLyX is translating.
16478  When using this option, you can translate more than one file, as long as
16479  all files are the same class.
16480  The LyX file created by reLyX can be included in an existing LyX file using
16481  
16482 \family sans
16483 \bar under
16484 I
16485 \bar default
16486 nsert\SpecialChar \menuseparator
16487 Fil
16488 \bar under
16489 e
16490 \bar default
16491 \SpecialChar \menuseparator
16492 Ly
16493 \bar under
16494 X
16495 \bar default
16496 \InsetSpace ~
16497 Document
16498 \family default
16499 .
16500 \end_layout
16501
16502 \begin_layout Description
16503
16504 \series bold
16505 -r
16506 \series default
16507  Regular environments (see the Section\InsetSpace ~
16508
16509 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16510
16511 \end_inset
16512
16513 ).
16514   If you give more than one environment, separate them with commas (not
16515  spaces).
16516  You'll probably need to quote the environment list, especially if it has
16517  asterisk environments (foo*) in it.
16518  If you use this command often, considering creating a personal syntax file.
16519 \end_layout
16520
16521 \begin_layout Description
16522
16523 \series bold
16524 -s
16525 \series default
16526  Syntax files.
16527  Input (one or more quoted, comma-separated) syntax files to read in addition
16528  to the default.
16529  (see the section Section\InsetSpace ~
16530
16531 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16532
16533 \end_inset
16534
16535  for details).
16536 \end_layout
16537
16538 \begin_layout Subsection
16539 Description
16540 \end_layout
16541
16542 \begin_layout Subsubsection
16543 Introduction
16544 \end_layout
16545
16546 \begin_layout Standard
16547 reLyX will create a LyX file 
16548 \emph on
16549 dir/foo.lyx
16550 \emph default
16551  from the LaTeX file 
16552 \emph on
16553 dir/foo.tex
16554 \emph default
16555  (unless the 
16556 \series bold
16557 -o
16558 \series default
16559  option is used).
16560 \end_layout
16561
16562 \begin_layout Standard
16563 Suffixes 
16564 \family typewriter
16565 .tex
16566 \family default
16567
16568 \family typewriter
16569 .ltx
16570 \family default
16571  and 
16572 \family typewriter
16573 .latex
16574 \family default
16575  are supported.
16576  If 
16577 \emph on
16578 inputfile
16579 \emph default
16580  does not exist and does not have one of these suffixes, reLyX will try
16581  to translate 
16582 \emph on
16583 inputfile.tex
16584 \emph default
16585 .
16586  (This is similar to the behavior of LaTeX.)
16587 \end_layout
16588
16589 \begin_layout Standard
16590 The purpose of reLyX is to translate 
16591 \shape italic
16592 well-behaved
16593 \shape default
16594  LaTeX2e into LyX.
16595  If your LaTeX file doesn't compile---or if you do weird things, like redefining
16596  standard LaTeX commands---it may choke.
16597  LaTeX209 will often be translated correctly, but it's not guaranteed.
16598 \end_layout
16599
16600 \begin_layout Standard
16601 reLyX has some bugs and lacks a few features.
16602  However, its main goals are:
16603 \end_layout
16604
16605 \begin_layout Itemize
16606 Get through a well-behaved LaTeX2e file without crashing
16607 \end_layout
16608
16609 \begin_layout Itemize
16610 Translate a lot of that file.
16611 \end_layout
16612
16613 \begin_layout Itemize
16614 Localize the parts that can't be translated and copy them in TeX mode
16615 \end_layout
16616
16617 \begin_layout Standard
16618 It achieves these main goals pretty well on most files.
16619 \end_layout
16620
16621 \begin_layout Standard
16622 There are many improvements that can and will be made to reLyX in the future.
16623  However, we wanted to get reLyX out there early on, to make it easier for
16624  new LyX users to read in their existing LaTeX files.
16625 \end_layout
16626
16627 \begin_layout Subsubsection
16628 Usage
16629 \end_layout
16630
16631 \begin_layout Standard
16632 Here's a more lengthy description of what you should do to translate a LaTeX
16633  document into LyX.
16634 \end_layout
16635
16636 \begin_layout Itemize
16637 Run reLyX.
16638 \end_layout
16639
16640 \begin_deeper
16641 \begin_layout Standard
16642 reLyX will inform you of its progress and give any warnings to stderr, so
16643  if you don't want any output at all, try (in csh) 
16644 \begin_inset Quotes eld
16645 \end_inset
16646
16647
16648 \family typewriter
16649 reLyX foo.tex >& /dev/null
16650 \family default
16651
16652 \begin_inset Quotes erd
16653 \end_inset
16654
16655  or (in bash) 
16656 \begin_inset Quotes eld
16657 \end_inset
16658
16659
16660 \family typewriter
16661 reLyX foo.tex
16662 \family default
16663  
16664 \family typewriter
16665 2>&1 >/dev/null
16666 \family default
16667
16668 \begin_inset Quotes erd
16669 \end_inset
16670
16671 .
16672  You should NOT redirect standard output to 
16673 \family typewriter
16674 foo.lyx
16675 \family default
16676 .
16677  
16678 \end_layout
16679
16680 \end_deeper
16681 \begin_layout Itemize
16682 Run LyX on the resulting .lyx file.
16683 \end_layout
16684
16685 \begin_deeper
16686 \begin_layout Standard
16687 In theory, most of the file will have been translated, and anything that's
16688  untranslatable will be highlighted in red (TeX mode).
16689  In theory, LyX will be able to read in the file, and to create printed
16690  documents from it, because all that untranslated red stuff will be passed
16691  directly back to LaTeX, which LyX  uses as a backend.
16692  Unfortunately, reality doesn't always reflect theory.
16693  If reLyX crashes, or LyX cannot read the generated LyX file, see Section\InsetSpace ~
16694
16695 \begin_inset LatexCommand \ref{sub:relyx-bugs}
16696
16697 \end_inset
16698
16699  or the 
16700 \family typewriter
16701 BUGS
16702 \family default
16703  file.
16704 \end_layout
16705
16706 \end_deeper
16707 \begin_layout Itemize
16708 Change things that are in ERT boxes (TeX code) by hand in LyX.
16709 \end_layout
16710
16711 \begin_deeper
16712 \begin_layout Standard
16713 As mentioned above, you should be able to print out the LyX file even without
16714  doing this.
16715  However, changing a command in TeX mode to the corresponding LyX object
16716  will allow you to take advantage of LyX's WYSIWYM editing.
16717 \end_layout
16718
16719 \begin_layout Standard
16720 reLyX is not guaranteed to create a LyX file which generates exactly the
16721  same output as the LaTeX file, but it should come close.
16722  reLyX will generally err on the side of translating less to ensure that
16723  dvi or ps files are accurate, even though this leads to more 
16724 \begin_inset Quotes eld
16725 \end_inset
16726
16727 evil red text
16728 \begin_inset Quotes erd
16729 \end_inset
16730
16731  and less WYSIWYM.
16732 \end_layout
16733
16734 \end_deeper
16735 \begin_layout Itemize
16736 PROOFREAD THE DOCUMENT!!
16737 \end_layout
16738
16739 \begin_deeper
16740 \begin_layout Standard
16741 I'm sure you were planning on doing this anyway, but it's particularly important
16742  after translating a LaTeX document.
16743  reLyX is, at least now, better at 
16744 \begin_inset Quotes eld
16745 \end_inset
16746
16747 macro-translating
16748 \begin_inset Quotes erd
16749 \end_inset
16750
16751  (translating the whole document) than 
16752 \begin_inset Quotes eld
16753 \end_inset
16754
16755 micro-translating
16756 \begin_inset Quotes erd
16757 \end_inset
16758
16759  (translating every little detail).
16760  For example, you may see extra spaces or deleted spaces.
16761  Space handling has improved, but it's not perfect.
16762 \end_layout
16763
16764 \end_deeper
16765 \begin_layout Subsubsection
16766 What reLyX Can Handle
16767 \end_layout
16768
16769 \begin_layout Standard
16770 reLyX understands many LaTeX commands.
16771  It will translate:
16772 \end_layout
16773
16774 \begin_layout Itemize
16775 regular text, including mini-commands like ~, '', 
16776 \family typewriter
16777
16778 \backslash
16779 @
16780 \family default
16781
16782 \family typewriter
16783
16784 \backslash
16785 TeX
16786 \family default
16787 , as well as accented characters like 
16788 \family typewriter
16789
16790 \backslash
16791 '{a}
16792 \family default
16793 , and the special cases ?` and !`
16794 \end_layout
16795
16796 \begin_layout Itemize
16797 title commands like 
16798 \family typewriter
16799
16800 \backslash
16801 author
16802 \family default
16803
16804 \family typewriter
16805
16806 \backslash
16807 date
16808 \family default
16809
16810 \family typewriter
16811
16812 \backslash
16813 title
16814 \family default
16815
16816 \family typewriter
16817
16818 \backslash
16819 thanks
16820 \family default
16821  and the abstract environment
16822 \end_layout
16823
16824 \begin_layout Itemize
16825 heading commands like 
16826 \family typewriter
16827
16828 \backslash
16829 section
16830 \family default
16831  including starred commands (
16832 \family typewriter
16833
16834 \backslash
16835 section*
16836 \family default
16837 )
16838 \end_layout
16839
16840 \begin_layout Itemize
16841 Environments: 
16842 \family typewriter
16843 quote
16844 \family default
16845
16846 \family typewriter
16847 quotation
16848 \family default
16849 , and 
16850 \family typewriter
16851 verse
16852 \family default
16853
16854 \family typewriter
16855 center
16856 \family default
16857
16858 \family typewriter
16859 flushright
16860 \family default
16861 , and 
16862 \family typewriter
16863 flushleft
16864 \end_layout
16865
16866 \begin_layout Itemize
16867
16868 \family typewriter
16869 itemize
16870 \family default
16871
16872 \family typewriter
16873 enumerate
16874 \family default
16875 , and 
16876 \family typewriter
16877 description
16878 \family default
16879  environments, and their 
16880 \family typewriter
16881
16882 \backslash
16883 item
16884 \family default
16885  commands.
16886  Also, well-behaved nested lists
16887 \end_layout
16888
16889 \begin_layout Itemize
16890 cross-referencing commands: 
16891 \family typewriter
16892
16893 \backslash
16894 ref
16895 \family default
16896
16897 \family typewriter
16898
16899 \backslash
16900 pageref
16901 \family default
16902
16903 \family typewriter
16904
16905 \backslash
16906 label
16907 \family default
16908 , and 
16909 \family typewriter
16910
16911 \backslash
16912 cite
16913 \end_layout
16914
16915 \begin_layout Itemize
16916
16917 \family typewriter
16918
16919 \backslash
16920 footnote
16921 \family default
16922  and 
16923 \family typewriter
16924
16925 \backslash
16926 margin
16927 \end_layout
16928
16929 \begin_layout Itemize
16930 font-changing commands including 
16931 \family typewriter
16932
16933 \backslash
16934 em
16935 \family default
16936
16937 \family typewriter
16938
16939 \backslash
16940 emph
16941 \family default
16942
16943 \family typewriter
16944
16945 \backslash
16946 textit
16947 \family default
16948 , and corresponding commands to change family, size, series, and shape
16949 \end_layout
16950
16951 \begin_layout Itemize
16952
16953 \family typewriter
16954
16955 \backslash
16956 input{foo}
16957 \family default
16958  (or 
16959 \family typewriter
16960
16961 \backslash
16962 input{foo.blah}
16963 \family default
16964 ) and 
16965 \family typewriter
16966
16967 \backslash
16968 include{foo}
16969 \family default
16970 .
16971  Plain TeX 
16972 \family typewriter
16973
16974 \backslash
16975 input
16976 \family default
16977  command 
16978 \begin_inset Quotes erd
16979 \end_inset
16980
16981
16982 \family typewriter
16983
16984 \backslash
16985 input foo.tex
16986 \family default
16987
16988 \begin_inset Quotes erd
16989 \end_inset
16990
16991  is also supported.
16992 \end_layout
16993
16994 \begin_layout Itemize
16995
16996 \family typewriter
16997 tabular
16998 \family default
16999  environment, and commands that go inside it like 
17000 \family typewriter
17001
17002 \backslash
17003 hline
17004 \family default
17005
17006 \family typewriter
17007
17008 \backslash
17009 cline
17010 \family default
17011 , and 
17012 \family typewriter
17013
17014 \backslash
17015 multicolumn
17016 \family default
17017  (but see below)
17018 \end_layout
17019
17020 \begin_layout Itemize
17021 float environments 
17022 \family typewriter
17023 table
17024 \family default
17025  and 
17026 \family typewriter
17027 table*
17028 \family default
17029 , as well as 
17030 \family typewriter
17031
17032 \backslash
17033 caption
17034 \family default
17035  commands within them
17036 \end_layout
17037
17038 \begin_layout Itemize
17039
17040 \family typewriter
17041 thebibliography
17042 \family default
17043  environment and 
17044 \family typewriter
17045
17046 \backslash
17047 bibitem
17048 \family default
17049  command, as well as BibTeX's 
17050 \family typewriter
17051
17052 \backslash
17053 bibliography
17054 \family default
17055  and 
17056 \family typewriter
17057
17058 \backslash
17059 bibliographystyle
17060 \family default
17061  commands
17062 \end_layout
17063
17064 \begin_layout Itemize
17065 miscellaneous commands: 
17066 \family typewriter
17067
17068 \backslash
17069 hfill
17070 \family default
17071
17072 \family typewriter
17073
17074 \backslash
17075
17076 \backslash
17077
17078 \family default
17079
17080 \family typewriter
17081
17082 \backslash
17083 noindent
17084 \family default
17085
17086 \family typewriter
17087
17088 \backslash
17089 ldots
17090 \family default
17091 ...
17092 \end_layout
17093
17094 \begin_layout Itemize
17095 documentclass-specific environments (and some commands) which can be  translated
17096  to LyX layouts
17097 \end_layout
17098
17099 \begin_layout Itemize
17100 arguments to certain untranslatable commands (e.g.
17101  
17102 \family typewriter
17103
17104 \backslash
17105 mbox
17106 \family default
17107 )
17108 \end_layout
17109
17110 \begin_layout Standard
17111 Some of this support may not be 100% yet.
17112  See below for details
17113 \end_layout
17114
17115 \begin_layout Standard
17116 reLyX copies math (almost) verbatim from your LaTeX file.
17117  Luckily, LyX reads  in LaTeX math, so (almost) any math which is supported
17118  by LyX should work just fine.
17119  A few math commands which are not supported by LyX will be replaced with
17120  their equivalents, e.g., 
17121 \family typewriter
17122
17123 \backslash
17124 to
17125 \family default
17126  is converted to 
17127 \family typewriter
17128
17129 \backslash
17130 rightarrow
17131 \family default
17132 .
17133  See the section on 
17134 \shape italic
17135 Syntax Files
17136 \shape default
17137  for more details.
17138 \end_layout
17139
17140 \begin_layout Standard
17141 reLyX will also copy any preamble commands (i.e., anything before 
17142 \family typewriter
17143
17144 \backslash
17145 begin{document}
17146 \family default
17147 ) verbatim, so fancy stuff you've got in your preamble should be conserved
17148  in dvi and printed documents, although it will not of course show up in
17149  the LyX window.
17150  Check the preamble to make sure.
17151 \end_layout
17152
17153 \begin_layout Subsubsection
17154 What reLyX Can't Handle --- But it's OK
17155 \end_layout
17156
17157 \begin_layout Itemize
17158 figures and 
17159 \family typewriter
17160 tabular*
17161 \family default
17162  tables
17163 \end_layout
17164
17165 \begin_layout Itemize
17166 minipages
17167 \end_layout
17168
17169 \begin_layout Itemize
17170 spacing commands (
17171 \family typewriter
17172
17173 \backslash
17174 vspace
17175 \family default
17176
17177 \family typewriter
17178
17179 \backslash
17180 pagebreak
17181 \family default
17182
17183 \family typewriter
17184
17185 \backslash
17186 par
17187 \family default
17188 )
17189 \end_layout
17190
17191 \begin_layout Itemize
17192
17193 \family typewriter
17194
17195 \backslash
17196 centering
17197 \family default
17198
17199 \family typewriter
17200
17201 \backslash
17202 raggedleft
17203 \family default
17204
17205 \family typewriter
17206
17207 \backslash
17208 raggedright
17209 \end_layout
17210
17211 \begin_layout Itemize
17212
17213 \family typewriter
17214
17215 \backslash
17216 verb
17217 \family default
17218  and 
17219 \family typewriter
17220 verbatim
17221 \family default
17222  environment.
17223  reLyX is careful to copy 
17224 \shape italic
17225 exactly
17226 \shape default
17227  in this case, including comments and whitespace.
17228 \end_layout
17229
17230 \begin_layout Itemize
17231 some unknown (e.g., user-defined) environments and commands
17232 \end_layout
17233
17234 \begin_layout Standard
17235 reLyX copies unknown commands, along with their arguments, verbatim into
17236  the LyX file.
17237  Also, if it sees a 
17238 \family typewriter
17239
17240 \backslash
17241 begin{foo}
17242 \family default
17243  where it doesn't recognize the 
17244 \begin_inset Quotes eld
17245 \end_inset
17246
17247 foo
17248 \begin_inset Quotes erd
17249 \end_inset
17250
17251  environment, it will copy verbatim until it sees 
17252 \family typewriter
17253
17254 \backslash
17255 end{foo}
17256 \family default
17257  (unless you use the 
17258 \series bold
17259 -r
17260 \series default
17261  option).
17262  Hopefully, then, most of these unknown commands won't cause reLyX to break;
17263  they'll merely require you to do some editing once you've loaded the file
17264  up in LyX.
17265   That should be less painful than editing either the 
17266 \family typewriter
17267 .tex
17268 \family default
17269  or the 
17270 \family typewriter
17271 .lyx
17272 \family default
17273  file using a text editor.
17274 \end_layout
17275
17276 \begin_layout Subsubsection
17277 What reLyX Handles Badly --- a.\InsetSpace ~
17278 k.\InsetSpace ~
17279 a.
17280  BUGS
17281 \begin_inset LatexCommand \label{sub:relyx-bugs}
17282
17283 \end_inset
17284
17285
17286 \end_layout
17287
17288 \begin_layout Standard
17289 Since reLyX is relatively new, it's got a number of problems.
17290   As it matures, these bugs will be squished.
17291  A number of bugs and missing features can be found listed on the LyX bug
17292  tracker, 
17293 \begin_inset LatexCommand \url[LyX Bugzilla]{http://bugzilla.lyx.org/}
17294
17295 \end_inset
17296
17297 .
17298 \end_layout
17299
17300 \begin_layout Standard
17301 If reLyX is choking on something, or LyX can't read it after reLyX translates
17302  it, the best thing to do is to put 
17303 \family typewriter
17304
17305 \backslash
17306 begin{reLyXskip}
17307 \family default
17308  before the offending text, and 
17309 \family typewriter
17310
17311 \backslash
17312 end{reLyXskip}
17313 \family default
17314  after it.
17315  I call this a 
17316 \begin_inset Quotes eld
17317 \end_inset
17318
17319 skip
17320 \begin_inset Quotes erd
17321 \end_inset
17322
17323  block.
17324  reLyX will copy this block exactly, in TeX mode.
17325  Then edit the resulting LyX file, and translate the unknown stuff by hand.
17326  The 
17327 \family typewriter
17328 reLyXskip
17329 \family default
17330  environment is magical; the 
17331 \family typewriter
17332
17333 \backslash
17334 begin
17335 \family default
17336  and 
17337 \family typewriter
17338
17339 \backslash
17340 end
17341 \family default
17342  commands will not be put into the LyX file.
17343 \end_layout
17344
17345 \begin_layout Itemize
17346 \begin_inset Quotes eld
17347 \end_inset
17348
17349 Exact
17350 \begin_inset Quotes erd
17351 \end_inset
17352
17353  copying of unknown environments and commands isn't quite exact.
17354  Specifically, newlines and comments may be lost.
17355  This will yield ugly LyX, but in almost all cases the output will be the
17356  same.
17357  However, certain parts of the file will be copied perfectly, including
17358  whitespace and comments.
17359  This includes: the LaTeX preamble, 
17360 \family typewriter
17361 verbatim
17362 \family default
17363  environments and 
17364 \family typewriter
17365
17366 \backslash
17367 verb
17368 \family default
17369  commands, and skip blocks.
17370 \end_layout
17371
17372 \begin_layout Itemize
17373 reLyX translates only a few options to the 
17374 \family typewriter
17375
17376 \backslash
17377 documentclass
17378 \family default
17379  command.
17380  (Specifically 1[012]pt, [letter|legal|executive|a4|a5|b5]paper, [one|two]side,
17381  landscape, and [one|two]column.) Other options are placed in the extra class
17382  options field in the 
17383 \family sans
17384 \bar under
17385 D
17386 \bar default
17387 ocument\SpecialChar \menuseparator
17388
17389 \bar under
17390 S
17391 \bar default
17392 ettings
17393 \family default
17394  dialog.
17395 \end_layout
17396
17397 \begin_deeper
17398 \begin_layout Standard
17399 More importantly, reLyX doesn't translate 
17400 \family typewriter
17401
17402 \backslash
17403 usepackage
17404 \family default
17405  commands, margin  commands, 
17406 \family typewriter
17407
17408 \backslash
17409 newcommand
17410 \family default
17411 s, or, in fact, anything else from the preamble.
17412  It simply copies them into the LaTeX preamble.
17413  If you have margin commands in your preamble, then the LyX file will generate
17414  the right margins.
17415  However, these margins will override any margins you set in the LyX 
17416 \family sans
17417 \bar under
17418 D
17419 \bar default
17420 ocument
17421 \bar under
17422 \SpecialChar \menuseparator
17423 S
17424 \bar default
17425 ettings
17426 \family default
17427  dialog.
17428  So you should remove the options from the preamble to be safe.
17429  The same goes for setting your language with babel, 
17430 \family typewriter
17431
17432 \backslash
17433 inputencoding
17434 \family default
17435
17436 \family typewriter
17437
17438 \backslash
17439 pagestyle
17440 \family default
17441 , etc.
17442 \end_layout
17443
17444 \end_deeper
17445 \begin_layout Itemize
17446 The foil class has a couple bugs.
17447  reLyX may do weird things with optional arguments to 
17448 \family typewriter
17449
17450 \backslash
17451 foilhead
17452 \family default
17453  commands.
17454  Also, it may handle 
17455 \family typewriter
17456
17457 \backslash
17458 begin{dinglist}
17459 \family default
17460  incorrectly (although the stuff in the environment should translate normally).
17461 \end_layout
17462
17463 \begin_layout Standard
17464 reLyX is hopefully rather robust.
17465  As mentioned above, it may not translate your file perfectly, but it shouldn't
17466  crash.
17467  If it does crash---and the problem is not one of those mentioned above
17468  or in the 
17469 \emph on
17470 BUGS
17471 \emph default
17472  file---see Section\InsetSpace ~
17473
17474 \begin_inset LatexCommand \ref{sub:relyx-bug-reports}
17475
17476 \end_inset
17477
17478 .
17479 \end_layout
17480
17481 \begin_layout Subsubsection
17482 What LyX Can't Handle
17483 \end_layout
17484
17485 \begin_layout Standard
17486 LyX itself is missing a couple features, such that even if reLyX translates
17487  things perfectly, LyX may still have trouble reading it.
17488  If you really need these features, you can export your final document as
17489  LaTeX, and put them back in.
17490  See 
17491 \emph on
17492 BUGS
17493 \emph default
17494  for more details on these bugs.
17495 \end_layout
17496
17497 \begin_layout Itemize
17498 For a number of commands, LyX does not support the optional argument.
17499  Examples include 
17500 \family typewriter
17501
17502 \backslash
17503 sqrt
17504 \family default
17505
17506 \family typewriter
17507
17508 \backslash
17509 chapter
17510 \family default
17511  (and other sectioning commands), and 
17512 \family typewriter
17513
17514 \backslash
17515
17516 \backslash
17517
17518 \family default
17519 .
17520  reLyX will automatically discard the optional arguments with a warning
17521  to stdout.
17522  LyX also ignores the width argument for the 
17523 \family typewriter
17524 thebibliography
17525 \family default
17526  environment.
17527 \end_layout
17528
17529 \begin_layout Itemize
17530 Centering (or right or left justifying) works on full paragraphs.
17531 \end_layout
17532
17533 \begin_layout Itemize
17534 LyX support for tables isn't perfect.
17535  For complicated tables, use a 
17536 \begin_inset Quotes eld
17537 \end_inset
17538
17539 skip
17540 \begin_inset Quotes erd
17541 \end_inset
17542
17543  block, so that they will be copied in TeX mode.
17544 \end_layout
17545
17546 \begin_layout Itemize
17547 The LyX math editor can't handle the AMS-LaTeX math environments align,
17548  split, etc.
17549  So those environments will be copied in TeX mode.
17550  You can change 
17551 \family typewriter
17552 equation*
17553 \family default
17554  environments to the exactly equivalent displaymath, and then they will
17555  be translated correctly.
17556 \end_layout
17557
17558 \begin_layout Subsection
17559 Examples
17560 \end_layout
17561
17562 \begin_layout Standard
17563
17564 \family typewriter
17565 reLyX -df -o 
17566 \begin_inset Quotes eld
17567 \end_inset
17568
17569 my/dir
17570 \begin_inset Quotes erd
17571 \end_inset
17572
17573  -r 
17574 \begin_inset Quotes eld
17575 \end_inset
17576
17577 myenv
17578 \begin_inset Quotes erd
17579 \end_inset
17580
17581  foo.tex > foo.debug
17582 \end_layout
17583
17584 \begin_layout Standard
17585 The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
17586   When it finds a 
17587 \family typewriter
17588
17589 \backslash
17590 begin{myenv} ...
17591  
17592 \backslash
17593 end{myenv}
17594 \family default
17595  block, it will translate the stuff within the block, but copy the 
17596 \family typewriter
17597
17598 \backslash
17599 begin
17600 \family default
17601  and 
17602 \family typewriter
17603
17604 \backslash
17605 end
17606 \family default
17607  commands in TeX mode.
17608   Finally, I'm going to keep the temporary files around (they will also
17609  be in my/dir/) and output lots of debugging information into the file foo.debug.
17610 \end_layout
17611
17612 \begin_layout Subsection
17613 Notes
17614 \end_layout
17615
17616 \begin_layout Subsubsection
17617 Bug Reports
17618 \begin_inset LatexCommand \label{sub:relyx-bug-reports}
17619
17620 \end_inset
17621
17622
17623 \end_layout
17624
17625 \begin_layout Standard
17626 If reLyX is crashing or otherwise acting strangely---in ways other than
17627  those described in Section\InsetSpace ~
17628
17629 \begin_inset LatexCommand \ref{sub:relyx-bugs}
17630
17631 \end_inset
17632
17633  or the bug tracker---then please run reLyX
17634 \series bold
17635  -d
17636 \series default
17637 .
17638   That will allow you to figure out where in the reLyXing process it crashed.
17639  That, in turn, will allow you to write a better bug report, which will
17640  allow the developers to fix it more quickly and easily.
17641 \end_layout
17642
17643 \begin_layout Standard
17644 Bug reports should be sent to the LyX developers' mailing list.
17645  Its address is currently 
17646 \family typewriter
17647 lyx-devel@lists.lyx.org
17648 \family default
17649 .
17650  If you are running reLyX on a huge file, please do not send all of the
17651  output in your bug report.
17652  Just include the last ten or twenty lines of output, along with the piece
17653  of the LaTeX file it crashed on.
17654   Or, even better, attach a small but complete file which causes the same
17655  problem as your original file.
17656 \end_layout
17657
17658 \begin_layout Subsubsection
17659 Implementation Details:
17660 \end_layout
17661
17662 \begin_layout Standard
17663 reLyX makes several 
17664 \begin_inset Quotes eld
17665 \end_inset
17666
17667 passes
17668 \begin_inset Quotes erd
17669 \end_inset
17670
17671  in order to translate a TeX file.
17672  On each pass, it creates one or two files.
17673 \end_layout
17674
17675 \begin_layout Description
17676 Pass\InsetSpace ~
17677 0 \InsetSpace ~
17678
17679 \newline
17680 Before doing anything, read the syntax file (or files).
17681 \end_layout
17682
17683 \begin_layout Description
17684 Pass\InsetSpace ~
17685 1a \InsetSpace ~
17686
17687 \newline
17688 Split preamble (anything before a 
17689 \family typewriter
17690
17691 \backslash
17692 begin{document}
17693 \family default
17694  command) off the rest of the file.
17695  It saves the two pieces in separate files.
17696  This is necessary because there may be very strange stuff in a preamble.
17697  It also ignores anything after the 
17698 \family typewriter
17699
17700 \backslash
17701 end{document}
17702 \family default
17703 , on the assumption that it isn't LaTeX.
17704 \end_layout
17705
17706 \begin_layout Description
17707 Pass\InsetSpace ~
17708 1b \InsetSpace ~
17709
17710 \newline
17711 Translate the preamble.
17712  Currently, that just means translating the 
17713 \family typewriter
17714
17715 \backslash
17716 documentclass
17717 \family default
17718  command and copying the rest exactly into the LyX preamble.
17719 \end_layout
17720
17721 \begin_deeper
17722 \begin_layout Standard
17723 Once you know what class the document is, read the LyX layout file for that
17724  class.
17725 \end_layout
17726
17727 \end_deeper
17728 \begin_layout Description
17729 Pass\InsetSpace ~
17730 2 \InsetSpace ~
17731
17732 \newline
17733
17734 \begin_inset Quotes eld
17735 \end_inset
17736
17737 Clean
17738 \begin_inset Quotes erd
17739 \end_inset
17740
17741  the TeX file, generating slightly stricter LaTeX.
17742  This includes:
17743 \end_layout
17744
17745 \begin_deeper
17746 \begin_layout Itemize
17747 Change, e.g., 
17748 \family typewriter
17749 x^2
17750 \family default
17751  to the equivalent but clearer 
17752 \family typewriter
17753 x^{2}
17754 \end_layout
17755
17756 \begin_layout Itemize
17757 Removing optional arguments that LyX can't handle (e.g., from 
17758 \family typewriter
17759
17760 \backslash
17761 sqrt
17762 \family default
17763 )
17764 \end_layout
17765
17766 \begin_layout Itemize
17767 Changing 
17768 \family typewriter
17769 {
17770 \backslash
17771 em foo}
17772 \family default
17773  to 
17774 \family typewriter
17775
17776 \backslash
17777 emph{foo}
17778 \family default
17779 , etc.
17780  This is necessary because LyX always writes out the non-local forms anyway.
17781  This should very rarely make a difference.
17782 \end_layout
17783
17784 \end_deeper
17785 \begin_layout Description
17786 Pass\InsetSpace ~
17787 3 \InsetSpace ~
17788
17789 \newline
17790 Translate LaTeX text, commands, and environments to LyX.
17791 \end_layout
17792
17793 \begin_layout Description
17794 Pass\InsetSpace ~
17795 4 \InsetSpace ~
17796
17797 \newline
17798 Put the two pieces back together, and do some final tweaking, to generate
17799  the LyX file
17800 \end_layout
17801
17802 \begin_layout Standard
17803 If there are any 
17804 \family typewriter
17805
17806 \backslash
17807 input
17808 \family default
17809  or 
17810 \family typewriter
17811
17812 \backslash
17813 include
17814 \family default
17815  commands, reLyX will loop back to the beginning and translate those.
17816  It assumes that the included files are the same class as the main file,
17817  and that they have no preamble matter.
17818  (If you have an 
17819 \family typewriter
17820
17821 \backslash
17822 input
17823 \family default
17824  command in the preamble of a file, the command will be copied exactly into
17825  the LaTeX preamble portion of the LyX file, so the included file won't
17826  be translated.) So when translating included files, it skips passes 0 and
17827  1.
17828 \end_layout
17829
17830 \begin_layout Standard
17831 If reLyX doesn't find a file you wanted to include, it will give a warning,
17832  but will continue to translate any files it does find.
17833 \end_layout
17834
17835 \begin_layout Subsubsection
17836 Layout Files
17837 \end_layout
17838
17839 \begin_layout Standard
17840 reLyX reads a LyX layout file to know how to handle LaTeX environments and
17841  commands which get translated to LyX layouts.
17842  This file will include all 
17843 \begin_inset Quotes eld
17844 \end_inset
17845
17846 normal
17847 \begin_inset Quotes erd
17848 \end_inset
17849
17850  non-math environments (i.e., including quote and itemize, but not tabular,
17851  minipage, and some other fancy environments), and commands like 
17852 \family typewriter
17853
17854 \backslash
17855 section
17856 \family default
17857  and 
17858 \family typewriter
17859
17860 \backslash
17861 title
17862 \family default
17863 .
17864  If you want to reLyX a class that doesn't have an existing layout file,
17865  then you'll have to create a layout file.
17866  But you have to do this anyway, in order to LyX the file, since LyX depends
17867  on layout files to know how to display and process its files.
17868  Check the LyX documentation for help with this task (which can be hard
17869  or easy, depending on the class you want to create a layout file for.) If
17870  your class is quite similar to a class that has a layout file, then consider
17871  using the 
17872 \series bold
17873 -c
17874 \series default
17875  option.
17876 \end_layout
17877
17878 \begin_layout Subsubsection
17879 Syntax Files
17880 \begin_inset LatexCommand \label{sub:relyx-syntax}
17881
17882 \end_inset
17883
17884
17885 \end_layout
17886
17887 \begin_layout Standard
17888 reLyX always reads at least one syntax file, called the default syntax file.
17889  reLyX will read your personal syntax file if it exists; otherwise it will
17890  read the system-wide file.
17891  reLyX will read additional syntax files if you specify them with the 
17892 \series bold
17893 -s
17894 \series default
17895  option.
17896  (These extra files should have the same format as the default file, but
17897  will tend to be shorter, since they only have to specify extra commands
17898  not found in the default file.) A syntax file tells reLyX a few things.
17899 \end_layout
17900
17901 \begin_layout Standard
17902 First, it describes the syntax of each command, that is, how many required
17903  arguments and how many optional arguments the command takes.
17904  Knowing this makes it easier for reLyX to copy (in TeX mode) commands that
17905  it doesn't know how to translate.
17906  The syntax file simply has a command, followed by braces or brackets describing
17907  its arguments in the correct order.
17908  For example, a syntax file entry 
17909 \family typewriter
17910
17911 \backslash
17912 bibitem[]{}
17913 \family default
17914  means that the 
17915 \family typewriter
17916
17917 \backslash
17918 bibitem
17919 \family default
17920  command takes an optional argument followed by a required one, while the
17921  entry 
17922 \family typewriter
17923
17924 \backslash
17925 bf
17926 \family default
17927  means that the 
17928 \family typewriter
17929
17930 \backslash
17931 bf
17932 \family default
17933  command takes no arguments at all.
17934   When reLyX encounters a token that it doesn't know how to translate into
17935  LyX, it will copy the token---along with the correct number of arguments---exac
17936 tly.
17937   If the token is not in the syntax file, then reLyX just copies as many
17938  arguments as it finds.
17939   This means that it may copy too much.
17940  But since the user can specify additional syntax files, that shouldn't
17941  happen often.
17942 \end_layout
17943
17944 \begin_layout Standard
17945 Some commands that cannot be translated to LyX, like 
17946 \family typewriter
17947
17948 \backslash
17949 mbox
17950 \family default
17951 , have as one of their arguments regular LaTeX text.
17952  If the string 
17953 \begin_inset Quotes eld
17954 \end_inset
17955
17956 translate
17957 \begin_inset Quotes erd
17958 \end_inset
17959
17960  is put into an argument of an (untranslatable) command in the syntax file,
17961  then reLyX will translate that argument instead of copying it verbatim.
17962  So, for example, the default syntax file has 
17963 \family typewriter
17964
17965 \backslash
17966 raisebox{}[][]{translate}
17967 \family default
17968 .
17969  This means that the 
17970 \family typewriter
17971
17972 \backslash
17973 raisebox
17974 \family default
17975  command and the first argument (and optional arguments if they exist) are
17976  copied in TeX mode, but the last argument (which may contain math, complicated
17977  LaTeX, other untranslatable commands, etc.) will be translated into LyX.
17978  You can't use 
17979 \begin_inset Quotes eld
17980 \end_inset
17981
17982 translate
17983 \begin_inset Quotes erd
17984 \end_inset
17985
17986  on optional arguments.
17987 \end_layout
17988
17989 \begin_layout Standard
17990 User-defined syntax files are allowed to define new commands and their syntax,
17991  or override the number of arguments for a command given in the default
17992  syntax file.
17993  (E.g., if you're using a style that gives an extra argument to some command...)
17994  However, this will only be useful for commands copied in TeX mode.
17995  Commands which are actually translated by reLyX (like 
17996 \family typewriter
17997
17998 \backslash
17999 item
18000 \family default
18001 ) have their argument syntax hard-coded.
18002  The hard-coded commands are identified in the default syntax file.
18003 \end_layout
18004
18005 \begin_layout Standard
18006 Second, the syntax file describes any 
18007 \begin_inset Quotes eld
18008 \end_inset
18009
18010 regular environments
18011 \begin_inset Quotes erd
18012 \end_inset
18013
18014 .
18015   Usually, an entire unknown environment will be copied in TeX mode.
18016  If you define a regular environment 
18017 \begin_inset Quotes eld
18018 \end_inset
18019
18020 foo
18021 \begin_inset Quotes erd
18022 \end_inset
18023
18024 , though, then only the 
18025 \family typewriter
18026
18027 \backslash
18028 begin{foo}
18029 \family default
18030  and 
18031 \family typewriter
18032
18033 \backslash
18034 end{foo}
18035 \family default
18036  commands will be copied in TeX mode; the text within the environment will
18037  be treated (i.e., translated) by reLyX as regular LaTeX, rather than being
18038  copied into TeX mode.
18039  Don't try to declare 
18040 \family typewriter
18041 tabbing
18042 \family default
18043  and 
18044 \family typewriter
18045 picture
18046 \family default
18047  as regular environments, as the text within those environments will confuse
18048  reLyX; use this capability for new environments you create that have plain
18049  text or math or simple commands in them.
18050  You also can't declare unknown math environments (like 
18051 \family typewriter
18052 equation*
18053 \family default
18054 ) as regular environments, either, since the LyX math editor won't understand
18055  them.
18056  The names of regular environments appear, whitespace-separated, between
18057  
18058 \family typewriter
18059
18060 \backslash
18061 begin{reLyXre}
18062 \family default
18063  and 
18064 \family typewriter
18065
18066 \backslash
18067 end{reLyXre}
18068 \family default
18069  statements in the syntax file.
18070  (If you have a regular environment which you won't use very often, you
18071  can use the 
18072 \series bold
18073 -r
18074 \series default
18075  option rather than writing a syntax file.)
18076 \end_layout
18077
18078 \begin_layout Standard
18079 Third, the syntax file describes a math translation table.
18080  The LyX math editor doesn't support a few commands.
18081  For example, 
18082 \family typewriter
18083 _
18084 \family default
18085  is supported, but the equivalent 
18086 \family typewriter
18087
18088 \backslash
18089 sb
18090 \family default
18091  is not.
18092  Put any commands you'd like translate between 
18093 \family typewriter
18094
18095 \backslash
18096 begin{reLyXmt}
18097 \family default
18098  and 
18099 \family typewriter
18100
18101 \backslash
18102 end{reLyXmt}
18103 \family default
18104  statements.
18105  The statement 
18106 \begin_inset Quotes eld
18107 \end_inset
18108
18109
18110 \family typewriter
18111
18112 \backslash
18113 | {
18114 \backslash
18115 Vert}
18116 \family default
18117
18118 \begin_inset Quotes erd
18119 \end_inset
18120
18121  means that any 
18122 \family typewriter
18123
18124 \backslash
18125 |
18126 \family default
18127  in math mode will be converted to 
18128 \begin_inset Quotes eld
18129 \end_inset
18130
18131
18132 \family typewriter
18133
18134 \backslash
18135 Vert
18136 \family default
18137  
18138 \begin_inset Quotes erd
18139 \end_inset
18140
18141
18142 \family typewriter
18143  
18144 \family default
18145 (in cases where a token made up of a backslash and a non-letter is translated
18146  to something with letters at the end, a space is added by reLyX.
18147  That way, 
18148 \begin_inset Quotes eld
18149 \end_inset
18150
18151
18152 \family typewriter
18153
18154 \backslash
18155 |a
18156 \family default
18157
18158 \begin_inset Quotes erd
18159 \end_inset
18160
18161  is correctly translated to 
18162 \begin_inset Quotes eld
18163 \end_inset
18164
18165
18166 \family typewriter
18167
18168 \backslash
18169 Vert a
18170 \family default
18171
18172 \begin_inset Quotes erd
18173 \end_inset
18174
18175 ).
18176 \end_layout
18177
18178 \begin_layout Subsubsection
18179 Miscellaneous
18180 \end_layout
18181
18182 \begin_layout Standard
18183 You need Perl version 5.002 or later to run reLyX.
18184  <plug> If you don't have Perl, you should get it anyway (at 
18185 \begin_inset LatexCommand \url[Perl]{http://www.perl.com/}
18186
18187 \end_inset
18188
18189 ), because it's a really useful tool for pretty much anything.
18190  </plug>
18191 \end_layout
18192
18193 \begin_layout Subsection
18194 Diagnostics
18195 \end_layout
18196
18197 \begin_layout Standard
18198 reLyX should always explain why it crashes, if it crashes.
18199  Some diagnostics may be very technical, though, if they come from the guts
18200  of the code.
18201  reLyX gives much more information while running if you use the 
18202 \series bold
18203 -d
18204 \series default
18205  option, but you shouldn't need that unless something goes wrong.
18206 \end_layout
18207
18208 \begin_layout Standard
18209 When it's finished, reLyX will tell you if it finished successfully or died
18210  due to some error.
18211 \end_layout
18212
18213 \begin_layout Subsection
18214 Warnings
18215 \end_layout
18216
18217 \begin_layout Standard
18218 Always keep a copy of your original LaTeX files either under a different
18219  name or in a different directory.
18220  There are a couple ways in which using LyX could lead to overwriting the
18221  original LaTeX file.
18222 \end_layout
18223
18224 \begin_layout Standard
18225 If you import 
18226 \family typewriter
18227 foo.tex
18228 \family default
18229  to create 
18230 \family typewriter
18231 foo.lyx
18232 \family default
18233 , then edit 
18234 \family typewriter
18235 foo.lyx
18236 \family default
18237  and want to re-export it, note that it will overwrite the original 
18238 \family typewriter
18239 foo.tex
18240 \family default
18241 .
18242  (LyX will 
18243 \emph on
18244 not
18245 \emph default
18246  ask you if you want to overwrite it.)
18247 \end_layout
18248
18249 \begin_layout Standard
18250 If you have chosen not to use a temporary directory in the preferences,
18251  then LyX will create its temporary files in your current directory, which
18252  means your LaTeX original may be overwritten (without a warning from LyX)
18253  when you 
18254 \begin_inset Quotes eld
18255 \end_inset
18256
18257 view dvi
18258 \begin_inset Quotes erd
18259 \end_inset
18260
18261  or print the LyX document.
18262 \end_layout
18263
18264 \begin_layout Subsection
18265 Files
18266 \end_layout
18267
18268 \begin_layout Description
18269
18270 \family typewriter
18271 \series medium
18272 MY_LYXDIR/layouts/*.layout
18273 \family default
18274 \series default
18275  \InsetSpace ~
18276
18277 \newline
18278 User's personal layout files for document classes
18279 \end_layout
18280
18281 \begin_layout Description
18282
18283 \family typewriter
18284 \series medium
18285 MY_LYXDIR/reLyX/syntax.default
18286 \family default
18287 \series default
18288  \InsetSpace ~
18289
18290 \newline
18291 User's personal syntax file
18292 \end_layout
18293
18294 \begin_layout Description
18295
18296 \family typewriter
18297 \series medium
18298 LIBDIR/layouts/*.layout
18299 \family default
18300 \series default
18301  \InsetSpace ~
18302
18303 \newline
18304 System-wide layout files for document classes
18305 \end_layout
18306
18307 \begin_layout Description
18308
18309 \family typewriter
18310 \series medium
18311 LIBDIR/reLyX/syntax.default
18312 \family default
18313 \series default
18314  \InsetSpace ~
18315
18316 \newline
18317 System-wide LaTeX syntax file
18318 \end_layout
18319
18320 \begin_layout Standard
18321
18322 \family typewriter
18323 LIBDIR
18324 \family default
18325  is the system-wide LyX directory, usually something like 
18326 \family typewriter
18327 /usr/local/share/lyx/
18328 \family default
18329 .
18330  
18331 \family typewriter
18332 MY_LYXDIR
18333 \family default
18334  is your personal LyX directory, something like 
18335 \family typewriter
18336 .lyx/
18337 \family default
18338  in your home directory.
18339  You can see their actual values in the 
18340 \family sans
18341 \bar under
18342 H
18343 \bar default
18344 elp\SpecialChar \menuseparator
18345 About\InsetSpace ~
18346 Ly
18347 \bar under
18348 X
18349 \family default
18350 \bar default
18351  dialog.
18352 \end_layout
18353
18354 \begin_layout Subsection
18355 See also
18356 \end_layout
18357
18358 \begin_layout Standard
18359
18360 \shape italic
18361 lyx
18362 \shape default
18363 (1), 
18364 \shape italic
18365 latex
18366 \shape default
18367 (1)
18368 \end_layout
18369
18370 \begin_layout Subsection
18371 Authors
18372 \end_layout
18373
18374 \begin_layout Standard
18375 Copyright (c) 1998--9 
18376 \noun on
18377 Amir Karger
18378 \noun default
18379  (
18380 \family typewriter
18381 karger@voth.chem.utah.edu
18382 \family default
18383 )
18384 \end_layout
18385
18386 \begin_layout Standard
18387 Code contributors:
18388 \end_layout
18389
18390 \begin_layout Itemize
18391
18392 \noun on
18393 John Weiss
18394 \noun default
18395  wrote the original CleanTeX pass.
18396 \end_layout
18397
18398 \begin_layout Itemize
18399
18400 \noun on
18401 Etienne Grossmann
18402 \end_layout
18403
18404 \begin_layout Itemize
18405
18406 \noun on
18407 Jos\i \'{e}
18408  Ab\i \'{\i}
18409 lio Oliveira Matos
18410 \end_layout
18411
18412 \begin_layout Itemize
18413
18414 \noun on
18415 David Suarez de Lis
18416 \end_layout
18417
18418 \begin_layout Standard
18419 Other contributors:
18420 \end_layout
18421
18422 \begin_layout Itemize
18423
18424 \noun on
18425 Jean-Marc Lasgouttes
18426 \noun default
18427  worked on the wrapper script and offered lots of bug reports, advice, and
18428  feature suggestions.
18429 \end_layout
18430
18431 \begin_layout Itemize
18432
18433 \noun on
18434 Asger K.
18435  Alstrup Nielsen
18436 \noun default
18437  and 
18438 \noun on
18439 Marc Pavese
18440 \noun default
18441  provided advice.
18442 \end_layout
18443
18444 \begin_layout Itemize
18445 Various members of the LyX developers' and users' lists provided bug reports
18446  and feature suggestions.
18447 \end_layout
18448
18449 \begin_layout Standard
18450 reLyX uses a modified version the Perl TeX parser 
18451 \family typewriter
18452 Text::TeX
18453 \family default
18454  package written by 
18455 \noun on
18456 Ilya Zakharevich
18457 \noun default
18458  (
18459 \family typewriter
18460 ilya@math.ohio-state.edu
18461 \family default
18462 ), available on CPAN.
18463 \end_layout
18464
18465 \begin_layout Chapter
18466 LyX Features needing Extra Software
18467 \end_layout
18468
18469 \begin_layout Section
18470 Using LyX with SGML-Tools (aka LinuxDoc)
18471 \end_layout
18472
18473 \begin_layout Standard
18474 by 
18475 \noun on
18476 Paul Evans
18477 \end_layout
18478
18479 \begin_layout Subsection
18480 Overview
18481 \end_layout
18482
18483 \begin_layout Standard
18484 LinuxDoc is a document class available in LyX if you have the 
18485 \family typewriter
18486 sgml-tools
18487 \family default
18488  package installed.
18489  You can use it to produce documents in the so-called Standardized General
18490  Mark-up Language (SGML) in the particular format used by the Linux Documentatio
18491 n Project.
18492  That is obviously helpful if you are contributing to that project.
18493  You can use the SGML format with the 
18494 \family typewriter
18495 sgml-tools
18496 \family default
18497  package of scripts and programs (to produce other formats, including Latex,
18498  HTML, plain text, man pages and\SpecialChar \ldots{}
18499 ).
18500  You may therefore prefer to use this document class if you want to write
18501  something that can be easily translated into other formats.
18502 \end_layout
18503
18504 \begin_layout Standard
18505 You will find that LinuxDoc has fewer layout options than the other text
18506  classes in LyX.
18507  This is mainly so that the translations into other formats have a chance
18508  of making some sense.
18509  In this section we describe:
18510 \end_layout
18511
18512 \begin_layout Itemize
18513 how to setup and use a document in LinuxDoc
18514 \end_layout
18515
18516 \begin_layout Itemize
18517 how to use the tags in LinuxDoc to layout your document
18518 \end_layout
18519
18520 \begin_layout Itemize
18521 how to use the SGML packages to produce the various formats
18522 \end_layout
18523
18524 \begin_layout Itemize
18525 how to sort out some problems.
18526 \end_layout
18527
18528 \begin_layout Subsection
18529 Preparing and using a LinuxDoc document
18530 \end_layout
18531
18532 \begin_layout Subsubsection
18533 Getting started
18534 \end_layout
18535
18536 \begin_layout Standard
18537 You start by selecting the LinuxDoc class using the 
18538 \family sans
18539 \bar under
18540 D
18541 \bar default
18542 ocument\SpecialChar \menuseparator
18543
18544 \bar under
18545 S
18546 \bar default
18547 ettings
18548 \family default
18549  dialog.
18550
18551 \family sans
18552  
18553 \family default
18554 Then you will find that there are fewer paragraph environments than for
18555  most other classes.
18556  You can see them on the pull down box on the left of the tool bar.
18557  How to use them is described in section\InsetSpace ~
18558
18559 \begin_inset LatexCommand \ref{sec:sgmlparas}
18560
18561 \end_inset
18562
18563 .
18564 \end_layout
18565
18566 \begin_layout Standard
18567 You 
18568 \emph on
18569 must
18570 \emph default
18571  enter a title for the document, followed by an author, marking each with
18572  the appropriate paragraph environment.
18573  If you don't do this, you will get errors when you try to print the file.
18574  You can then enter the date and an abstract.
18575  The document proper must start with a Section paragraph environment rather
18576  than any standard layout.
18577 \end_layout
18578
18579 \begin_layout Standard
18580 After that you can prepare a document as usual using the available range
18581  of paragraph environments.
18582  See section\InsetSpace ~
18583
18584 \begin_inset LatexCommand \ref{sec:sgmlparas}
18585
18586 \end_inset
18587
18588  for the full list and their uses.
18589 \end_layout
18590
18591 \begin_layout Subsubsection
18592 Output from LinuxDoc
18593 \end_layout
18594
18595 \begin_layout Standard
18596 You can print and save these documents in the normal way.
18597  To use the other features of the SGML package you need to save your document
18598  as LinuxDoc; this is a version in which the document is translated into
18599  the basic sgml tags.
18600  Use
18601 \family sans
18602  
18603 \bar under
18604 F
18605 \bar default
18606 ile\SpecialChar \menuseparator
18607
18608 \bar under
18609 E
18610 \bar default
18611 xport\SpecialChar \menuseparator
18612 Linu
18613 \bar under
18614 x
18615 \bar default
18616 Doc.
18617
18618 \family default
18619  You will get a file with the same name and a 
18620 \family typewriter
18621 .sgml
18622 \family default
18623  extension rather than a 
18624 \family typewriter
18625 .lyx
18626 \family default
18627  extension.
18628  See\InsetSpace ~
18629
18630 \begin_inset LatexCommand \ref{sec:sgmloperate}
18631
18632 \end_inset
18633
18634  on how you than make use of this file.
18635 \end_layout
18636
18637 \begin_layout Subsection
18638 Using the paragraph environments in LinuxDoc
18639 \end_layout
18640
18641 \begin_layout Subsubsection
18642 The Structure of a LinuxDoc Document
18643 \end_layout
18644
18645 \begin_layout Standard
18646 There is a formal structure for LinuxDoc which limits how you can place
18647  tags.
18648  There are two parts to all documents: 
18649 \end_layout
18650
18651 \begin_layout Description
18652 Header: this is everything up to the first time you insert a Section layout
18653  marker.
18654  It can include title, author, date, abstract and ToC.
18655  You must include the first two.
18656 \end_layout
18657
18658 \begin_layout Description
18659 Body: from the beginning of the first section onwards.
18660  All other tags are allowed.
18661  
18662 \end_layout
18663
18664 \begin_layout Subsubsection
18665 The LinuxDoc Paragraph Environments
18666 \end_layout
18667
18668 \begin_layout Standard
18669 \begin_inset LatexCommand \label{sec:sgmlparas}
18670
18671 \end_inset
18672
18673 Here is a list of all the tags you will find listed on the layout bar in
18674  the order they come there, with some comments where the purpose or use
18675  is not obvious:
18676 \end_layout
18677
18678 \begin_layout Itemize
18679
18680 \family sans
18681 Standard:
18682 \family roman
18683  works as described in [cross reference]
18684 \end_layout
18685
18686 \begin_layout Itemize
18687
18688 \family sans
18689 Title
18690 \family default
18691 : This will appear at the top left of the document when printed, above a
18692  heavy horizontal rule, although you will not see this on the LyX screen.
18693 \end_layout
18694
18695 \begin_layout Itemize
18696
18697 \family sans
18698 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
18699 \family default
18700  all do what you would expect and in the usual order.
18701  Whether they are numbered or not is controlled by the 
18702 \family sans
18703 Section\InsetSpace ~
18704 number\InsetSpace ~
18705 depth
18706 \family default
18707  setting.
18708  You cannot get the equivalent number free versions in any other way; there
18709  is no 
18710 \family sans
18711 Section*
18712 \family default
18713  or similar
18714 \end_layout
18715
18716 \begin_layout Itemize
18717
18718 \family sans
18719 Enumerate:
18720 \family default
18721  As usual this produces a numbered and indented list as described in the
18722  
18723 \emph on
18724 User's Guide
18725 \emph default
18726 .
18727 \end_layout
18728
18729 \begin_layout Itemize
18730
18731 \family sans
18732 Itemize: 
18733 \family roman
18734 Again much the same as in the other classes: see the 
18735 \emph on
18736 User's Guide
18737 \emph default
18738 .
18739 \end_layout
18740
18741 \begin_layout Itemize
18742
18743 \family sans
18744 Description
18745 \family default
18746 : As explained in the 
18747 \emph on
18748 User's Guide
18749 \emph default
18750 .
18751  Remember that if you want the bold element at the start of a description
18752  to be more than one word then you need to put protected spaces between
18753  the words.
18754  
18755 \end_layout
18756
18757 \begin_layout Itemize
18758
18759 \family sans
18760 Verbatim: 
18761 \family default
18762 As usual.
18763 \end_layout
18764
18765 \begin_layout Itemize
18766
18767 \family sans
18768 Code: similar to the Lyx-Code
18769 \family roman
18770  environment
18771 \end_layout
18772
18773 \begin_layout Itemize
18774
18775 \family sans
18776 Author
18777 \family default
18778 : Anything you mark with this will appear on the left of the heading of
18779  the document, under the heavy rule.
18780 \end_layout
18781
18782 \begin_layout Itemize
18783
18784 \family sans
18785 Date:
18786 \family default
18787  Anything you mark with this will appear on the right of the heading under
18788  the rule.
18789  You do not have to make this a date.
18790  Any text can be entered, e.\InsetSpace ~
18791 g.
18792  a version number.
18793 \end_layout
18794
18795 \begin_layout Itemize
18796
18797 \family sans
18798 Abstract
18799 \family default
18800 : You can use this to produce a free standing paragraph after the author
18801  and date, and before the first section.
18802  You are only allowed one such paragraph.
18803 \begin_inset Foot
18804 status collapsed
18805
18806 \begin_layout Standard
18807
18808 \emph on
18809 Author's note.
18810  
18811 \emph default
18812 This needs checking ---
18813 \emph on
18814 pe.
18815 \end_layout
18816
18817 \end_inset
18818
18819
18820 \end_layout
18821
18822 \begin_layout Itemize
18823
18824 \family sans
18825 Displaymath
18826 \family default
18827 :
18828 \begin_inset Foot
18829 status collapsed
18830
18831 \begin_layout Standard
18832
18833 \emph on
18834 Author's note: 
18835 \emph default
18836 I have not yet checked this ---
18837 \emph on
18838 pe.
18839 \end_layout
18840
18841 \end_inset
18842
18843
18844 \end_layout
18845
18846 \begin_layout Subsubsection
18847 Other document features
18848 \end_layout
18849
18850 \begin_layout Standard
18851 You can also use the 
18852 \family sans
18853 Layout 
18854 \family default
18855 menu to set fonts or to emphasis words.
18856  You can also use the table of contents as usual; see the corresponding
18857  section of the 
18858 \emph on
18859 User's Guide
18860 \emph default
18861 .
18862  Although you will find some some other features on the menus e.\InsetSpace ~
18863 g.
18864  inserting footnotes.
18865  There is some doubt about whether these will work correctly.
18866 \begin_inset Foot
18867 status collapsed
18868
18869 \begin_layout Standard
18870
18871 \emph on
18872 Author's note: 
18873 \emph default
18874 Again still checking to see whether this is my system
18875 \emph on
18876  ---pe.
18877 \end_layout
18878
18879 \end_inset
18880
18881
18882 \end_layout
18883
18884 \begin_layout Subsubsection
18885 Cross references and HTML 
18886 \end_layout
18887
18888 \begin_layout Standard
18889 On the
18890 \family sans
18891  Insert
18892 \family default
18893  menu you will find two new options relating to the inclusion of URL addresses.
18894  If you use either option you will find some highlighted TeX code inserted
18895  into your document in three separate blocks with spaces available between.
18896  The blocks will be:
18897 \end_layout
18898
18899 \begin_layout Quote
18900
18901 \family typewriter
18902
18903 \backslash
18904 htmlurl{
18905 \family default
18906  or 
18907 \family typewriter
18908
18909 \backslash
18910 url{
18911 \family roman
18912
18913 \hfill
18914 space
18915 \family default
18916  
18917 \family typewriter
18918
18919 \hfill
18920 }{
18921 \family roman
18922
18923 \hfill
18924 space
18925 \hfill
18926
18927 \family typewriter
18928 }
18929 \end_layout
18930
18931 \begin_layout Standard
18932 You insert a full HTML tag between the first and second blocks.
18933  This can be 
18934 \begin_inset LatexCommand \url{http://any.address}
18935
18936 \end_inset
18937
18938  or other valid tags such as 
18939 \begin_inset LatexCommand \url{mailto:me@my.address}
18940
18941 \end_inset
18942
18943
18944 \family typewriter
18945 .
18946 \family default
18947 Then y
18948 \family roman
18949 ou 
18950 \family default
18951 insert some description between the second and third blocks.
18952  The differences are:
18953 \end_layout
18954
18955 \begin_layout Itemize
18956
18957 \family sans
18958 URL:
18959 \family roman
18960  both the HTML tag and the description will appear in the document
18961 \end_layout
18962
18963 \begin_layout Itemize
18964
18965 \family sans
18966 HTML\InsetSpace ~
18967 URL: 
18968 \family roman
18969 only the description appears in the printed version
18970 \end_layout
18971
18972 \begin_layout Subsection
18973 Using the LinuxDoc Sgml scripts
18974 \begin_inset Note Note
18975 status collapsed
18976
18977 \begin_layout Standard
18978 This section is completely outdated.
18979 \end_layout
18980
18981 \end_inset
18982
18983
18984 \end_layout
18985
18986 \begin_layout Standard
18987 \begin_inset LatexCommand \label{sec:sgmloperate}
18988
18989 \end_inset
18990
18991 You can use LinuxDoc as a text class without any additional scripts or programs,
18992  but there is not much point in doing this.
18993  All you will get is a document that looks like a 
18994 \emph on
18995 Linux Documentation Project Howto
18996 \family sans
18997 \emph default
18998 .
18999  
19000 \family default
19001 To do the document translation you need to get and install the 
19002 \family typewriter
19003 sgml-tools-1.0.x.tar.gz 
19004 \family default
19005 (with 
19006 \begin_inset Formula $x\geq3$
19007 \end_inset
19008
19009 ) package from 
19010 \family roman
19011 the SGML-Tools WWW Page
19012 \family default
19013  at
19014 \end_layout
19015
19016 \begin_layout LyX-Code
19017
19018 \family roman
19019 \begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
19020
19021 \end_inset
19022
19023
19024 \family default
19025  
19026 \end_layout
19027
19028 \begin_layout Standard
19029 Alternatively, you can go to the 
19030 \family typewriter
19031 sunsite
19032 \family default
19033  archive at
19034 \begin_inset Foot
19035 status collapsed
19036
19037 \begin_layout Standard
19038 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
19039  has not yet been made available at 
19040 \family typewriter
19041 sunsite
19042 \family default
19043 .
19044 \end_layout
19045
19046 \end_inset
19047
19048
19049 \end_layout
19050
19051 \begin_layout LyX-Code
19052
19053 \family roman
19054 \begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
19055
19056 \end_inset
19057
19058
19059 \end_layout
19060
19061 \begin_layout Standard
19062
19063 \family roman
19064 The
19065 \family default
19066  file 
19067 \family typewriter
19068 sgml-tools-1.0.x.tar.gz
19069 \family default
19070  contains everything that you need to write SGML documents and convert them
19071  to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
19072
19073 \end_layout
19074
19075 \begin_layout Standard
19076 This package was renamed from 
19077 \family typewriter
19078 linuxdoc-sgml-1.5.tar.gz
19079 \family default
19080  in January 1997.
19081 \end_layout
19082
19083 \begin_layout Standard
19084 Follow the instructions in that package on how to install it and how to
19085  use it.
19086  All this has to be done outside of LyX, before you can use the 
19087 \family sans
19088 \bar under
19089 F
19090 \bar default
19091 ile\SpecialChar \menuseparator
19092
19093 \bar under
19094 E
19095 \bar default
19096 xport\SpecialChar \menuseparator
19097 as\InsetSpace ~
19098 LinuxDoc 
19099 \family roman
19100 option.
19101 \end_layout
19102
19103 \begin_layout Subsection
19104 Troubleshooting LinuxDoc
19105 \end_layout
19106
19107 \begin_layout Standard
19108 When you print or preview a LinuxDoc document some checking is done of the
19109  tags before LaTeX is run.
19110  Some errors are trapped here, especially those concerning the structure
19111  of the document.
19112  LyX may produce an error message, but not leave an error box in the document
19113  for you to open.
19114  You may have to look at the files directly to discover what is wrong.
19115  Most problems seem to come from the use of options that are not fully available
19116  in the text class.
19117 \end_layout
19118
19119 \begin_layout Section
19120 Checking TeX
19121 \end_layout
19122
19123 \begin_layout Standard
19124 by 
19125 \noun on
19126 Asger Alstrup
19127 \end_layout
19128
19129 \begin_layout Subsection
19130 Introduction
19131 \end_layout
19132
19133 \begin_layout Standard
19134 Under the 
19135 \family sans
19136 \bar under
19137 T
19138 \bar default
19139 ools
19140 \family default
19141  menu, you'll find a 
19142 \family sans
19143 \bar under
19144 C
19145 \bar default
19146 heck\InsetSpace ~
19147 TeX
19148 \family default
19149  command.
19150  This feature requires you to have the 
19151 \family typewriter
19152 chktex
19153 \family default
19154  program installed, and is grayed out if you don't have it.
19155  You can get it from your nearest CTAN mirror, or over the Web from 
19156 \begin_inset LatexCommand \url{http://www.ifi.uio.no/~jensthi/chktex/}
19157
19158 \end_inset
19159
19160 .
19161 \end_layout
19162
19163 \begin_layout Standard
19164 The 
19165 \family sans
19166 ChkTeX
19167 \family default
19168  package is a program that was written by 
19169 \noun on
19170 Jens T.
19171  Berger Thielemann
19172 \noun default
19173  in frustration because some constructs in LaTeX are sometimes non-intuitive,
19174  and easy to forget.
19175  The program runs over your LaTeX file and checks the integrity of the file,
19176  and flags some common errors.
19177  In other technical words, it is 
19178 \family typewriter
19179 Lint
19180 \family default
19181  for LaTeX.
19182 \end_layout
19183
19184 \begin_layout Standard
19185 Well, what is a syntax checker doing in LyX which is supposed to produce
19186  correct LaTeX anyways? The answer is simple: Just as 
19187 \family typewriter
19188 Lint
19189 \family default
19190  not only checks the 
19191 \emph on
19192 syntax
19193 \emph default
19194  of C programs, but also does 
19195 \emph on
19196 semantic
19197 \emph default
19198  checks for type-errors, 
19199 \family sans
19200 ChkTeX
19201 \family default
19202  catches some common 
19203 \emph on
19204 typographic
19205 \emph default
19206  errors, in addition to the syntactical ones.
19207  Specifically, 
19208 \family sans
19209 ChkTeX
19210 \family default
19211  is capable of detecting several common errors, such as
19212 \end_layout
19213
19214 \begin_layout Itemize
19215 Ellipsis detection:
19216 \newline
19217 Use \SpecialChar \ldots{}
19218  instead of ...
19219 \end_layout
19220
19221 \begin_layout Itemize
19222 No space in front of/after parenthesis:
19223 \newline
19224 ( wrong spacing )
19225 \end_layout
19226
19227 \begin_layout Itemize
19228 Enforcement of normal space after common abbreviations:
19229 \newline
19230 e.
19231  g.
19232  is too wide spacing.
19233 \end_layout
19234
19235 \begin_layout Itemize
19236 Enforcement of end-of-sentence space when the last sentence ends with a
19237  capital letter:
19238 \newline
19239 This is a TEST.
19240  And this is wrong spacing.
19241 \end_layout
19242
19243 \begin_layout Itemize
19244 Space in front of labels and similar commands:
19245 \newline
19246 The label should stick right
19247  up to the text to avoid falling to a wrong page.
19248  
19249 \begin_inset LatexCommand \label{sec:chktex}
19250
19251 \end_inset
19252
19253  
19254 \begin_inset Foot
19255 status collapsed
19256
19257 \begin_layout Standard
19258 This footnote is in danger of falling off to a wrong page
19259 \end_layout
19260
19261 \end_inset
19262
19263  The label is separated too much.
19264 \end_layout
19265
19266 \begin_layout Itemize
19267 Space in front of references, instead of hard spaces:
19268 \newline
19269 In you are in bad luck,
19270  the text will break right between the referenced text and reference number,
19271  and that's a pity.
19272  See section 
19273 \begin_inset LatexCommand \ref{sec:chktex}
19274
19275 \end_inset
19276
19277 .
19278 \end_layout
19279
19280 \begin_layout Itemize
19281 Use of 
19282 \begin_inset Quotes eld
19283 \end_inset
19284
19285 x
19286 \begin_inset Quotes erd
19287 \end_inset
19288
19289  instead of 
19290 \begin_inset Formula $\times$
19291 \end_inset
19292
19293  between numbers:
19294 \newline
19295 2x2 looks cheap compared to 
19296 \begin_inset Formula $2\times2$
19297 \end_inset
19298
19299 .
19300 \end_layout
19301
19302 \begin_layout Standard
19303 and more \SpecialChar \ldots{}
19304  It is an invaluable tool when you are 
19305 \begin_inset Quotes eld
19306 \end_inset
19307
19308 finishing up
19309 \begin_inset Quotes erd
19310 \end_inset
19311
19312  your document before printing, and you should run it right after the obligatory
19313  spelling check, and before you go fine tuning the typesetting.
19314 \end_layout
19315
19316 \begin_layout Subsection
19317 How to use it
19318 \end_layout
19319
19320 \begin_layout Standard
19321 If you have the program installed, usage is as simple as choosing 
19322 \family sans
19323 \bar under
19324 T
19325 \bar default
19326 ools\SpecialChar \menuseparator
19327
19328 \bar under
19329 C
19330 \bar default
19331 heck\InsetSpace ~
19332 TeX
19333 \family default
19334 .
19335  This will make LyX generate a LaTeX file of your document, start 
19336 \family sans
19337 ChkTeX
19338 \family default
19339  to check it, and then make LyX insert 
19340 \begin_inset Quotes eld
19341 \end_inset
19342
19343 error boxes
19344 \begin_inset Quotes erd
19345 \end_inset
19346
19347  with the warnings from 
19348 \family sans
19349 ChkTeX
19350 \family default
19351 , if there were any.
19352  The warnings will be placed close to the point of the mistake, and you
19353  can quickly find them by using the 
19354 \family sans
19355 \bar under
19356 N
19357 \bar default
19358 avigate\SpecialChar \menuseparator
19359
19360 \bar under
19361 E
19362 \bar default
19363 rror
19364 \family default
19365  menu item, or the shortcut key 
19366 \family sans
19367 C-g
19368 \family default
19369  from the default 
19370 \family typewriter
19371 cua
19372 \family default
19373  bind file.
19374  Open the error boxes by clicking on them with the mouse, or use the shortcut
19375  key 
19376 \family sans
19377 C-i
19378 \family default
19379  from 
19380 \family typewriter
19381 cua
19382 \family default
19383  bindings, or the corresponding 
19384 \family sans
19385 C-o
19386 \family default
19387  for the alternate 
19388 \family typewriter
19389 emacs
19390 \family default
19391  bind file.
19392  Read the warning and correct the mistake, if it is a mistake.
19393  If you have trouble understanding what the warning is about, you can safely
19394  ignore it.
19395  Remember that there is a hidden layer between the document on screen and
19396  the technical details in invoking 
19397 \family sans
19398 ChkTeX
19399 \family default
19400 , and this gap can make some warnings seem arcane or just right down plain
19401  silly.
19402 \end_layout
19403
19404 \begin_layout Standard
19405 This document is an excellent testing bed for the feature, and it should
19406  provide quite a few warnings for you to fiddle with.
19407  Since computers are only so smart, expect most of the warnings to be false
19408  alarms, though.
19409 \end_layout
19410
19411 \begin_layout Subsection
19412 How to fine tune it
19413 \end_layout
19414
19415 \begin_layout Standard
19416 Sometimes, you'll find that 
19417 \family sans
19418 ChkTeX
19419 \family default
19420  makes more noise than suits your mood.
19421  Then you can choose not to use it, wait until your mood changes, or try
19422  to customize 
19423 \family sans
19424 ChkTeX
19425 \family default
19426  to get better along with you.
19427  Another choice in the most desperate situations is to use 
19428 \family sans
19429 \bar under
19430 V
19431 \bar default
19432 iew\SpecialChar \menuseparator
19433
19434 \bar under
19435 R
19436 \bar default
19437 emove\InsetSpace ~
19438 All\InsetSpace ~
19439 Error\InsetSpace ~
19440 Boxes
19441 \family default
19442 , which will get rid of all warnings instantly.
19443 \end_layout
19444
19445 \begin_layout Standard
19446 Although 
19447 \family sans
19448 ChkTeX
19449 \family default
19450  
19451 \emph on
19452 is
19453 \emph default
19454  very configurable and extensible, you shouldn't expect to solve all problems
19455  with 
19456 \family sans
19457 ChkTeX
19458 \family default
19459  in LyX this way.
19460  Since LyX has to generate a somewhat special LaTeX file to be able to match
19461  the line numbers from the 
19462 \family sans
19463 ChkTeX
19464 \family default
19465  output
19466 \begin_inset Foot
19467 status collapsed
19468
19469 \begin_layout Standard
19470 You can inspect the specific output from 
19471 \family sans
19472 chktex
19473 \family default
19474  by using 
19475 \family sans
19476 Edit\SpecialChar \menuseparator
19477 View\InsetSpace ~
19478 LaTeX\InsetSpace ~
19479 Log
19480 \family default
19481  right after a 
19482 \family sans
19483 chktex
19484 \family default
19485  run.
19486 \end_layout
19487
19488 \end_inset
19489
19490  to the internal document structure, some of the warnings will not seen
19491  to appear correctly.
19492  There are two things you can do about this:
19493 \end_layout
19494
19495 \begin_layout Itemize
19496 Fine tune the 
19497 \family sans
19498 ChkTeX
19499 \family default
19500  invocation command line in 
19501 \family sans
19502 Preferences
19503 \family default
19504  (tabs 
19505 \family sans
19506 Outputs
19507 \family default
19508
19509 \family sans
19510 Misc
19511 \family default
19512 ), or the global 
19513 \family sans
19514 ChkTeX
19515 \family default
19516  installation configuration file (usually with the file 
19517 \family typewriter
19518 /usr/local/share/chktexrc
19519 \family default
19520 ).
19521  See below to learn what warnings can be enabled and disabled on the command
19522  line.
19523  
19524 \end_layout
19525
19526 \begin_layout Itemize
19527 Export your document as a raw LaTeX file using 
19528 \family sans
19529 \bar under
19530 F
19531 \bar default
19532 ile\SpecialChar \menuseparator
19533
19534 \bar under
19535 E
19536 \bar default
19537 xport\SpecialChar \menuseparator
19538
19539 \bar under
19540 L
19541 \bar default
19542 aTeX
19543 \family default
19544  and run 
19545 \family typewriter
19546 chktex
19547 \family default
19548  manually on that.
19549  Invoked in this way, it can be a hassle to find the corresponding place
19550  in the document inside LyX, but with a little patience, you should be able
19551  to do it.
19552 \end_layout
19553
19554 \begin_layout Standard
19555 Here follows the warning messages that can be enabled and disabled in 
19556 \family sans
19557 Preferences
19558 \family default
19559 .
19560  Use 
19561 \family typewriter
19562 -n#
19563 \family default
19564  to disable a warning, and 
19565 \family typewriter
19566 -w#
19567 \family default
19568  to enable a warning.
19569  The emphasized entries are disabled by default, because the default is
19570  "
19571 \family typewriter
19572 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19573 \family default
19574 ".
19575 \end_layout
19576
19577 \begin_layout Standard
19578 Notice that you should only use the options that enable and disable warnings,
19579  because LyX relies on some of the other command line parameters to be set
19580  in a specific way to have a chance to communicate with 
19581 \family typewriter
19582 chktex
19583 \family default
19584 .
19585 \end_layout
19586
19587 \begin_layout Enumerate
19588
19589 \size small
19590 \emph on
19591 Command terminated with space.
19592 \end_layout
19593
19594 \begin_layout Enumerate
19595
19596 \size small
19597 Non-breaking space (
19598 \begin_inset Quotes eld
19599 \end_inset
19600
19601
19602 \family typewriter
19603 ~
19604 \family default
19605
19606 \begin_inset Quotes erd
19607 \end_inset
19608
19609 ) should have been used.
19610 \end_layout
19611
19612 \begin_layout Enumerate
19613
19614 \size small
19615 \emph on
19616 You should enclose the previous parenthesis with 
19617 \begin_inset Quotes eld
19618 \end_inset
19619
19620
19621 \family typewriter
19622 {}
19623 \family default
19624
19625 \begin_inset Quotes erd
19626 \end_inset
19627
19628 .
19629 \end_layout
19630
19631 \begin_layout Enumerate
19632
19633 \size small
19634 Italic correction (
19635 \begin_inset Quotes eld
19636 \end_inset
19637
19638
19639 \family typewriter
19640
19641 \backslash
19642 /
19643 \family default
19644
19645 \begin_inset Quotes erd
19646 \end_inset
19647
19648 ) found in non-italic buffer.
19649 \end_layout
19650
19651 \begin_layout Enumerate
19652
19653 \size small
19654 Italic correction (
19655 \begin_inset Quotes eld
19656 \end_inset
19657
19658
19659 \family typewriter
19660
19661 \backslash
19662 /
19663 \family default
19664
19665 \begin_inset Quotes erd
19666 \end_inset
19667
19668 ) found more than once.
19669 \end_layout
19670
19671 \begin_layout Enumerate
19672
19673 \size small
19674 \emph on
19675 No italic correction (
19676 \begin_inset Quotes eld
19677 \end_inset
19678
19679
19680 \family typewriter
19681
19682 \backslash
19683 /
19684 \family default
19685
19686 \begin_inset Quotes erd
19687 \end_inset
19688
19689 ) found.
19690 \end_layout
19691
19692 \begin_layout Enumerate
19693
19694 \size small
19695 Accent command 
19696 \begin_inset Quotes eld
19697 \end_inset
19698
19699
19700 \family typewriter
19701 cmd
19702 \family default
19703
19704 \begin_inset Quotes erd
19705 \end_inset
19706
19707  needs use of 
19708 \begin_inset Quotes eld
19709 \end_inset
19710
19711
19712 \family typewriter
19713 cmd
19714 \family default
19715
19716 \begin_inset Quotes erd
19717 \end_inset
19718
19719 .
19720 \end_layout
19721
19722 \begin_layout Enumerate
19723
19724 \size small
19725 Wrong length of dash may have been used.
19726 \end_layout
19727
19728 \begin_layout Enumerate
19729
19730 \size small
19731 \emph on
19732 \begin_inset Quotes eld
19733 \end_inset
19734
19735
19736 \family typewriter
19737 %s
19738 \family default
19739
19740 \begin_inset Quotes erd
19741 \end_inset
19742
19743  expected, found 
19744 \begin_inset Quotes eld
19745 \end_inset
19746
19747
19748 \family typewriter
19749 %s
19750 \family default
19751
19752 \begin_inset Quotes erd
19753 \end_inset
19754
19755 .
19756 \end_layout
19757
19758 \begin_layout Enumerate
19759
19760 \size small
19761 Solo 
19762 \begin_inset Quotes eld
19763 \end_inset
19764
19765
19766 \family typewriter
19767 %s
19768 \family default
19769
19770 \begin_inset Quotes erd
19771 \end_inset
19772
19773  found.
19774 \end_layout
19775
19776 \begin_layout Enumerate
19777
19778 \size small
19779 You should use 
19780 \begin_inset Quotes eld
19781 \end_inset
19782
19783
19784 \family typewriter
19785 %s
19786 \family default
19787
19788 \begin_inset Quotes erd
19789 \end_inset
19790
19791  to achieve an ellipsis.
19792 \end_layout
19793
19794 \begin_layout Enumerate
19795
19796 \size small
19797 Inter-word spacing (
19798 \begin_inset Quotes eld
19799 \end_inset
19800
19801
19802 \family typewriter
19803
19804 \backslash
19805  
19806 \family default
19807
19808 \begin_inset Quotes eld
19809 \end_inset
19810
19811 ) should perhaps be used.
19812 \end_layout
19813
19814 \begin_layout Enumerate
19815
19816 \size small
19817 Inter-sentence spacing (
19818 \begin_inset Quotes eld
19819 \end_inset
19820
19821
19822 \family typewriter
19823
19824 \backslash
19825 @
19826 \family default
19827
19828 \begin_inset Quotes erd
19829 \end_inset
19830
19831 ) should perhaps be used.
19832 \end_layout
19833
19834 \begin_layout Enumerate
19835
19836 \size small
19837 Could not find argument for command.
19838 \end_layout
19839
19840 \begin_layout Enumerate
19841
19842 \size small
19843 No match found for 
19844 \begin_inset Quotes eld
19845 \end_inset
19846
19847
19848 \family typewriter
19849 %s
19850 \family default
19851
19852 \begin_inset Quotes erd
19853 \end_inset
19854
19855 .
19856 \end_layout
19857
19858 \begin_layout Enumerate
19859
19860 \size small
19861 Math mode still on at end of LaTeX file.
19862 \end_layout
19863
19864 \begin_layout Enumerate
19865
19866 \size small
19867 Number of 
19868 \begin_inset Quotes eld
19869 \end_inset
19870
19871
19872 \family typewriter
19873 char
19874 \family default
19875
19876 \begin_inset Quotes erd
19877 \end_inset
19878
19879  doesn't match the number of 
19880 \begin_inset Quotes eld
19881 \end_inset
19882
19883
19884 \family typewriter
19885 char
19886 \family default
19887
19888 \begin_inset Quotes erd
19889 \end_inset
19890
19891 .
19892 \end_layout
19893
19894 \begin_layout Enumerate
19895
19896 \size small
19897 You should use either 
19898 \family typewriter
19899
19900 \begin_inset Quotes eld
19901 \end_inset
19902
19903
19904 \family default
19905  or 
19906 \family typewriter
19907
19908 \begin_inset Quotes erd
19909 \end_inset
19910
19911
19912 \family default
19913  as an alternative to 
19914 \begin_inset Quotes eld
19915 \end_inset
19916
19917
19918 \family typewriter
19919 "
19920 \family default
19921
19922 \begin_inset Quotes erd
19923 \end_inset
19924
19925 .
19926 \end_layout
19927
19928 \begin_layout Enumerate
19929
19930 \size small
19931 You should use "
19932 \family typewriter
19933 '
19934 \family default
19935 " (ASCII 39) instead of "
19936 \family typewriter
19937 ´
19938 \family default
19939 " (ASCII 180).
19940 \end_layout
19941
19942 \begin_layout Enumerate
19943
19944 \size small
19945 User-specified pattern found.
19946 \end_layout
19947
19948 \begin_layout Enumerate
19949
19950 \size small
19951 This command might not be intended.
19952 \end_layout
19953
19954 \begin_layout Enumerate
19955
19956 \size small
19957 \emph on
19958 Comment displayed.
19959 \end_layout
19960
19961 \begin_layout Enumerate
19962
19963 \size small
19964 Either 
19965 \family typewriter
19966 ''
19967 \backslash
19968 ,'
19969 \family default
19970  or 
19971 \family typewriter
19972 '
19973 \backslash
19974 ,''
19975 \family default
19976  will look better.
19977 \end_layout
19978
19979 \begin_layout Enumerate
19980
19981 \size small
19982 Delete this space to maintain correct page references.
19983 \end_layout
19984
19985 \begin_layout Enumerate
19986
19987 \size small
19988 \emph on
19989 You might wish to put this between a pair of 
19990 \begin_inset Quotes eld
19991 \end_inset
19992
19993
19994 \family typewriter
19995 {}
19996 \family default
19997
19998 \begin_inset Quotes erd
19999 \end_inset
20000
20001 .
20002 \end_layout
20003
20004 \begin_layout Enumerate
20005
20006 \size small
20007 You ought to remove spaces in front of punctuation.
20008 \end_layout
20009
20010 \begin_layout Enumerate
20011
20012 \size small
20013 Could not execute LaTeX command.
20014 \end_layout
20015
20016 \begin_layout Enumerate
20017
20018 \size small
20019 Don't use 
20020 \family typewriter
20021
20022 \backslash
20023 /
20024 \family default
20025  in front of small punctuation.
20026 \end_layout
20027
20028 \begin_layout Enumerate
20029
20030 \family typewriter
20031 \size small
20032 $
20033 \backslash
20034 times$
20035 \family default
20036  may look prettier here.
20037 \end_layout
20038
20039 \begin_layout Enumerate
20040
20041 \size small
20042 \emph on
20043 Multiple spaces detected in output.
20044 \end_layout
20045
20046 \begin_layout Enumerate
20047
20048 \size small
20049 This text may be ignored.
20050 \end_layout
20051
20052 \begin_layout Enumerate
20053
20054 \size small
20055 Use 
20056 \family typewriter
20057
20058 \begin_inset Quotes eld
20059 \end_inset
20060
20061
20062 \family default
20063  to begin quotation, not 
20064 \family typewriter
20065 '
20066 \family default
20067 .
20068 \end_layout
20069
20070 \begin_layout Enumerate
20071
20072 \size small
20073 Use 
20074 \family typewriter
20075 '
20076 \family default
20077  to end quotation, not 
20078 \family typewriter
20079
20080 \begin_inset Quotes eld
20081 \end_inset
20082
20083
20084 \family default
20085 .
20086 \end_layout
20087
20088 \begin_layout Enumerate
20089
20090 \size small
20091 Don't mix quotes.
20092 \end_layout
20093
20094 \begin_layout Enumerate
20095
20096 \size small
20097 You should perhaps use 
20098 \begin_inset Quotes eld
20099 \end_inset
20100
20101
20102 \family typewriter
20103 cmd
20104 \family default
20105
20106 \begin_inset Quotes erd
20107 \end_inset
20108
20109  instead.
20110 \end_layout
20111
20112 \begin_layout Enumerate
20113
20114 \size small
20115 You should put a space in front of/after parenthesis.
20116 \end_layout
20117
20118 \begin_layout Enumerate
20119
20120 \size small
20121 You should avoid spaces in front of/after parenthesis.
20122 \end_layout
20123
20124 \begin_layout Enumerate
20125
20126 \size small
20127 \emph on
20128 You should not use punctuation in front of/after quotes.
20129 \end_layout
20130
20131 \begin_layout Enumerate
20132
20133 \size small
20134 Double space found.
20135 \end_layout
20136
20137 \begin_layout Enumerate
20138
20139 \size small
20140 You should put punctuation outside inner/inside display math mode.
20141 \end_layout
20142
20143 \begin_layout Enumerate
20144
20145 \size small
20146 You ought to not use primitive TeX in LaTeX code.
20147 \end_layout
20148
20149 \begin_layout Enumerate
20150
20151 \size small
20152 You should remove spaces in front of 
20153 \begin_inset Quotes eld
20154 \end_inset
20155
20156
20157 \family typewriter
20158 %s
20159 \family default
20160
20161 \begin_inset Quotes erd
20162 \end_inset
20163
20164
20165 \end_layout
20166
20167 \begin_layout Enumerate
20168
20169 \size small
20170 \begin_inset Quotes eld
20171 \end_inset
20172
20173
20174 \family typewriter
20175 %s
20176 \family default
20177
20178 \begin_inset Quotes erd
20179 \end_inset
20180
20181  is normally not followed by 
20182 \begin_inset Quotes eld
20183 \end_inset
20184
20185
20186 \family typewriter
20187 %c
20188 \family default
20189
20190 \begin_inset Quotes erd
20191 \end_inset
20192
20193 .
20194 \end_layout
20195
20196 \begin_layout Standard
20197 In later versions of LyX, we hope to provide a more complete interface to
20198  this tool (and it's smaller cousin 
20199 \family typewriter
20200 lacheck
20201 \family default
20202 ) to exploit the full power of it.
20203  But it's not exactly useless as it is now: go try it on one of your existing
20204  documents of a certain length and be surprised.
20205 \end_layout
20206
20207 \begin_layout Section
20208 Version Control in LyX
20209 \end_layout
20210
20211 \begin_layout Standard
20212 by
20213 \noun on
20214  Lars Gullik Bjønnes
20215 \end_layout
20216
20217 \begin_layout Subsection
20218 Introduction
20219 \end_layout
20220
20221 \begin_layout Standard
20222 A friend of mine wanted to try LyX for a group project.
20223  When he didn't find support for version control or file locking, he dropped
20224  it.
20225  This angered me a bit, so I thought that I should at least make support
20226  for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
20227  This has now been done.
20228  LyX now supports some of the most basic RCS commands.
20229  If you need to something a bit more sophisticated you will have to do that
20230  manually in an xterm.
20231 \end_layout
20232
20233 \begin_layout Standard
20234 Before you begin to use the version control features in LyX, you should
20235  read 
20236 \begin_inset Quotes eld
20237 \end_inset
20238
20239 rcsintro
20240 \begin_inset Quotes erd
20241 \end_inset
20242
20243  (a man file, read it with 
20244 \family typewriter
20245 man rcsintro
20246 \family default
20247 ).
20248  This file describes all the basic features of RCS.
20249  You should especially notice the comment about a RCS directory, and the
20250  notion of a master RCS file (the file ending in 
20251 \family typewriter
20252 ,v
20253 \family default
20254 ).
20255 \end_layout
20256
20257 \begin_layout Standard
20258 The implementation in LyX assumes a recent version of the GNU RCS package---no
20259  guarantees are made for older versions.
20260 \end_layout
20261
20262 \begin_layout Subsection
20263 RCS commands in LyX
20264 \end_layout
20265
20266 \begin_layout Standard
20267 The following sections describe the RCS commands supported by LyX.
20268  You can find them in the 
20269 \family sans
20270 \bar under
20271 F
20272 \bar default
20273 ile\SpecialChar \menuseparator
20274
20275 \bar under
20276 V
20277 \bar default
20278 ersion\InsetSpace ~
20279 Control
20280 \family default
20281  submenu.
20282 \end_layout
20283
20284 \begin_layout Subsubsection
20285
20286 \family sans
20287 Register
20288 \end_layout
20289
20290 \begin_layout Standard
20291 If your document is not under revision control, this is the only item shown
20292  in the menu.
20293  And if it is under revision control, the 
20294 \family sans
20295 \bar under
20296 R
20297 \bar default
20298 egister
20299 \family default
20300  item is grayed out.
20301  
20302 \end_layout
20303
20304 \begin_layout Standard
20305 This command registers your document with RCS\SpecialChar \@.
20306  You are asked interactively
20307  to supply an initial description of the document.
20308  The document is now set in Read-Only mode and you have to 
20309 \family sans
20310 Check\InsetSpace ~
20311 Out\InsetSpace ~
20312 For\InsetSpace ~
20313 Edit
20314 \family default
20315 , before making any changes to it.
20316  A document under revision control has a 
20317 \begin_inset Quotes eld
20318 \end_inset
20319
20320 [RCS:<version> <locker>]
20321 \begin_inset Quotes erd
20322 \end_inset
20323
20324  item tagged to the filename in the minibuffer.
20325 \end_layout
20326
20327 \begin_layout Standard
20328 RCS command that is run: 
20329 \family typewriter
20330 ci -q -u -i -t-"<initial description>" <file-name>
20331 \end_layout
20332
20333 \begin_layout Standard
20334 Read 
20335 \family typewriter
20336 man ci
20337 \family default
20338  to understand the switches.
20339  
20340 \end_layout
20341
20342 \begin_layout Subsubsection
20343
20344 \family sans
20345 Check In Changes
20346 \end_layout
20347
20348 \begin_layout Standard
20349 When you are finished editing a file, you check in your changes.
20350  When you do this, you are asked for a description of the changes.
20351  This is stored in the history log.
20352  The version number is bumped, your changes are applied to the master RCS
20353  file, the document is unlocked and set to Read-Only mode.
20354  
20355 \end_layout
20356
20357 \begin_layout Standard
20358 RCS command: 
20359 \family typewriter
20360 ci -q -u -m"<description>" <file-name>
20361 \end_layout
20362
20363 \begin_layout Subsubsection
20364
20365 \family sans
20366 Check Out For Edit
20367 \end_layout
20368
20369 \begin_layout Standard
20370 By doing this you lock the document so that only you can edit it.
20371  This will also make the document Read-Write only for you.
20372  You will usually continue editing for a while and when you are finished
20373  you check in your changes.
20374  The status line is changed to reflect that you have locked the file.
20375  
20376 \end_layout
20377
20378 \begin_layout Standard
20379 RCS command: 
20380 \family typewriter
20381 co -q -l <file-name>
20382 \end_layout
20383
20384 \begin_layout Subsubsection
20385
20386 \family sans
20387 Revert To Last Version
20388 \end_layout
20389
20390 \begin_layout Standard
20391 This will discard all changes made to the document since the last check
20392  in.
20393  You get a warning before changes are discarded.
20394 \end_layout
20395
20396 \begin_layout Standard
20397 RCS command: 
20398 \family typewriter
20399 co -f -u<version> <file-name>
20400 \end_layout
20401
20402 \begin_layout Subsubsection
20403
20404 \family sans
20405 Undo Last Checkin
20406 \end_layout
20407
20408 \begin_layout Standard
20409 This makes as if the last check in never happened.
20410  No changes are made to the document loaded into LyX, but the last version
20411  is removed from the master RCS file.
20412  
20413 \end_layout
20414
20415 \begin_layout Standard
20416 RCS command: 
20417 \family typewriter
20418 rcs -o<version> <file-name>
20419 \end_layout
20420
20421 \begin_layout Subsubsection
20422
20423 \family sans
20424 Show History
20425 \end_layout
20426
20427 \begin_layout Standard
20428 This show the complete history of the RCS document.
20429  The output of 
20430 \family typewriter
20431 rlog <file-name>
20432 \family default
20433  is shown in a browser.
20434  See 
20435 \family typewriter
20436 man rlog
20437 \family default
20438  for more info.
20439 \end_layout
20440
20441 \begin_layout Section
20442 Literate Programming
20443 \end_layout
20444
20445 \begin_layout Standard
20446 Updated by 
20447 \noun on
20448 Kayvan Sylvan 
20449 \noun default
20450 (kayvan@sylvan.com)
20451 \noun on
20452
20453 \noun default
20454 original documentation written by 
20455 \noun on
20456 Edmar Wienskoski Jr.
20457
20458 \noun default
20459  (edmar-w-jr@technologist.com)
20460 \end_layout
20461
20462 \begin_layout Subsection
20463 Introduction
20464 \end_layout
20465
20466 \begin_layout Standard
20467 The main purpose of this documentation is to show you how to use LyX for
20468  literate programming.
20469  Where it is assumed that you are familiar with this programming technique,
20470  and know what 
20471 \begin_inset Quotes eld
20472 \end_inset
20473
20474 tangling
20475 \begin_inset Quotes erd
20476 \end_inset
20477
20478  and 
20479 \begin_inset Quotes eld
20480 \end_inset
20481
20482 weaving
20483 \begin_inset Quotes erd
20484 \end_inset
20485
20486  means.
20487  If that is not the case, please follow the web links provided in the following
20488  sections.
20489  There is a lot of good documentation out there covering old development
20490  history to the latest tools tips.
20491 \end_layout
20492
20493 \begin_layout Standard
20494 It is also assumed that you are familiar with LyX itself to a point that
20495  you are comfortable changing your LyX preferences, and X resources file.
20496  If that is not the case please refer to other LyX documentation to cover
20497  your specific needs.
20498 \end_layout
20499
20500 \begin_layout Subsection
20501 Literate Programming
20502 \end_layout
20503
20504 \begin_layout Standard
20505 From the Literate Programming FAQ: 
20506 \end_layout
20507
20508 \begin_layout Quotation
20509 Literate programming is the combination of documentation and source together
20510  in a fashion suited for reading by human beings.
20511  In fact, literate programs should be enjoyable reading, even inviting!
20512  (Sorry Bob, I couldn't resist!) In general, literate programs combine source
20513  and documentation in a single file.
20514  Literate programming tools then parse the file to produce either readable
20515  documentation or compilable source.
20516  The WEB style of literate programming was created by D.E.
20517  Knuth during the development of his TeX typesetting software.
20518  
20519 \end_layout
20520
20521 \begin_layout Standard
20522 Another excerpt says:
20523 \end_layout
20524
20525 \begin_layout Quotation
20526
20527 \emph on
20528 How is literate programming different from verbose commenting?
20529 \end_layout
20530
20531 \begin_layout Quotation
20532 There are three distinguishing characteristics.
20533  In order of importance, they are: 
20534 \end_layout
20535
20536 \begin_deeper
20537 \begin_layout Itemize
20538 flexible order of elaboration 
20539 \end_layout
20540
20541 \begin_layout Itemize
20542 automatic support for browsing 
20543 \end_layout
20544
20545 \begin_layout Itemize
20546 typeset documentation, especially diagrams and mathematics 
20547 \end_layout
20548
20549 \end_deeper
20550 \begin_layout Standard
20551 Now that I sparked your curiosity, take a look in the references.
20552 \end_layout
20553
20554 \begin_layout Subsubsection
20555 References
20556 \end_layout
20557
20558 \begin_layout Standard
20559 The complete Literate Programming FAQ can be found at:
20560 \end_layout
20561
20562 \begin_layout Quote
20563 \begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
20564
20565 \end_inset
20566
20567
20568 \end_layout
20569
20570 \begin_layout Standard
20571 The FAQ lists 23 (twenty three!) different literate programming tools.
20572  Where some are specialized or 
20573 \begin_inset Quotes eld
20574 \end_inset
20575
20576 tailored
20577 \begin_inset Quotes erd
20578 \end_inset
20579
20580  for particular programming languages, while other have general scope.
20581  I selected 
20582 \noun on
20583 Noweb
20584 \noun default
20585  for my own use for several reasons:
20586 \end_layout
20587
20588 \begin_layout Itemize
20589 It can generate the documentation either in latex or html.
20590 \end_layout
20591
20592 \begin_layout Itemize
20593 It has a open architecture, i.e., it is easy to plug in new filters and to
20594  perform special processing that you may need.
20595  
20596 \end_layout
20597
20598 \begin_layout Itemize
20599 There is a good selection of filters available already (the html is one
20600  of them).
20601 \end_layout
20602
20603 \begin_layout Itemize
20604 It is free.
20605 \end_layout
20606
20607 \begin_layout Standard
20608 The Noweb web page can be found at: 
20609 \end_layout
20610
20611 \begin_layout Quote
20612 \begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
20613
20614 \end_inset
20615
20616
20617 \end_layout
20618
20619 \begin_layout Standard
20620 Starting from there you can reach many other interesting links and even
20621  some literate program examples.
20622 \end_layout
20623
20624 \begin_layout Subsection
20625 LyX and Literate Programming
20626 \end_layout
20627
20628 \begin_layout Standard
20629 The LyX support for Literate Programming is provided by using the generic
20630  LyX convertors mechanism.
20631  This support is provided in a 
20632 \begin_inset Quotes eld
20633 \end_inset
20634
20635 Noweb independent
20636 \begin_inset Quotes erd
20637 \end_inset
20638
20639  way, i.e., you will be able to use this new LyX feature with some other literate
20640  programming tool of your choice by just changing your LyX preferences.
20641 \end_layout
20642
20643 \begin_layout Subsubsection
20644 Generating documents and code (weaving and tangling)
20645 \end_layout
20646
20647 \begin_layout Paragraph
20648 Selecting the document class
20649 \end_layout
20650
20651 \begin_layout Standard
20652 If you have installed Noweb and LyX successfully, whenever you open a new
20653  document or try to change the document class of an existing one, you will
20654  find that there are three new document classes available:
20655 \end_layout
20656
20657 \begin_layout Itemize
20658 Article (Noweb)
20659 \end_layout
20660
20661 \begin_layout Itemize
20662 Book (Noweb)
20663 \end_layout
20664
20665 \begin_layout Itemize
20666 Report (Noweb)
20667 \end_layout
20668
20669 \begin_layout Standard
20670 You must select one of them to create your literate documents from.
20671  
20672 \end_layout
20673
20674 \begin_layout Standard
20675 Note that literate documents are not limited to these three classes.
20676  New classes can be generated from other styles like letter or in combination
20677  with other class variations like Article (AMS).
20678  If you have special needs that cannot be covered by one of the existing
20679  classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
20680  will arrange to insert a new entry, or teach you how to do it.
20681 \begin_inset Foot
20682 status collapsed
20683
20684 \begin_layout Standard
20685 It is very simple, it involves the creation of a file with four lines, and
20686  re-running of the auto configuration.
20687 \end_layout
20688
20689 \end_inset
20690
20691  Moreover, if you use a literate tool other than Noweb you may need to create
20692  a new set of document classes for it.
20693 \end_layout
20694
20695 \begin_layout Paragraph
20696 Typing code in
20697 \end_layout
20698
20699 \begin_layout Standard
20700 LyX enables you to write code with a layout named 
20701 \noun on
20702 Scrap
20703 \noun default
20704 .
20705 \begin_inset Foot
20706 status collapsed
20707
20708 \begin_layout Standard
20709 The equivalent Noweb term is 
20710 \begin_inset Quotes eld
20711 \end_inset
20712
20713 Chunk
20714 \begin_inset Quotes erd
20715 \end_inset
20716
20717 .
20718  For historical reasons, I got used to the term 
20719 \begin_inset Quotes eld
20720 \end_inset
20721
20722 scrap
20723 \begin_inset Quotes erd
20724 \end_inset
20725
20726  introduced by other literate tool named Nuweb, which I used for many years
20727  before rendering myself to Noweb.
20728 \end_layout
20729
20730 \end_inset
20731
20732  Noweb delimits scraps like this:
20733 \end_layout
20734
20735 \begin_layout LyX-Code
20736 <<My scrap>>=
20737 \end_layout
20738
20739 \begin_layout LyX-Code
20740   code
20741 \end_layout
20742
20743 \begin_layout LyX-Code
20744   more code
20745 \end_layout
20746
20747 \begin_layout LyX-Code
20748   even more code
20749 \end_layout
20750
20751 \begin_layout LyX-Code
20752   @
20753 \end_layout
20754
20755 \begin_layout Standard
20756 The problem is that whatever is written in between the << and the 
20757 \family typewriter
20758 @
20759 \family default
20760  must be taken literally, i.e., LyX should be prevented from making any special
20761  interpretation of what has been written.
20762  This is handled by a special layout named Scrap, that works like a normal
20763  paragraph but has a free spacing capability.
20764 \end_layout
20765
20766 \begin_layout Standard
20767 The down side of the Scrap paragraph layout is that consecutive paragraphs
20768  of code will be spaced with one empty line in the source code and also
20769  in the printed documentation.
20770  The work around is to enter each line of code within a single Scrap, with
20771  a newline (ctrl-return).
20772  The example above will look like this:
20773 \begin_inset Foot
20774 status collapsed
20775
20776 \begin_layout Standard
20777 If you have a printed version of this document you will not see any difference
20778  between the previous example and this one.
20779 \end_layout
20780
20781 \end_inset
20782
20783
20784 \end_layout
20785
20786 \begin_layout LyX-Code
20787 <<My scrap>>=
20788 \newline
20789   code
20790 \newline
20791   more code
20792 \newline
20793   even more code
20794 \newline
20795   @
20796 \end_layout
20797
20798 \begin_layout Standard
20799 This layout works fine.
20800  The only real inconvenience is that you have to type ctrl-return instead
20801  of a plain return.
20802 \begin_inset Foot
20803 status collapsed
20804
20805 \begin_layout Standard
20806 It is in my list of 
20807 \begin_inset Quotes eld
20808 \end_inset
20809
20810 improvements
20811 \begin_inset Quotes erd
20812 \end_inset
20813
20814  to fix that.
20815 \end_layout
20816
20817 \end_inset
20818
20819
20820 \end_layout
20821
20822 \begin_layout Standard
20823 As a special note, you can also use the 
20824 \begin_inset Quotes eld
20825 \end_inset
20826
20827 %def
20828 \begin_inset Quotes erd
20829 \end_inset
20830
20831  construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
20832 rence:
20833 \end_layout
20834
20835 \begin_layout LyX-Code
20836 <<My scrap>>=
20837 \newline
20838   def some_function(args):
20839 \newline
20840     "This is the doc string for this
20841  function."
20842 \newline
20843     print "My args: ", args
20844 \end_layout
20845
20846 \begin_layout LyX-Code
20847 @ %def some_function
20848 \end_layout
20849
20850 \begin_layout Standard
20851 For an example of this usage and the resulting cross-reference output, look
20852  at the Literate python program in 
20853 \emph on
20854 LIBDIR/examples/listerrors.lyx 
20855 \emph default
20856 which should make this all clear.
20857 \end_layout
20858
20859 \begin_layout Paragraph
20860 Generating the documentation
20861 \end_layout
20862
20863 \begin_layout Standard
20864 At this point you already have a new document file with a proper document
20865  class, and with some code and text on it.
20866  How do I print it? The answer is simple, you select 
20867 \family sans
20868 \bar under
20869 V
20870 \bar default
20871 iew\SpecialChar \menuseparator
20872
20873 \bar under
20874 D
20875 \bar default
20876 VI,
20877 \family default
20878  etc.
20879  Just like you would do for a plain document.
20880  No special procedure is required.
20881 \end_layout
20882
20883 \begin_layout Standard
20884 To help orientate you, I will now explain what happens inside LyX:
20885 \end_layout
20886
20887 \begin_layout Enumerate
20888 When the 
20889 \family sans
20890 \bar under
20891 U
20892 \bar default
20893 pdate\SpecialChar \menuseparator
20894
20895 \bar under
20896 D
20897 \bar default
20898 VI 
20899 \family default
20900 menu option is chosen, a latex file is generated.
20901  
20902 \end_layout
20903
20904 \begin_deeper
20905 \begin_layout Standard
20906 If the document is of any literate class the generated file will be named
20907  with an extension name defined by the 
20908 \begin_inset Quotes eld
20909 \end_inset
20910
20911 literate
20912 \begin_inset Quotes erd
20913 \end_inset
20914
20915  format (defined in the Preferences panel), otherwise the file will have
20916  the usual 
20917 \family typewriter
20918 .tex 
20919 \family default
20920 extension.
20921 \end_layout
20922
20923 \end_deeper
20924 \begin_layout Enumerate
20925 Note that the only difference so far is in the name of the file, no special
20926  processing is required by LyX.
20927  Given that you formatted the code using the Scrap layout that, by itself,
20928  takes care of the business.
20929 \end_layout
20930
20931 \begin_layout Enumerate
20932 If the document is of any literate class LyX will then use the internal
20933  LyX to Noweb converter, followed by the Noweb to LaTeX converter
20934 \begin_inset Foot
20935 status open
20936
20937 \begin_layout Standard
20938 The converters are defined in the 
20939 \family sans
20940 \bar under
20941 T
20942 \bar default
20943 ools\SpecialChar \menuseparator
20944
20945 \bar under
20946 P
20947 \bar default
20948 references
20949 \family default
20950  panel, under the 
20951 \begin_inset Quotes eld
20952 \end_inset
20953
20954 Conversion
20955 \begin_inset Quotes erd
20956 \end_inset
20957
20958  tab.
20959 \end_layout
20960
20961 \end_inset
20962
20963  to generate the LaTeX file.
20964 \end_layout
20965
20966 \begin_deeper
20967 \begin_layout Standard
20968 Otherwise it will just skip this step.
20969 \end_layout
20970
20971 \end_deeper
20972 \begin_layout Enumerate
20973 Finally, LaTeX is invoked and the regular post processing continues as in
20974  a plain document.
20975 \end_layout
20976
20977 \begin_layout Standard
20978 Independence from a particular 
20979 \begin_inset Quotes eld
20980 \end_inset
20981
20982 literate tool
20983 \begin_inset Quotes erd
20984 \end_inset
20985
20986  is easily achieved by changing the commands that are run by the various
20987  converters.
20988 \end_layout
20989
20990 \begin_layout Paragraph
20991 Generating the code
20992 \end_layout
20993
20994 \begin_layout Standard
20995 When the build menu option is chosen or the corresponding button in the
20996  toolbar is pressed, a latex file is generated just like step 1 above.
20997  Next, LyX invokes the
20998 \family typewriter
20999  Noweb->Program
21000 \family default
21001  converter.
21002  Typically, this converter (like any other converter), has two parts:
21003 \end_layout
21004
21005 \begin_layout Enumerate
21006 The converter program itself.
21007  This program performs the conversion from the one format to the other (in
21008  this case, from the Noweb format to the Program pseudo-format).
21009 \end_layout
21010
21011 \begin_layout Enumerate
21012 The error log parser.
21013  This is a program whose sole purpose is to rewrite error messages in a
21014  format that LyX understands.
21015  This makes it possible for LyX to place error boxes in the right places
21016  in the file buffer.
21017 \end_layout
21018
21019 \begin_layout Standard
21020 The first part, the 
21021 \begin_inset Quotes eld
21022 \end_inset
21023
21024 Converter
21025 \begin_inset Quotes erd
21026 \end_inset
21027
21028  setting, should be set to 
21029 \begin_inset Quotes eld
21030 \end_inset
21031
21032
21033 \family typewriter
21034 build-script $$i
21035 \family default
21036
21037 \begin_inset Quotes erd
21038 \end_inset
21039
21040 .
21041  This basically means that LyX will call 
21042 \begin_inset Quotes eld
21043 \end_inset
21044
21045 build-script
21046 \begin_inset Quotes erd
21047 \end_inset
21048
21049  (a program or script) with the name of the Noweb file (generally a file
21050  in the LyX temp directory).
21051  
21052 \end_layout
21053
21054 \begin_layout Standard
21055 This is an implementation of 
21056 \begin_inset Quotes eld
21057 \end_inset
21058
21059 build-script
21060 \begin_inset Quotes erd
21061 \end_inset
21062
21063  that you can place in a directory on your path:
21064 \end_layout
21065
21066 \begin_layout LyX-Code
21067 #!/bin/sh
21068 \end_layout
21069
21070 \begin_layout LyX-Code
21071 #
21072 \end_layout
21073
21074 \begin_layout LyX-Code
21075 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
21076 \end_layout
21077
21078 \begin_layout Standard
21079 The next part of the converter setting is the 
21080 \begin_inset Quotes eld
21081 \end_inset
21082
21083 Flags
21084 \begin_inset Quotes erd
21085 \end_inset
21086
21087  which is to be set to 
21088 \begin_inset Quotes eld
21089 \end_inset
21090
21091
21092 \family typewriter
21093 originaldir,parselog=listerrors
21094 \family default
21095
21096 \begin_inset Quotes erd
21097 \end_inset
21098
21099 .
21100  This will run any errors that are generated by the 
21101 \begin_inset Quotes eld
21102 \end_inset
21103
21104 build-script
21105 \begin_inset Quotes erd
21106 \end_inset
21107
21108  process through the 
21109 \begin_inset Quotes eld
21110 \end_inset
21111
21112 listerrors
21113 \begin_inset Quotes erd
21114 \end_inset
21115
21116  program.
21117 \end_layout
21118
21119 \begin_layout Standard
21120 The converter code looks in 
21121 \emph on
21122 MYLYXDIR/scripts 
21123 \emph default
21124 first, then in
21125 \emph on
21126  LIBDIR/scripts 
21127 \emph default
21128 then on the path for the 
21129 \begin_inset Quotes eld
21130 \end_inset
21131
21132 listerrors
21133 \begin_inset Quotes erd
21134 \end_inset
21135
21136  program.
21137 \end_layout
21138
21139 \begin_layout Paragraph
21140 Build instructions in the document
21141 \end_layout
21142
21143 \begin_layout Standard
21144 The last piece of the integration between LyX and noweb is the 
21145 \begin_inset Quotes eld
21146 \end_inset
21147
21148 build-script
21149 \begin_inset Quotes erd
21150 \end_inset
21151
21152  scrap.
21153  Generally, the instructions for building your program should be embedded
21154  in a scrap of its own.
21155  The noweb-specific 
21156 \begin_inset Quotes eld
21157 \end_inset
21158
21159 build-script
21160 \begin_inset Quotes erd
21161 \end_inset
21162
21163  above uses the notangle command to look for this scrap (called 
21164 \begin_inset Quotes eld
21165 \end_inset
21166
21167 build-script
21168 \begin_inset Quotes erd
21169 \end_inset
21170
21171 ) and runs its contents through 
21172 \begin_inset Quotes eld
21173 \end_inset
21174
21175 sh
21176 \begin_inset Quotes erd
21177 \end_inset
21178
21179 .
21180 \end_layout
21181
21182 \begin_layout Standard
21183 Typically, such a scrap would look something like this:
21184 \end_layout
21185
21186 \begin_layout LyX-Code
21187 <<build-script>>=
21188 \newline
21189 #!/bin/sh
21190 \newline
21191
21192 \newline
21193 if [ -z "${NOWEB_SOURCE}" ]
21194 \newline
21195 then
21196 \newline
21197   NOWEB_SOURCE=myfile.nw
21198 \newline
21199
21200 fi
21201 \newline
21202 [...
21203  code to extract files ...]
21204 \newline
21205 [...
21206  code to compile files ...]
21207 \newline
21208 @
21209 \end_layout
21210
21211 \begin_layout Standard
21212 Look in 
21213 \emph on
21214 LIBDIR/examples/listerrors.lyx 
21215 \emph default
21216 or in 
21217 \emph on
21218 LIBDIR/examples/Literate.lyx
21219 \emph default
21220  which implement two versions of the 
21221 \begin_inset Quotes eld
21222 \end_inset
21223
21224 listerrors
21225 \begin_inset Quotes erd
21226 \end_inset
21227
21228  program for some illustrations of how all of these pieces go together or
21229  in 
21230 \emph on
21231 LIBDIR/examples/noweb2lyx.lyx.
21232  
21233 \emph default
21234 Interestingly, these three files show off the language-indepence of the
21235  LyX literate programming support since they are written in Python, C and
21236  Perl respectively.
21237 \end_layout
21238
21239 \begin_layout Subsubsection
21240 Configuring LyX
21241 \end_layout
21242
21243 \begin_layout Standard
21244 All the Literate Programming support is configured by the 
21245 \family sans
21246 \bar under
21247 T
21248 \bar default
21249 ools\SpecialChar \menuseparator
21250
21251 \bar under
21252 P
21253 \bar default
21254 references
21255 \family default
21256  panel in the 
21257 \begin_inset Quotes eld
21258 \end_inset
21259
21260 Conversion
21261 \begin_inset Quotes erd
21262 \end_inset
21263
21264  tab.
21265  The important parts are:
21266 \end_layout
21267
21268 \begin_layout Description
21269 the\InsetSpace ~
21270
21271 \begin_inset Quotes eld
21272 \end_inset
21273
21274 literate
21275 \begin_inset Quotes erd
21276 \end_inset
21277
21278 \InsetSpace ~
21279 format Set up via the Formats tab, this is where the Noweb-specific pieces
21280  are set up.
21281  The 
21282 \family sans
21283 GUI Name
21284 \family default
21285  is set to 
21286 \family typewriter
21287 NoWeb
21288 \family default
21289 , the file extension is set to 
21290 \family typewriter
21291 .nw
21292 \family default
21293 .
21294  This tells LyX to create a file with a 
21295 \family typewriter
21296 .nw
21297 \family default
21298  extension in the first step of the conversion process.
21299 \end_layout
21300
21301 \begin_layout Description
21302 the\InsetSpace ~
21303
21304 \family sans
21305 Program
21306 \family default
21307 \InsetSpace ~
21308 format This is an empty format whose sole purpose is to be the endpoint
21309  of a conversion (which then allows us to set up a converter for it).
21310 \end_layout
21311
21312 \begin_layout Description
21313
21314 \family sans
21315 NoWeb
21316 \family default
21317 ->
21318 \family sans
21319 LaTeX
21320 \family default
21321  This converter performs the 
21322 \begin_inset Quotes eld
21323 \end_inset
21324
21325 weaving
21326 \begin_inset Quotes erd
21327 \end_inset
21328
21329  of the literate document.
21330  For Noweb, it is set to 
21331 \begin_inset Quotes eld
21332 \end_inset
21333
21334
21335 \family typewriter
21336 noweave -delay -index $$i > $$o
21337 \family default
21338
21339 \begin_inset Quotes erd
21340 \end_inset
21341
21342
21343 \end_layout
21344
21345 \begin_layout Description
21346
21347 \family sans
21348 NoWeb
21349 \family default
21350 ->
21351 \family sans
21352 Program
21353 \family default
21354  This performs the 
21355 \begin_inset Quotes eld
21356 \end_inset
21357
21358 tangling step
21359 \begin_inset Quotes erd
21360 \end_inset
21361
21362 .
21363  As stated above, the Converter is set to 
21364 \begin_inset Quotes eld
21365 \end_inset
21366
21367
21368 \family typewriter
21369 build-script $$i
21370 \family default
21371
21372 \begin_inset Quotes erd
21373 \end_inset
21374
21375 , with Flags set to 
21376 \begin_inset Quotes eld
21377 \end_inset
21378
21379
21380 \family typewriter
21381 originaldir,parselog=listerrors
21382 \family default
21383
21384 \begin_inset Quotes erd
21385 \end_inset
21386
21387 .
21388 \end_layout
21389
21390 \begin_layout Subsubsection
21391 Debug extensions
21392 \end_layout
21393
21394 \begin_layout Standard
21395 There is also a new function implemented in the LyX server, the 
21396 \begin_inset Quotes eld
21397 \end_inset
21398
21399 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
21400  
21401 \end_layout
21402
21403 \begin_layout Standard
21404 When debugging code with ddd/gdb, it is possible to invoke a text editor
21405  at the current execution position with a single key stroke.
21406  The default ddd configuration for that is shift-ctrl-V.
21407  It happens that you can define the editor command line invocation in ddd
21408  by accessing the
21409 \family sans
21410  
21411 \bar under
21412 E
21413 \bar default
21414 dit\SpecialChar \menuseparator
21415
21416 \bar under
21417 P
21418 \bar default
21419 references\SpecialChar \menuseparator
21420
21421 \bar under
21422 H
21423 \bar default
21424 elpers 
21425 \family default
21426 dialog and changing the "Edit Sources" entry.
21427 \end_layout
21428
21429 \begin_layout Standard
21430 I take advantage of the new created LyX server function and this ddd feature,
21431  and set 
21432 \begin_inset Quotes eld
21433 \end_inset
21434
21435 Edit Sources
21436 \begin_inset Quotes erd
21437 \end_inset
21438
21439  to:
21440 \end_layout
21441
21442 \begin_layout LyX-Code
21443 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
21444 \end_layout
21445
21446 \begin_layout Standard
21447 With this, whenever you are using ddd and find a point in the program that
21448  you want to edit, you just press shift-ctrl-V (in the ddd window), and
21449  ddd you forward this information to LyX through the LyX server and then
21450  the LyX window will show the same file with the cursor at the same position
21451  ddd was pointing to.
21452  No more guessing or long scrolling to locate a point in the program back
21453  from debugging !
21454 \end_layout
21455
21456 \begin_layout Standard
21457 Note however that you must enable the LyX server to get this feature working
21458  (it is disabled by default).
21459  You can enable it in 
21460 \family sans
21461 Preferences
21462 \family default
21463  (tabs 
21464 \family sans
21465 Inputs
21466 \family default
21467
21468 \family sans
21469 Paths
21470 \family default
21471 ) by entering in the 
21472 \family sans
21473 LyXserver pipe
21474 \family default
21475  a path like 
21476 \begin_inset Quotes eld
21477 \end_inset
21478
21479
21480 \family typewriter
21481 /home/<your-home-directory>/.lyx/lyxpipe
21482 \family default
21483
21484 \begin_inset Quotes erd
21485 \end_inset
21486
21487
21488 \end_layout
21489
21490 \begin_layout Standard
21491 Read the LyX server documentation in the 
21492 \emph on
21493 Customization Manual
21494 \emph default
21495  for further information.
21496 \end_layout
21497
21498 \begin_layout Subsubsection
21499 Toolbar extensions
21500 \end_layout
21501
21502 \begin_layout Standard
21503 There are six new buttons that can be added to your LyX toolbar.
21504  Five of these buttons are short cuts to layout styles: 
21505 \family sans
21506 Standard
21507 \family default
21508
21509 \family sans
21510 Section
21511 \family default
21512
21513 \family sans
21514 LaTeX
21515 \family default
21516
21517 \family sans
21518 LyX-Code
21519 \family default
21520 , and 
21521 \family sans
21522 Scrap
21523 \family default
21524 .
21525  The last one is a short cut to the 
21526 \begin_inset Quotes eld
21527 \end_inset
21528
21529 Build Program
21530 \begin_inset Quotes erd
21531 \end_inset
21532
21533  File menu entry.
21534  
21535 \end_layout
21536
21537 \begin_layout Standard
21538 LyX has a range of buttons that are available for tool bar customization.
21539  In my toolbar I like to combine the six short cuts above with two more:
21540  One for 
21541 \family sans
21542 \bar under
21543 V
21544 \bar default
21545 iew
21546 \family default
21547 \SpecialChar \menuseparator
21548
21549 \family sans
21550 \bar under
21551 U
21552 \bar default
21553 pdate
21554 \family default
21555 \SpecialChar \menuseparator
21556
21557 \family sans
21558 \bar under
21559 D
21560 \bar default
21561 VI
21562 \family default
21563  and the other for 
21564 \family sans
21565 \bar under
21566 V
21567 \bar default
21568 iew\SpecialChar \menuseparator
21569
21570 \bar under
21571 D
21572 \bar default
21573 VI
21574 \family default
21575  File menu entries.
21576  Here is how it looks like:
21577 \end_layout
21578
21579 \begin_layout LyX-Code
21580 Toolbar
21581 \end_layout
21582
21583 \begin_layout LyX-Code
21584   Layouts
21585 \end_layout
21586
21587 \begin_layout LyX-Code
21588   Icon "layout Standard"
21589 \end_layout
21590
21591 \begin_layout LyX-Code
21592   Icon "layout Section"
21593 \end_layout
21594
21595 \begin_layout LyX-Code
21596   Icon "layout LaTeX"
21597 \end_layout
21598
21599 \begin_layout LyX-Code
21600   Icon "layout LyX-Code"
21601 \end_layout
21602
21603 \begin_layout LyX-Code
21604   Icon "layout Scrap"
21605 \end_layout
21606
21607 \begin_layout LyX-Code
21608   Separator
21609 \end_layout
21610
21611 \begin_layout LyX-Code
21612   Icon "buffer-view"
21613 \end_layout
21614
21615 \begin_layout LyX-Code
21616   Icon "buffer-typeset"
21617 \end_layout
21618
21619 \begin_layout LyX-Code
21620   Icon "build-program"
21621 \end_layout
21622
21623 \begin_layout LyX-Code
21624   Separator
21625 \end_layout
21626
21627 \begin_layout LyX-Code
21628 .
21629 \end_layout
21630
21631 \begin_layout LyX-Code
21632 .
21633 \end_layout
21634
21635 \begin_layout LyX-Code
21636 .
21637 \end_layout
21638
21639 \begin_layout LyX-Code
21640 End
21641 \end_layout
21642
21643 \begin_layout Subsubsection
21644 Colors customization
21645 \end_layout
21646
21647 \begin_layout Standard
21648 There are a number of colors in LyX that can be customized in 
21649 \family sans
21650 Preferences
21651 \family default
21652 .
21653  One of the things that bothers people is the LaTeX font color.
21654  The default color is red, since the scraps uses LaTeX font, and there is
21655  a lot of scraps in literate documents, you may get tired of seeing everything
21656  in red.
21657  You can change it by going to the tabs 
21658 \family sans
21659 Look&Feel
21660 \family default
21661
21662 \family sans
21663 Colors.
21664 \end_layout
21665
21666 \begin_layout Standard
21667 The next thing is the visible presence of the newline character in the screen.
21668  You can choose the color of this particular character and make it blend
21669  in the background.
21670  I recommend you choosing a color that is close to the background but not
21671  equal, that way you still can see it is there, but it is not bothering
21672  you anymore.
21673  
21674 \end_layout
21675
21676 \begin_layout Chapter
21677 Secrets of the LaTeX Masters
21678 \begin_inset LatexCommand \label{cha:secrets}
21679
21680 \end_inset
21681
21682
21683 \end_layout
21684
21685 \begin_layout Standard
21686 Though LyX is a powerful tool, it cannot hope to support everything that
21687  can be done with pure TeX/LaTeX.
21688  However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
21689  as long as you are not afraid to use that 
21690 \begin_inset Quotes eld
21691 \end_inset
21692
21693 TeX
21694 \begin_inset Quotes erd
21695 \end_inset
21696
21697  button on the toolbar or add things to the LaTeX preamble.
21698  This section lists some tips, tricks, and otherwise cool ideas to give
21699  your document that extra little flair.
21700  
21701 \emph on
21702 Do try this at home
21703 \emph default
21704 , just start with something a little smaller and less important than your
21705  dissertation!
21706 \end_layout
21707
21708 \begin_layout Standard
21709 Most ideas in this section require less common files in your LaTeX installation.
21710  If you have a system like teTeX, most will already be available.
21711  A few, however, will need to be downloaded from one of the CTAN archives.
21712  Often, there are several ways to do something, or several LaTeX style files
21713  which do the same thing.
21714  We do not endorse one choice over another, we simply claim that we have
21715  done a particular task with a particular file.
21716  Put on your wizard hat, keep an eye out for dragons, and let us begin.
21717 \end_layout
21718
21719 \begin_layout Section
21720 Tricks for Footnotes and Margin Notes
21721 \end_layout
21722
21723 \begin_layout Standard
21724 suggested by 
21725 \noun on
21726 Robin Socha
21727 \end_layout
21728
21729 \begin_layout Subsection
21730 Footnotes 
21731 \end_layout
21732
21733 \begin_layout Standard
21734 LyX cannot yet take care of setting the footnote numbering back to 1 after
21735  each section in the 
21736 \begin_inset Quotes eld
21737 \end_inset
21738
21739
21740 \family sans
21741 article
21742 \family default
21743
21744 \begin_inset Quotes erd
21745 \end_inset
21746
21747
21748 \family roman
21749  document class or changing the counter style.
21750  You'll need to insert LaTeX commands like the following to achieve that:
21751 \end_layout
21752
21753 \begin_layout Standard
21754 \begin_inset ERT
21755 status inlined
21756
21757 \begin_layout Standard
21758
21759
21760 \backslash
21761 setcounter{footnote}{0}
21762 \end_layout
21763
21764 \end_inset
21765
21766  Using 
21767 \family typewriter
21768
21769 \backslash
21770 setcounter{footnote}{0}
21771 \family roman
21772  will set the counter back to 1
21773 \begin_inset Foot
21774 status collapsed
21775
21776 \begin_layout Standard
21777 The counter has been set back to 1.
21778 \end_layout
21779
21780 \end_inset
21781
21782 .
21783 \end_layout
21784
21785 \begin_layout Standard
21786 The following command will change the numbering to small letters.
21787  Take a look at the next footnote in your xdvi or ghostview 
21788 \begin_inset ERT
21789 status inlined
21790
21791 \begin_layout Standard
21792
21793
21794 \backslash
21795 renewcommand{
21796 \backslash
21797 thefootnote}{
21798 \backslash
21799 alph{footnote}}
21800 \end_layout
21801
21802 \end_inset
21803
21804 :
21805 \begin_inset Foot
21806 status collapsed
21807
21808 \begin_layout Standard
21809 This is an example for a footnote with alphabetic numbering.
21810 \newline
21811 Use
21812 \family typewriter
21813  
21814 \backslash
21815 renewcommand{
21816 \backslash
21817 thefootnote {
21818 \backslash
21819 alph{footnote}} 
21820 \family roman
21821 to get this.
21822 \end_layout
21823
21824 \end_inset
21825
21826
21827 \end_layout
21828
21829 \begin_layout Standard
21830 The next command sets the counter style back to default, i.e.
21831  
21832 \family typewriter
21833
21834 \backslash
21835 arabic
21836 \family default
21837
21838 \begin_inset Foot
21839 status collapsed
21840
21841 \begin_layout Standard
21842 Use
21843 \family typewriter
21844  
21845 \backslash
21846 renewcommand{
21847 \backslash
21848 thefootnote}{
21849 \backslash
21850 arabic{footnote}}
21851 \family roman
21852  to set the counter--style back to LyX's default, i.e.
21853  
21854 \backslash
21855 arabic.
21856 \family default
21857
21858 \begin_inset ERT
21859 status collapsed
21860
21861 \begin_layout Standard
21862
21863
21864 \backslash
21865 renewcommand {
21866 \backslash
21867 thefootnote} {
21868 \backslash
21869 arabic{footnote}}
21870 \end_layout
21871
21872 \end_inset
21873
21874
21875 \end_layout
21876
21877 \end_inset
21878
21879 .
21880 \end_layout
21881
21882 \begin_layout Standard
21883 You can use 
21884 \family typewriter
21885
21886 \backslash
21887 arabic
21888 \family default
21889
21890 \family typewriter
21891
21892 \backslash
21893 roman
21894 \family default
21895
21896 \family typewriter
21897
21898 \backslash
21899 Roman
21900 \family default
21901
21902 \family typewriter
21903
21904 \backslash
21905 alph
21906 \family default
21907  or 
21908 \family typewriter
21909
21910 \backslash
21911 Alph
21912 \family default
21913  and others as counter styles.
21914  Just replace the LaTeX command in the above example and rerun TeX to see
21915  what those styles can do.
21916  
21917 \end_layout
21918
21919 \begin_layout Subsection
21920 Margin Notes
21921 \end_layout
21922
21923 \begin_layout Standard
21924 Here are two examples of neat things you can do to margin notes using LaTeX
21925  commands.
21926 \end_layout
21927
21928 \begin_layout Standard
21929 The following command will make a vertical line appear alongside your text---gre
21930 at for 
21931 \begin_inset Quotes eld
21932 \end_inset
21933
21934 thumbing
21935 \begin_inset Quotes erd
21936 \end_inset
21937
21938
21939 \family typewriter
21940
21941 \backslash
21942 marginpar{
21943 \backslash
21944 rule[-10mm]{30mm}{5mm}}
21945 \family roman
21946 .
21947 \family default
21948
21949 \begin_inset ERT
21950 status inlined
21951
21952 \begin_layout Standard
21953
21954
21955 \backslash
21956 marginpar{
21957 \backslash
21958 rule[-10mm]{30mm}{5mm}}
21959 \end_layout
21960
21961 \end_inset
21962
21963
21964 \end_layout
21965
21966 \begin_layout Standard
21967 Check your dvi- or ghostview-output to see what the 
21968 \family typewriter
21969
21970 \backslash
21971 reversemarginpar 
21972 \family default
21973 command does to the following margin note.
21974 \end_layout
21975
21976 \begin_layout Standard
21977 \begin_inset ERT
21978 status inlined
21979
21980 \begin_layout Standard
21981
21982
21983 \backslash
21984 reversemarginpar
21985 \end_layout
21986
21987 \end_inset
21988
21989
21990 \begin_inset Marginal
21991 status collapsed
21992
21993 \begin_layout Standard
21994 This is a 
21995 \newline
21996 margin note.
21997 \end_layout
21998
21999 \end_inset
22000
22001
22002 \end_layout
22003
22004 \begin_layout Section
22005 Multiple Columns
22006 \end_layout
22007
22008 \begin_layout Standard
22009 by 
22010 \noun on
22011 Lars Gullik Bjønnes
22012 \end_layout
22013
22014 \begin_layout Subsection
22015 Purpose
22016 \end_layout
22017
22018 \begin_layout Standard
22019 The aim for this chapter
22020 \begin_inset Foot
22021 status collapsed
22022
22023 \begin_layout Standard
22024 Editor's note: Lars' original chapter was a masterful description of how
22025  to use the 
22026 \family typewriter
22027 multicol
22028 \family default
22029  package.
22030  However, it was too long to flow smoothly in this document.
22031  I have therefore chosen to excerpt the most important sections here (sorry,
22032  Lars); you can read the original chapter (and more of the story!) in the
22033  example file 
22034 \family typewriter
22035 examples/multicol.lyx
22036 \family default
22037 .
22038  --- mer
22039 \end_layout
22040
22041 \end_inset
22042
22043  is to show how the LaTeX package 
22044 \family typewriter
22045 multicol
22046 \family default
22047  can be used in a LyX document.
22048  As LyX doesn't support the 
22049 \family typewriter
22050 multicol
22051 \family default
22052  package natively yet, we have to use some small hacks.
22053  By reading this section it should be obvious how to do this.
22054 \end_layout
22055
22056 \begin_layout Subsection
22057 Limitations 
22058 \end_layout
22059
22060 \begin_layout Standard
22061 The 
22062 \family typewriter
22063 multicol
22064 \family default
22065  package allows switching between one and multicolumn format on the same
22066  page.
22067  Footnotes are handled correctly (for the most part), but will be placed
22068  at the bottom of the page and not under each column.
22069  LaTeX's float mechanism, however, is partly disabled in the current implementat
22070 ion.
22071  At the moment only page-wide floats can be used within the scope of the
22072  environment.
22073 \end_layout
22074
22075 \begin_layout Subsection
22076 Examples
22077 \end_layout
22078
22079 \begin_layout Subsubsection
22080 Two columns
22081 \end_layout
22082
22083 \begin_layout Standard
22084 If you want to have two columns in your text, you have use LaTeX mode to
22085  insert 
22086 \family typewriter
22087
22088 \backslash
22089 begin{multicols}{2}
22090 \family default
22091  at the point where you want the two column layout to start, and then 
22092 \family typewriter
22093
22094 \backslash
22095 end{multicols}
22096 \family default
22097  where you want it to end.
22098  Like this:
22099 \end_layout
22100
22101 \begin_layout Standard
22102 \begin_inset ERT
22103 status inlined
22104
22105 \begin_layout Standard
22106
22107
22108 \backslash
22109 begin{multicols}{2}
22110 \end_layout
22111
22112 \end_inset
22113
22114
22115 \end_layout
22116
22117 \begin_layout Standard
22118 \noindent
22119
22120 \series bold
22121 \size small
22122 The Adventure of the Empty House
22123 \series default
22124
22125 \newline
22126 by 
22127 \noun on
22128 Sir Arthur Conan Doyle
22129 \end_layout
22130
22131 \begin_layout Standard
22132
22133 \size small
22134 It was in the spring of the year 1894 that all London was interested, and
22135  the fashionable world dismayed, by the murder of the Honourable Ronald
22136  Adair under most unusual and inexplicable circumstances.
22137  The public has already learned those particulars of the crime which came
22138  out in the police investigation, but a good deal was suppressed upon that
22139  occasion, since the case for the prosecution was so overwhelmingly strong
22140  that it was not necessary to bring forward all the facts.
22141  Only now, at the end of nearly ten years, am I allowed to supply those
22142  missing links which make up the whole of that remarkable chain.
22143  The crime was of interest in itself, but that interest was as nothing to
22144  me compared to the inconceivable sequel, which afforded me the greatest
22145  shock and surprise of any event in my adventurous life.
22146  Even now, after this long interval, I find myself thrilling as I think
22147  of it, and feeling once more that sudden flood of joy, amazement, and increduli
22148 ty which utterly submerged my mind.
22149  Let me say to that public, which has shown some interest in those glimpses
22150  which I have occasionally given them of the thoughts and actions of a very
22151  remarkable man, that they are not to blame me if I have not shared my knowledge
22152  with them, for I should have considered it my first duty to do so, had
22153  I not been barred by a positive prohibition from his own lips, which was
22154  only withdrawn upon the third of last month.
22155 \end_layout
22156
22157 \begin_layout Standard
22158 \begin_inset ERT
22159 status inlined
22160
22161 \begin_layout Standard
22162
22163
22164 \backslash
22165 end{multicols}
22166 \end_layout
22167
22168 \end_inset
22169
22170
22171 \end_layout
22172
22173 \begin_layout Subsubsection
22174 Multiple columns
22175 \end_layout
22176
22177 \begin_layout Standard
22178 The same pattern is used when you want more than two columns:
22179 \end_layout
22180
22181 \begin_layout Standard
22182 \begin_inset ERT
22183 status inlined
22184
22185 \begin_layout Standard
22186
22187
22188 \backslash
22189 begin{multicols}{3}
22190 \end_layout
22191
22192 \end_inset
22193
22194
22195 \end_layout
22196
22197 \begin_layout Standard
22198
22199 \size footnotesize
22200 It can be imagined that my close intimacy with Sherlock Holmes had interested
22201  me deeply in crime, and that after his disappearance I never failed to
22202  read with care the various problems which came before the public.
22203  And I even attempted, more than once, for my own private satisfaction,
22204  to employ his methods in their solution, though with indifferent success.
22205  There was none, however, which appealed to me like this tragedy of Ronald
22206  Adair.
22207  As I read the evidence at the inquest, which led up to a verdict of willful
22208  murder against some person or persons unknown, I realized more clearly
22209  than I had ever done the loss which the community had sustained by the
22210  death of Sherlock Holmes.
22211  There were points about this strange business which would, I was sure,
22212  have specially appealed to him, and the efforts of the police would have
22213  been supplemented, or more probably anticipated, by the trained observation
22214  and the alert mind of the first criminal agent in Europe.
22215  All day, as I drove upon my round, I turned over the case in my mind and
22216  found no explanation which appeared to me to be adequate.
22217  At the risk of telling a twice-told tale, I will recapitulate the facts
22218  as they were known to the public at the conclusion of the inquest.
22219 \end_layout
22220
22221 \begin_layout Standard
22222 \begin_inset ERT
22223 status inlined
22224
22225 \begin_layout Standard
22226
22227
22228 \backslash
22229 end{multicols}
22230 \end_layout
22231
22232 \end_inset
22233
22234
22235 \end_layout
22236
22237 \begin_layout Standard
22238 You can have have more than 3 columns if you want to, but that might not
22239  be very pleasant for the eye.
22240 \end_layout
22241
22242 \begin_layout Subsubsection
22243 Columns inside columns
22244 \end_layout
22245
22246 \begin_layout Standard
22247 You can even have columns inside columns:
22248 \end_layout
22249
22250 \begin_layout Standard
22251 \begin_inset ERT
22252 status inlined
22253
22254 \begin_layout Standard
22255
22256
22257 \backslash
22258 begin{multicols}{2}
22259 \end_layout
22260
22261 \end_inset
22262
22263
22264 \end_layout
22265
22266 \begin_layout Standard
22267
22268 \size footnotesize
22269 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
22270  at that time governor of one of the Australian colonies.
22271  Adair's mother had returned from Australia to undergo the operation for
22272  cataract, and she, her son Ronald, and her daughter Hilda were living together
22273  at 427 Park Lane.
22274 \end_layout
22275
22276 \begin_layout Standard
22277 \begin_inset ERT
22278 status inlined
22279
22280 \begin_layout Standard
22281
22282
22283 \backslash
22284 begin{multicols}{2}
22285 \end_layout
22286
22287 \end_inset
22288
22289
22290 \end_layout
22291
22292 \begin_layout Standard
22293
22294 \size footnotesize
22295 The youth moved in the best society--had, so far as was known, no enemies
22296  and no particular vices.
22297  He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
22298  had been broken off by mutual consent some months before, and there was
22299  no sign that it had left any very profound feeling behind it.
22300  For the rest {sic} the man's life moved in a narrow and conventional circle,
22301  for his habits were quiet and his nature unemotional.
22302  Yet it was upon this easy-going young aristocrat that death came, in most
22303  strange and unexpected form, between the hours of ten and eleven-twenty
22304  on the night of March 30, 1894.
22305 \end_layout
22306
22307 \begin_layout Standard
22308 \begin_inset ERT
22309 status inlined
22310
22311 \begin_layout Standard
22312
22313
22314 \backslash
22315 end{multicols}
22316 \end_layout
22317
22318 \end_inset
22319
22320
22321 \end_layout
22322
22323 \begin_layout Standard
22324
22325 \size footnotesize
22326 Ronald Adair was fond of cards--playing continually, but never for such
22327  stakes as would hurt him.
22328  He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
22329  It was shown that, after dinner on the day of his death, he had played
22330  a rubber of whist at the latter club.
22331  He had also played there in the afternoon.
22332
22333 \size default
22334  
22335 \size footnotesize
22336 The evidence of those who had played with him-- Mr.
22337  Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
22338  and that there was a fairly equal fall of the cards.
22339  Adair might have lost five pounds, but not more.
22340  His fortune was a considerable one, and such a loss could not in any way
22341  affect him.
22342  He had played nearly every day at one club or other, but he was a cautious
22343  player, and usually rose a winner.
22344  It came out in evidence that, in partnership with Colonel Moran, he had
22345  actually won as much as four hundred and twenty pounds in a sitting, some
22346  weeks before, from Godfrey Milner and Lord Balmoral.
22347  So much for his recent history as it came out at the inquest.
22348 \end_layout
22349
22350 \begin_layout Standard
22351 \begin_inset ERT
22352 status inlined
22353
22354 \begin_layout Standard
22355
22356
22357 \backslash
22358 end{multicols}
22359 \end_layout
22360
22361 \end_inset
22362
22363
22364 \end_layout
22365
22366 \begin_layout Standard
22367 Please do read the file 
22368 \family typewriter
22369 examples/multicol.lyx
22370 \family default
22371  for more advanced examples including column and header spacing, vertical
22372  separator lines, and more.
22373 \end_layout
22374
22375 \begin_layout Section
22376 Numbering in the 
22377 \family sans
22378 Enumerate
22379 \family default
22380  Paragraph Environment
22381 \begin_inset OptArg
22382 status collapsed
22383
22384 \begin_layout Standard
22385 Numbering in Enumerate
22386 \end_layout
22387
22388 \end_inset
22389
22390
22391 \end_layout
22392
22393 \begin_layout Standard
22394 by 
22395 \noun on
22396 John Weiss
22397 \end_layout
22398
22399 \begin_layout Standard
22400 \begin_inset VSpace bigskip
22401 \end_inset
22402
22403
22404 \end_layout
22405
22406 \begin_layout Standard
22407 \noindent
22408 The default numbering for the 
22409 \family sans
22410 Enumerate
22411 \family default
22412  paragraph environment begins with Arabic numbers and ends with uppercase
22413  letters.
22414  Suppose, however, you wanted a different type of numbering scheme.
22415  Here's a quickie example of how to change the numbering scheme:
22416 \end_layout
22417
22418 \begin_layout LyX-Code
22419
22420 \backslash
22421 renewcommand{
22422 \backslash
22423 labelenumi}{
22424 \backslash
22425 Roman{enumi}.}
22426 \end_layout
22427
22428 \begin_layout LyX-Code
22429
22430 \backslash
22431 renewcommand{
22432 \backslash
22433 labelenumii}{
22434 \backslash
22435 Alph{enumii}.}
22436 \end_layout
22437
22438 \begin_layout LyX-Code
22439
22440 \backslash
22441 renewcommand{
22442 \backslash
22443 labelenumiii}{
22444 \backslash
22445 arabic{enumiii}.}
22446 \end_layout
22447
22448 \begin_layout LyX-Code
22449
22450 \backslash
22451 renewcommand{
22452 \backslash
22453 labelenumiv}{
22454 \backslash
22455 alph{enumiv}.)}
22456 \end_layout
22457
22458 \begin_layout Standard
22459 \SpecialChar \ldots{}
22460  which changes the numbering scheme to uppercase Roman numerals, uppercase
22461  letters, Arabic numbers, and lowercase letter.
22462 \end_layout
22463
22464 \begin_layout Standard
22465 Additionally, the previous example also adds a little bit extra to the numbering
22466  scheme.
22467  For example, the first level label actually looks like: 
22468 \begin_inset Quotes eld
22469 \end_inset
22470
22471 I.
22472 \begin_inset Quotes erd
22473 \end_inset
22474
22475 .
22476  For ease of reading, we'll describe what the numbering schemes look like
22477  using a notation something like this: <
22478 \begin_inset Quotes eld
22479 \end_inset
22480
22481 I.
22482 \begin_inset Quotes erd
22483 \end_inset
22484
22485 ,\InsetSpace ~
22486
22487 \begin_inset Quotes erd
22488 \end_inset
22489
22490 A.
22491 \begin_inset Quotes erd
22492 \end_inset
22493
22494 ,\InsetSpace ~
22495
22496 \begin_inset Quotes erd
22497 \end_inset
22498
22499 1.
22500 \begin_inset Quotes erd
22501 \end_inset
22502
22503 ,\InsetSpace ~
22504
22505 \begin_inset Quotes eld
22506 \end_inset
22507
22508 a.)
22509 \begin_inset Quotes erd
22510 \end_inset
22511
22512 >.
22513  
22514 \end_layout
22515
22516 \begin_layout Standard
22517 As you can see in the example, there is a label command for each nesting
22518  level, 
22519 \family typewriter
22520
22521 \backslash
22522 labelenumi
22523 \family default
22524  \SpecialChar \ldots{}
22525  
22526 \family typewriter
22527
22528 \backslash
22529 labelenumiv
22530 \family default
22531 , as well as a counter, 
22532 \family typewriter
22533 enumi
22534 \family default
22535  \SpecialChar \ldots{}
22536  
22537 \family typewriter
22538 enumiv
22539 \family default
22540 .
22541  There are also five 
22542 \begin_inset Quotes eld
22543 \end_inset
22544
22545 number printing
22546 \begin_inset Quotes erd
22547 \end_inset
22548
22549  commands, 
22550 \family typewriter
22551
22552 \backslash
22553 arabic{}
22554 \family default
22555
22556 \family typewriter
22557
22558 \backslash
22559 roman{}
22560 \family default
22561
22562 \family typewriter
22563
22564 \backslash
22565 Roman{}
22566 \family default
22567
22568 \family typewriter
22569
22570 \backslash
22571 alph{}
22572 \family default
22573 , and 
22574 \family typewriter
22575
22576 \backslash
22577 Alph{}
22578 \family default
22579 , each of which take one counter as an argument.
22580  You can add characters before or after these, but there's no need to add
22581  spaces.
22582 \end_layout
22583
22584 \begin_layout Standard
22585 You can get really fancy with these.
22586  For example:
22587 \end_layout
22588
22589 \begin_layout LyX-Code
22590
22591 \backslash
22592 renewcommand{
22593 \backslash
22594 labelenumi}{
22595 \backslash
22596 #
22597 \backslash
22598 Alph{enumi}
22599 \backslash
22600 #}
22601 \end_layout
22602
22603 \begin_layout LyX-Code
22604
22605 \backslash
22606 renewcommand{
22607 \backslash
22608 labelenumii}{
22609 \backslash
22610 Alph{enumi}.
22611 \backslash
22612 arabic{enumii}}
22613 \end_layout
22614
22615 \begin_layout LyX-Code
22616
22617 \backslash
22618 renewcommand{
22619 \backslash
22620 labelenumiii}{
22621 \backslash
22622 alph{enumiii}+}
22623 \end_layout
22624
22625 \begin_layout LyX-Code
22626
22627 \backslash
22628 renewcommand{
22629 \backslash
22630 labelenumiv}{(
22631 \backslash
22632 roman{enumiv})}
22633 \end_layout
22634
22635 \begin_layout Standard
22636 produces the somewhat out of hand numbering scheme: <
22637 \begin_inset Quotes eld
22638 \end_inset
22639
22640 #A#
22641 \begin_inset Quotes erd
22642 \end_inset
22643
22644 ,\InsetSpace ~
22645
22646 \begin_inset Quotes erd
22647 \end_inset
22648
22649 A.1
22650 \begin_inset Quotes erd
22651 \end_inset
22652
22653 ,\InsetSpace ~
22654
22655 \begin_inset Quotes erd
22656 \end_inset
22657
22658 a+
22659 \begin_inset Quotes erd
22660 \end_inset
22661
22662 ,\InsetSpace ~
22663
22664 \begin_inset Quotes eld
22665 \end_inset
22666
22667 (i)
22668 \begin_inset Quotes erd
22669 \end_inset
22670
22671 >.
22672  
22673 \end_layout
22674
22675 \begin_layout Section
22676 Extra Space Between Table Rows
22677 \end_layout
22678
22679 \begin_layout Standard
22680 by 
22681 \noun on
22682 Mike Ressler
22683 \end_layout
22684
22685 \begin_layout Standard
22686 \begin_inset VSpace bigskip
22687 \end_inset
22688
22689
22690 \end_layout
22691
22692 \begin_layout Standard
22693 \noindent
22694 LaTeX allows you to put a bit of extra space between rows in a table by
22695  giving an optional argument to the end-of-row specifier (
22696 \family typewriter
22697
22698 \backslash
22699
22700 \backslash
22701
22702 \family default
22703 ).
22704  LyX has not yet implemented this in a formal way, so here are two dirty
22705  little tricks to do the same job.
22706  
22707 \end_layout
22708
22709 \begin_layout Standard
22710 The first is the more formal, but longwinded way to do it.
22711  In the LaTeX preamble, add the following command definition: 
22712 \end_layout
22713
22714 \begin_layout Standard
22715
22716 \family typewriter
22717
22718 \backslash
22719 newcommand{
22720 \backslash
22721 extratablespace}[1]{
22722 \backslash
22723 noalign{vskip#1}}
22724 \family default
22725  This command takes a single argument---the amount of space you would like
22726  to insert.
22727  Insert the command in the first column of the row 
22728 \emph on
22729 after
22730 \emph default
22731  where you would like the space to appear.
22732  Here is an example (I've removed all the borders using 
22733 \family sans
22734 \bar under
22735 L
22736 \bar default
22737 ayout\SpecialChar \menuseparator
22738 Tabl
22739 \bar under
22740 e
22741 \family default
22742 \bar default
22743 ):
22744 \end_layout
22745
22746 \begin_layout Standard
22747 \align center
22748 \begin_inset Tabular
22749 <lyxtabular version="3" rows="4" columns="3">
22750 <features>
22751 <column alignment="center" valignment="top" width="0pt">
22752 <column alignment="center" valignment="top" width="0pt">
22753 <column alignment="center" valignment="top" width="0pt">
22754 <row>
22755 <cell alignment="center" valignment="top" topline="true" usebox="none">
22756 \begin_inset Text
22757
22758 \begin_layout Standard
22759
22760 \family roman
22761 \series medium
22762 \shape up
22763 \size normal
22764 \emph off
22765 \bar no
22766 \noun off
22767 \color none
22768 Minerals
22769 \end_layout
22770
22771 \end_inset
22772 </cell>
22773 <cell alignment="center" valignment="top" topline="true" usebox="none">
22774 \begin_inset Text
22775
22776 \begin_layout Standard
22777
22778 \family roman
22779 \series medium
22780 \shape up
22781 \size normal
22782 \emph off
22783 \bar no
22784 \noun off
22785 \color none
22786 Calcite
22787 \end_layout
22788
22789 \end_inset
22790 </cell>
22791 <cell alignment="center" valignment="top" topline="true" usebox="none">
22792 \begin_inset Text
22793
22794 \begin_layout Standard
22795
22796 \family roman
22797 \series medium
22798 \shape up
22799 \size normal
22800 \emph off
22801 \bar no
22802 \noun off
22803 \color none
22804 Dolomite
22805 \end_layout
22806
22807 \end_inset
22808 </cell>
22809 </row>
22810 <row>
22811 <cell alignment="center" valignment="top" topline="true" usebox="none">
22812 \begin_inset Text
22813
22814 \begin_layout Standard
22815
22816 \end_layout
22817
22818 \end_inset
22819 </cell>
22820 <cell alignment="center" valignment="top" topline="true" usebox="none">
22821 \begin_inset Text
22822
22823 \begin_layout Standard
22824
22825 \family roman
22826 \series medium
22827 \shape up
22828 \size normal
22829 \emph off
22830 \bar no
22831 \noun off
22832 \color none
22833 Quartz
22834 \end_layout
22835
22836 \end_inset
22837 </cell>
22838 <cell alignment="center" valignment="top" topline="true" usebox="none">
22839 \begin_inset Text
22840
22841 \begin_layout Standard
22842
22843 \family roman
22844 \series medium
22845 \shape up
22846 \size normal
22847 \emph off
22848 \bar no
22849 \noun off
22850 \color none
22851 Graphite
22852 \end_layout
22853
22854 \end_inset
22855 </cell>
22856 </row>
22857 <row>
22858 <cell alignment="center" valignment="top" topline="true" usebox="none">
22859 \begin_inset Text
22860
22861 \begin_layout Standard
22862
22863 \family roman
22864 \series medium
22865 \shape up
22866 \size normal
22867 \emph off
22868 \bar no
22869 \noun off
22870 \color none
22871 \begin_inset ERT
22872 status collapsed
22873
22874 \begin_layout Standard
22875
22876
22877 \backslash
22878 extratablespace{2ex}
22879 \end_layout
22880
22881 \end_inset
22882
22883 Rocks
22884 \end_layout
22885
22886 \end_inset
22887 </cell>
22888 <cell alignment="center" valignment="top" topline="true" usebox="none">
22889 \begin_inset Text
22890
22891 \begin_layout Standard
22892
22893 \family roman
22894 \series medium
22895 \shape up
22896 \size normal
22897 \emph off
22898 \bar no
22899 \noun off
22900 \color none
22901 Limestone
22902 \end_layout
22903
22904 \end_inset
22905 </cell>
22906 <cell alignment="center" valignment="top" topline="true" usebox="none">
22907 \begin_inset Text
22908
22909 \begin_layout Standard
22910
22911 \family roman
22912 \series medium
22913 \shape up
22914 \size normal
22915 \emph off
22916 \bar no
22917 \noun off
22918 \color none
22919 Sandstone
22920 \end_layout
22921
22922 \end_inset
22923 </cell>
22924 </row>
22925 <row>
22926 <cell alignment="center" valignment="top" topline="true" usebox="none">
22927 \begin_inset Text
22928
22929 \begin_layout Standard
22930
22931 \end_layout
22932
22933 \end_inset
22934 </cell>
22935 <cell alignment="center" valignment="top" topline="true" usebox="none">
22936 \begin_inset Text
22937
22938 \begin_layout Standard
22939
22940 \family roman
22941 \series medium
22942 \shape up
22943 \size normal
22944 \emph off
22945 \bar no
22946 \noun off
22947 \color none
22948 Granite
22949 \end_layout
22950
22951 \end_inset
22952 </cell>
22953 <cell alignment="center" valignment="top" topline="true" usebox="none">
22954 \begin_inset Text
22955
22956 \begin_layout Standard
22957
22958 \family roman
22959 \series medium
22960 \shape up
22961 \size normal
22962 \emph off
22963 \bar no
22964 \noun off
22965 \color none
22966 Andesite
22967 \end_layout
22968
22969 \end_inset
22970 </cell>
22971 </row>
22972 </lyxtabular>
22973
22974 \end_inset
22975
22976
22977 \end_layout
22978
22979 \begin_layout Standard
22980 The second method is faster, but will make typographers and TeXperts all
22981  over the world groan.
22982  Simply put an end of row specifier with optional argument at the same spot.
22983  No fancy definitions are needed as in the above example, but there will
22984  be more space inserted than you specified because you essentially added
22985  a blank row plus the extra space.
22986  If the space added is too much, simply use a negative number, like so:
22987 \end_layout
22988
22989 \begin_layout Standard
22990 \align center
22991 \begin_inset Tabular
22992 <lyxtabular version="3" rows="4" columns="3">
22993 <features>
22994 <column alignment="center" valignment="top" width="0pt">
22995 <column alignment="center" valignment="top" width="0pt">
22996 <column alignment="center" valignment="top" width="0pt">
22997 <row>
22998 <cell alignment="center" valignment="top" topline="true" usebox="none">
22999 \begin_inset Text
23000
23001 \begin_layout Standard
23002
23003 \family roman
23004 \series medium
23005 \shape up
23006 \size normal
23007 \emph off
23008 \bar no
23009 \noun off
23010 \color none
23011 Minerals
23012 \end_layout
23013
23014 \end_inset
23015 </cell>
23016 <cell alignment="center" valignment="top" topline="true" usebox="none">
23017 \begin_inset Text
23018
23019 \begin_layout Standard
23020
23021 \family roman
23022 \series medium
23023 \shape up
23024 \size normal
23025 \emph off
23026 \bar no
23027 \noun off
23028 \color none
23029 Calcite
23030 \end_layout
23031
23032 \end_inset
23033 </cell>
23034 <cell alignment="center" valignment="top" topline="true" usebox="none">
23035 \begin_inset Text
23036
23037 \begin_layout Standard
23038
23039 \family roman
23040 \series medium
23041 \shape up
23042 \size normal
23043 \emph off
23044 \bar no
23045 \noun off
23046 \color none
23047 Dolomite
23048 \end_layout
23049
23050 \end_inset
23051 </cell>
23052 </row>
23053 <row>
23054 <cell alignment="center" valignment="top" topline="true" usebox="none">
23055 \begin_inset Text
23056
23057 \begin_layout Standard
23058
23059 \end_layout
23060
23061 \end_inset
23062 </cell>
23063 <cell alignment="center" valignment="top" topline="true" usebox="none">
23064 \begin_inset Text
23065
23066 \begin_layout Standard
23067
23068 \family roman
23069 \series medium
23070 \shape up
23071 \size normal
23072 \emph off
23073 \bar no
23074 \noun off
23075 \color none
23076 Quartz
23077 \end_layout
23078
23079 \end_inset
23080 </cell>
23081 <cell alignment="center" valignment="top" topline="true" usebox="none">
23082 \begin_inset Text
23083
23084 \begin_layout Standard
23085
23086 \family roman
23087 \series medium
23088 \shape up
23089 \size normal
23090 \emph off
23091 \bar no
23092 \noun off
23093 \color none
23094 Graphite
23095 \end_layout
23096
23097 \end_inset
23098 </cell>
23099 </row>
23100 <row>
23101 <cell alignment="center" valignment="top" topline="true" usebox="none">
23102 \begin_inset Text
23103
23104 \begin_layout Standard
23105
23106 \family roman
23107 \series medium
23108 \shape up
23109 \size normal
23110 \emph off
23111 \bar no
23112 \noun off
23113 \color none
23114 \begin_inset ERT
23115 status collapsed
23116
23117 \begin_layout Standard
23118
23119
23120 \backslash
23121
23122 \backslash
23123 [-1ex]
23124 \end_layout
23125
23126 \end_inset
23127
23128  Rocks
23129 \end_layout
23130
23131 \end_inset
23132 </cell>
23133 <cell alignment="center" valignment="top" topline="true" usebox="none">
23134 \begin_inset Text
23135
23136 \begin_layout Standard
23137
23138 \family roman
23139 \series medium
23140 \shape up
23141 \size normal
23142 \emph off
23143 \bar no
23144 \noun off
23145 \color none
23146 Limestone
23147 \end_layout
23148
23149 \end_inset
23150 </cell>
23151 <cell alignment="center" valignment="top" topline="true" usebox="none">
23152 \begin_inset Text
23153
23154 \begin_layout Standard
23155
23156 \family roman
23157 \series medium
23158 \shape up
23159 \size normal
23160 \emph off
23161 \bar no
23162 \noun off
23163 \color none
23164 Sandstone
23165 \end_layout
23166
23167 \end_inset
23168 </cell>
23169 </row>
23170 <row>
23171 <cell alignment="center" valignment="top" topline="true" usebox="none">
23172 \begin_inset Text
23173
23174 \begin_layout Standard
23175
23176 \end_layout
23177
23178 \end_inset
23179 </cell>
23180 <cell alignment="center" valignment="top" topline="true" usebox="none">
23181 \begin_inset Text
23182
23183 \begin_layout Standard
23184
23185 \family roman
23186 \series medium
23187 \shape up
23188 \size normal
23189 \emph off
23190 \bar no
23191 \noun off
23192 \color none
23193 Granite
23194 \end_layout
23195
23196 \end_inset
23197 </cell>
23198 <cell alignment="center" valignment="top" topline="true" usebox="none">
23199 \begin_inset Text
23200
23201 \begin_layout Standard
23202
23203 \family roman
23204 \series medium
23205 \shape up
23206 \size normal
23207 \emph off
23208 \bar no
23209 \noun off
23210 \color none
23211 Andesite
23212 \end_layout
23213
23214 \end_inset
23215 </cell>
23216 </row>
23217 </lyxtabular>
23218
23219 \end_inset
23220
23221
23222 \end_layout
23223
23224 \begin_layout Standard
23225 It's short, sweet, and gets the job done quickly, even if it is really ugly.
23226  You may put away the rotten vegetables now! I promise I won't suggest anything
23227  else like that!
23228 \end_layout
23229
23230 \begin_layout Section
23231 Dropped Capitals
23232 \end_layout
23233
23234 \begin_layout Standard
23235 by 
23236 \noun on
23237 Mike Ressler
23238 \end_layout
23239
23240 \begin_layout Standard
23241 \begin_inset VSpace bigskip
23242 \end_inset
23243
23244
23245 \end_layout
23246
23247 \begin_layout Standard
23248 \noindent
23249 \begin_inset ERT
23250 status collapsed
23251
23252 \begin_layout Standard
23253
23254
23255 \backslash
23256 newfont{
23257 \backslash
23258 tmpfont}{cmr17 scaled 2500}{
23259 \backslash
23260 tmpfont T}
23261 \backslash
23262 vspace*{-8.4ex}
23263 \end_layout
23264
23265 \end_inset
23266
23267
23268 \end_layout
23269
23270 \begin_layout Standard
23271 \noindent
23272 \begin_inset ERT
23273 status inlined
23274
23275 \begin_layout Standard
23276
23277
23278 \backslash
23279 hangindent=3.3em 
23280 \backslash
23281 hangafter=-3
23282 \end_layout
23283
23284 \end_inset
23285
23286  hose of you who like the style of old books probably also like 
23287 \begin_inset Quotes eld
23288 \end_inset
23289
23290 dropped capitals
23291 \begin_inset Quotes erd
23292 \end_inset
23293
23294 ---those large capital letters which begin each new chapter or section.
23295  Implementing them with plain LyX/LaTeX is straightforward (assuming you
23296  know some plain TeX!) but does require a lot of work and many iterations,
23297  as you can see by all the ugly TeX-mode stuff at the beginning of this
23298  paragraph.
23299 \end_layout
23300
23301 \begin_layout Standard
23302 \begin_inset ERT
23303 status inlined
23304
23305 \begin_layout Standard
23306
23307
23308 \backslash
23309 verb+
23310 \backslash
23311 bigdrop{-1em}{3}{ptmri}{T}+
23312 \end_layout
23313
23314 \end_inset
23315
23316 here is a much easier way of doing this, of course.
23317  The 
23318 \family typewriter
23319 dropcaps
23320 \family default
23321  (or the newer 
23322 \family typewriter
23323 dropping
23324 \family default
23325 ) package from CTAN allows a simple way to add such letters to your documents.
23326  Since this package is not a standard part of teTeX, I can't demonstrate
23327  it within this document, but if you copy this paragraph to a new document,
23328  delete the 
23329 \begin_inset Quotes eld
23330 \end_inset
23331
23332
23333 \family typewriter
23334
23335 \backslash
23336 verb
23337 \family default
23338
23339 \begin_inset Quotes erd
23340 \end_inset
23341
23342  and the pluses from the TeX code at the beginning of the paragraph, and
23343  add 
23344 \family typewriter
23345
23346 \backslash
23347 usepackage{dropcaps}
23348 \family default
23349  to your LaTeX preamble, you will get a nice Times Roman Italic 
23350 \begin_inset Quotes eld
23351 \end_inset
23352
23353 T
23354 \begin_inset Quotes erd
23355 \end_inset
23356
23357 , whose height is three lines of text and which protrudes 1 em into the
23358  margin.
23359  (Make certain you have copied 
23360 \begin_inset Quotes eld
23361 \end_inset
23362
23363
23364 \family typewriter
23365 dropcaps.sty
23366 \family default
23367
23368 \begin_inset Quotes erd
23369 \end_inset
23370
23371  into a directory where TeX can see it.) The first argument is the amount
23372  of indentation; in this case the negative sign moves it into the margin.
23373  The second argument is the height of the letter in number of lines of text.
23374  The third argument is the font name: virtually anything which has a tfm
23375  file should work (wade through the 
23376 \family typewriter
23377 .../texmf/fonts/tfm
23378 \family default
23379  directory for possibilities).
23380  My personal favorite is 
23381 \begin_inset Quotes eld
23382 \end_inset
23383
23384
23385 \family typewriter
23386 yinit
23387 \family default
23388
23389 \begin_inset Quotes erd
23390 \end_inset
23391
23392 , a fancy German font specifically designed for dropped capitals.
23393  The fourth argument is the letter (or letters) to be dropped.
23394  The 
23395 \family typewriter
23396 dropping
23397 \family default
23398  package also offers the 
23399 \family typewriter
23400
23401 \backslash
23402 bigdrop
23403 \family default
23404  command, as well as a slightly simplified 
23405 \family typewriter
23406
23407 \backslash
23408 dropping
23409 \family default
23410  command.
23411 \end_layout
23412
23413 \begin_layout Section
23414 Non-standard Paragraph Shapes
23415 \end_layout
23416
23417 \begin_layout Standard
23418 by 
23419 \noun on
23420 Mike Ressler
23421 \end_layout
23422
23423 \begin_layout Standard
23424 \begin_inset VSpace bigskip
23425 \end_inset
23426
23427
23428 \end_layout
23429
23430 \begin_layout Standard
23431 \begin_inset ERT
23432 status inlined
23433
23434 \begin_layout Standard
23435
23436
23437 \backslash
23438 begin{sloppypar}
23439 \end_layout
23440
23441 \end_inset
23442
23443
23444 \end_layout
23445
23446 \begin_layout Standard
23447 \begin_inset ERT
23448 status collapsed
23449
23450 \begin_layout Standard
23451
23452
23453 \backslash
23454 newdimen
23455 \backslash
23456 varunit 
23457 \end_layout
23458
23459 \begin_layout Standard
23460
23461
23462 \backslash
23463 setlength{
23464 \backslash
23465 varunit}{4.5in}
23466 \end_layout
23467
23468 \end_inset
23469
23470
23471 \end_layout
23472
23473 \begin_layout Standard
23474 \noindent
23475 \begin_inset ERT
23476 status collapsed
23477
23478 \begin_layout Standard
23479
23480
23481 \backslash
23482 parshape 19 0.45
23483 \backslash
23484 varunit 0.332
23485 \backslash
23486 varunit
23487 \end_layout
23488
23489 \begin_layout Standard
23490
23491 0.40
23492 \backslash
23493 varunit 0.300
23494 \backslash
23495 varunit
23496 \end_layout
23497
23498 \begin_layout Standard
23499
23500 0.35
23501 \backslash
23502 varunit 0.293
23503 \backslash
23504 varunit
23505 \end_layout
23506
23507 \begin_layout Standard
23508
23509 0.30
23510 \backslash
23511 varunit 0.300
23512 \backslash
23513 varunit
23514 \end_layout
23515
23516 \begin_layout Standard
23517
23518 0.25
23519 \backslash
23520 varunit 0.317
23521 \backslash
23522 varunit
23523 \end_layout
23524
23525 \begin_layout Standard
23526
23527 0.20
23528 \backslash
23529 varunit 0.342
23530 \backslash
23531 varunit
23532 \end_layout
23533
23534 \begin_layout Standard
23535
23536 0.15
23537 \backslash
23538 varunit 0.373
23539 \backslash
23540 varunit
23541 \end_layout
23542
23543 \begin_layout Standard
23544
23545 0.10
23546 \backslash
23547 varunit 0.410
23548 \backslash
23549 varunit
23550 \end_layout
23551
23552 \begin_layout Standard
23553
23554 0.05
23555 \backslash
23556 varunit 0.453
23557 \backslash
23558 varunit
23559 \end_layout
23560
23561 \begin_layout Standard
23562
23563 0.00
23564 \backslash
23565 varunit 0.500
23566 \backslash
23567 varunit
23568 \end_layout
23569
23570 \begin_layout Standard
23571
23572 0.05
23573 \backslash
23574 varunit 0.453
23575 \backslash
23576 varunit
23577 \end_layout
23578
23579 \begin_layout Standard
23580
23581 0.10
23582 \backslash
23583 varunit 0.410
23584 \backslash
23585 varunit
23586 \end_layout
23587
23588 \begin_layout Standard
23589
23590 0.15
23591 \backslash
23592 varunit 0.373
23593 \backslash
23594 varunit
23595 \end_layout
23596
23597 \begin_layout Standard
23598
23599 0.20
23600 \backslash
23601 varunit 0.342
23602 \backslash
23603 varunit
23604 \end_layout
23605
23606 \begin_layout Standard
23607
23608 0.25
23609 \backslash
23610 varunit 0.317
23611 \backslash
23612 varunit
23613 \end_layout
23614
23615 \begin_layout Standard
23616
23617 0.30
23618 \backslash
23619 varunit 0.300
23620 \backslash
23621 varunit
23622 \end_layout
23623
23624 \begin_layout Standard
23625
23626 0.35
23627 \backslash
23628 varunit 0.293
23629 \backslash
23630 varunit
23631 \end_layout
23632
23633 \begin_layout Standard
23634
23635 0.40
23636 \backslash
23637 varunit 0.300
23638 \backslash
23639 varunit
23640 \end_layout
23641
23642 \begin_layout Standard
23643
23644 0.45
23645 \backslash
23646 varunit 0.332
23647 \backslash
23648 varunit
23649 \end_layout
23650
23651 \begin_layout Standard
23652
23653 \end_layout
23654
23655 \end_inset
23656
23657 There are times when the tyranny of rectangular paragraphs must be overthrown.
23658  In such situations, a call to the delightful plain TeX command 
23659 \family typewriter
23660
23661 \backslash
23662 parshape
23663 \family default
23664  is called for.
23665  As you can see, completely arbitrary shapes can be laid out with a suitable
23666  set of linelength definitions.
23667  While this parshape may look a bit silly and useless, one could conceive
23668  of situations such as finely tuned dropped capitals, word wrapping around
23669  non-rectangular graphics, etc.
23670  which will benefit from such handcrafting.
23671 \end_layout
23672
23673 \begin_layout Standard
23674 \begin_inset VSpace bigskip
23675 \end_inset
23676
23677
23678 \end_layout
23679
23680 \begin_layout Standard
23681 The syntax is 
23682 \family typewriter
23683
23684 \backslash
23685 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
23686  #nindent #nlength
23687 \family default
23688 , where 
23689 \family typewriter
23690 numlines
23691 \family default
23692  is the number of lines of text which define the paragraph.
23693  If there turn out to be fewer lines, the shape is truncated; if there are
23694  more, the excess lines have the same dimensions as the last line of the
23695  definition.
23696  The 
23697 \family typewriter
23698 #nindent
23699 \family default
23700  and 
23701 \family typewriter
23702 #nlength
23703 \family default
23704  entries specify the indentation of the line from the left margin, and the
23705  length of the line as measured from that point.
23706  The shape applies only to the current paragraph; everything is reset to
23707  normal for the next paragraph.
23708 \end_layout
23709
23710 \begin_layout Standard
23711 \begin_inset ERT
23712 status inlined
23713
23714 \begin_layout Standard
23715
23716
23717 \backslash
23718 end{sloppypar}
23719 \end_layout
23720
23721 \end_inset
23722
23723
23724 \end_layout
23725
23726 \begin_layout Section
23727 Summary
23728 \end_layout
23729
23730 \begin_layout Standard
23731 As you can see, the examples in this section range from the useful to the
23732  whimsical.
23733  While I don't expect that anyone will ever need the paragraph shape demonstrate
23734 d in the last section, the important point is that you can do almost anything
23735  you want in LyX if you are willing to figure out how to do it in TeX and
23736  LaTeX.
23737  TeX is a fantastically powerful typesetting system and all that power is
23738  available to you since LyX uses it as its backend.
23739  Happy LyXing!
23740 \end_layout
23741
23742 \end_body
23743 \end_document