]> git.lyx.org Git - lyx.git/blob - lib/doc/Extended.lyx
d7cb91659ac7e9d12bcd8e96bd988854ad49c8c8
[lyx.git] / lib / doc / Extended.lyx
1 #LyX 1.4.3 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 Notation Lists
2673 \end_layout
2674
2675 \begin_layout Standard
2676 by 
2677 \noun on
2678 Özgür U\i \~{g}
2679 ra\i \c{s}
2680  Baram
2681 \end_layout
2682
2683 \begin_layout Standard
2684 Sometimes you need to compile a list of symbols that are mentioned in your
2685  document with a brief explanation of them.
2686  A LaTeX package named 
2687 \family typewriter
2688 nomencl
2689 \family default
2690  provides an easy way of compiling such lists.
2691  
2692 \family typewriter
2693 nomencl
2694 \family default
2695  is included in most standard Linux distributions.
2696  If your distribution doesn't contain it, you should download it from a
2697  CTAN mirror and install the package in order to use this feature of LyX.
2698 \end_layout
2699
2700 \begin_layout Standard
2701 A notation entry is created if you place the cursor after a symbol entry
2702  and then use the menu 
2703 \family sans
2704 Insert\SpecialChar \menuseparator
2705 Notation\InsetSpace ~
2706 Entry
2707 \family default
2708 .
2709  A gray box labeled 
2710 \begin_inset Quotes eld
2711 \end_inset
2712
2713
2714 \family sans
2715 Not
2716 \family default
2717
2718 \begin_inset Quotes erd
2719 \end_inset
2720
2721  is inserted and a window pops up asking for the notation entry.
2722  A notation entry consists of two main entries.
2723  The first is the symbol that you want to refer to.
2724  You should enter a valid LaTeX code for the corresponding field in the
2725  notation dialog.
2726  The second is the description of the symbol.
2727  You should fill the corresponding field to complete the notation entry.
2728 \end_layout
2729
2730 \begin_layout Subsection
2731 Sort Order of Notation Entries
2732 \end_layout
2733
2734 \begin_layout Standard
2735 Suppose you have two notation entries for the symbols 
2736 \begin_inset Formula $a$
2737 \end_inset
2738
2739  and 
2740 \begin_inset Formula $\sigma$
2741 \end_inset
2742
2743 .
2744  The 
2745 \family typewriter
2746 nomencl
2747 \family default
2748  package automatically sorts these two entries considering the symbol entry,
2749  while printing the Notation List.
2750  However, this can lead to an undesired sort order.
2751  For the example given, the first entry appears as 
2752 \family typewriter
2753 $a$
2754 \family default
2755 , while the second is 
2756 \family typewriter
2757 $
2758 \backslash
2759 sigma$
2760 \family default
2761 .
2762  Note that, in this case 
2763 \begin_inset Formula $\sigma$
2764 \end_inset
2765
2766  is located in front of the 
2767 \begin_inset Formula $a$
2768 \end_inset
2769
2770 , since the character 
2771 \begin_inset Quotes eld
2772 \end_inset
2773
2774
2775 \backslash
2776
2777 \begin_inset Quotes erd
2778 \end_inset
2779
2780  is considered in sorting.
2781  In order to control the sort order, you can edit the 
2782 \family sans
2783 Sort\InsetSpace ~
2784 as
2785 \family default
2786  field of the notation dialog.
2787  For the given example, you can edit this field as 
2788 \family typewriter
2789 a
2790 \family default
2791  and 
2792 \family typewriter
2793 sigma 
2794 \family default
2795 correspondingly.
2796  Then, these entries will be effective in the sort ordering and 
2797 \begin_inset Formula $a$
2798 \end_inset
2799
2800  will be located before 
2801 \begin_inset Formula $\sigma$
2802 \end_inset
2803
2804 .
2805 \end_layout
2806
2807 \begin_layout Standard
2808 This feature provides exciting ways of ordering the entries.
2809  For subgrouping and tips for using sort entries see the official nomencl
2810  documentation.
2811 \end_layout
2812
2813 \begin_layout Subsection
2814 Referencing
2815 \end_layout
2816
2817 \begin_layout Standard
2818 You can turn on referencing to the equations and pages in the notation entries.
2819  For this purpose, you should add referencing options commands at the end
2820  of description field.
2821  There are six referencing options in nomencl package:
2822 \end_layout
2823
2824 \begin_layout Paragraph*
2825
2826 \backslash
2827 refeq:
2828 \end_layout
2829
2830 \begin_layout Standard
2831 Adds reference to the equation by adding the phrase 
2832 \begin_inset Quotes eld
2833 \end_inset
2834
2835 , see equation (#)
2836 \begin_inset Quotes erd
2837 \end_inset
2838
2839
2840 \end_layout
2841
2842 \begin_layout Paragraph*
2843
2844 \backslash
2845 refpage:
2846 \end_layout
2847
2848 \begin_layout Standard
2849 Adds reference to the page by adding the phrase 
2850 \begin_inset Quotes eld
2851 \end_inset
2852
2853 , page (#)
2854 \begin_inset Quotes erd
2855 \end_inset
2856
2857
2858 \end_layout
2859
2860 \begin_layout Paragraph*
2861
2862 \backslash
2863 refeqpage:
2864 \end_layout
2865
2866 \begin_layout Standard
2867 Is the short notation of 
2868 \backslash
2869 refeq
2870 \backslash
2871 refpage.
2872 \end_layout
2873
2874 \begin_layout Paragraph*
2875
2876 \backslash
2877 norefeq, 
2878 \backslash
2879 norefpag, 
2880 \backslash
2881 norefeqpage:
2882 \end_layout
2883
2884 \begin_layout Standard
2885 Turns off corresponding referencing options if they are turned on globally
2886  (see reference documentation of nomencl).
2887 \end_layout
2888
2889 \begin_layout Subsection
2890 Printing Notation List
2891 \end_layout
2892
2893 \begin_layout Standard
2894 You can insert the notation list with the menu 
2895 \family sans
2896 Insert\SpecialChar \menuseparator
2897 Lists\InsetSpace ~
2898 &TOC\SpecialChar \menuseparator
2899 Notation\InsetSpace ~
2900 List
2901 \family default
2902 .
2903  A light blue box labeled 
2904 \begin_inset Quotes eld
2905 \end_inset
2906
2907
2908 \family sans
2909 Notation
2910 \family default
2911
2912 \begin_inset Quotes erd
2913 \end_inset
2914
2915  will show the place where the index is printed in the output.
2916  The index list box is not clickable like other LyX-boxes.
2917  In the printed output the title of the notation list appears as 
2918 \series bold
2919 Nomenclature
2920 \series default
2921
2922 \begin_inset Foot
2923 status collapsed
2924
2925 \begin_layout Standard
2926 This is translated to the document language for a small number of languages,
2927  amongst others French and German
2928 \end_layout
2929
2930 \end_inset
2931
2932 .
2933  If you are not happy with the title, you can change it by re-defining the
2934  command 
2935 \family typewriter
2936
2937 \backslash
2938 nomname
2939 \family default
2940  in the preamble.
2941  For example, in order to change the title 
2942 \emph on
2943 List of Symbols
2944 \emph default
2945  for the 
2946 \emph on
2947 Notation List
2948 \emph default
2949  add the following line to the preamble.
2950 \end_layout
2951
2952 \begin_layout LyX-Code
2953
2954 \backslash
2955 renewcommand{
2956 \backslash
2957 nomname}{List of Symbols}
2958 \end_layout
2959
2960 \begin_layout LyX-Code
2961
2962 \end_layout
2963
2964 \begin_layout Section
2965 Multipart Documents
2966 \end_layout
2967
2968 \begin_layout Subsection
2969 General Operation
2970 \end_layout
2971
2972 \begin_layout Standard
2973 When you are working on a large file with many sections, it is often convenient
2974  to break up the document into several files, or perhaps you have something
2975  where a table may change from time to time, but the preceding text does
2976  not.
2977  In these cases, you should seriously consider using multipart documents.
2978  For example, scientific papers often have five major sections: the introduction
2979 , observations, results, discussion, and conclusion.
2980  Each of these could be its own separate LyX file, with one 
2981 \begin_inset Quotes eld
2982 \end_inset
2983
2984 master
2985 \begin_inset Quotes erd
2986 \end_inset
2987
2988  file which contains the title, authors, abstract, references, etc., plus
2989  the five included files.
2990  It is important to note that each of these files is a full LyX file which
2991  can be formatted and printed on its own, as well as included in a master
2992  file.
2993  Each of these files must have the same document class, however--- don't
2994  attempt to mix book classes with article classes.
2995  You may also include LaTeX files; however, these files must not have their
2996  own preamble 
2997 \emph on
2998 (i.e.
2999
3000 \emph default
3001  everything up to and including the 
3002 \family typewriter
3003
3004 \backslash
3005 begin{document}
3006 \family default
3007  line as well as the 
3008 \family typewriter
3009
3010 \backslash
3011 end{document}
3012 \family default
3013  line must be deleted) or else errors will be generated when you try to
3014  make a DVI file.
3015 \end_layout
3016
3017 \begin_layout Standard
3018 LyX allows you to include files quite easily with 
3019 \family sans
3020 \bar under
3021 I
3022 \bar default
3023 nsert\SpecialChar \menuseparator
3024 ChiI
3025 \bar under
3026 d
3027 \bar default
3028 \InsetSpace ~
3029 Document
3030 \family default
3031 .
3032  When you click on this selection a small box is inserted into the file
3033  at the current cursor location.
3034  Clicking on the box raises a dialog which allows you to select the file
3035  to be included, and the method of its inclusion.
3036  
3037 \end_layout
3038
3039 \begin_layout Standard
3040 The file selection box should by now be obvious.
3041  The three inclusion methods are 
3042 \begin_inset Quotes eld
3043 \end_inset
3044
3045 include
3046 \begin_inset Quotes erd
3047 \end_inset
3048
3049
3050 \begin_inset Quotes eld
3051 \end_inset
3052
3053 input
3054 \begin_inset Quotes erd
3055 \end_inset
3056
3057 , and 
3058 \begin_inset Quotes eld
3059 \end_inset
3060
3061 verbatim
3062 \begin_inset Quotes erd
3063 \end_inset
3064
3065 .
3066  The difference between 
3067 \begin_inset Quotes eld
3068 \end_inset
3069
3070 include
3071 \begin_inset Quotes erd
3072 \end_inset
3073
3074  and 
3075 \begin_inset Quotes eld
3076 \end_inset
3077
3078 input
3079 \begin_inset Quotes erd
3080 \end_inset
3081
3082  is really only meaningful to LaTeXperts, but the practical difference is
3083  that files which are 
3084 \begin_inset Quotes eld
3085 \end_inset
3086
3087 included
3088 \begin_inset Quotes erd
3089 \end_inset
3090
3091  are typeset beginning on a new page, while files which are 
3092 \begin_inset Quotes eld
3093 \end_inset
3094
3095 inputted
3096 \begin_inset Quotes erd
3097 \end_inset
3098
3099  are typeset starting on the current page.
3100  Perhaps the labeling in LyX will be changed someday to reflect this.
3101 \end_layout
3102
3103 \begin_layout Standard
3104 Generally, the master file is converted into a full LaTeX file before typesettin
3105 g, while the included files are converted to LaTeX files which do not have
3106  all the preamble information.
3107  Checking the 
3108 \family sans
3109 Don't
3110 \family default
3111 \InsetSpace ~
3112
3113 \family sans
3114 typeset
3115 \family default
3116  button prevents this conversion.
3117 \end_layout
3118
3119 \begin_layout Standard
3120
3121 \begin_inset Quotes eld
3122 \end_inset
3123
3124 verbatim
3125 \begin_inset Quotes erd
3126 \end_inset
3127
3128  included file allows you to include a file typeset exactly as it appears
3129  in the file, i.e.\InsetSpace ~
3130 verbatim mode, with the characters set in a fixed-width
3131  typewriter font.
3132  Normally, spaces in this file are invisible, though two consecutive spaces
3133  are conserved, unlike LyX's normal treatment of spaces.
3134  However, setting the 
3135 \family sans
3136 \bar under
3137 M
3138 \bar default
3139 ark\InsetSpace ~
3140 spaces\InsetSpace ~
3141 in\InsetSpace ~
3142 output
3143 \family default
3144  checkbox typesets a mark to unambiguously define the presence of a space.
3145
3146 \emph on
3147  
3148 \end_layout
3149
3150 \begin_layout Subsection
3151 Cross-References Between Files
3152 \end_layout
3153
3154 \begin_layout Standard
3155 It is possible to set up cross-references between the different files.
3156  First, open all the files in question: let's call them A and B in a two
3157  file example, where B is included in A.
3158  Let's say you insert a label in A, then want to reference it in B.
3159  Open the cross-reference dialog in whilst in document B, and you can select
3160  the 
3161 \begin_inset Quotes eld
3162 \end_inset
3163
3164 buffer
3165 \begin_inset Quotes erd
3166 \end_inset
3167
3168  to use.
3169 \end_layout
3170
3171 \begin_layout Section
3172 Algorithms
3173 \end_layout
3174
3175 \begin_layout Standard
3176 The package 
3177 \family sans
3178 algorithm
3179 \family default
3180  is needed by LyX to be able to output algorithm floats.
3181  These are useful in placing short algorithms across page breaks and support
3182  an index of algorithms too.
3183 \end_layout
3184
3185 \begin_layout Section
3186 Subfigures
3187 \end_layout
3188
3189 \begin_layout Standard
3190 The package
3191 \family sans
3192  subfigure 
3193 \family default
3194 is used by LyX when you select ``subfigure'' in the graphics dialog and
3195  enter the subfigure caption.
3196  Several figures marked in this way can be packed into a single float with
3197  individual sub-captions.
3198 \end_layout
3199
3200 \begin_layout Section
3201 Fancy Headers and Footers
3202 \end_layout
3203
3204 \begin_layout Standard
3205 The default page layout is rather plain; for an article document class,
3206  all you get is a centered page number at the bottom of the page.
3207  This document is the book class, so it appears to be a bit fancier, but
3208  to really put on a show, you need to set the document page style to 
3209 \begin_inset Quotes eld
3210 \end_inset
3211
3212 fancy
3213 \begin_inset Quotes erd
3214 \end_inset
3215
3216 , as mentioned in the 
3217 \family sans
3218 User\InsetSpace ~
3219 Guide
3220 \family default
3221 .
3222  This section describes the LaTeX codes you need to insert in your LaTeX
3223  preamble or the text in order to get the desired effects.
3224 \end_layout
3225
3226 \begin_layout Standard
3227 The page header is divided into three fields, not surprisingly labeled 
3228 \begin_inset Quotes eld
3229 \end_inset
3230
3231 left
3232 \begin_inset Quotes erd
3233 \end_inset
3234
3235
3236 \begin_inset Quotes eld
3237 \end_inset
3238
3239 center
3240 \begin_inset Quotes erd
3241 \end_inset
3242
3243 , and 
3244 \begin_inset Quotes eld
3245 \end_inset
3246
3247 right
3248 \begin_inset Quotes erd
3249 \end_inset
3250
3251 .
3252  The footer is also divided into these three fields.
3253  The LaTeX commands to set these fields in the simplest manner are 
3254 \family typewriter
3255
3256 \backslash
3257 lhead
3258 \family default
3259
3260 \family typewriter
3261
3262 \backslash
3263 chead
3264 \family default
3265
3266 \family typewriter
3267
3268 \backslash
3269 rhead
3270 \family default
3271
3272 \family typewriter
3273
3274 \backslash
3275 lfoot
3276 \family default
3277 , etc.
3278  Suppose you wish to put your name in the upper left hand corner of each
3279  page.
3280  Simply insert the following command in the preamble: 
3281 \end_layout
3282
3283 \begin_layout Standard
3284
3285 \family typewriter
3286
3287 \backslash
3288 lhead{John Q.
3289  DocWriter}
3290 \end_layout
3291
3292 \begin_layout Standard
3293 You will now see your name in the upper left.
3294  If a field has a default entry that you would like to get rid of (often
3295  the page number appears in the central footer, simply include a command
3296  with a blank argument, e.g.
3297 \end_layout
3298
3299 \begin_layout Standard
3300
3301 \family typewriter
3302
3303 \backslash
3304 cfoot{}
3305 \end_layout
3306
3307 \begin_layout Standard
3308 Let's get really fancy: lets put the section number with the word 
3309 \begin_inset Quotes eld
3310 \end_inset
3311
3312 Section
3313 \begin_inset Quotes erd
3314 \end_inset
3315
3316  (e.g.
3317  Section 3) in the upper left, the page number (e.g.
3318  Page 4) in the upper right, your name in the lower left, and the date in
3319  the lower right.
3320  The following commands should now appear in the preamble:
3321 \end_layout
3322
3323 \begin_layout Standard
3324
3325 \family typewriter
3326
3327 \backslash
3328 lhead{Section 
3329 \backslash
3330 thesection}
3331 \end_layout
3332
3333 \begin_layout Standard
3334
3335 \family typewriter
3336
3337 \backslash
3338 chead{}
3339 \end_layout
3340
3341 \begin_layout Standard
3342
3343 \family typewriter
3344
3345 \backslash
3346 rhead{Page 
3347 \backslash
3348 thepage}
3349 \end_layout
3350
3351 \begin_layout Standard
3352
3353 \family typewriter
3354
3355 \backslash
3356 lfoot{John Q.
3357  DocWriter}
3358 \end_layout
3359
3360 \begin_layout Standard
3361
3362 \family typewriter
3363
3364 \backslash
3365 cfoot{}
3366 \end_layout
3367
3368 \begin_layout Standard
3369
3370 \family typewriter
3371
3372 \backslash
3373 rfoot{
3374 \backslash
3375 today}
3376 \end_layout
3377
3378 \begin_layout Standard
3379 The codes 
3380 \family typewriter
3381
3382 \backslash
3383 thesection
3384 \family default
3385  and 
3386 \family typewriter
3387
3388 \backslash
3389 thepage
3390 \family default
3391  access LaTeX's section and page counters, and so print out the current
3392  section and page numbers.
3393  
3394 \family typewriter
3395
3396 \backslash
3397 today
3398 \family default
3399  simply prints out today's date.
3400 \end_layout
3401
3402 \begin_layout Standard
3403 The thicknesses of the horizontal rules drawn beneath the header and above
3404  the footer can also be modified.
3405  If you don't want one of the headers, set its thickness to 0.
3406  The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3407  Use the commands, e.g.
3408  
3409 \family typewriter
3410
3411 \backslash
3412 renewcommand{
3413 \backslash
3414 headrulewidth}{0.4pt}
3415 \family default
3416  and 
3417 \family typewriter
3418
3419 \backslash
3420 renewcommand{
3421 \backslash
3422 footrulewidth}{0.4pt}
3423 \family default
3424  to set the thicknesses.
3425 \end_layout
3426
3427 \begin_layout Standard
3428 You can switch the header/footer settings on and off for individual pages
3429  using commands like 
3430 \family typewriter
3431
3432 \backslash
3433 thispagestyle{empty}
3434 \family default
3435
3436 \family typewriter
3437
3438 \backslash
3439 thispagestyle{plain}
3440 \family default
3441 , and 
3442 \family typewriter
3443
3444 \backslash
3445 thispagestyle{fancy}
3446 \family default
3447 .
3448  Simply insert them in the text on the page you want changed and mark them
3449  as TeX code.
3450  In fact, title pages are marked as plain by default, while following pages
3451  are marked fancy when using the global fancy setting.
3452 \end_layout
3453
3454 \begin_layout Standard
3455 There are more complex commands which will let you insert things in the
3456  upper left on odd numbered pages, etc., but I will refer you to the 
3457 \family typewriter
3458 fancyhdr
3459 \family default
3460  package documentation for more descriptions.
3461  For example, if you have a teTeX installation, look for 
3462 \family typewriter
3463 /usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
3464 fancyhdr.dvi
3465 \family default
3466 .
3467 \end_layout
3468
3469 \begin_layout Standard
3470 As a final example, it is possible to include an Encapsulated PostScript®
3471  file in the header or footer.
3472  Suppose you want to put a company logo in the upper lefthand corner.
3473  You might try something like
3474 \end_layout
3475
3476 \begin_layout Standard
3477
3478 \family typewriter
3479
3480 \backslash
3481 lhead{
3482 \backslash
3483 resizebox{1in}{!}{
3484 \backslash
3485 includegraphics{logo.eps}}}
3486 \end_layout
3487
3488 \begin_layout Standard
3489 \noindent
3490 (you may need to preface this with 
3491 \family typewriter
3492
3493 \backslash
3494 usepackage{graphics}
3495 \family default
3496  if you don't include EPS files elsewhere in your document).
3497 \end_layout
3498
3499 \begin_layout Section
3500 Minipages
3501 \end_layout
3502
3503 \begin_layout Standard
3504 LaTeX provides a mechanism to produce essentially a page within a page,
3505  called minipages.
3506  Within a minipage, all the usual rules of indentation, line wrapping, etc.\InsetSpace ~
3507 apply.
3508  LyX also provides some of the minipage capability.
3509 \end_layout
3510
3511 \begin_layout Standard
3512 Minipages in LyX have their own collapsable box; insert one via 
3513 \family sans
3514 \bar under
3515 I
3516 \bar default
3517 nsert\SpecialChar \menuseparator
3518 Mini
3519 \bar under
3520 p
3521 \bar default
3522 age
3523 \family default
3524 .
3525  Right-clicking on the box allows you to alter the minipage's width and
3526  alignment within the page.
3527  Warning: if the minipage is too long to fit on a page, it is truncated,
3528  not wrapped onto the next page.
3529 \end_layout
3530
3531 \begin_layout Standard
3532 If you place two minipages side-by-side, you can use 
3533 \family sans
3534 \bar under
3535 I
3536 \bar default
3537 nsert\SpecialChar \menuseparator
3538
3539 \bar under
3540 S
3541 \bar default
3542 pecial\InsetSpace ~
3543 Character
3544 \family default
3545  to insert a special instruction known in the LaTeX world as an 
3546 \family typewriter
3547 hfill
3548 \family default
3549  to put a maximum amount of space between them; it forces one minipage to
3550  the left edge, the other to the right edge.
3551  The examples below show the difference.
3552 \end_layout
3553
3554 \begin_layout Standard
3555 \begin_inset Box Frameless
3556 position "t"
3557 hor_pos "c"
3558 has_inner_box 1
3559 inner_pos "c"
3560 use_parbox 0
3561 width "1.5in"
3562 special "none"
3563 height "1pt"
3564 height_special "totalheight"
3565 status open
3566
3567 \begin_layout Standard
3568 This is a minipage which does not use hfill.
3569  This is the second sentence of a minipage which does not use hfill.
3570 \end_layout
3571
3572 \end_inset
3573
3574
3575 \end_layout
3576
3577 \begin_layout Standard
3578 \begin_inset Box Frameless
3579 position "t"
3580 hor_pos "c"
3581 has_inner_box 1
3582 inner_pos "c"
3583 use_parbox 0
3584 width "1.5in"
3585 special "none"
3586 height "1pt"
3587 height_special "totalheight"
3588 status open
3589
3590 \begin_layout Standard
3591 This is a second minipage which does not use hfill.
3592  This is the second sentence of a second minipage which does not use hfill.
3593 \end_layout
3594
3595 \end_inset
3596
3597
3598 \end_layout
3599
3600 \begin_layout Standard
3601 \begin_inset VSpace medskip
3602 \end_inset
3603
3604
3605 \end_layout
3606
3607 \begin_layout Standard
3608 Here is some normal text to separate the two examples.
3609 \end_layout
3610
3611 \begin_layout Standard
3612 \begin_inset VSpace medskip
3613 \end_inset
3614
3615
3616 \end_layout
3617
3618 \begin_layout Standard
3619 \begin_inset Box Frameless
3620 position "t"
3621 hor_pos "c"
3622 has_inner_box 1
3623 inner_pos "c"
3624 use_parbox 0
3625 width "1.5in"
3626 special "none"
3627 height "1pt"
3628 height_special "totalheight"
3629 status open
3630
3631 \begin_layout Standard
3632 This is a minipage which does use hfill.
3633  This is the second sentence of a minipage which does use hfill.
3634 \end_layout
3635
3636 \end_inset
3637
3638
3639 \hfill
3640
3641 \begin_inset Box Frameless
3642 position "t"
3643 hor_pos "c"
3644 has_inner_box 1
3645 inner_pos "c"
3646 use_parbox 0
3647 width "1.5in"
3648 special "none"
3649 height "1pt"
3650 height_special "totalheight"
3651 status open
3652
3653 \begin_layout Standard
3654 This is a second minipage which does use hfill.
3655  This is the second sentence of a second minipage which does use hfill.
3656 \end_layout
3657
3658 \end_inset
3659
3660
3661 \end_layout
3662
3663 \begin_layout Section
3664 Wrapping Text Around Figures
3665 \begin_inset LatexCommand \label{sec:floatflt}
3666
3667 \end_inset
3668
3669
3670 \end_layout
3671
3672 \begin_layout Standard
3673 \begin_inset Wrap figure
3674 placement r
3675 width "6cm"
3676 status open
3677
3678 \begin_layout Standard
3679 \begin_inset Graphics
3680         filename mobius.eps
3681         display color
3682         width 40col%
3683         rotateOrigin center
3684
3685 \end_inset
3686
3687
3688 \end_layout
3689
3690 \begin_layout Caption
3691 This is a wrapped figure, and this is the brilliant caption that describes
3692  it
3693 \end_layout
3694
3695 \end_inset
3696
3697
3698 \end_layout
3699
3700 \begin_layout Standard
3701 A very frequently asked question is whether text can be made to 
3702 \begin_inset Quotes eld
3703 \end_inset
3704
3705 wrap
3706 \begin_inset Quotes erd
3707 \end_inset
3708
3709  around figures so that a figure occupies some fraction of the column width
3710  and text fills the rest.
3711  If you have the LaTeX package 
3712 \family typewriter
3713 floatflt
3714 \family default
3715  installed (you can find out about it in the 
3716 \emph on
3717 LaTeX Configuration
3718 \emph default
3719  manual) you can do this.
3720 \end_layout
3721
3722 \begin_layout Standard
3723 At the right is a figure of a mobius strip---you should have already seen
3724  this in the 
3725 \emph on
3726 User's Guide
3727 \emph default
3728 .
3729  To wrap the text like this insert a wrap box via 
3730 \family sans
3731 \bar under
3732 I
3733 \bar default
3734 nsert\SpecialChar \menuseparator
3735 Flo
3736 \bar under
3737 a
3738 \bar default
3739 ts\SpecialChar \menuseparator
3740 Floatflt Figure
3741 \family default
3742 .
3743 \end_layout
3744
3745 \begin_layout Standard
3746 Note: this package is very fragile! For example, having a figure too close
3747  to the bottom of the page will mess things up, as will having two figures
3748  close together.
3749  Use this package sparingly and do read the documentation that came with
3750  it (which will also tell you how to wrap text around tables).
3751 \end_layout
3752
3753 \begin_layout Section
3754 Extra Table Options
3755 \end_layout
3756
3757 \begin_layout Standard
3758 While the standard table layout will suffice in 99% of all tables you generate,
3759  occasionally you will run into one which requires a bit of extra tweaking.
3760  The table dialog which appears on a right-click of a table allows these
3761  tweaks to be made.
3762  It will give you access to some extra column alignment parameters.
3763  A little bit of LaTeX background is useful here: when you set up a table
3764  in LaTeX, each column is given an alignment type.
3765  For example, you would give it 
3766 \begin_inset Quotes eld
3767 \end_inset
3768
3769
3770 \family typewriter
3771 l
3772 \family default
3773
3774 \begin_inset Quotes erd
3775 \end_inset
3776
3777
3778 \begin_inset Quotes eld
3779 \end_inset
3780
3781
3782 \family typewriter
3783 c
3784 \family default
3785
3786 \begin_inset Quotes erd
3787 \end_inset
3788
3789 , or 
3790 \begin_inset Quotes eld
3791 \end_inset
3792
3793
3794 \family typewriter
3795 r
3796 \family default
3797
3798 \begin_inset Quotes erd
3799 \end_inset
3800
3801  for left-aligned, centered, and right-aligned columns respectively (which
3802  appear as the left/center/right radio buttons in LyX).
3803  A fourth type is 
3804 \begin_inset Quotes eld
3805 \end_inset
3806
3807
3808 \family typewriter
3809 p
3810 \family default
3811
3812 \begin_inset Quotes erd
3813 \end_inset
3814
3815 , which will make a column of a specified width (the width box in LyX),
3816  and will wrap text within that box.
3817  A fifth type is 
3818 \begin_inset Quotes eld
3819 \end_inset
3820
3821
3822 \family typewriter
3823 |
3824 \family default
3825
3826 \begin_inset Quotes erd
3827 \end_inset
3828
3829  (vertical bar) which rather than making a column will make a vertical rule
3830  at that point; this manifests itself in LyX as the 
3831 \begin_inset Quotes eld
3832 \end_inset
3833
3834 borders
3835 \begin_inset Quotes erd
3836 \end_inset
3837
3838  buttons.
3839  Finally, there is a type 
3840 \begin_inset Quotes eld
3841 \end_inset
3842
3843
3844 \family typewriter
3845 @
3846 \family default
3847
3848 \begin_inset Quotes erd
3849 \end_inset
3850
3851 , which allows you to use whatever is enclosed in the accompanying braces
3852  as the column separator, including a null argument.
3853  The reasons for doing this may not be obvious, but they can be very powerful.
3854  They are best demonstrated by example.
3855 \end_layout
3856
3857 \begin_layout Subsection
3858 Removing Extra Column Space
3859 \end_layout
3860
3861 \begin_layout Standard
3862 Here is a standard table:
3863 \end_layout
3864
3865 \begin_layout Standard
3866 \align center
3867 \begin_inset Tabular
3868 <lyxtabular version="3" rows="3" columns="2">
3869 <features>
3870 <column alignment="left" valignment="top" width="0pt">
3871 <column alignment="left" valignment="top" leftline="true" width="0pt">
3872 <row bottomline="true">
3873 <cell alignment="left" valignment="top" topline="true" usebox="none">
3874 \begin_inset Text
3875
3876 \begin_layout Standard
3877
3878 \family roman
3879 \series medium
3880 \shape up
3881 \size normal
3882 \emph off
3883 \bar no
3884 \noun off
3885 \color none
3886 Type
3887 \end_layout
3888
3889 \end_inset
3890 </cell>
3891 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
3892 \begin_inset Text
3893
3894 \begin_layout Standard
3895
3896 \family roman
3897 \series medium
3898 \shape up
3899 \size normal
3900 \emph off
3901 \bar no
3902 \noun off
3903 \color none
3904 Example
3905 \end_layout
3906
3907 \end_inset
3908 </cell>
3909 </row>
3910 <row>
3911 <cell alignment="left" valignment="top" topline="true" usebox="none">
3912 \begin_inset Text
3913
3914 \begin_layout Standard
3915
3916 \family roman
3917 \series medium
3918 \shape up
3919 \size normal
3920 \emph off
3921 \bar no
3922 \noun off
3923 \color none
3924 Rock
3925 \end_layout
3926
3927 \end_inset
3928 </cell>
3929 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3930 \begin_inset Text
3931
3932 \begin_layout Standard
3933
3934 \family roman
3935 \series medium
3936 \shape up
3937 \size normal
3938 \emph off
3939 \bar no
3940 \noun off
3941 \color none
3942 Granite
3943 \end_layout
3944
3945 \end_inset
3946 </cell>
3947 </row>
3948 <row>
3949 <cell alignment="center" valignment="top" topline="true" usebox="none">
3950 \begin_inset Text
3951
3952 \begin_layout Standard
3953
3954 \family roman
3955 \series medium
3956 \shape up
3957 \size normal
3958 \emph off
3959 \bar no
3960 \noun off
3961 \color none
3962 Mineral
3963 \end_layout
3964
3965 \end_inset
3966 </cell>
3967 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3968 \begin_inset Text
3969
3970 \begin_layout Standard
3971
3972 \family roman
3973 \series medium
3974 \shape up
3975 \size normal
3976 \emph off
3977 \bar no
3978 \noun off
3979 \color none
3980 Quartz
3981 \end_layout
3982
3983 \end_inset
3984 </cell>
3985 </row>
3986 </lyxtabular>
3987
3988 \end_inset
3989
3990
3991 \end_layout
3992
3993 \begin_layout Standard
3994 Notice that the horizontal rule extends a bit past the text on both sides.
3995  If you wanted the line to end even with the text, we can put a null separator
3996  on the ends to get rid of the bit of extra space LaTeX adds by default.
3997  Here is the example:
3998 \end_layout
3999
4000 \begin_layout Standard
4001 \align center
4002 \begin_inset Tabular
4003 <lyxtabular version="3" rows="3" columns="2">
4004 <features>
4005 <column alignment="left" valignment="top" width="0pt" special="@{} l">
4006 <column alignment="left" valignment="top" leftline="true" width="0pt" special="l @{}">
4007 <row bottomline="true">
4008 <cell alignment="left" valignment="top" topline="true" usebox="none">
4009 \begin_inset Text
4010
4011 \begin_layout Standard
4012
4013 \family roman
4014 \series medium
4015 \shape up
4016 \size normal
4017 \emph off
4018 \bar no
4019 \noun off
4020 \color none
4021 Type
4022 \end_layout
4023
4024 \end_inset
4025 </cell>
4026 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
4027 \begin_inset Text
4028
4029 \begin_layout Standard
4030
4031 \family roman
4032 \series medium
4033 \shape up
4034 \size normal
4035 \emph off
4036 \bar no
4037 \noun off
4038 \color none
4039 Example
4040 \end_layout
4041
4042 \end_inset
4043 </cell>
4044 </row>
4045 <row>
4046 <cell alignment="left" valignment="top" topline="true" usebox="none">
4047 \begin_inset Text
4048
4049 \begin_layout Standard
4050
4051 \family roman
4052 \series medium
4053 \shape up
4054 \size normal
4055 \emph off
4056 \bar no
4057 \noun off
4058 \color none
4059 Rock
4060 \end_layout
4061
4062 \end_inset
4063 </cell>
4064 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4065 \begin_inset Text
4066
4067 \begin_layout Standard
4068
4069 \family roman
4070 \series medium
4071 \shape up
4072 \size normal
4073 \emph off
4074 \bar no
4075 \noun off
4076 \color none
4077 Granite
4078 \end_layout
4079
4080 \end_inset
4081 </cell>
4082 </row>
4083 <row>
4084 <cell alignment="center" valignment="top" topline="true" usebox="none">
4085 \begin_inset Text
4086
4087 \begin_layout Standard
4088
4089 \family roman
4090 \series medium
4091 \shape up
4092 \size normal
4093 \emph off
4094 \bar no
4095 \noun off
4096 \color none
4097 Mineral
4098 \end_layout
4099
4100 \end_inset
4101 </cell>
4102 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4103 \begin_inset Text
4104
4105 \begin_layout Standard
4106
4107 \family roman
4108 \series medium
4109 \shape up
4110 \size normal
4111 \emph off
4112 \bar no
4113 \noun off
4114 \color none
4115 Quartz
4116 \end_layout
4117
4118 \end_inset
4119 </cell>
4120 </row>
4121 </lyxtabular>
4122
4123 \end_inset
4124
4125
4126 \end_layout
4127
4128 \begin_layout Standard
4129 In this case, the column specifier for the left column was set to 
4130 \begin_inset Quotes eld
4131 \end_inset
4132
4133
4134 \family typewriter
4135 @{} l
4136 \family default
4137
4138 \begin_inset Quotes erd
4139 \end_inset
4140
4141 , while the right column was set to 
4142 \begin_inset Quotes eld
4143 \end_inset
4144
4145
4146 \family typewriter
4147 l @{}
4148 \family default
4149
4150 \begin_inset Quotes erd
4151 \end_inset
4152
4153 , in order to put the null characters on the edges.
4154  
4155 \end_layout
4156
4157 \begin_layout Subsection
4158 Changing the Column Separator Character
4159 \end_layout
4160
4161 \begin_layout Standard
4162 Now suppose you really wanted, for reasons that are completely opaque, to
4163  use 
4164 \begin_inset Formula $\sqrt{\pi}$
4165 \end_inset
4166
4167  with some space around it for the column separator.
4168  Simply turn off the vertical border, then set the right column specifier
4169  to 
4170 \begin_inset Quotes eld
4171 \end_inset
4172
4173
4174 \family typewriter
4175 @{~$
4176 \backslash
4177 sqrt{
4178 \backslash
4179 pi}$~} l
4180 \family default
4181
4182 \begin_inset Quotes erd
4183 \end_inset
4184
4185 .
4186  You could now make a table like this:
4187 \end_layout
4188
4189 \begin_layout Standard
4190 \align center
4191 \begin_inset Tabular
4192 <lyxtabular version="3" rows="3" columns="2">
4193 <features>
4194 <column alignment="left" valignment="top" width="0pt">
4195 <column alignment="left" valignment="top" width="0in" special="@{~$\sqrt{\pi}$~}l">
4196 <row bottomline="true">
4197 <cell alignment="left" valignment="top" topline="true" usebox="none">
4198 \begin_inset Text
4199
4200 \begin_layout Standard
4201
4202 \family roman
4203 \series medium
4204 \shape up
4205 \size normal
4206 \emph off
4207 \bar no
4208 \noun off
4209 \color none
4210 Type
4211 \end_layout
4212
4213 \end_inset
4214 </cell>
4215 <cell alignment="left" valignment="top" topline="true" usebox="none">
4216 \begin_inset Text
4217
4218 \begin_layout Standard
4219
4220 \family roman
4221 \series medium
4222 \shape up
4223 \size normal
4224 \emph off
4225 \bar no
4226 \noun off
4227 \color none
4228 Example
4229 \end_layout
4230
4231 \end_inset
4232 </cell>
4233 </row>
4234 <row>
4235 <cell alignment="left" valignment="top" topline="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 Rock
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 \family roman
4259 \series medium
4260 \shape up
4261 \size normal
4262 \emph off
4263 \bar no
4264 \noun off
4265 \color none
4266 Granite
4267 \end_layout
4268
4269 \end_inset
4270 </cell>
4271 </row>
4272 <row>
4273 <cell alignment="center" valignment="top" topline="true" usebox="none">
4274 \begin_inset Text
4275
4276 \begin_layout Standard
4277
4278 \family roman
4279 \series medium
4280 \shape up
4281 \size normal
4282 \emph off
4283 \bar no
4284 \noun off
4285 \color none
4286 Mineral
4287 \end_layout
4288
4289 \end_inset
4290 </cell>
4291 <cell alignment="center" valignment="top" topline="true" usebox="none">
4292 \begin_inset Text
4293
4294 \begin_layout Standard
4295
4296 \family roman
4297 \series medium
4298 \shape up
4299 \size normal
4300 \emph off
4301 \bar no
4302 \noun off
4303 \color none
4304 Quartz
4305 \end_layout
4306
4307 \end_inset
4308 </cell>
4309 </row>
4310 </lyxtabular>
4311
4312 \end_inset
4313
4314
4315 \end_layout
4316
4317 \begin_layout Subsection
4318 Making a Decimal Point Aligned Column
4319 \end_layout
4320
4321 \begin_layout Standard
4322 Okay, that last example was very silly, but here is one that is not.
4323  Suppose you want to make a table that has a column which is aligned on
4324  a decimal point.
4325  A standard LaTeX trick to do this is to set the whole number part in a
4326  right-aligned column, use a decimal point for the column separator, then
4327  set the fractional part as a left-aligned column.
4328  A variation on this is to include the decimal point explicitly with the
4329  whole part, then use just a null separator in between.
4330  The latter variation is demonstrated here:
4331 \end_layout
4332
4333 \begin_layout Standard
4334 \align center
4335 \begin_inset Tabular
4336 <lyxtabular version="3" rows="5" columns="3">
4337 <features>
4338 <column alignment="center" valignment="top" width="0pt">
4339 <column alignment="right" valignment="top" leftline="true" width="0pt">
4340 <column alignment="center" valignment="top" width="0pt" special="@{} l">
4341 <row bottomline="true">
4342 <cell alignment="center" valignment="top" topline="true" usebox="none">
4343 \begin_inset Text
4344
4345 \begin_layout Standard
4346
4347 \family roman
4348 \series medium
4349 \shape up
4350 \size normal
4351 \emph off
4352 \bar no
4353 \noun off
4354 \color none
4355 Expression
4356 \end_layout
4357
4358 \end_inset
4359 </cell>
4360 <cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
4361 \begin_inset Text
4362
4363 \begin_layout Standard
4364
4365 \family roman
4366 \series medium
4367 \shape up
4368 \size normal
4369 \emph off
4370 \bar no
4371 \noun off
4372 \color none
4373 Value 
4374 \end_layout
4375
4376 \end_inset
4377 </cell>
4378 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
4379 \begin_inset Text
4380
4381 \begin_layout Standard
4382
4383 \end_layout
4384
4385 \end_inset
4386 </cell>
4387 </row>
4388 <row>
4389 <cell alignment="center" valignment="top" topline="true" usebox="none">
4390 \begin_inset Text
4391
4392 \begin_layout Standard
4393
4394 \family roman
4395 \series medium
4396 \shape up
4397 \size normal
4398 \emph off
4399 \bar no
4400 \noun off
4401 \color none
4402 \begin_inset Formula $\pi$
4403 \end_inset
4404
4405
4406 \end_layout
4407
4408 \end_inset
4409 </cell>
4410 <cell alignment="right" valignment="top" topline="true" leftline="true" usebox="none">
4411 \begin_inset Text
4412
4413 \begin_layout Standard
4414
4415 \family roman
4416 \series medium
4417 \shape up
4418 \size normal
4419 \emph off
4420 \bar no
4421 \noun off
4422 \color none
4423 3.
4424 \end_layout
4425
4426 \end_inset
4427 </cell>
4428 <cell alignment="center" valignment="top" topline="true" usebox="none">
4429 \begin_inset Text
4430
4431 \begin_layout Standard
4432
4433 \family roman
4434 \series medium
4435 \shape up
4436 \size normal
4437 \emph off
4438 \bar no
4439 \noun off
4440 \color none
4441 1416
4442 \end_layout
4443
4444 \end_inset
4445 </cell>
4446 </row>
4447 <row>
4448 <cell alignment="center" valignment="top" topline="true" usebox="none">
4449 \begin_inset Text
4450
4451 \begin_layout Standard
4452
4453 \family roman
4454 \series medium
4455 \shape up
4456 \size normal
4457 \emph off
4458 \bar no
4459 \noun off
4460 \color none
4461 \begin_inset Formula $\pi^{\pi}$
4462 \end_inset
4463
4464
4465 \end_layout
4466
4467 \end_inset
4468 </cell>
4469 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4470 \begin_inset Text
4471
4472 \begin_layout Standard
4473
4474 \family roman
4475 \series medium
4476 \shape up
4477 \size normal
4478 \emph off
4479 \bar no
4480 \noun off
4481 \color none
4482 36.
4483 \end_layout
4484
4485 \end_inset
4486 </cell>
4487 <cell alignment="center" valignment="top" topline="true" usebox="none">
4488 \begin_inset Text
4489
4490 \begin_layout Standard
4491
4492 \family roman
4493 \series medium
4494 \shape up
4495 \size normal
4496 \emph off
4497 \bar no
4498 \noun off
4499 \color none
4500 462
4501 \end_layout
4502
4503 \end_inset
4504 </cell>
4505 </row>
4506 <row>
4507 <cell alignment="center" valignment="top" topline="true" usebox="none">
4508 \begin_inset Text
4509
4510 \begin_layout Standard
4511
4512 \family roman
4513 \series medium
4514 \shape up
4515 \size normal
4516 \emph off
4517 \bar no
4518 \noun off
4519 \color none
4520 \begin_inset Formula $(\pi^{\pi})^{\pi}$
4521 \end_inset
4522
4523
4524 \end_layout
4525
4526 \end_inset
4527 </cell>
4528 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4529 \begin_inset Text
4530
4531 \begin_layout Standard
4532
4533 \family roman
4534 \series medium
4535 \shape up
4536 \size normal
4537 \emph off
4538 \bar no
4539 \noun off
4540 \color none
4541 80663.
4542 \end_layout
4543
4544 \end_inset
4545 </cell>
4546 <cell alignment="center" valignment="top" topline="true" usebox="none">
4547 \begin_inset Text
4548
4549 \begin_layout Standard
4550
4551 \end_layout
4552
4553 \end_inset
4554 </cell>
4555 </row>
4556 <row>
4557 <cell alignment="center" valignment="top" topline="true" usebox="none">
4558 \begin_inset Text
4559
4560 \begin_layout Standard
4561
4562 \family roman
4563 \series medium
4564 \shape up
4565 \size normal
4566 \emph off
4567 \bar no
4568 \noun off
4569 \color none
4570 \begin_inset Formula $\pi^{\pi^{\pi}}$
4571 \end_inset
4572
4573
4574 \end_layout
4575
4576 \end_inset
4577 </cell>
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 1.
4592 \end_layout
4593
4594 \end_inset
4595 </cell>
4596 <cell alignment="center" valignment="top" topline="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 3402
4610 \begin_inset Formula $\times10^{18}$
4611 \end_inset
4612
4613
4614 \end_layout
4615
4616 \end_inset
4617 </cell>
4618 </row>
4619 </lyxtabular>
4620
4621 \end_inset
4622
4623
4624 \end_layout
4625
4626 \begin_layout Standard
4627 Though it appears a bit funny in LyX, on paper it will produce what appears
4628  to be a 2-column table in which the right column is aligned on the decimal
4629  point and the header appears to be centered over it.
4630 \end_layout
4631
4632 \begin_layout Standard
4633 Perhaps it is best if I described just what I did: first, create a 3
4634 \begin_inset Formula $\times$
4635 \end_inset
4636
4637 3 table and remove all the borders.
4638  Then re-add a bottom border to the top row, and a right border to the first
4639  column.
4640  Type in the values for the first column and set its alignment to 
4641 \family sans
4642 center
4643 \family default
4644 .
4645  Type in the 
4646 \family typewriter
4647 3.
4648 \family default
4649
4650 \family typewriter
4651 36.
4652 \family default
4653
4654 \family typewriter
4655 80663.
4656 \family default
4657 , and 
4658 \family typewriter
4659 1.
4660
4661 \family default
4662  and set that column's alignment to 
4663 \family sans
4664 right
4665 \family default
4666 .
4667  Type in the 
4668 \family typewriter
4669 1416
4670 \family default
4671
4672 \family typewriter
4673 462
4674 \family default
4675 , and 
4676 \family typewriter
4677 3402
4678 \begin_inset Formula $\times10^{18}$
4679 \end_inset
4680
4681
4682 \family default
4683  and set the extra column alignment to 
4684 \family typewriter
4685 @{} l
4686 \family default
4687 .
4688  Finally type in the word 
4689 \family typewriter
4690 Value
4691 \family default
4692  in the middle column, highlight it and the blank entry to its right, and
4693  check the 
4694 \family sans
4695 Special Cell
4696 \family default
4697  entry 
4698 \family sans
4699 multicolumn
4700 \family default
4701 .
4702  Easy, right? 
4703 \end_layout
4704
4705 \begin_layout Subsection
4706 A Better Decimal-Alignment Solution
4707 \end_layout
4708
4709 \begin_layout Standard
4710 An alternative way to have decimal alignment in tables is through the 
4711 \family typewriter
4712 dcolumn
4713 \family default
4714  package.
4715  Add the following to the LateX preamble:
4716 \end_layout
4717
4718 \begin_layout LyX-Code
4719
4720 \backslash
4721 usepackage{dcolumn}
4722 \end_layout
4723
4724 \begin_layout LyX-Code
4725
4726 \backslash
4727 newcolumntype{d}[1]{D{.}{.}{#1}}
4728 \end_layout
4729
4730 \begin_layout Standard
4731 To have a column decimally aligned, enter in the 
4732 \family sans
4733 Special Column Alignment
4734 \family default
4735  box of the 
4736 \family sans
4737 Table
4738 \family default
4739  dialog the following:
4740 \end_layout
4741
4742 \begin_layout LyX-Code
4743 d{number of decimals of the data}
4744 \end_layout
4745
4746 \begin_layout Standard
4747 To create extra column space just increase the number of decimals in 
4748 \family typewriter
4749 d{}
4750 \family default
4751 .
4752  Setting the multicolumn attribute for a single cell makes it insensitive
4753  to the decimal alignment which comes in handy as well.
4754  A drawback of this method is that math mode is not allowed in a column
4755  with decimal alignment except if the multicolumn attribute is set.
4756 \end_layout
4757
4758 \begin_layout Standard
4759 This method offers the same flexibility as the 
4760 \family typewriter
4761 dcolumn
4762 \family default
4763  package.
4764  One could, for example, change the alignment separator, and have different
4765  alignment separators for different columns by defining multiple column
4766  types in the preamble.
4767  The syntax is as follows: 
4768 \end_layout
4769
4770 \begin_layout LyX-Code
4771 D{inputsep}{outputsep}{decimal places}
4772 \end_layout
4773
4774 \begin_layout Standard
4775 The interested reader is directed towards the 
4776 \family typewriter
4777 dcolumn
4778 \family default
4779  package documentation for more details.
4780 \end_layout
4781
4782 \begin_layout Section
4783 Itemize Bullet Selection
4784 \begin_inset LatexCommand \label{sec:bullet}
4785
4786 \end_inset
4787
4788
4789 \end_layout
4790
4791 \begin_layout Standard
4792 by
4793 \noun on
4794  Allan Rae
4795 \end_layout
4796
4797 \begin_layout Subsection
4798 Introduction
4799 \end_layout
4800
4801 \begin_layout Standard
4802 LyX provides 216 bullet shapes that can be accessed from a simple dialog.
4803  Using this dialog you can easily specify what bullet shape to use at each
4804  level of an itemized list.
4805  These settings are document-wide so you won't be able to specify different
4806  sets of bullets for different paragraphs
4807 \begin_inset Foot
4808 status collapsed
4809
4810 \begin_layout Standard
4811 Well, actually you can but you'll have to do it by hand.
4812 \end_layout
4813
4814 \end_inset
4815
4816 .
4817 \end_layout
4818
4819 \begin_layout Subsection
4820 How it looks
4821 \end_layout
4822
4823 \begin_layout Standard
4824 Open the dialog by selecting the 
4825 \family sans
4826 \bar under
4827 D
4828 \bar default
4829 ocument\SpecialChar \menuseparator
4830
4831 \bar under
4832 S
4833 \bar default
4834 ettings
4835 \family default
4836  menu item and then select the 
4837 \family sans
4838 \bar under
4839 B
4840 \bar default
4841 ullets
4842 \family default
4843  tab.
4844 \end_layout
4845
4846 \begin_layout Standard
4847 The dialog provides you with a table of bullet shapes.
4848  A column of buttons on the left of the table provides access to the six
4849  different panels of bullet shapes.
4850  The row of buttons across the top is used to select which bullet depth
4851  you are changing.
4852  A text entry under the table shows the currently selected bullet shape's
4853  LaTeX equivalent and this can be edited if desired.
4854  If you do modify the text you will also need to specify any needed packages
4855  in the LaTeX preamble.
4856 \end_layout
4857
4858 \begin_layout Standard
4859 The six panels are divided up by the packages they require.
4860  The following table shows the mappings from button name to LaTeX packages.
4861 \end_layout
4862
4863 \begin_layout Standard
4864 \align center
4865 \begin_inset Tabular
4866 <lyxtabular version="3" rows="7" columns="2">
4867 <features>
4868 <column alignment="center" valignment="top" leftline="true" width="0pt">
4869 <column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
4870 <row topline="true" bottomline="true">
4871 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4872 \begin_inset Text
4873
4874 \begin_layout Standard
4875
4876 \family roman
4877 \series medium
4878 \shape up
4879 \size normal
4880 \emph off
4881 \bar no
4882 \noun off
4883 \color none
4884 Button
4885 \end_layout
4886
4887 \end_inset
4888 </cell>
4889 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4890 \begin_inset Text
4891
4892 \begin_layout Standard
4893
4894 \family roman
4895 \series medium
4896 \shape up
4897 \size normal
4898 \emph off
4899 \bar no
4900 \noun off
4901 \color none
4902 Packages Required
4903 \end_layout
4904
4905 \end_inset
4906 </cell>
4907 </row>
4908 <row topline="true">
4909 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4910 \begin_inset Text
4911
4912 \begin_layout Standard
4913
4914 \family sans
4915 \series medium
4916 \shape up
4917 \size normal
4918 \emph off
4919 \bar no
4920 \noun off
4921 \color none
4922 Standard
4923 \end_layout
4924
4925 \end_inset
4926 </cell>
4927 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4928 \begin_inset Text
4929
4930 \begin_layout Standard
4931
4932 \series medium
4933 \shape up
4934 \size normal
4935 \emph off
4936 \bar no
4937 \noun off
4938 \color none
4939 base LaTeX
4940 \end_layout
4941
4942 \end_inset
4943 </cell>
4944 </row>
4945 <row topline="true">
4946 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4947 \begin_inset Text
4948
4949 \begin_layout Standard
4950
4951 \family sans
4952 \series medium
4953 \shape up
4954 \size normal
4955 \emph off
4956 \bar no
4957 \noun off
4958 \color none
4959 Maths
4960 \end_layout
4961
4962 \end_inset
4963 </cell>
4964 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4965 \begin_inset Text
4966
4967 \begin_layout Standard
4968
4969 \family typewriter
4970 \series medium
4971 \shape up
4972 \size normal
4973 \emph off
4974 \bar no
4975 \noun off
4976 \color none
4977 amssymb.sty
4978 \end_layout
4979
4980 \end_inset
4981 </cell>
4982 </row>
4983 <row topline="true">
4984 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4985 \begin_inset Text
4986
4987 \begin_layout Standard
4988
4989 \family sans
4990 \series medium
4991 \shape up
4992 \size normal
4993 \emph off
4994 \bar no
4995 \noun off
4996 \color none
4997 Ding1
4998 \end_layout
4999
5000 \end_inset
5001 </cell>
5002 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
5003 \begin_inset Text
5004
5005 \begin_layout Standard
5006
5007 \family typewriter
5008 \series medium
5009 \shape up
5010 \size normal
5011 \emph off
5012 \bar no
5013 \noun off
5014 \color none
5015 pifont.sty
5016 \end_layout
5017
5018 \end_inset
5019 </cell>
5020 </row>
5021 <row topline="true">
5022 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
5023 \begin_inset Text
5024
5025 \begin_layout Standard
5026
5027 \family sans
5028 \series medium
5029 \shape up
5030 \size normal
5031 \emph off
5032 \bar no
5033 \noun off
5034 \color none
5035 Ding2
5036 \end_layout
5037
5038 \end_inset
5039 </cell>
5040 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
5041 \begin_inset Text
5042
5043 \begin_layout Standard
5044
5045 \family typewriter
5046 \series medium
5047 \shape up
5048 \size normal
5049 \emph off
5050 \bar no
5051 \noun off
5052 \color none
5053 pifont.sty
5054 \end_layout
5055
5056 \end_inset
5057 </cell>
5058 </row>
5059 <row topline="true">
5060 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
5061 \begin_inset Text
5062
5063 \begin_layout Standard
5064
5065 \family sans
5066 \series medium
5067 \shape up
5068 \size normal
5069 \emph off
5070 \bar no
5071 \noun off
5072 \color none
5073 Ding3
5074 \end_layout
5075
5076 \end_inset
5077 </cell>
5078 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
5079 \begin_inset Text
5080
5081 \begin_layout Standard
5082
5083 \family typewriter
5084 \series medium
5085 \shape up
5086 \size normal
5087 \emph off
5088 \bar no
5089 \noun off
5090 \color none
5091 pifont.sty
5092 \end_layout
5093
5094 \end_inset
5095 </cell>
5096 </row>
5097 <row topline="true" bottomline="true">
5098 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
5099 \begin_inset Text
5100
5101 \begin_layout Standard
5102
5103 \family sans
5104 \series medium
5105 \shape up
5106 \size normal
5107 \emph off
5108 \bar no
5109 \noun off
5110 \color none
5111 Ding4
5112 \end_layout
5113
5114 \end_inset
5115 </cell>
5116 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
5117 \begin_inset Text
5118
5119 \begin_layout Standard
5120
5121 \family typewriter
5122 \series medium
5123 \shape up
5124 \size normal
5125 \emph off
5126 \bar no
5127 \noun off
5128 \color none
5129 pifont.sty
5130 \end_layout
5131
5132 \end_inset
5133 </cell>
5134 </row>
5135 </lyxtabular>
5136
5137 \end_inset
5138
5139
5140 \end_layout
5141
5142 \begin_layout Standard
5143 LyX doesn't stop you using bullets from packages you don't have.
5144  If you get errors from LaTeX when you try to view or print the file then
5145  its likely you are missing a package.
5146  LyX doesn't restrict your use since you may be editing locally and exporting
5147  elsewhere.
5148 \end_layout
5149
5150 \begin_layout Subsection
5151 How to use it
5152 \end_layout
5153
5154 \begin_layout Standard
5155 Select which bullet depth you want to change then select the bullet shape
5156  and size.
5157
5158 \family sans
5159  
5160 \family default
5161 Any changes will not be visible in LyX, but are visible when viewing the
5162  document using xdvi or ghostview.
5163 \end_layout
5164
5165 \begin_layout Standard
5166 You can reset a bullet shape to the default simply by clicking your right
5167  mouse button on the appropriate bullet depth button.
5168 \end_layout
5169
5170 \begin_layout Standard
5171 If you 
5172 \emph on
5173 really
5174 \emph default
5175  want to have multiple sets of paragraphs with different sets of bullets
5176  in each then you're going to have to get your hands dirty.
5177  The itemize bullet selection dialog can help though because it provides
5178  you with the LaTeX code for a wide range of bullet shapes.
5179  To make your own custom paragraphs you have the following options:
5180 \end_layout
5181
5182 \begin_layout Standard
5183 \begin_inset ERT
5184 status inlined
5185
5186 \begin_layout Standard
5187
5188
5189 \backslash
5190 let
5191 \backslash
5192 savelabelitemi=
5193 \backslash
5194 labelitemi
5195 \end_layout
5196
5197 \end_inset
5198
5199
5200 \end_layout
5201
5202 \begin_layout Standard
5203 \begin_inset ERT
5204 status inlined
5205
5206 \begin_layout Standard
5207
5208
5209 \backslash
5210 renewcommand
5211 \backslash
5212 labelitemi[0]{
5213 \backslash
5214 small
5215 \backslash
5216 (
5217 \backslash
5218 sharp
5219 \backslash
5220 )}
5221 \end_layout
5222
5223 \end_inset
5224
5225
5226 \end_layout
5227
5228 \begin_layout Itemize
5229 Use the LaTeX command 
5230 \family typewriter
5231
5232 \backslash
5233 renewcommand{}{}
5234 \family default
5235  to specify a new bullet shape for a given depth.
5236  You'll also need to save the current bullet shape so you can restore it
5237  again afterwards.
5238  In this itemized list the following LaTeX code was used to change the bullet
5239  used for the first depth.
5240 \newline
5241
5242 \family typewriter
5243
5244 \backslash
5245 let
5246 \backslash
5247 savelabelitemi=
5248 \backslash
5249 labelitemi
5250 \family default
5251  
5252 \family typewriter
5253
5254 \newline
5255
5256 \backslash
5257 renewcommand
5258 \backslash
5259 labelitemi[0]{
5260 \backslash
5261 small
5262 \backslash
5263 (
5264 \backslash
5265 sharp
5266 \backslash
5267 )}
5268 \newline
5269
5270 \family default
5271 Note that the itemize depth is specified in Roman numerals as part of the
5272  
5273 \family typewriter
5274
5275 \backslash
5276 labelitem
5277 \family default
5278  command.
5279 \end_layout
5280
5281 \begin_layout Itemize
5282 \begin_inset ERT
5283 status inlined
5284
5285 \begin_layout Standard
5286
5287 [
5288 \backslash
5289 (
5290 \backslash
5291 star
5292 \backslash
5293 )]
5294 \end_layout
5295
5296 \end_inset
5297
5298  Specify each individual entry by starting each item with the bullet shape
5299  enclosed in square brackets and set as TeX.
5300  For example, this item was started with 
5301 \family typewriter
5302 [
5303 \backslash
5304 (
5305 \backslash
5306 star
5307 \backslash
5308 )]
5309 \family default
5310 .
5311 \end_layout
5312
5313 \begin_layout Standard
5314 \begin_inset ERT
5315 status inlined
5316
5317 \begin_layout Standard
5318
5319
5320 \backslash
5321 renewcommand
5322 \backslash
5323 labelitemi[0]{
5324 \backslash
5325 savelabelitemi}
5326 \end_layout
5327
5328 \end_inset
5329
5330
5331 \end_layout
5332
5333 \begin_layout Standard
5334 You'll also need to revert the labelitem back to its previous setting for
5335  the global bullet shape settings to remain in effect.
5336  The way used here was:
5337 \newline
5338
5339 \family typewriter
5340
5341 \backslash
5342 renewcommand
5343 \backslash
5344 labelitemi[0]{
5345 \backslash
5346 savelabelitemi}
5347 \end_layout
5348
5349 \begin_layout Chapter
5350 Special Document Classes
5351 \end_layout
5352
5353 \begin_layout Section
5354 AMS LaTeX
5355 \end_layout
5356
5357 \begin_layout Standard
5358 by 
5359 \noun on
5360 David Johnson
5361 \end_layout
5362
5363 \begin_layout Standard
5364 \begin_inset VSpace bigskip
5365 \end_inset
5366
5367
5368 \end_layout
5369
5370 \begin_layout Standard
5371 \noindent
5372 The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
5373  papers to be submitted to American Mathematical Society publications.
5374  The layouts are not tailored to a specific journal, but easily can be.
5375  You should refer to the AMS documentation for specific instructions for
5376  each journal (usually it will entail only changing a single line in the
5377  TeX output).
5378  That documentation is available on the Web at 
5379 \begin_inset LatexCommand \url{http://www.ams.org}
5380
5381 \end_inset
5382
5383  or by ftp at 
5384 \begin_inset LatexCommand \url{ftp://ftp.ams.org/pub/tex/amslatex/}
5385
5386 \end_inset
5387
5388 .These layouts are appropriate, and useful, for any mathematical writing.
5389  There are currently 4 distinct AMS LaTeX layouts: 
5390 \end_layout
5391
5392 \begin_layout Enumerate
5393 amsart: The standard AMS-article format.
5394  All results and similar statements are numbered as 
5395 \begin_inset Formula $(n.m)$
5396 \end_inset
5397
5398 , where the first number refers to the section, and the second refers to
5399  the total number of results (Theorems, Corollaries, Propositions, Definitions
5400  and Remarks, etc.) in that section.
5401  There are also many (but not all) environments available unnumbered, which
5402  is occasionally needed.
5403  Unnumbered environments indicated by an asterisk at the end.
5404 \end_layout
5405
5406 \begin_layout Enumerate
5407 amsart-seq: Here, numbering for each type of statement is in its own sequence,
5408  with no reference to the section number.
5409  There are also many (but not all) environments available unnumbered, which
5410  is occasionally needed.
5411  Unnumbered environments indicated by an asterisk at the end.
5412 \end_layout
5413
5414 \begin_layout Enumerate
5415 amsart-plain: This one is even more terse, since all the environments are
5416  unnumbered.
5417 \end_layout
5418
5419 \begin_layout Enumerate
5420 amsbook: the standard AMS book (really, monograph) format.
5421  Numbering is similar to the amsart layout, except that all numbering is
5422  by 
5423 \begin_inset Formula $(n.m.p)$
5424 \end_inset
5425
5426 , where the first number refers to the chapter, the second to the section,
5427  and the third is the number of the results (Theorems, Corollaries, Propositions
5428 , Definitions and Remarks, etc.) in that section.
5429  There are also many (but not all) environments available unnumbered, which
5430  is occasionally needed.
5431  Unnumbered environments indicated by an asterisk at the end.
5432 \end_layout
5433
5434 \begin_layout Standard
5435 Any AMS LyX file can be converted to either of the numbering schemes by
5436  simply changing the document class in the 
5437 \family sans
5438 \bar under
5439 D
5440 \bar default
5441 ocument\SpecialChar \menuseparator
5442
5443 \bar under
5444 S
5445 \bar default
5446 ettings
5447 \family default
5448  dialog.
5449  
5450 \end_layout
5451
5452 \begin_layout Subsection
5453 What these layouts provide
5454 \end_layout
5455
5456 \begin_layout Standard
5457 There is a long list of included environments provided by these layouts.
5458  Most mathematical papers or books will set as special statements most of
5459  these environments, in AMS-LaTeX there is an opportunity to define an unlimited
5460  variety of such declarations.
5461  However, the AMS recommends the environments that are available in LyX.
5462  The list of environments (not counting the standard environments such as
5463  
5464 \family sans
5465 sections, bibliography, title, author, date
5466 \family default
5467 ), is:
5468 \end_layout
5469
5470 \begin_layout Description
5471 Theorem This is typically used for the statements of major results.
5472  The word 
5473 \begin_inset Quotes eld
5474 \end_inset
5475
5476
5477 \family sans
5478 Theorem
5479 \family default
5480
5481 \begin_inset Quotes erd
5482 \end_inset
5483
5484  appears in bold type, along with an automatically-determined number (an
5485  unnumbered version, 
5486 \family sans
5487 Theorem*
5488 \family default
5489 , is also available).
5490  The text is italicized.
5491 \end_layout
5492
5493 \begin_layout Description
5494 Corollary This is used for statements which follow fairly directly from
5495  previous statements.
5496  Again, these can be major results.
5497  Unnumbered version 
5498 \family sans
5499 Corollary*
5500 \family default
5501  is available.
5502 \end_layout
5503
5504 \begin_layout Description
5505 Lemma These are smaller results needed to prove other statements.
5506 \end_layout
5507
5508 \begin_layout Description
5509 Proposition These are less major results which (hopefully) add to the general
5510  theory being discussed.
5511 \end_layout
5512
5513 \begin_layout Description
5514 Conjecture These are statements provided without justification, which the
5515  author does not know how to prove, but which seem to be true (to the author,
5516  at least).
5517 \end_layout
5518
5519 \begin_layout Description
5520 Criterion A required condition.
5521 \end_layout
5522
5523 \begin_layout Description
5524 Algorithm A general procedure to be used.
5525 \end_layout
5526
5527 \begin_layout Description
5528 Axiom This is a property or statement taken as true within the system being
5529  discussed.
5530 \end_layout
5531
5532 \begin_layout Description
5533 Definition Guess what this is for.
5534  The font, both on-screen and in the output, is different for this environment
5535  than for the previous ones.
5536  The heading (
5537 \begin_inset Quotes eld
5538 \end_inset
5539
5540 definition
5541 \begin_inset Quotes erd
5542 \end_inset
5543
5544 ) is still set in boldface, along with the number, if any, but the rest
5545  is set upright.
5546 \end_layout
5547
5548 \begin_layout Description
5549 Example Typeset similarly to Definition.
5550 \end_layout
5551
5552 \begin_layout Description
5553 Condition
5554 \end_layout
5555
5556 \begin_layout Description
5557 Problem
5558 \end_layout
5559
5560 \begin_layout Description
5561 Exercise
5562 \end_layout
5563
5564 \begin_layout Description
5565 Remark This environment is also a new type of theorem.
5566  This is set with the word Remark in italics, and the rest upright.
5567 \end_layout
5568
5569 \begin_layout Description
5570 Note Set similarly to the Remark environment.
5571 \end_layout
5572
5573 \begin_layout Description
5574 Notation
5575 \end_layout
5576
5577 \begin_layout Description
5578 Claim
5579 \end_layout
5580
5581 \begin_layout Description
5582 Summary
5583 \end_layout
5584
5585 \begin_layout Description
5586 Acknowledgement
5587 \end_layout
5588
5589 \begin_layout Description
5590 Case Generally, these are used to break up long arguments, using specific
5591  instances of some condition.
5592  The numbering scheme for cases is on its own, not together with other numbered
5593  statements.
5594  
5595 \end_layout
5596
5597 \begin_layout Description
5598 Conclusion
5599 \end_layout
5600
5601 \begin_layout Description
5602 Fact 
5603 \end_layout
5604
5605 \begin_layout Description
5606 Proof The word 
5607 \begin_inset Quotes eld
5608 \end_inset
5609
5610
5611 \shape italic
5612 Proof
5613 \shape default
5614
5615 \begin_inset Quotes erd
5616 \end_inset
5617
5618  is set in italics, but the rest is set upright.
5619  At the end of this environment (other environments can be nested within
5620  this one, of course) a QED symbol (usually a square, but it can vary with
5621  different styles) is placed.
5622 \end_layout
5623
5624 \begin_layout Description
5625 Address This should be the author's permanent address.
5626 \end_layout
5627
5628 \begin_layout Description
5629 Current\InsetSpace ~
5630 Address This should be the author's temporary address at the time
5631  of submission, if different from the Address.
5632 \end_layout
5633
5634 \begin_layout Description
5635 Email Author's e-mail address
5636 \end_layout
5637
5638 \begin_layout Description
5639 URL Author's Web address, if desired.
5640 \end_layout
5641
5642 \begin_layout Description
5643 Keywords Key words or phrases used to identify specific topics discussed
5644  in the paper.
5645 \end_layout
5646
5647 \begin_layout Description
5648 Subjectclass These refer to the AMS Subject Classifications, published and
5649  described in 
5650 \emph on
5651 Mathematical Reviews
5652 \emph default
5653 .
5654  These are also available online at the AMS cites listed above.
5655 \end_layout
5656
5657 \begin_layout Description
5658 Thanks
5659 \end_layout
5660
5661 \begin_layout Description
5662 Dedicatory
5663 \end_layout
5664
5665 \begin_layout Description
5666 Translator
5667 \end_layout
5668
5669 \begin_layout Standard
5670 In addition, these environments automatically provide the AMS LaTeX and
5671  AMS fonts packages.
5672  They need to be available on your system in order to use these environments.
5673 \end_layout
5674
5675 \begin_layout Section
5676 Dinbrief
5677 \end_layout
5678
5679 \begin_layout Standard
5680 The document class 
5681 \family sans
5682 dinbrief
5683 \family default
5684  can be used to type letters according to German conventions.
5685  A template file is included in 
5686 \family typewriter
5687 .../lyx/share/templates
5688 \family default
5689  for you to use as a starting point.
5690 \end_layout
5691
5692 \begin_layout Section
5693 Paper
5694 \end_layout
5695
5696 \begin_layout Standard
5697 The document class 
5698 \family sans
5699 paper
5700 \family default
5701  provides an alternative to the standard 
5702 \family sans
5703 article
5704 \family default
5705  class.
5706  It provides similar functionality, but you might prefer this layout with
5707  sans serif sections, headings, and more.
5708 \end_layout
5709
5710 \begin_layout Section
5711 A&A Paper
5712 \end_layout
5713
5714 \begin_layout Standard
5715 by 
5716 \noun on
5717 Peter Sütterlin
5718 \end_layout
5719
5720 \begin_layout Subsection
5721 Introduction
5722 \end_layout
5723
5724 \begin_layout Standard
5725 This section describes how LyX can be used to write articles for submission
5726  to the scientific journal 
5727 \emph on
5728 Astronomy and Astrophysics
5729 \emph default
5730  (
5731 \begin_inset LatexCommand \url[www.edpsciences.fr/aa/]{http://www.edpsciences.fr/aa/}
5732
5733 \end_inset
5734
5735 )
5736 \emph on
5737  
5738 \emph default
5739 using
5740 \emph on
5741  
5742 \emph default
5743 Version 5.01 of the document class 
5744 \family typewriter
5745 aa.cls
5746 \family default
5747 .
5748  This package can be downloaded from the ftp site
5749 \end_layout
5750
5751 \begin_layout Standard
5752 \begin_inset VSpace medskip
5753 \end_inset
5754
5755
5756 \end_layout
5757
5758 \begin_layout Standard
5759 \align center
5760 \begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
5761
5762 \end_inset
5763
5764
5765 \end_layout
5766
5767 \begin_layout Standard
5768 \begin_inset VSpace medskip
5769 \end_inset
5770
5771
5772 \end_layout
5773
5774 \begin_layout Standard
5775 A manual comes together with that package, and this text is not meant to
5776  replace the original manual but merely a short guide how to realize the
5777  correct form of your paper.
5778  
5779 \end_layout
5780
5781 \begin_layout Standard
5782 Please note that the publisher of the journal was changed from Springer
5783  to EDP Sciences starting January 1, 2001.
5784  That change implicated also some slight changes of the style files, namely
5785  the removal of the thesaurus command.
5786  The LyX class aa supports the newest version of these style files, V 5.01.
5787  If you have an older version installed, please upgrade.
5788  For compatibility, the old (version 4) layout has been kept as 
5789 \family sans
5790 article (A&A V4)
5791 \family default
5792 .
5793  Please refer to the comments in 
5794 \family typewriter
5795 LyXDir/layouts/aapaper.layout
5796 \family default
5797 .
5798 \end_layout
5799
5800 \begin_layout Subsection
5801 Getting started
5802 \end_layout
5803
5804 \begin_layout Standard
5805 It is recommended you start from the example template distributed with LyX.
5806  If you are not using a template, note the following settings:
5807 \end_layout
5808
5809 \begin_layout Itemize
5810 Select 
5811 \family sans
5812 article (A&A)
5813 \family default
5814  in the 
5815 \family sans
5816 \bar under
5817 D
5818 \bar default
5819 ocument\SpecialChar \menuseparator
5820
5821 \bar under
5822 S
5823 \bar default
5824 ettings
5825 \family default
5826  dialog (OK, that one was obvious).
5827 \end_layout
5828
5829 \begin_layout Itemize
5830 Don't change the option 
5831 \family sans
5832 Page\InsetSpace ~
5833 style
5834 \family default
5835 : Leave it set to 
5836 \family sans
5837 default
5838 \family default
5839 .
5840  The whole layout is done by the macros, you shouldn't change anything.
5841 \end_layout
5842
5843 \begin_layout Subsection
5844 The header block
5845 \end_layout
5846
5847 \begin_layout Standard
5848 First thing to enter is the header information.
5849  It consists of seven entries, of which some are optional.
5850  They are
5851 \end_layout
5852
5853 \begin_layout Itemize
5854
5855 \family sans
5856 Title
5857 \family default
5858 : [required] 
5859 \end_layout
5860
5861 \begin_layout Itemize
5862
5863 \family sans
5864 Subtitle
5865 \family default
5866 : [optional] 
5867 \end_layout
5868
5869 \begin_layout Itemize
5870
5871 \family sans
5872 Author
5873 \family default
5874 : [required]
5875 \end_layout
5876
5877 \begin_layout Itemize
5878
5879 \family sans
5880 Address
5881 \family default
5882 : [required]
5883 \end_layout
5884
5885 \begin_layout Itemize
5886
5887 \family sans
5888 Offprints
5889 \family default
5890 : [optional] if more than one author: whom to contact for offprint requests.
5891 \end_layout
5892
5893 \begin_layout Itemize
5894
5895 \family sans
5896 Mail
5897 \family default
5898 : [optional] mail address for contacts.
5899 \end_layout
5900
5901 \begin_layout Itemize
5902
5903 \family sans
5904 Date
5905 \family default
5906 : [required].
5907  Suggested format is 
5908 \family typewriter
5909 Received: <date>; Accepted <date> 
5910 \end_layout
5911
5912 \begin_layout Standard
5913 There is no need to issue the 
5914 \family typewriter
5915
5916 \backslash
5917 maketitle
5918 \family default
5919  command, this is done automatically by LyX when the header is finished.
5920  Although the order of the single header entries doesn't matter it is advised
5921  to keep the above sequence, just to get the best optics and meets the layout
5922  of the real document.
5923 \end_layout
5924
5925 \begin_layout Standard
5926 If you want to place footnotes in the header block, e.g.
5927 \begin_inset ERT
5928 status collapsed
5929
5930 \begin_layout Standard
5931
5932
5933 \backslash
5934  
5935 \end_layout
5936
5937 \end_inset
5938
5939 to state your present address, just use the standard footnote via 
5940 \family sans
5941 \bar under
5942 I
5943 \bar default
5944 nsert\SpecialChar \menuseparator
5945
5946 \bar under
5947 F
5948 \bar default
5949 ootnote.
5950  
5951 \family default
5952 LyX will automagically use the term 
5953 \family typewriter
5954
5955 \backslash
5956 thanks{}
5957 \family default
5958  in that case.
5959 \end_layout
5960
5961 \begin_layout Standard
5962 In addition to these topics, the macros use three additional LaTeX commands
5963  that have no counterpart in LyX:
5964 \end_layout
5965
5966 \begin_layout Itemize
5967
5968 \family typewriter
5969
5970 \backslash
5971 and
5972 \family default
5973  to separate different names for more than one author and institute, respectivel
5974 y.
5975 \end_layout
5976
5977 \begin_layout Itemize
5978
5979 \family typewriter
5980
5981 \backslash
5982 inst{<nr>}
5983 \family default
5984 to mark corresponding author/institute pairs.
5985  The institutes are numbered sequentially as they appear in the 
5986 \family sans
5987 Address
5988 \family default
5989  field, so you have to put a marker to each author.
5990 \end_layout
5991
5992 \begin_layout Itemize
5993
5994 \family typewriter
5995
5996 \backslash
5997 email{address}
5998 \family default
5999  to supply an email address for fast contact.
6000 \end_layout
6001
6002 \begin_layout Standard
6003 In all cases, the appropriate command has to be entered in LyX an marked
6004  as LaTeX code.
6005  See the examples.
6006  
6007 \end_layout
6008
6009 \begin_layout Subsection
6010 The abstract
6011 \end_layout
6012
6013 \begin_layout Standard
6014 The abstract should immediately follow the header block.
6015  With version 5 the abstract environment was changed to a command, and there
6016  is now a resctriction to only one paragraph.
6017  In addition, it should contain an entry with the keywords.
6018  This is not yet implemented for LyX, therefore you have to enter the LaTeX
6019  command 
6020 \family typewriter
6021
6022 \backslash
6023 keywords{}
6024 \family default
6025  by hand and mark it as LaTeX code.
6026  Refer to the example paper.
6027 \end_layout
6028
6029 \begin_layout Subsection
6030 Supported environments
6031 \end_layout
6032
6033 \begin_layout Standard
6034 The A&A paper layout supports the following environments for structuring
6035  your text:
6036 \end_layout
6037
6038 \begin_layout Itemize
6039
6040 \family sans
6041 Standard
6042 \end_layout
6043
6044 \begin_layout Itemize
6045
6046 \family sans
6047 Section
6048 \end_layout
6049
6050 \begin_layout Itemize
6051
6052 \family sans
6053 Subsection
6054 \end_layout
6055
6056 \begin_layout Itemize
6057
6058 \family sans
6059 Subsubsection
6060 \end_layout
6061
6062 \begin_layout Itemize
6063
6064 \family sans
6065 Itemize
6066 \end_layout
6067
6068 \begin_layout Itemize
6069
6070 \family sans
6071 Enumerate
6072 \end_layout
6073
6074 \begin_layout Itemize
6075
6076 \family sans
6077 Description
6078 \end_layout
6079
6080 \begin_layout Itemize
6081
6082 \family sans
6083 Caption
6084 \end_layout
6085
6086 \begin_layout Itemize
6087
6088 \family sans
6089 Abstract
6090 \end_layout
6091
6092 \begin_layout Itemize
6093
6094 \family sans
6095 Acknowledgment
6096 \end_layout
6097
6098 \begin_layout Itemize
6099
6100 \family sans
6101 Bibliography
6102 \end_layout
6103
6104 \begin_layout Itemize
6105
6106 \family sans
6107 LaTeX
6108 \end_layout
6109
6110 \begin_layout Subsection
6111 Commands not supported by LyX
6112 \end_layout
6113
6114 \begin_layout Standard
6115 Some commands are not yet supported by the 
6116 \family sans
6117 paper (A&A)
6118 \family default
6119  layout for LyX.
6120  Some have already been mentioned.
6121  For the sake of completeness, they are listed all together here:
6122 \end_layout
6123
6124 \begin_layout Itemize
6125
6126 \family typewriter
6127
6128 \backslash
6129 and
6130 \end_layout
6131
6132 \begin_layout Itemize
6133
6134 \family typewriter
6135
6136 \backslash
6137 email
6138 \end_layout
6139
6140 \begin_layout Itemize
6141
6142 \family typewriter
6143
6144 \backslash
6145 appendix
6146 \end_layout
6147
6148 \begin_layout Itemize
6149
6150 \family typewriter
6151
6152 \backslash
6153 authorrunning
6154 \end_layout
6155
6156 \begin_layout Itemize
6157
6158 \family typewriter
6159
6160 \backslash
6161 inst{}
6162 \end_layout
6163
6164 \begin_layout Itemize
6165
6166 \family typewriter
6167
6168 \backslash
6169 keywords{}
6170 \end_layout
6171
6172 \begin_layout Itemize
6173
6174 \family typewriter
6175
6176 \backslash
6177 object{}
6178 \end_layout
6179
6180 \begin_layout Itemize
6181
6182 \family typewriter
6183
6184 \backslash
6185 titlerunning{}
6186 \end_layout
6187
6188 \begin_layout Standard
6189 If you want to use any of these commands, you have to enter them yourself.
6190  
6191 \series bold
6192 Do not forget to mark them as LaTeX code!
6193 \end_layout
6194
6195 \begin_layout Subsection
6196 Figure and Table Floats
6197 \end_layout
6198
6199 \begin_layout Standard
6200 LyX provides support for the necessary float environments 
6201 \family sans
6202 figure, figure*, table 
6203 \family default
6204 and 
6205 \family sans
6206 table*
6207 \family default
6208 , therefore we won't tell much about it here.
6209  Refer to the 
6210 \emph on
6211 User's\InsetSpace ~
6212 Guide
6213 \emph default
6214 .
6215  Just remember that tables should be left-aligned.
6216  For that, select the table and change the alignment in 
6217 \family sans
6218 \bar under
6219 E
6220 \bar default
6221 dit\SpecialChar \menuseparator
6222
6223 \bar under
6224 P
6225 \bar default
6226 aragraph\InsetSpace ~
6227 Settings.
6228 \end_layout
6229
6230 \begin_layout Standard
6231 There is
6232 \family sans
6233  
6234 \family default
6235 only one special thing: the figures with caption besides the figure.
6236  To create such a figure, you have to do the following:
6237 \end_layout
6238
6239 \begin_layout Enumerate
6240 Create a wide figure float: 
6241 \family sans
6242 \bar under
6243 I
6244 \bar default
6245 nsert\SpecialChar \menuseparator
6246 Flo
6247 \bar under
6248 a
6249 \bar default
6250 t\SpecialChar \menuseparator
6251 Figure
6252 \family default
6253 , then right click in the figure and select
6254 \family sans
6255  
6256 \bar under
6257 S
6258 \bar default
6259 pan\InsetSpace ~
6260 columns
6261 \family default
6262 .
6263 \end_layout
6264
6265 \begin_layout Enumerate
6266 Enter your caption text.
6267 \end_layout
6268
6269 \begin_layout Enumerate
6270 Press 
6271 \family sans
6272 Return
6273 \family default
6274  to move the cursor above the caption.
6275 \end_layout
6276
6277 \begin_layout Enumerate
6278 Insert your figure
6279 \end_layout
6280
6281 \begin_layout Enumerate
6282 Position the cursor behind the figure and insert a horizontal fill: 
6283 \family sans
6284 \bar under
6285 I
6286 \bar default
6287 nsert\SpecialChar \menuseparator
6288
6289 \bar under
6290 S
6291 \bar default
6292 pecial\InsetSpace ~
6293 Character
6294 \bar under
6295 \SpecialChar \menuseparator
6296 H
6297 \bar default
6298 orizontal\InsetSpace ~
6299 Fill
6300 \family default
6301 .
6302 \end_layout
6303
6304 \begin_layout Enumerate
6305 Switch to LaTeX mode: 
6306 \family sans
6307 M-c\InsetSpace ~
6308 t
6309 \family default
6310 .
6311 \end_layout
6312
6313 \begin_layout Enumerate
6314 Enter 
6315 \family typewriter
6316
6317 \backslash
6318 parbox[b]{55mm}{
6319 \family default
6320 .
6321  
6322 \series bold
6323 Do not close the brace!
6324 \end_layout
6325
6326 \begin_layout Enumerate
6327 Position the cursor behind the caption text, switch to LaTeX mode and insert
6328  the closing brace: 
6329 \family sans
6330 M-c\InsetSpace ~
6331
6332 \family typewriter
6333 }
6334 \family default
6335 .
6336 \end_layout
6337
6338 \begin_layout Standard
6339 Also, refer to the figures in the example paper.
6340 \end_layout
6341
6342 \begin_layout Subsection
6343 Referee layout
6344 \end_layout
6345
6346 \begin_layout Standard
6347 For submission, the paper has to be formated in a special double-spacing
6348  layout.
6349  For this purpose, you have to give the option 
6350 \family typewriter
6351 referee
6352 \family default
6353  to the documentclass.
6354  This must be done using the extra class options field in the 
6355 \family sans
6356 \bar under
6357 D
6358 \bar default
6359 ocument\SpecialChar \menuseparator
6360
6361 \bar under
6362 S
6363 \bar default
6364 ettings
6365 \family default
6366  dialog.
6367  Just enter the string 
6368 \family typewriter
6369 referee
6370 \family default
6371  there.
6372 \end_layout
6373
6374 \begin_layout Subsection
6375 The example paper
6376 \end_layout
6377
6378 \begin_layout Standard
6379 The 
6380 \family sans
6381 Examples
6382 \family default
6383  directory contains an example paper written with LyX.
6384  It is the example paper from the original macro package, translated to
6385  LyX.
6386  Use it for inspiration, and compare the original LaTeX code with LyX way
6387  of writing.
6388 \end_layout
6389
6390 \begin_layout Section
6391 AASTeX
6392 \end_layout
6393
6394 \begin_layout Standard
6395 by 
6396 \noun on
6397 Mike Ressler
6398 \end_layout
6399
6400 \begin_layout Subsection
6401 Introduction
6402 \end_layout
6403
6404 \begin_layout Standard
6405 AASTeX is a set of macros produced by the American Astronomical Society
6406  to facilitate electronic manuscript submission to the three journals they
6407  publish: the Astrophysical Journal (including the Letters and Supplement),
6408  the Astronomical Journal, and the Publications of the Astronomical Society
6409  of the Pacific.
6410  LyX has proven to be an excellent tool for generating these documents,
6411  especially given its equation, citation, and figure handling capabilities.
6412  LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
6413  is the version described here, or higher.
6414  Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
6415  incompatible with LyX.
6416  The AASTeX package may be downloaded from the AASTeX Web site
6417 \end_layout
6418
6419 \begin_layout Standard
6420 \begin_inset VSpace medskip
6421 \end_inset
6422
6423
6424 \end_layout
6425
6426 \begin_layout Standard
6427 \align center
6428 \begin_inset LatexCommand \url{http://www.journals.uchicago.edu/AAS/AASTeX}
6429
6430 \end_inset
6431
6432
6433 \end_layout
6434
6435 \begin_layout Standard
6436 \begin_inset VSpace medskip
6437 \end_inset
6438
6439
6440 \end_layout
6441
6442 \begin_layout Standard
6443 A complete user guide is contained in that package and you should familiarize
6444  yourself with it thoroughly before embarking on writing a paper in LyX.
6445  LyX will not reduce the need to figure out all the AASTeX commands, it
6446  will only reduce the drudgery of typing everything in.
6447  It is your responsibility to ensure that the final exported LaTeX document
6448  conforms completely to the requirements of the journal to which you are
6449  submitting your paper.
6450 \end_layout
6451
6452 \begin_layout Subsection
6453 Starting a New Paper
6454 \end_layout
6455
6456 \begin_layout Standard
6457 I strongly suggest that you start with the AASTeX template file.
6458  Click on 
6459 \family sans
6460 \bar under
6461 F
6462 \bar default
6463 ile\SpecialChar \menuseparator
6464 New from 
6465 \bar under
6466 T
6467 \bar default
6468 emplate
6469 \family default
6470 , enter the new file name, then choose the 
6471 \family typewriter
6472 aastex.lyx
6473 \family default
6474  template.
6475  This will show the most common fields found in a manuscript.
6476  Simply overwrite the existing text (including the brackets, 
6477 \family typewriter
6478 <>
6479 \family default
6480 ) with the correct information.
6481  Many of the AASTeX commands and environments can be implemented directly
6482  in LyX, but some cannot: most noticeably 
6483 \family typewriter
6484
6485 \backslash
6486 altaffilmark
6487 \family default
6488  and 
6489 \family typewriter
6490
6491 \backslash
6492 altaffiltext
6493 \family default
6494 , which should stick out like a sore thumb if you actually just opened the
6495  template file.
6496  For commands such as these, the LaTeX code must be entered directly and
6497  marked as such.
6498  Such commands are referred to as ERT, or Evil Red Text.
6499  I tried to minimize the amount of ERT needed in an AASTeX document, but
6500  there is still a bit more required than any of us would like.
6501 \end_layout
6502
6503 \begin_layout Subsection
6504 Finishing Your Paper
6505 \end_layout
6506
6507 \begin_layout Standard
6508 When the paper is finished to your satisfaction and previews/prints correctly,
6509  there are a few 
6510 \begin_inset Quotes eld
6511 \end_inset
6512
6513 postprocessing
6514 \begin_inset Quotes erd
6515 \end_inset
6516
6517  actions which need to be done before you submit it to the journals.
6518  
6519 \end_layout
6520
6521 \begin_layout Enumerate
6522 Export your paper as a LaTeX file (
6523 \family sans
6524 \bar under
6525 F
6526 \bar default
6527 ile\SpecialChar \menuseparator
6528
6529 \bar under
6530 E
6531 \bar default
6532 xport\SpecialChar \menuseparator
6533
6534 \bar under
6535 L
6536 \bar default
6537 aTeX
6538 \family default
6539 ).
6540  
6541 \end_layout
6542
6543 \begin_layout Enumerate
6544 Edit the resulting 
6545 \family typewriter
6546 .tex
6547 \family default
6548  file with your favorite text editor
6549 \end_layout
6550
6551 \begin_deeper
6552 \begin_layout Enumerate
6553 remove the comment lines before the 
6554 \family typewriter
6555
6556 \backslash
6557 documentclass
6558 \family default
6559  command
6560 \end_layout
6561
6562 \begin_layout Enumerate
6563 remove the 
6564 \family typewriter
6565
6566 \backslash
6567 usepackage...{fontenc}
6568 \family default
6569  line if it appears (usually just after 
6570 \family typewriter
6571
6572 \backslash
6573 documentclass
6574 \family default
6575 }; also remove the 
6576 \family typewriter
6577
6578 \backslash
6579 secnumdepth
6580 \family default
6581  line if it appears.
6582 \end_layout
6583
6584 \begin_layout Enumerate
6585 remove everything between (and including) the 
6586 \family typewriter
6587
6588 \backslash
6589 makeatletter
6590 \family default
6591  and 
6592 \family typewriter
6593
6594 \backslash
6595 makeatother
6596 \family default
6597  commands, except for any commands you specifically put into the LaTeX preamble
6598  (which should appear immediately after the 
6599 \begin_inset Quotes eld
6600 \end_inset
6601
6602 User specified LaTeX commands
6603 \begin_inset Quotes erd
6604 \end_inset
6605
6606  comment in the 
6607 \family typewriter
6608 .tex
6609 \family default
6610  file).
6611 \end_layout
6612
6613 \end_deeper
6614 \begin_layout Enumerate
6615 Run the resulting file through LaTeX to make sure it still processes correctly.
6616 \end_layout
6617
6618 \begin_layout Enumerate
6619 Reread the journal requirements to make sure your filenames and formats
6620  are correct.
6621 \end_layout
6622
6623 \begin_layout Enumerate
6624 Submit it.
6625 \end_layout
6626
6627 \begin_layout Subsection
6628 Comments On Specific Commands
6629 \end_layout
6630
6631 \begin_layout Standard
6632 I will not describe the detailed usage of the individual AASTeX commands:
6633  the AASTeX User Guide (
6634 \family typewriter
6635 aasguide.tex
6636 \family default
6637 ) gives a good description of each.
6638  Thus it's probably easiest for me to go down the list as found in the guide
6639  and offer comments where necessary.
6640  So let's begin \SpecialChar \ldots{}
6641
6642 \end_layout
6643
6644 \begin_layout Subsubsection
6645 Things that work as expected
6646 \end_layout
6647
6648 \begin_layout Standard
6649 \begin_inset ERT
6650 status inlined
6651
6652 \begin_layout Standard
6653
6654
6655 \backslash
6656 begin{sloppypar}
6657 \end_layout
6658
6659 \end_inset
6660
6661
6662 \end_layout
6663
6664 \begin_layout Standard
6665 Because they work as you might expect, I simply list them and the section
6666  they are found in: 
6667 \family typewriter
6668
6669 \backslash
6670 documentclass
6671 \family default
6672  (2.1.1), 
6673 \family typewriter
6674
6675 \backslash
6676 begin{document}
6677 \family default
6678  (2.2), 
6679 \family typewriter
6680
6681 \backslash
6682 title
6683 \family default
6684  (2.3), 
6685 \family typewriter
6686
6687 \backslash
6688 author
6689 \family default
6690  (2.3), 
6691 \family typewriter
6692
6693 \backslash
6694 affil
6695 \family default
6696  (2.3), 
6697 \family typewriter
6698
6699 \backslash
6700 abstract
6701 \family default
6702  (2.4), 
6703 \family typewriter
6704
6705 \backslash
6706 keywords
6707 \family default
6708  (2.5), 
6709 \family typewriter
6710
6711 \backslash
6712 section
6713 \family default
6714  (2.7), 
6715 \family typewriter
6716
6717 \backslash
6718 subsection
6719 \family default
6720  (2.7), 
6721 \family typewriter
6722
6723 \backslash
6724 subsubsection
6725 \family default
6726  (2.7), 
6727 \family typewriter
6728
6729 \backslash
6730 paragraph
6731 \family default
6732  (2.7),
6733 \family typewriter
6734  
6735 \backslash
6736 facility
6737 \family default
6738  (2.10), 
6739 \family typewriter
6740
6741 \backslash
6742 begin{displaymath}
6743 \family default
6744  (2.12), 
6745 \family typewriter
6746
6747 \backslash
6748 begin{equation}
6749 \family default
6750  (2.12), 
6751 \family typewriter
6752
6753 \backslash
6754 begin{eqnarray}
6755 \family default
6756  (2.12), 
6757 \family typewriter
6758
6759 \backslash
6760 begin{mathletters}
6761 \family default
6762  (2.12), 
6763 \family typewriter
6764
6765 \backslash
6766 begin{thebibliography}
6767 \family default
6768  (2.13.1), 
6769 \family typewriter
6770
6771 \backslash
6772 bibitem
6773 \family default
6774  (2.13.2), all the cite commands and their variations (2.13.2), the generic
6775  graphicx figure commands (2.14.1),
6776 \family typewriter
6777  
6778 \backslash
6779 begin{table}
6780 \family default
6781  (2.15.4), 
6782 \family typewriter
6783
6784 \backslash
6785 begin{tabular}
6786 \family default
6787  (2.15.4), 
6788 \family typewriter
6789
6790 \backslash
6791 caption
6792 \family default
6793  (2.15.4), 
6794 \family typewriter
6795
6796 \backslash
6797 label
6798 \family default
6799  (2.15.4, amongst other places), 
6800 \family typewriter
6801
6802 \backslash
6803 tablerefs
6804 \family default
6805  (2.15.5), 
6806 \family typewriter
6807
6808 \backslash
6809 tablecomments
6810 \family default
6811  (2.15.5), 
6812 \family typewriter
6813
6814 \backslash
6815 url
6816 \family default
6817  (2.17.4), 
6818 \family typewriter
6819
6820 \backslash
6821 end{document}
6822 \family default
6823  (2.18).
6824 \end_layout
6825
6826 \begin_layout Standard
6827 The following style options also work correctly: 
6828 \family typewriter
6829 longabstract
6830 \family default
6831  (2.4), 
6832 \family typewriter
6833 preprint
6834 \family default
6835  (3.2.1), 
6836 \family typewriter
6837 preprint2
6838 \family default
6839  (3.2.2), 
6840 \family typewriter
6841 eqsecnum
6842 \family default
6843  (3.3), 
6844 \family typewriter
6845 flushrt
6846 \family default
6847  (3.4).
6848  Simply put them in the 
6849 \family sans
6850 Options
6851 \family default
6852  box in 
6853 \family sans
6854 Layout\SpecialChar \menuseparator
6855 Document
6856 \family default
6857 .
6858 \end_layout
6859
6860 \begin_layout Standard
6861 \begin_inset ERT
6862 status inlined
6863
6864 \begin_layout Standard
6865
6866
6867 \backslash
6868 end{sloppypar}
6869 \end_layout
6870
6871 \end_inset
6872
6873
6874 \end_layout
6875
6876 \begin_layout Subsubsection
6877 Things that work, but require more comment
6878 \end_layout
6879
6880 \begin_layout Standard
6881 The following items work, but require a little more discussion:
6882 \end_layout
6883
6884 \begin_layout Itemize
6885 These items are reserved for use by the journal editors, but you can put
6886  them into the LaTeX preamble if you feel compelled to do so: 
6887 \family typewriter
6888
6889 \backslash
6890 received
6891 \family default
6892
6893 \family typewriter
6894
6895 \backslash
6896 revised
6897 \family default
6898
6899 \family typewriter
6900
6901 \backslash
6902 accepted
6903 \family default
6904
6905 \family typewriter
6906
6907 \backslash
6908 ccc
6909 \family default
6910
6911 \family typewriter
6912
6913 \backslash
6914 cpright
6915 \family default
6916  (all from 2.1.3)
6917 \end_layout
6918
6919 \begin_layout Itemize
6920 These items may be placed in the LaTeX preamble, and are included as blanks
6921  in the template file: 
6922 \family typewriter
6923
6924 \backslash
6925 slugcomment
6926 \family default
6927  (2.1.4), 
6928 \family typewriter
6929
6930 \backslash
6931 shorttitle
6932 \family default
6933  (2.1.5), 
6934 \family typewriter
6935
6936 \backslash
6937 shortauthors
6938 \family default
6939  (2.1.5)
6940 \end_layout
6941
6942 \begin_layout Itemize
6943
6944 \family typewriter
6945
6946 \backslash
6947 email
6948 \family default
6949  (2.3) -- can only be used 
6950 \begin_inset Quotes eld
6951 \end_inset
6952
6953 standalone
6954 \begin_inset Quotes erd
6955 \end_inset
6956
6957 , not in the middle of a paragraph.
6958  Use ERT if you need to embed it.
6959 \end_layout
6960
6961 \begin_layout Itemize
6962
6963 \family typewriter
6964
6965 \backslash
6966 and
6967 \family default
6968  (2.3) -- will have extra {} after it.
6969  This should not cause an error.
6970 \end_layout
6971
6972 \begin_layout Itemize
6973
6974 \family typewriter
6975
6976 \backslash
6977 notetoeditor
6978 \family default
6979  (2.6) -- can only be used 
6980 \begin_inset Quotes eld
6981 \end_inset
6982
6983 standalone
6984 \begin_inset Quotes erd
6985 \end_inset
6986
6987 , not in the middle of a paragraph.
6988  Use ERT if you need to embed it.
6989 \end_layout
6990
6991 \begin_layout Itemize
6992
6993 \family typewriter
6994
6995 \backslash
6996 placetable
6997 \family default
6998  (2.8) -- can't insert a cross-reference tag, you must type the tag name
6999  by hand
7000 \end_layout
7001
7002 \begin_layout Itemize
7003
7004 \family typewriter
7005
7006 \backslash
7007 placefigure
7008 \family default
7009  (2.8) -- same as for 
7010 \family typewriter
7011
7012 \backslash
7013 placetable
7014 \end_layout
7015
7016 \begin_layout Itemize
7017
7018 \family typewriter
7019
7020 \backslash
7021 acknowledgements
7022 \family default
7023  (2.9) -- will have extra {} after it.
7024  This should not cause an error.
7025 \end_layout
7026
7027 \begin_layout Itemize
7028
7029 \family typewriter
7030
7031 \backslash
7032 appendix
7033 \family default
7034  (2.11) -- will have extra {} after it.
7035  This should not cause an error.
7036 \end_layout
7037
7038 \begin_layout Itemize
7039
7040 \family typewriter
7041
7042 \backslash
7043 figcaption
7044 \family default
7045  (2.14.2) -- you can insert an optional filename argument by placing the cursor
7046  at the beginning of the text and selecting 
7047 \family sans
7048 Insert\SpecialChar \menuseparator
7049 Short Title
7050 \family default
7051 .
7052  
7053 \begin_inset Quotes eld
7054 \end_inset
7055
7056 Short Title
7057 \begin_inset Quotes erd
7058 \end_inset
7059
7060  inserts an optional argument of the type needed by 
7061 \family typewriter
7062
7063 \backslash
7064 figcaption
7065 \family default
7066 .
7067  Hopefully it will be renamed someday.
7068 \end_layout
7069
7070 \begin_layout Itemize
7071
7072 \family typewriter
7073
7074 \backslash
7075 objectname
7076 \family default
7077  (2.17.1) -- same as 
7078 \family typewriter
7079
7080 \backslash
7081 figcaption
7082 \family default
7083  for the catalog ID optional parameter
7084 \end_layout
7085
7086 \begin_layout Itemize
7087
7088 \family typewriter
7089
7090 \backslash
7091 dataset
7092 \family default
7093  (2.17.1) -- same as 
7094 \family typewriter
7095
7096 \backslash
7097 figcaption
7098 \family default
7099  for the catalog ID optional parameter
7100 \end_layout
7101
7102 \begin_layout Subsubsection
7103 Things not implemented, use ERT
7104 \end_layout
7105
7106 \begin_layout Standard
7107 \begin_inset ERT
7108 status inlined
7109
7110 \begin_layout Standard
7111
7112
7113 \backslash
7114 begin{sloppypar}
7115 \end_layout
7116
7117 \end_inset
7118
7119
7120 \end_layout
7121
7122 \begin_layout Standard
7123
7124 \family typewriter
7125
7126 \backslash
7127 altaffilmark
7128 \family default
7129  (2.3), 
7130 \family typewriter
7131
7132 \backslash
7133 altaffiltext
7134 \family default
7135  (2.3), 
7136 \family typewriter
7137
7138 \backslash
7139 eqnum
7140 \family default
7141  (2.12), 
7142 \family typewriter
7143
7144 \backslash
7145 setcounter{equation}
7146 \family default
7147  (2.12), Journal name abbreviations (2.13.4), 
7148 \family typewriter
7149
7150 \backslash
7151 figurenum
7152 \family default
7153  (2.14.1), 
7154 \family typewriter
7155
7156 \backslash
7157 epsscale
7158 \family default
7159  (2.14.1), 
7160 \family typewriter
7161
7162 \backslash
7163 plotone
7164 \family default
7165  (2.14.1), 
7166 \family typewriter
7167
7168 \backslash
7169 plottwo
7170 \family default
7171  (2.14.1), 
7172 \family typewriter
7173
7174 \backslash
7175 tablenum
7176 \family default
7177  (2.15.4), 
7178 \family typewriter
7179
7180 \backslash
7181 tableline
7182 \family default
7183  (2.15.4, insert it as the first element in the lefthand cell after where
7184  you want it.
7185  Don't use any of LyX's rules in the table), 
7186 \family typewriter
7187
7188 \backslash
7189 tablenotemark
7190 \family default
7191  (2.15.5), 
7192 \family typewriter
7193
7194 \backslash
7195 tablenotetext
7196 \family default
7197  (2.15.5), much of Misc (2.17, except 
7198 \family typewriter
7199
7200 \backslash
7201 objectname
7202 \family default
7203 ,
7204 \family typewriter
7205  
7206 \backslash
7207 dataset
7208 \family default
7209 ,
7210 \family typewriter
7211  
7212 \backslash
7213 url
7214 \family default
7215 , and 
7216 \family typewriter
7217
7218 \backslash
7219 email
7220 \family default
7221 ; see above), 
7222 \family typewriter
7223
7224 \backslash
7225 singlespace
7226 \family default
7227  (3.1), 
7228 \family typewriter
7229
7230 \backslash
7231 doublespace
7232 \family default
7233  (3.1), 
7234 \family typewriter
7235
7236 \backslash
7237 onecolumn
7238 \family default
7239  (3.2), 
7240 \family typewriter
7241
7242 \backslash
7243 twocolumn
7244 \family default
7245  (3.2)
7246 \end_layout
7247
7248 \begin_layout Standard
7249 \begin_inset ERT
7250 status inlined
7251
7252 \begin_layout Standard
7253
7254
7255 \backslash
7256 end{sloppypar}
7257 \end_layout
7258
7259 \end_inset
7260
7261
7262 \end_layout
7263
7264 \begin_layout Subsubsection
7265 Things that cannot be implemented
7266 \end_layout
7267
7268 \begin_layout Standard
7269 \SpecialChar \ldots{}
7270  at least in any meaningful sort of way, so I suggest ignoring them.
7271  They are the references environment (2.13.3), and the deluxetable environment
7272  (2.15).
7273  If you really, really need to use deluxetable, I suggest editing it in
7274  a separate file with a text editor, then using 
7275 \family sans
7276 \bar under
7277 I
7278 \bar default
7279 nsert\SpecialChar \menuseparator
7280 Chil
7281 \bar under
7282 d
7283 \bar default
7284 \InsetSpace ~
7285 Document
7286 \family default
7287  to include it in your LyX document.
7288  See the 
7289 \family typewriter
7290 aas_sample.lyx
7291 \family default
7292  file to see an example of this.
7293 \end_layout
7294
7295 \begin_layout Subsection
7296 FAQs, Tips, Tricks, and Other Ruminations
7297 \end_layout
7298
7299 \begin_layout Subsubsection
7300 Getting LyX and AASTeX to cooperate
7301 \end_layout
7302
7303 \begin_layout Standard
7304 It can be a bit tricky to get LyX to recognize a new layout and document
7305  class.
7306  When all else fails, do this:
7307 \end_layout
7308
7309 \begin_layout Enumerate
7310 Make certain that LaTeX can find AASTeX.
7311  Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
7312  a directory completely unrelated to LaTeX or AASTeX and run LaTeX on 
7313 \family typewriter
7314 sample.tex
7315 \family default
7316 .
7317 \end_layout
7318
7319 \begin_layout Enumerate
7320 Make certain that 
7321 \family typewriter
7322 aastex.layout
7323 \family default
7324  appears in 
7325 \family typewriter
7326 /usr/.../share/lyx/layouts
7327 \family default
7328  or 
7329 \family typewriter
7330 ~/.lyx/layouts
7331 \family default
7332 .
7333 \end_layout
7334
7335 \begin_layout Enumerate
7336 Rerun 
7337 \family sans
7338 \bar under
7339 T
7340 \bar default
7341 ools\SpecialChar \menuseparator
7342
7343 \bar under
7344 R
7345 \bar default
7346 econfigure
7347 \family default
7348  in LyX, then restart LyX.
7349 \end_layout
7350
7351 \begin_layout Enumerate
7352 Open a regular new file, not from a template.
7353  Does AASTeX appear in the class list in 
7354 \family sans
7355 \bar under
7356 D
7357 \bar default
7358 ocument\SpecialChar \menuseparator
7359
7360 \bar under
7361 S
7362 \bar default
7363 ettings
7364 \family default
7365 ?
7366 \end_layout
7367
7368 \begin_layout Standard
7369 If you get a warning from an existing AASTeX document about not being able
7370  to find the AASTeX layout or a message about 
7371 \begin_inset Quotes eld
7372 \end_inset
7373
7374 You should not mix title layouts with normal ones
7375 \begin_inset Quotes erd
7376 \end_inset
7377
7378 , things haven't been installed correctly.
7379 \end_layout
7380
7381 \begin_layout Subsubsection
7382 LaTeX error processing a table 
7383 \end_layout
7384
7385 \begin_layout Standard
7386 LyX, by default, attempts to center the table caption/title.
7387  This seems to produce a bad interaction in AASTeX so you should click somewhere
7388  in the caption/title, then select 
7389 \family sans
7390 \bar under
7391 E
7392 \bar default
7393 dit\SpecialChar \menuseparator
7394
7395 \bar under
7396 P
7397 \bar default
7398 aragraph\InsetSpace ~
7399 Settings
7400 \family default
7401 , then set the 
7402 \family sans
7403 Alignment
7404 \family default
7405  to 
7406 \family sans
7407 \bar under
7408 B
7409 \bar default
7410 lock
7411 \family default
7412 .
7413  This took care of it for me.
7414 \end_layout
7415
7416 \begin_layout Subsubsection
7417 References
7418 \begin_inset LatexCommand \label{cite}
7419
7420 \end_inset
7421
7422
7423 \end_layout
7424
7425 \begin_layout Standard
7426 A couple of things: 1) I have noticed some funny spacing in the reference
7427  entries in the text.
7428  When you enter the bibliography item data, make sure their is 
7429 \emph on
7430 no
7431 \emph default
7432  space between the last author and the parenthesis setting off the year;
7433  
7434 \emph on
7435 e.g.
7436  
7437 \emph default
7438 type
7439 \family typewriter
7440  Ressler(1992)
7441 \family default
7442 , not 
7443 \family typewriter
7444 Ressler (1992)
7445 \family default
7446 .
7447  2) Entering the references at all is not obvious.
7448  The easiest thing is to start typing your first reference at the end of
7449  the document, then mark it as type 
7450 \family sans
7451 References
7452 \family default
7453 .
7454  That will put a small gray box in front of what you just typed.
7455  Click on the box to fill in the rest of the information.
7456  For new references, go to the end of an existing reference and press return.
7457  That will create a new line with its own box, etc.
7458 \end_layout
7459
7460 \begin_layout Subsubsection
7461 Including EPS files
7462 \end_layout
7463
7464 \begin_layout Standard
7465 Even though AASTeX provides its own figure commands (
7466 \family typewriter
7467
7468 \backslash
7469 plotone
7470 \family default
7471 , for example), I much prefer LaTeX's standard figure commands (with the
7472  default graphicx).
7473  You can insert the 
7474 \family typewriter
7475
7476 \backslash
7477 plotone
7478 \family default
7479 , etc.\InsetSpace ~
7480 commands as ERT into a Figure Float box if you desire, but I never
7481  have much luck getting the layout right.
7482  With the standard graphics, LyX will insert a 
7483 \family typewriter
7484
7485 \backslash
7486 usepackage{graphicx}
7487 \family default
7488  command into the LaTeX preamble and handle the figures in the standard
7489  LaTeX2e way, interspersing the figures in the text.
7490  I believe ApJ accepts figures exactly this way now; AJ might still use
7491  the 
7492 \begin_inset Quotes eld
7493 \end_inset
7494
7495 stack everything at the end
7496 \begin_inset Quotes erd
7497 \end_inset
7498
7499  technique.
7500 \end_layout
7501
7502 \begin_layout Subsubsection
7503 Things I could have done, but didn't
7504 \end_layout
7505
7506 \begin_layout Standard
7507 There are a few 
7508 \begin_inset Quotes eld
7509 \end_inset
7510
7511 pretty
7512 \begin_inset Quotes erd
7513 \end_inset
7514
7515  things I could have implemented, but chose not to.
7516  For instance, I saw no point in double-spacing the text in the LyX window,
7517  even though it is double-spaced in the paper manuscript.
7518  Also, I chose not to make separate layouts for the preprint and preprint2
7519  styles.
7520  Since I assume you will spend most of your time in the plain manuscript
7521  mode anyway, I decided not to chew up more disk space with this.
7522  
7523 \end_layout
7524
7525 \begin_layout Subsection
7526 Final Caveat
7527 \end_layout
7528
7529 \begin_layout Standard
7530 Your mileage may vary.
7531  I've now had papers published by both ApJ and AJ that have had 98% of the
7532  effort done in LyX; the last 2% was the LaTeX post-processing and a few
7533  cleanups.
7534  I have had no trouble with the submission process, and I'm sure the journals
7535  were never aware that there might be a difference.
7536  So, go forth and publish!
7537 \end_layout
7538
7539 \begin_layout Section
7540 qijmpc and ijmpd
7541 \end_layout
7542
7543 \begin_layout Standard
7544 by 
7545 \noun on
7546 Panayotis Papasotiriou
7547 \end_layout
7548
7549 \begin_layout Subsection
7550 Overview
7551 \end_layout
7552
7553 \begin_layout Standard
7554 The ijmpc package is a set of macros that facilitates electronic manuscript
7555  submission to the 
7556 \emph on
7557 International Journal of Modern Physics C
7558 \emph default
7559 .
7560  Similarly, the ijmpd package is for creating manuscripts to be submitted
7561  to the 
7562 \emph on
7563 International Journal of Modern Physics D
7564 \emph default
7565 .
7566  Both journals are published by World Scientific.
7567  The corresponding document classes are named 
7568 \family typewriter
7569 ws-ijmpc.cls
7570 \family default
7571  and 
7572 \family typewriter
7573 ws-ijmpd.cls
7574 \family default
7575 , respectively.
7576  These files, together with instructions for the authors, can be downloaded
7577  from the sites 
7578 \begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml}
7579
7580 \end_inset
7581
7582  and 
7583 \begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml}
7584
7585 \end_inset
7586
7587 .
7588  Both packages are modified versions of the standard 
7589 \begin_inset Quotes eld
7590 \end_inset
7591
7592 article
7593 \begin_inset Quotes erd
7594 \end_inset
7595
7596  package, and they are almost (but not exactly) identical.
7597  Most of their features are supported by LyX.
7598  I have used LyX successfully to write articles submitted to both journals
7599  without any problem.
7600 \end_layout
7601
7602 \begin_layout Subsection
7603 Writing a paper
7604 \end_layout
7605
7606 \begin_layout Standard
7607 As usual, the easiest way to write a paper is to start with a template.
7608  Click on 
7609 \family sans
7610 \bar under
7611 F
7612 \bar default
7613 ile\SpecialChar \menuseparator
7614 New from 
7615 \bar under
7616 T
7617 \bar default
7618 emplate
7619 \family default
7620 , then choose the 
7621 \family typewriter
7622 ijmpc.lyx
7623 \family default
7624  or 
7625 \family typewriter
7626 ijmpd.lyx
7627 \family default
7628  template.
7629  This will give an (almost) empty document that includes the most common
7630  fields found in a manuscript.
7631  Simply overwrite the existing text (including the brackets, 
7632 \family typewriter
7633 <>
7634 \family default
7635 ) with your text.
7636  You should keep in mind the following remarks.
7637 \end_layout
7638
7639 \begin_layout Enumerate
7640 LyX won't let you change the font size and the page style of the document,
7641  because such modifications are not allowed by both packages.
7642 \end_layout
7643
7644 \begin_layout Enumerate
7645 The language of the document should not be changed.
7646  Before previewing your paper, be sure that the babel package is not used.
7647  To do this, click on 
7648 \family sans
7649 \bar under
7650 T
7651 \bar default
7652 ools\SpecialChar \menuseparator
7653
7654 \bar under
7655 P
7656 \bar default
7657 references
7658 \family default
7659 , select the 
7660 \family sans
7661 Lang Opts
7662 \family default
7663  tab, deselect the 
7664 \family sans
7665 \bar under
7666 U
7667 \bar default
7668 se babel
7669 \family default
7670  checkbox in the language settings, and click on 
7671 \family sans
7672 \bar under
7673 A
7674 \bar default
7675 pply
7676 \family default
7677  (or 
7678 \family sans
7679 Save
7680 \family default
7681 , if you wish to make this change permanent).
7682 \end_layout
7683
7684 \begin_layout Enumerate
7685 The 
7686 \begin_inset Quotes eld
7687 \end_inset
7688
7689 Keywords
7690 \begin_inset Quotes erd
7691 \end_inset
7692
7693  style must be used to define keywords.
7694 \end_layout
7695
7696 \begin_layout Enumerate
7697 The ijmpc package provides a style named 
7698 \begin_inset Quotes eld
7699 \end_inset
7700
7701 Classification Codes
7702 \begin_inset Quotes erd
7703 \end_inset
7704
7705 , which can be used to define classification codes, such as PACS numbers.
7706  Note that this facility is not supported by the ijmpd package.
7707 \end_layout
7708
7709 \begin_layout Enumerate
7710 Several new environments are available: 
7711 \begin_inset Quotes eld
7712 \end_inset
7713
7714 Definition
7715 \begin_inset Quotes erd
7716 \end_inset
7717
7718
7719 \begin_inset Quotes eld
7720 \end_inset
7721
7722 Step
7723 \begin_inset Quotes erd
7724 \end_inset
7725
7726
7727 \begin_inset Quotes eld
7728 \end_inset
7729
7730 Example
7731 \begin_inset Quotes erd
7732 \end_inset
7733
7734
7735 \begin_inset Quotes eld
7736 \end_inset
7737
7738 Remark
7739 \begin_inset Quotes erd
7740 \end_inset
7741
7742
7743 \begin_inset Quotes eld
7744 \end_inset
7745
7746 Notation
7747 \begin_inset Quotes erd
7748 \end_inset
7749
7750
7751 \begin_inset Quotes eld
7752 \end_inset
7753
7754 Theorem
7755 \begin_inset Quotes erd
7756 \end_inset
7757
7758
7759 \begin_inset Quotes eld
7760 \end_inset
7761
7762 Proof
7763 \begin_inset Quotes erd
7764 \end_inset
7765
7766
7767 \begin_inset Quotes eld
7768 \end_inset
7769
7770 Corollary
7771 \begin_inset Quotes erd
7772 \end_inset
7773
7774
7775 \begin_inset Quotes eld
7776 \end_inset
7777
7778 Lemma
7779 \begin_inset Quotes erd
7780 \end_inset
7781
7782
7783 \begin_inset Quotes eld
7784 \end_inset
7785
7786 Proposition
7787 \begin_inset Quotes erd
7788 \end_inset
7789
7790
7791 \begin_inset Quotes eld
7792 \end_inset
7793
7794 Prop
7795 \begin_inset Quotes erd
7796 \end_inset
7797
7798
7799 \begin_inset Quotes eld
7800 \end_inset
7801
7802 Question
7803 \begin_inset Quotes erd
7804 \end_inset
7805
7806
7807 \begin_inset Quotes eld
7808 \end_inset
7809
7810 Claim
7811 \begin_inset Quotes erd
7812 \end_inset
7813
7814 , and 
7815 \begin_inset Quotes eld
7816 \end_inset
7817
7818 Conjecture
7819 \begin_inset Quotes erd
7820 \end_inset
7821
7822 .
7823  Their use is more or less obvious.
7824  LyX supports all these environments; it will use the proper label, text
7825  style, and numbering scheme for each of them.
7826 \end_layout
7827
7828 \begin_layout Enumerate
7829 Both packages use basic citations; the natbib package should not be used.
7830  In LyX, citation references are shown as usual; in the output, citations
7831  are shown as superscripts.
7832  If you want to use a citation as normal text, you should use the 
7833 \family typewriter
7834 refcite
7835 \family default
7836  command, e.g., 
7837 \begin_inset Quotes eld
7838 \end_inset
7839
7840 See Ref.\InsetSpace ~
7841
7842 \family typewriter
7843
7844 \backslash
7845 refcite{key}
7846 \family default
7847
7848 \begin_inset Quotes erd
7849 \end_inset
7850
7851 .
7852 \end_layout
7853
7854 \begin_layout Enumerate
7855 There is no 
7856 \begin_inset Quotes eld
7857 \end_inset
7858
7859 Acknowledgments
7860 \begin_inset Quotes erd
7861 \end_inset
7862
7863  section in both packages.
7864  To put acknowledgments, just use the 
7865 \begin_inset Quotes eld
7866 \end_inset
7867
7868 Section*
7869 \begin_inset Quotes erd
7870 \end_inset
7871
7872  environment.
7873 \end_layout
7874
7875 \begin_layout Enumerate
7876 Appendices may be added to the paper, 
7877 \emph on
7878 after
7879 \emph default
7880  the Acknowledgments and 
7881 \shape italic
7882 before
7883 \shape default
7884  the References.
7885  LyX provides a special environment, called 
7886 \begin_inset Quotes eld
7887 \end_inset
7888
7889 Appendices Section
7890 \begin_inset Quotes erd
7891 \end_inset
7892
7893  which marks the beginning of the appendices.
7894  This environment should be left blank; it just sends a LaTeX command, but
7895  nothing is really printed.
7896  In LyX, the word 
7897 \begin_inset Quotes eld
7898 \end_inset
7899
7900 Appendix
7901 \begin_inset Quotes erd
7902 \end_inset
7903
7904  is printed with blue letters, as a signal that all sections after that
7905  point are appendices.
7906  To write an appendix, use the 
7907 \begin_inset Quotes eld
7908 \end_inset
7909
7910 Appendix
7911 \begin_inset Quotes erd
7912 \end_inset
7913
7914  environment.
7915  LyX will number each appendix with capital letters, as required by both
7916  journals.
7917  Note that 
7918 \begin_inset Quotes eld
7919 \end_inset
7920
7921 Appendices Section
7922 \begin_inset Quotes erd
7923 \end_inset
7924
7925  
7926 \emph on
7927 must
7928 \emph default
7929  be present before the first appendix; if not, all appendices will be numbered
7930  as normal sections in the output.
7931 \end_layout
7932
7933 \begin_layout Enumerate
7934 The ijmpc and the ijmpd packages use the 
7935 \family typewriter
7936 tbl
7937 \family default
7938  command to implement table captions.
7939  As a result, a table created by LyX is printed correctly, but its caption
7940  is ignored.
7941  However, you can use some ERT to overpass this problem, so that captions
7942  are printed as expected.
7943  To do so, create a float table as usual, remove the caption, and replace
7944  it with the ERT 
7945 \family typewriter
7946
7947 \backslash
7948 tbl{
7949 \emph on
7950 your table caption
7951 \emph default
7952 }{
7953 \family default
7954  (sic); you must also the ERT 
7955 \family typewriter
7956 }
7957 \family default
7958  immediately after the tabular material.
7959  Study the example table included in the template files to see how this
7960  trick is implemented.
7961  Alternatively, If you need table captions, you should implement the whole
7962  table float in a 
7963 \family typewriter
7964 .tex
7965 \family default
7966  file, then include this file to the LyX document (
7967 \family sans
7968 \bar under
7969 I
7970 \bar default
7971 nsert\SpecialChar \menuseparator
7972 Fil
7973 \bar under
7974 e
7975 \bar default
7976 \SpecialChar \menuseparator
7977 Chil
7978 \bar under
7979 d
7980 \bar default
7981 \InsetSpace ~
7982 Document
7983 \family default
7984 ).
7985  Details on how to create a table float can be found in the files 
7986 \family typewriter
7987 ws-ijmpc.tex
7988 \family default
7989  and 
7990 \family typewriter
7991 ws-ijmpd.tex
7992 \family default
7993 , included in the corresponding packages.
7994 \end_layout
7995
7996 \begin_layout Subsection
7997 Preparing a paper for submission
7998 \end_layout
7999
8000 \begin_layout Standard
8001 Before you submit your paper you must export the LyX document as a LaTeX
8002  file (
8003 \family sans
8004 \bar under
8005 F
8006 \bar default
8007 ile\SpecialChar \menuseparator
8008
8009 \bar under
8010 E
8011 \bar default
8012 xport\SpecialChar \menuseparator
8013
8014 \bar under
8015 L
8016 \bar default
8017 ateX
8018 \family default
8019 ), then make the following changes to the resulting 
8020 \family typewriter
8021 .tex
8022 \family default
8023  file.
8024 \end_layout
8025
8026 \begin_layout Enumerate
8027 Remove the comment lines before the 
8028 \family typewriter
8029
8030 \backslash
8031 documentclass
8032 \family default
8033  command.
8034 \end_layout
8035
8036 \begin_layout Enumerate
8037 Remove everything between (and including) the 
8038 \family typewriter
8039
8040 \backslash
8041 makeatletter
8042 \family default
8043  and 
8044 \family typewriter
8045
8046 \backslash
8047 makeatother
8048 \family default
8049  commands, except for any commands you specifically put into the LaTeX preamble.
8050 \end_layout
8051
8052 \begin_layout Standard
8053 The modified 
8054 \family typewriter
8055 .tex
8056 \family default
8057  file should be saved and processed through LaTeX as many times as necessary.
8058  You may also want to check the resulting 
8059 \family typewriter
8060 .dvi
8061 \family default
8062  document.
8063 \end_layout
8064
8065 \begin_layout Subsection
8066 Use of ERT
8067 \end_layout
8068
8069 \begin_layout Standard
8070 The use of ERT is reduced to two commands, which must be placed at the top
8071  of the document.
8072  If you started writing your paper by using the 
8073 \family typewriter
8074 ijmpc.lyx
8075 \family default
8076  or the 
8077 \family typewriter
8078 ijmpd.lyx
8079 \family default
8080  template, the ERT needed is already in its place; you usually don't need
8081  to delete it.
8082  You may only modify the first ERT to specify the information printed to
8083  the top of odd and even pages (authors' names and short paper's title,
8084  respectively).
8085  This ERT must have the form 
8086 \family typewriter
8087
8088 \backslash
8089 markboth{Authors' Names}{Short Paper's Title}
8090 \family default
8091 .
8092 \end_layout
8093
8094 \begin_layout Section
8095 Kluwer
8096 \end_layout
8097
8098 \begin_layout Standard
8099 by 
8100 \noun on
8101 Panayotis Papasotiriou
8102 \end_layout
8103
8104 \begin_layout Subsection
8105 Overview
8106 \end_layout
8107
8108 \begin_layout Standard
8109 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
8110  that facilitates electronic manuscript submission to the journals they
8111  publish.
8112  Most known of them (at least in my domain of interest) are 
8113 \emph on
8114 Astrophysics and Space Science
8115 \emph default
8116  and 
8117 \emph on
8118 Solar Physics
8119 \emph default
8120 , but there are many others (see a complete list at 
8121 \begin_inset LatexCommand \url{http://www.wkap.nl/jrnllist.htm/JRNLHOME}
8122
8123 \end_inset
8124
8125 ).
8126  The Kluwer package may be downloaded from the site 
8127 \begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
8128
8129 \end_inset
8130
8131 .
8132  A complete user guide is contained in that package (but it can also be
8133  downloaded separately).
8134 \end_layout
8135
8136 \begin_layout Standard
8137 LyX supports many features of the package but not everything.
8138  However, the ERT needed is reduced to some 
8139 \begin_inset Quotes eld
8140 \end_inset
8141
8142 peculiar
8143 \begin_inset Quotes erd
8144 \end_inset
8145
8146  commands of the package (see\InsetSpace ~
8147
8148 \begin_inset LatexCommand \ref{subsec:kluwer_peculiarities}
8149
8150 \end_inset
8151
8152 ).
8153  I have recently used LyX to write an article submitted to the 
8154 \emph on
8155 Astrophysics and Space Science
8156 \emph default
8157  without any problem.
8158 \end_layout
8159
8160 \begin_layout Subsection
8161 Writing a paper
8162 \end_layout
8163
8164 \begin_layout Standard
8165 The easiest way to write a paper is to start with the Kluwer template file.
8166  Click on 
8167 \family sans
8168 File\SpecialChar \menuseparator
8169 New from 
8170 \bar under
8171 T
8172 \bar default
8173 emplate
8174 \family default
8175 , then choose the 
8176 \family typewriter
8177 kluwer.lyx
8178 \family default
8179  template.
8180  This will give an (almost) empty document that includes the most common
8181  fields found in a manuscript and a short description of their use.
8182  As in most templates, simply overwrite the existing text (including the
8183  brackets, 
8184 \family typewriter
8185 <>
8186 \family default
8187 ) with the correct information.
8188 \end_layout
8189
8190 \begin_layout Subsection
8191 Preparing a paper for submission
8192 \end_layout
8193
8194 \begin_layout Standard
8195 As in the AASTeX package, before you submit your paper to a journal you
8196  must 
8197 \begin_inset Quotes eld
8198 \end_inset
8199
8200 postprocess
8201 \begin_inset Quotes erd
8202 \end_inset
8203
8204  it as follows.
8205 \end_layout
8206
8207 \begin_layout Enumerate
8208 Export your paper as a LaTeX file.
8209  To do this, click on 
8210 \family sans
8211 \bar under
8212 F
8213 \bar default
8214 ile\SpecialChar \menuseparator
8215
8216 \bar under
8217 E
8218 \bar default
8219 xport\SpecialChar \menuseparator
8220
8221 \bar under
8222 L
8223 \bar default
8224 ateX
8225 \family default
8226 .
8227  
8228 \end_layout
8229
8230 \begin_layout Enumerate
8231 Edit the resulting 
8232 \family typewriter
8233 .tex
8234 \family default
8235  file with a text editor and make the following changes
8236 \end_layout
8237
8238 \begin_deeper
8239 \begin_layout Enumerate
8240 remove the comment lines before the 
8241 \family typewriter
8242
8243 \backslash
8244 documentclass
8245 \family default
8246  command,
8247 \end_layout
8248
8249 \begin_layout Enumerate
8250 remove everything between (and including) the 
8251 \family typewriter
8252
8253 \backslash
8254 makeatletter
8255 \family default
8256  and 
8257 \family typewriter
8258
8259 \backslash
8260 makeatother
8261 \family default
8262  commands, except for any commands you specifically put into the LaTeX preamble.
8263 \end_layout
8264
8265 \begin_layout Standard
8266 Save the resulting 
8267 \family typewriter
8268 .tex
8269 \family default
8270  file.
8271 \end_layout
8272
8273 \end_deeper
8274 \begin_layout Enumerate
8275 Run the 
8276 \family typewriter
8277 .tex
8278 \family default
8279  file through LaTeX as many times as necessary (usually up to three).
8280 \end_layout
8281
8282 \begin_layout Enumerate
8283 View the resulting 
8284 \family typewriter
8285 .dvi
8286 \family default
8287  document using, e.g., 
8288 \family sans
8289 xdvi
8290 \family default
8291 , and check if everything is ok (it should, if you didn't make any mistake).
8292 \end_layout
8293
8294 \begin_layout Subsection
8295 \begin_inset Quotes eld
8296 \end_inset
8297
8298 Peculiarities
8299 \begin_inset Quotes erd
8300 \end_inset
8301
8302  of the Kluwer package
8303 \begin_inset LatexCommand \label{subsec:kluwer_peculiarities}
8304
8305 \end_inset
8306
8307
8308 \end_layout
8309
8310 \begin_layout Standard
8311 The Kluwer package has the following 
8312 \begin_inset Quotes eld
8313 \end_inset
8314
8315 peculiarities
8316 \begin_inset Quotes erd
8317 \end_inset
8318
8319 .
8320 \end_layout
8321
8322 \begin_layout Enumerate
8323 It is possible to write multiple articles in the same LaTeX file
8324 \begin_inset Foot
8325 status collapsed
8326
8327 \begin_layout Standard
8328 I can't imagine any good reason to do this.
8329 \end_layout
8330
8331 \end_inset
8332
8333 .
8334  Each article must be included in the environment 
8335 \begin_inset Quotes eld
8336 \end_inset
8337
8338 article
8339 \begin_inset Quotes erd
8340 \end_inset
8341
8342 .
8343  Unfortunately, this environment cannot be omitted, even if you write just
8344  one article.
8345  Therefore, each article starts with the command 
8346 \family typewriter
8347
8348 \backslash
8349 begin{article}
8350 \family default
8351  and, obviously, ends with the command 
8352 \family typewriter
8353
8354 \backslash
8355 end{article}
8356 \family default
8357 .
8358  Although this can be implemented in LyX, I didn't included it, since it
8359  looks ugly and can confuse the novice user.
8360  Therefore, you need to enter them directly and mark them as LaTeX code
8361  (the well-known 
8362 \begin_inset Quotes eld
8363 \end_inset
8364
8365 ERT
8366 \begin_inset Quotes erd
8367 \end_inset
8368
8369 ).
8370 \end_layout
8371
8372 \begin_layout Enumerate
8373 Information given at the beginning of the article (i.e., title, subtitle,
8374  author, institution, running title, running author, abstract and keywords)
8375  must be included in an environment called 
8376 \begin_inset Quotes eld
8377 \end_inset
8378
8379 opening
8380 \begin_inset Quotes erd
8381 \end_inset
8382
8383 .
8384  This is not implemented in LyX, so you must enter title, subtitle etc.
8385  between two ERT lines (
8386 \family typewriter
8387
8388 \backslash
8389 begin{opening}
8390 \family default
8391  and 
8392 \family typewriter
8393
8394 \backslash
8395 end{opening}
8396 \family default
8397 ).
8398 \end_layout
8399
8400 \begin_layout Enumerate
8401 According to the user manual, the label of each bibliography item must be
8402  written as 
8403 \family typewriter
8404
8405 \backslash
8406 protect
8407 \backslash
8408 citeauthoryear{
8409 \family default
8410 \emph on
8411 author(s)
8412 \family typewriter
8413 \emph default
8414 }{
8415 \family default
8416 \emph on
8417 year
8418 \family typewriter
8419 \emph default
8420 }
8421 \family default
8422 .
8423 \end_layout
8424
8425 \begin_layout Standard
8426 The 
8427 \family typewriter
8428 kluwer.lyx
8429 \family default
8430  template takes care of all these 
8431 \begin_inset Quotes eld
8432 \end_inset
8433
8434 peculiarities
8435 \begin_inset Quotes erd
8436 \end_inset
8437
8438 .
8439  If you start a new paper using this template you don't need to do anything
8440  special.
8441  Just 
8442 \end_layout
8443
8444 \begin_layout Enumerate
8445 don't delete the ERT included in the template, and
8446 \end_layout
8447
8448 \begin_layout Enumerate
8449 copy the example bibliography item included in the template and modify it
8450  as necessary to enter new bibliography items.
8451 \end_layout
8452
8453 \begin_layout Section
8454 Koma-Script
8455 \end_layout
8456
8457 \begin_layout Standard
8458 by 
8459 \noun on
8460 Bernd Rellermeyer
8461 \end_layout
8462
8463 \begin_layout Subsection
8464 Overview
8465 \end_layout
8466
8467 \begin_layout Standard
8468 The LyX document classes
8469 \emph on
8470  article (koma-script)
8471 \emph default
8472
8473 \emph on
8474 report (koma-script)
8475 \emph default
8476
8477 \emph on
8478 book
8479 \emph default
8480  
8481 \emph on
8482 (koma-script)
8483 \emph default
8484 , and 
8485 \emph on
8486 letter
8487 \emph default
8488  
8489 \emph on
8490 (koma-script)
8491 \emph default
8492  correspond to the LaTeX document classes 
8493 \family typewriter
8494 scrartcl.cls
8495 \family default
8496
8497 \family typewriter
8498 scrreprt.cls
8499 \family default
8500
8501 \family typewriter
8502 scrbook.cls
8503 \family default
8504 , and 
8505 \family typewriter
8506 scrlettr.cls
8507 \family default
8508 , resp.
8509  of the Koma-Script family.
8510  They are replacements for the standard document classes 
8511 \family typewriter
8512 article.cls
8513 \family default
8514
8515 \family typewriter
8516 report.cls
8517 \family default
8518
8519 \family typewriter
8520 book.cls
8521 \family default
8522  and 
8523 \family typewriter
8524 letter.cls
8525 \family default
8526 , resp., and fit better to European typography conventions in a number of
8527  points.
8528 \end_layout
8529
8530 \begin_layout Itemize
8531 Standard character size is 11pt in 
8532 \emph on
8533 article (koma-script)
8534 \emph default
8535
8536 \emph on
8537 report (koma-script)
8538 \emph default
8539 , and 
8540 \emph on
8541 book (koma-script)
8542 \emph default
8543 , and 12pt in 
8544 \emph on
8545 letter (koma-script)
8546 \emph default
8547 .
8548 \end_layout
8549
8550 \begin_layout Itemize
8551 Headings, labels of the description environment, and a number of elements
8552  of the 
8553 \emph on
8554 letter (koma-script) 
8555 \emph default
8556 document class are set in a bold sans serif font.
8557 \begin_inset Foot
8558 status collapsed
8559
8560 \begin_layout Standard
8561 There is a big difference between the bold sans serif old cm fonts and new
8562  ec fonts, especially in the appearance of headings.
8563  In comparison, the ec bold sans serif fonts look a bit thin.
8564  Here the LaTeX package 
8565 \family typewriter
8566 cmsd.sty by 
8567 \family default
8568 \shape smallcaps
8569 Walter Schmidt
8570 \shape default
8571  helps to produce the 
8572 \begin_inset Quotes eld
8573 \end_inset
8574
8575 usual
8576 \begin_inset Quotes erd
8577 \end_inset
8578
8579  appearance when using the ec fonts.
8580 \end_layout
8581
8582 \end_inset
8583
8584  The numbering of chapter headings is made in the same way as the numbering
8585  of section headings, that is without the extra line 
8586 \begin_inset Quotes eld
8587 \end_inset
8588
8589 Chapter\SpecialChar \ldots{}
8590
8591 \begin_inset Quotes erd
8592 \end_inset
8593
8594 .
8595  In addition, the appearance of the headings can be modified by using a
8596  number of options (in LyX to be entered in the field 
8597 \family sans
8598 E
8599 \bar under
8600 x
8601 \bar default
8602 tra\InsetSpace ~
8603 Options
8604 \family default
8605  of the dialog 
8606 \family sans
8607 \bar under
8608 L
8609 \bar default
8610 ayout\SpecialChar \menuseparator
8611
8612 \bar under
8613 D
8614 \bar default
8615 ocument
8616 \family default
8617 ).
8618  A detailed German description of these options can be found in the Koma-Script
8619  documentation 
8620 \emph on
8621 scrguide
8622 \emph default
8623 .
8624 \end_layout
8625
8626 \begin_layout Itemize
8627 The main means in the Koma-Script document classes to design the type area
8628  are the options 
8629 \family sans
8630 BCOR
8631 \family default
8632  and 
8633 \family sans
8634 DIV
8635 \family default
8636  (in LyX to be entered in the extra class options field in the dialog 
8637 \family sans
8638 \bar under
8639 D
8640 \bar default
8641 ocument\SpecialChar \menuseparator
8642
8643 \bar under
8644 S
8645 \bar default
8646 ettings
8647 \family default
8648 ).
8649  They make a clearer modification of page margins possible as do the options
8650  of the dialog 
8651 \family sans
8652 \bar under
8653 D
8654 \bar default
8655 ocument\SpecialChar \menuseparator
8656
8657 \bar under
8658 S
8659 \bar default
8660 ettings
8661 \family default
8662 .
8663  A detailed German description of these and other type area options can
8664  be found in the Koma-Script documentation 
8665 \emph on
8666 scrguide
8667 \emph default
8668 .
8669 \end_layout
8670
8671 \begin_layout Itemize
8672 The LaTeX document classes of the Koma-Script family define a number of
8673  additional commands.
8674  Those part of it which makes sense in LyX is implemented in corresponding
8675  paragraph types.
8676 \end_layout
8677
8678 \begin_layout Standard
8679 A detailed German description of the LaTeX document classes of the Koma-Script
8680  family can be found in the Koma-Script documentation 
8681 \emph on
8682 scrguide
8683 \emph default
8684 .
8685 \begin_inset Foot
8686 status collapsed
8687
8688 \begin_layout Standard
8689 There is an English translation 
8690 \emph on
8691 screnggu
8692 \emph default
8693 , but it is not a complete one.
8694 \end_layout
8695
8696 \end_inset
8697
8698  The following sections describe only those aspects, which are relevant
8699  in LyX.
8700 \end_layout
8701
8702 \begin_layout Subsection
8703 article (koma-script), report (koma-script), and book (koma-script)
8704 \end_layout
8705
8706 \begin_layout Standard
8707 The document classes 
8708 \emph on
8709 article (koma-script)
8710 \emph default
8711
8712 \emph on
8713 report (koma-script)
8714 \emph default
8715 , and 
8716 \emph on
8717 book
8718 \emph default
8719  
8720 \emph on
8721 (koma-script)
8722 \emph default
8723  are implemented in the layout files 
8724 \family typewriter
8725 scrartcl.layout
8726 \family default
8727
8728 \family typewriter
8729 scrreprt.layout
8730 \family default
8731 , and 
8732 \family typewriter
8733 scrbook.layout
8734 \family default
8735 , resp.
8736  They contain all the paragraph types of the corresponding standard document
8737  classes 
8738 \emph on
8739 article
8740 \emph default
8741
8742 \emph on
8743 report
8744 \emph default
8745 , and 
8746 \emph on
8747 book
8748 \emph default
8749 , resp., partly modified, with the exception of the LyX specific 
8750 \family sans
8751 List
8752 \family default
8753 -type, which is replaced by the new 
8754 \family sans
8755 Labeling
8756 \family default
8757 -type having the same functionality.
8758  Beside the 
8759 \family sans
8760 Labeling
8761 \family default
8762 -Type there is a number of new paragraph types added.
8763  They are 
8764 \emph on
8765 not
8766 \emph default
8767  part of 
8768 \emph on
8769 letter (koma-script)
8770 \emph default
8771 .
8772 \end_layout
8773
8774 \begin_layout Itemize
8775
8776 \family sans
8777 Addpart, Addchap
8778 \family default
8779
8780 \family sans
8781 Addsec
8782 \family default
8783 : are equivalents to 
8784 \family sans
8785 Part*, Chapter*
8786 \family default
8787  and 
8788 \family sans
8789 Section*
8790 \family default
8791 , resp., additionally inserting an entry in the table of contents.
8792  
8793 \family sans
8794 Addpart 
8795 \family default
8796 and
8797 \family sans
8798  Addchap
8799 \family default
8800  are not contained in 
8801 \emph on
8802 article (koma-script)
8803 \emph default
8804 .
8805 \end_layout
8806
8807 \begin_layout Itemize
8808
8809 \family sans
8810 Addchap*
8811 \family default
8812
8813 \family sans
8814 Addsec*
8815 \family default
8816 : behave exactly as 
8817 \family sans
8818 Addchap
8819 \family default
8820  and 
8821 \family sans
8822 Addsec
8823 \family default
8824 , resp., additionally clearing running heads.
8825
8826 \family sans
8827  Addchap*
8828 \family default
8829  is not contained in 
8830 \emph on
8831 article (koma-script)
8832 \emph default
8833 .
8834 \begin_inset Foot
8835 status collapsed
8836
8837 \begin_layout Standard
8838 There is also an 
8839 \family typewriter
8840
8841 \backslash
8842 addpart*
8843 \family default
8844  command in 
8845 \emph on
8846 book (koma-script)
8847 \emph default
8848  and in 
8849 \emph on
8850 report (koma-script)
8851 \emph default
8852 , but since this is identical to 
8853 \family sans
8854 Part*
8855 \family default
8856 , is has not been implemented in LyX.
8857 \end_layout
8858
8859 \end_inset
8860
8861
8862 \end_layout
8863
8864 \begin_layout Itemize
8865
8866 \family sans
8867 Minisec
8868 \family default
8869 : generates a heading directly above the following paragraph in the standard
8870  character size without affecting the structure of the document.
8871 \end_layout
8872
8873 \begin_layout Itemize
8874
8875 \family sans
8876 Captionabove
8877 \family default
8878  and 
8879 \family sans
8880 Captionbelow 
8881 \family default
8882 are special captions which respect the different space settings needed for
8883  captions placed above or below an element (if you follow strict typographic
8884  rules, you might want to place table captions always above the table).
8885  You can also use the class option 
8886 \family typewriter
8887 tablecaptionsabove
8888 \family default
8889 , which will switch 
8890 \family sans
8891 caption
8892 \family default
8893  to 
8894 \family sans
8895 captionabove
8896 \family default
8897  for tables and 
8898 \family sans
8899 captionbelow
8900 \family default
8901  for figures.
8902  You need at least Koma-Script version 2.8q to use this.
8903 \end_layout
8904
8905 \begin_layout Itemize
8906
8907 \family sans
8908 Dictum
8909 \family default
8910 : can be used to set a bonmot, e.
8911 \begin_inset ERT
8912 status collapsed
8913
8914 \begin_layout Standard
8915
8916
8917 \backslash
8918 ,
8919 \end_layout
8920
8921 \end_inset
8922
8923 g.
8924 \begin_inset ERT
8925 status collapsed
8926
8927 \begin_layout Standard
8928
8929
8930 \backslash
8931  
8932 \end_layout
8933
8934 \end_inset
8935
8936 at the beginning of a chapter.
8937  If you use the optional argument (
8938 \family sans
8939 \bar under
8940 I
8941 \bar default
8942 nsert\SpecialChar \menuseparator
8943 Short\InsetSpace ~
8944 Title
8945 \family default
8946 ), you can insert the dictum's author there.
8947  Dictum and author are separated by a line.
8948  You need at least Koma-Script version 2.8q to use this.
8949  
8950 \family sans
8951 Dictum
8952 \family default
8953  is not contained in 
8954 \emph on
8955 article (koma-script)
8956 \emph default
8957 .
8958 \end_layout
8959
8960 \begin_layout Standard
8961 The following types, together with the standard types 
8962 \family sans
8963 Title
8964 \family default
8965
8966 \family sans
8967 Author
8968 \family default
8969 , and 
8970 \family sans
8971 Date
8972 \family default
8973 , form the title area of the document.
8974  They must be entered ahead of the first 
8975 \begin_inset Quotes eld
8976 \end_inset
8977
8978 ordinary
8979 \begin_inset Quotes erd
8980 \end_inset
8981
8982  paragraph.
8983 \begin_inset Foot
8984 status collapsed
8985
8986 \begin_layout Standard
8987 The corresponding LaTeX commands must appear before the 
8988 \family typewriter
8989
8990 \backslash
8991 maketitle
8992 \family default
8993  command.
8994 \end_layout
8995
8996 \end_inset
8997
8998  When such a type is used more than once, the latter usage overwrites the
8999  former one, that means, for every type only the latest usage is valid.
9000  The order of the different types however has, like 
9001 \family sans
9002 Title
9003 \family default
9004
9005 \family sans
9006 Author
9007 \family default
9008 , and 
9009 \family sans
9010 Date
9011 \family default
9012 , no effect on the appearance of the produced document.
9013 \end_layout
9014
9015 \begin_layout Itemize
9016
9017 \family sans
9018 Subject
9019 \family default
9020 : produces a centered paragraph above the ordinary title (
9021 \family sans
9022 Title
9023 \family default
9024
9025 \family sans
9026 Author
9027 \family default
9028
9029 \family sans
9030 Date
9031 \family default
9032 ) for the subject of the document.
9033 \end_layout
9034
9035 \begin_layout Itemize
9036
9037 \family sans
9038 Publishers
9039 \family default
9040 : produces a centered paragraph below the ordinary title (
9041 \family sans
9042 Title
9043 \family default
9044
9045 \family sans
9046 Author
9047 \family default
9048
9049 \family sans
9050 Date
9051 \family default
9052 ) for the publishers' name.
9053 \end_layout
9054
9055 \begin_layout Itemize
9056
9057 \family sans
9058 Dedication
9059 \family default
9060 : in 
9061 \emph on
9062 report (koma-script)
9063 \emph default
9064  and 
9065 \emph on
9066 book (koma-script)
9067 \emph default
9068  produces a centered paragraph on its own page behind the title page, or
9069  in 
9070 \emph on
9071 article (koma-script)
9072 \emph default
9073  produces a centered paragraph below the ordinary title (
9074 \family sans
9075 Title
9076 \family default
9077
9078 \family sans
9079 Author
9080 \family default
9081
9082 \family sans
9083 Date
9084 \family default
9085
9086 \family sans
9087 Publishers
9088 \family default
9089 ) for a dedication.
9090 \end_layout
9091
9092 \begin_layout Itemize
9093
9094 \family sans
9095 Titlehead
9096 \family default
9097 : produces a left aligned paragraph above the ordinary title (
9098 \family sans
9099 Title
9100 \family default
9101
9102 \family sans
9103 Author
9104 \family default
9105
9106 \family sans
9107 Date
9108 \family default
9109
9110 \family sans
9111 Subject
9112 \family default
9113 ) for a document`s head.
9114 \end_layout
9115
9116 \begin_layout Itemize
9117
9118 \family sans
9119 Uppertitleback
9120 \family default
9121 : produces in a double-sided print in 
9122 \emph on
9123 report (koma-script)
9124 \emph default
9125  and 
9126 \emph on
9127 book (koma-script)
9128 \emph default
9129  a left-aligned paragraph at the top of the title page`s back or has no
9130  effect in a single-sided print or in 
9131 \emph on
9132 article (koma-script)
9133 \emph default
9134 .
9135 \end_layout
9136
9137 \begin_layout Itemize
9138
9139 \family sans
9140 Lowertitleback
9141 \family default
9142 : produces in a double-sided print in 
9143 \emph on
9144 report (koma-script)
9145 \emph default
9146  and 
9147 \emph on
9148 book (koma-script)
9149 \emph default
9150  a left-aligned paragraph at the bottom of the title page`s back or has
9151  no effect in a single-sided print or in 
9152 \emph on
9153 article (koma-script)
9154 \emph default
9155 .
9156 \end_layout
9157
9158 \begin_layout Itemize
9159
9160 \family sans
9161 Extratitle
9162 \family default
9163 : produces a special 
9164 \begin_inset Quotes eld
9165 \end_inset
9166
9167 dirty
9168 \begin_inset Quotes erd
9169 \end_inset
9170
9171  page ahead of the actual document containing a paragraph without special
9172  formatting.
9173 \end_layout
9174
9175 \begin_layout Standard
9176 The layout files for the document classes 
9177 \emph on
9178 article (koma-script)
9179 \emph default
9180
9181 \emph on
9182 report (koma-script)
9183 \emph default
9184 , and 
9185 \emph on
9186 book (koma-script)
9187 \emph default
9188  do include the file 
9189 \family typewriter
9190 scrmacros.inc
9191 \family default
9192 .
9193  This is thought of as a place to define your own types.
9194  Copy s
9195 \family typewriter
9196 crmacros.inc
9197 \family default
9198  in your personal layout directory and edit the file!
9199 \end_layout
9200
9201 \begin_layout Subsection
9202 letter (koma-script)
9203 \end_layout
9204
9205 \begin_layout Standard
9206 \begin_inset ERT
9207 status inlined
9208
9209 \begin_layout Standard
9210
9211
9212 \backslash
9213 begin{sloppypar}
9214 \end_layout
9215
9216 \end_inset
9217
9218
9219 \end_layout
9220
9221 \begin_layout Standard
9222 \noindent
9223 The document class 
9224 \emph on
9225 letter (koma-script)
9226 \emph default
9227  is implemented in the layout file 
9228 \family typewriter
9229 scrlettr.layout
9230 \family default
9231 .
9232  It contains all the paragraph types of the corresponding standard document
9233  class 
9234 \emph on
9235 letter
9236 \emph default
9237 , partly modified, with the exception of the LyX specific types 
9238 \family sans
9239 LyX-Code
9240 \family default
9241  and 
9242 \family sans
9243 Comment
9244 \family default
9245  and the 
9246 \family sans
9247 List
9248 \family default
9249  type, which is replaced by the new 
9250 \family sans
9251 Labeling
9252 \family default
9253  type.
9254  In addition, it contains, in contrast to the standard document class, the
9255  standard types 
9256 \family sans
9257 LaTeX
9258 \family default
9259
9260 \family sans
9261 Quotation
9262 \family default
9263
9264 \family sans
9265 Quote
9266 \family default
9267 , and 
9268 \family sans
9269 Verse
9270 \family default
9271 .
9272  Furthermore, there are a number of new letter specific types.
9273 \end_layout
9274
9275 \begin_layout Standard
9276 \begin_inset ERT
9277 status inlined
9278
9279 \begin_layout Standard
9280
9281
9282 \backslash
9283 end{sloppypar}
9284 \end_layout
9285
9286 \end_inset
9287
9288
9289 \end_layout
9290
9291 \begin_layout Standard
9292 The appearance of the letter produced by this document class can be controlled
9293  by a number of LaTeX commands, which you can put in the LaTeX preamble.
9294 \begin_inset Foot
9295 status collapsed
9296
9297 \begin_layout Standard
9298 For example, the standard appearance of the letter`s heading, consisting
9299  of name and address, is quite self-willed.
9300  An 
9301 \begin_inset Quotes eld
9302 \end_inset
9303
9304 ordinary
9305 \begin_inset Quotes erd
9306 \end_inset
9307
9308  heading is produced by the following LaTeX commands in the preamble:
9309 \end_layout
9310
9311 \begin_layout LyX-Code
9312
9313 \backslash
9314 firsthead{
9315 \backslash
9316 parbox[b]{
9317 \backslash
9318 textwidth}
9319 \end_layout
9320
9321 \begin_layout LyX-Code
9322   {
9323 \backslash
9324 ignorespaces 
9325 \backslash
9326 fromname
9327 \backslash
9328
9329 \backslash
9330  
9331 \backslash
9332 ignorespaces 
9333 \backslash
9334 fromaddress}} 
9335 \end_layout
9336
9337 \begin_layout LyX-Code
9338
9339 \backslash
9340 nexthead{
9341 \backslash
9342 parbox[b]{
9343 \backslash
9344 textwidth}
9345 \end_layout
9346
9347 \begin_layout LyX-Code
9348   {
9349 \backslash
9350 ignorespaces 
9351 \backslash
9352 fromname 
9353 \backslash
9354 hfill 
9355 \backslash
9356 ignorespaces 
9357 \backslash
9358 pagename
9359 \backslash
9360  
9361 \backslash
9362 thepage}}
9363 \end_layout
9364
9365 \end_inset
9366
9367  A detailed German description of such LaTeX commands can be found in the
9368  Koma-Script documentation 
9369 \emph on
9370 scrguide
9371 \emph default
9372 .
9373  With it, the letter's author can produce his personal letter layout.
9374 \end_layout
9375
9376 \begin_layout Standard
9377 The types 
9378 \family sans
9379 Letter 
9380 \family default
9381 and 
9382 \family sans
9383 Opening
9384 \family default
9385  define the beginning of the letter and must be used in every letter.
9386  To emphasize them in the LyX document class, they are marked with the letter
9387  
9388 \shape italic
9389 L
9390 \shape default
9391  or 
9392 \shape italic
9393 O
9394 \shape default
9395 , resp.
9396  in the left margin.
9397  It is possible to write any number of letters in one file.
9398  An 
9399 \family sans
9400 Opening
9401 \family default
9402  type produces a new letter using the same addressee and a 
9403 \family sans
9404 Letter
9405 \family default
9406  type produces a new addressee.
9407  The types 
9408 \family sans
9409 Closing
9410 \family default
9411
9412 \family sans
9413 PS
9414 \family default
9415
9416 \family sans
9417 CC
9418 \family default
9419 , and 
9420 \family sans
9421 Encl
9422 \family default
9423  are ordinary paragraph types and can also be used several times in one
9424  and the same letter.
9425 \end_layout
9426
9427 \begin_layout Itemize
9428
9429 \family sans
9430 Letter
9431 \family default
9432 : produces a paragraph for the addressee and implicitly defines the beginning
9433  of the letter.
9434 \end_layout
9435
9436 \begin_layout Itemize
9437
9438 \family sans
9439 Opening
9440 \family default
9441 : produces a paragraph for the form of address and implicitly produces a
9442  new letter.
9443 \end_layout
9444
9445 \begin_layout Itemize
9446
9447 \family sans
9448 Closing
9449 \family default
9450 : produces a paragraph for a close.
9451 \end_layout
9452
9453 \begin_layout Itemize
9454
9455 \family sans
9456 PS
9457 \family default
9458 : produces a paragraph for a postscript.
9459 \end_layout
9460
9461 \begin_layout Itemize
9462
9463 \family sans
9464 CC
9465 \family default
9466 : produces a paragraph for a distribution list.
9467 \end_layout
9468
9469 \begin_layout Itemize
9470
9471 \family sans
9472 Encl
9473 \family default
9474 : produces a paragraph for enclosures.
9475 \end_layout
9476
9477 \begin_layout Standard
9478 The types 
9479 \family sans
9480 Name
9481 \family default
9482
9483 \family sans
9484 Signature
9485 \family default
9486
9487 \family sans
9488 Address
9489 \family default
9490 ,
9491 \family sans
9492  Telephone
9493 \family default
9494
9495 \family sans
9496 Place
9497 \family default
9498
9499 \family sans
9500 Backaddress
9501 \family default
9502
9503 \family sans
9504 Specialmail
9505 \family default
9506
9507 \family sans
9508 Location
9509 \family default
9510
9511 \family sans
9512 Title
9513 \family default
9514 , and 
9515 \family sans
9516 Subject
9517 \family default
9518  are input types provided with a label to enter information, which will
9519  be processed by the document class.
9520 \begin_inset Foot
9521 status collapsed
9522
9523 \begin_layout Standard
9524 It could be seen as a matter of inconsequence, that the types 
9525 \family sans
9526 Letter
9527 \family default
9528  and 
9529 \family sans
9530 Opening
9531 \family default
9532  described above are not such input types as well.
9533  Because of the special meaning of those types, however, I have implemented
9534  them as ordinary paragraph types with a one letter mark in the left margin.
9535  Moreover, it would affect my feeling of symmetry, if the 
9536 \family sans
9537 Opening
9538 \family default
9539  type and the 
9540 \family sans
9541 Closing
9542 \family default
9543  type had such a serious different appearance.
9544 \end_layout
9545
9546 \end_inset
9547
9548  The types must be used ahead of the corresponding 
9549 \family sans
9550 Opening
9551 \family default
9552  type.
9553 \end_layout
9554
9555 \begin_layout Standard
9556 An implementation of these types in a WYSIWYG fashion does not seem to make
9557  sense, because the real appearance of the produced letter does not only
9558  depend on the usage of the particular type, but also on other factors.
9559  For example, a signature entered in the 
9560 \family sans
9561 Signature
9562 \family default
9563  type will in the standard behavior appear in the produced letter only,
9564  when in the same letter also a 
9565 \family sans
9566 Closing
9567 \family default
9568  type is used.
9569  The entered value of the 
9570 \family sans
9571 Telephone
9572 \family default
9573  type will in the standard behavior not appear in the produced letter at
9574  all.
9575  The possibility to design the letter`s heading freely is already indicated
9576  in a footnote above.
9577 \end_layout
9578
9579 \begin_layout Standard
9580 The input types can also be used as empty paragraphs.
9581  This makes sense e.\InsetSpace ~
9582 g.
9583  for the 
9584 \family sans
9585 Signature
9586 \family default
9587  type.
9588  If the 
9589 \family sans
9590 Signature
9591 \family default
9592  type is not used at all, in the standard behavior the value of the 
9593 \family sans
9594 Name
9595 \family default
9596  type is used as signature, whereas if an empty 
9597 \family sans
9598 Signature
9599 \family default
9600  type is used, no signature value is defined.
9601 \end_layout
9602
9603 \begin_layout Standard
9604 By using the input types it is possible to write a letter template, containing
9605  filled input types with your personal dates (name, address, etc.) and empty
9606  input types for other dates you want to enter.
9607 \end_layout
9608
9609 \begin_layout Itemize
9610
9611 \family sans
9612 Name
9613 \family default
9614 : sender's name, in the standard behavior appears as a centered paragraph
9615  in small caps in the letter`s heading.
9616 \end_layout
9617
9618 \begin_layout Itemize
9619
9620 \family sans
9621 Signature
9622 \family default
9623 : sender's signature, in the standard behavior appears below the 
9624 \family sans
9625 Closing
9626 \family default
9627  type.
9628  If no 
9629 \family sans
9630 Signature
9631 \family default
9632  type is used, the value of the 
9633 \family sans
9634 Name
9635 \family default
9636  type appears instead.
9637 \end_layout
9638
9639 \begin_layout Itemize
9640
9641 \family sans
9642 Address
9643 \family default
9644 : sender's address, in the standard behavior appears in a centered paragraph
9645  in the letter`s heading below the sender's name.
9646 \end_layout
9647
9648 \begin_layout Itemize
9649
9650 \family sans
9651 Telephone
9652 \family default
9653 : sender's telephone number, in the standard behavior only sets the LaTeX
9654  variable 
9655 \family typewriter
9656
9657 \backslash
9658 telephonenum
9659 \family default
9660 .
9661 \end_layout
9662
9663 \begin_layout Itemize
9664
9665 \family sans
9666 Place
9667 \family default
9668 : place of the letter`s making.
9669 \end_layout
9670
9671 \begin_layout Itemize
9672
9673 \family sans
9674 Date
9675 \family default
9676 : date of the letter`s making.
9677  
9678 \family sans
9679 Place
9680 \family default
9681  and 
9682 \family sans
9683 Date
9684 \family default
9685 , in the standard behavior, produce the place and the date in a right-aligned
9686  line below the addressee's field.
9687  If an empty 
9688 \family sans
9689 Date
9690 \family default
9691  type is used, neither place nor date appear, independent of the value of
9692  the 
9693 \family sans
9694 Place
9695 \family default
9696  type.
9697  If no 
9698 \family sans
9699 Date
9700 \family default
9701  type is used, the date of the letter `s production is used.
9702 \end_layout
9703
9704 \begin_layout Itemize
9705
9706 \family sans
9707 Backaddress
9708 \family default
9709 : sender`s back address, in the standard behavior appears above the addressee's
9710  field in a small sans serif font.
9711 \end_layout
9712
9713 \begin_layout Itemize
9714
9715 \family sans
9716 Specialmail
9717 \family default
9718 : special mail information, in the standard behavior appears underlined
9719  above the addressee's field below the back address.
9720 \end_layout
9721
9722 \begin_layout Itemize
9723
9724 \family sans
9725 Location
9726 \family default
9727 : additional information, in the standard behavior appears on right side
9728  below the addressee`s field.
9729 \end_layout
9730
9731 \begin_layout Itemize
9732
9733 \family sans
9734 Title
9735 \family default
9736 : the letter's title, in the standard behavior appears in a big, bold, sans
9737  serif font above the subject.
9738 \end_layout
9739
9740 \begin_layout Itemize
9741
9742 \family sans
9743 Subject
9744 \family default
9745 : the letter's subject, in the standard behavior appears in a bold font
9746  above the 
9747 \family sans
9748 Opening
9749 \family default
9750  paragraph.
9751 \end_layout
9752
9753 \begin_layout Standard
9754 The types 
9755 \family sans
9756 Yourref
9757 \family default
9758
9759 \family sans
9760 Yourmail
9761 \family default
9762
9763 \family sans
9764 Myref
9765 \family default
9766
9767 \family sans
9768 Customer
9769 \family default
9770 , and 
9771 \family sans
9772 Invoice
9773 \family default
9774  produce a business letter like line above the 
9775 \family sans
9776 Title
9777 \family default
9778  line containing the fields 
9779 \begin_inset Quotes eld
9780 \end_inset
9781
9782 Your ref.
9783 \begin_inset Quotes erd
9784 \end_inset
9785
9786
9787 \begin_inset Quotes eld
9788 \end_inset
9789
9790 Your letter of
9791 \begin_inset Quotes erd
9792 \end_inset
9793
9794
9795 \begin_inset Quotes eld
9796 \end_inset
9797
9798 Our ref.
9799 \begin_inset Quotes erd
9800 \end_inset
9801
9802
9803 \begin_inset Quotes eld
9804 \end_inset
9805
9806 Customer no.
9807 \begin_inset Quotes erd
9808 \end_inset
9809
9810
9811 \begin_inset Quotes eld
9812 \end_inset
9813
9814 Invoice no.
9815 \begin_inset Quotes erd
9816 \end_inset
9817
9818 , and 
9819 \begin_inset Quotes eld
9820 \end_inset
9821
9822 Date
9823 \begin_inset Quotes erd
9824 \end_inset
9825
9826 .
9827  For the date field, the value of the 
9828 \family sans
9829 Date
9830 \family default
9831  type is used.
9832  If one of these 
9833 \begin_inset Quotes eld
9834 \end_inset
9835
9836 business letter types
9837 \begin_inset Quotes erd
9838 \end_inset
9839
9840  is used, the value of the 
9841 \family sans
9842 Place
9843 \family default
9844  type however does not appear, but only the LaTeX variable 
9845 \family typewriter
9846
9847 \backslash
9848 fromplace
9849 \family default
9850  is set.
9851  The ordinary output of place and date in a right-aligned line below the
9852  addressee`s field is suppressed.
9853  The types are implemented as input types provided with a label and must
9854  be used ahead of the corresponding 
9855 \family sans
9856 Opening
9857 \family default
9858  type.
9859 \end_layout
9860
9861 \begin_layout Itemize
9862
9863 \family sans
9864 Yourref
9865 \family default
9866 : Your ref.
9867 \end_layout
9868
9869 \begin_layout Itemize
9870
9871 \family sans
9872 Yourmail
9873 \family default
9874 : Your letter of.
9875 \end_layout
9876
9877 \begin_layout Itemize
9878
9879 \family sans
9880 Myref
9881 \family default
9882 : Our ref.
9883 \end_layout
9884
9885 \begin_layout Itemize
9886
9887 \family sans
9888 Customer
9889 \family default
9890 : Customer no.
9891 \end_layout
9892
9893 \begin_layout Itemize
9894
9895 \family sans
9896 Invoice
9897 \family default
9898 : Invoice no.
9899 \end_layout
9900
9901 \begin_layout Subsection
9902 The new letter class: letter (koma-script v.2)
9903 \end_layout
9904
9905 \begin_layout Standard
9906 by 
9907 \noun on
9908 Jürgen Spitzmüller
9909 \end_layout
9910
9911 \begin_layout Standard
9912 \begin_inset VSpace medskip
9913 \end_inset
9914
9915
9916 \end_layout
9917
9918 \begin_layout Standard
9919 \noindent
9920 Koma-Script version 2.8 has introduced a new letter class 
9921 \family typewriter
9922 scrlttr2
9923 \family default
9924  which superceeds the now unsupported 
9925 \family typewriter
9926 scrlettr
9927 \family default
9928 .
9929  It has --- on the LaTeX side --- a completely new interface and is not
9930  compatible with the old class.
9931  Therefore, LyX supports both, though it is recommended to use the new class.
9932 \end_layout
9933
9934 \begin_layout Standard
9935 This class covers the same functionality as 
9936 \emph on
9937 letter (koma-script),
9938 \emph default
9939  and a few more.
9940  The basic items are 
9941 \family sans
9942 Address
9943 \family default
9944  (receiver's address, same as 
9945 \family sans
9946 Letter
9947 \family default
9948  in the old layout), 
9949 \family sans
9950 Opening
9951 \family default
9952 , and 
9953 \family sans
9954 Closing
9955 \family default
9956 .
9957  
9958 \family sans
9959 NextAddress
9960 \family default
9961  will start a new letter (i.
9962 \begin_inset ERT
9963 status collapsed
9964
9965 \begin_layout Standard
9966
9967
9968 \backslash
9969 ,
9970 \end_layout
9971
9972 \end_inset
9973
9974 e.
9975 \begin_inset ERT
9976 status collapsed
9977
9978 \begin_layout Standard
9979
9980
9981 \backslash
9982  
9983 \end_layout
9984
9985 \end_inset
9986
9987 you can write several letters per document).
9988  New elements are sender's 
9989 \family sans
9990 E-Mail
9991 \family default
9992
9993 \family sans
9994 URL
9995 \family default
9996
9997 \family sans
9998 Fax
9999 \family default
10000
10001 \family sans
10002 Bank
10003 \family default
10004  and the possibility to use a 
10005 \family sans
10006 Logo
10007 \family default
10008  (via 
10009 \family sans
10010 \bar under
10011 I
10012 \bar default
10013 nsert\SpecialChar \menuseparator
10014
10015 \bar under
10016 G
10017 \bar default
10018 raphics
10019 \family default
10020 ) in the header.
10021 \end_layout
10022
10023 \begin_layout Standard
10024 The biggest improvement is, though, that the letter's layout is configurable
10025  at almost any needs.
10026  This can be done via the preamble or with a special style file (Letter
10027  Class Option, extension 
10028 \family typewriter
10029 *.lco
10030 \family default
10031 ), that will be read in as a class option.
10032 \begin_inset Foot
10033 status collapsed
10034
10035 \begin_layout Standard
10036 The KOMA package comes with some default 
10037 \family typewriter
10038 *.lco
10039 \family default
10040  files.
10041  There is, for instance, a 
10042 \family typewriter
10043 DIN.lco
10044 \family default
10045  file that follows german typesetting rules, or a 
10046 \family typewriter
10047 KOMAold.lco
10048 \family default
10049  that provides the default layout of the old 
10050 \family typewriter
10051 scrlettr
10052 \family default
10053  class.
10054  The latter can be loaded with the class option 
10055 \family typewriter
10056 KOMAold
10057 \family default
10058 , inserted via the 
10059 \family sans
10060 \bar under
10061 L
10062 \bar default
10063 ayout\SpecialChar \menuseparator
10064
10065 \bar under
10066 D
10067 \bar default
10068 ocument\SpecialChar \menuseparator
10069 Extra Options 
10070 \family default
10071 field.
10072 \end_layout
10073
10074 \end_inset
10075
10076  Have a look at the 
10077 \emph on
10078 koma-letter2
10079 \emph default
10080  template that is included in LyX for examples.
10081  A detailed description is to be found in the Koma-Script documentation
10082  (
10083 \emph on
10084 scrguide
10085 \emph default
10086 ).
10087 \end_layout
10088
10089 \begin_layout Subsection
10090 Problems
10091 \end_layout
10092
10093 \begin_layout Standard
10094 Visualizing the Koma-Script document classes in LyX, the LyX internals cause
10095  some problems.
10096 \end_layout
10097
10098 \begin_layout Itemize
10099 The chapter number of a 
10100 \family sans
10101 Chapter
10102 \family default
10103  type appears on a line of its own above the chapter heading instead of
10104  appearing in the same line ahead of it.
10105  The cause for that is the LyX internal behavior for the labeltype 
10106 \family sans
10107 Counter_Chapter
10108 \family default
10109  in the layout file.
10110 \end_layout
10111
10112 \begin_layout Itemize
10113 The headings of the types 
10114 \family sans
10115 Addchap
10116 \family default
10117  and 
10118 \family sans
10119 Addsec
10120 \family default
10121  are only put in the 
10122 \begin_inset Quotes eld
10123 \end_inset
10124
10125 true
10126 \begin_inset Quotes erd
10127 \end_inset
10128
10129  LaTeX table of contents, but not in the LyX table of contents (
10130 \family sans
10131 \bar under
10132 D
10133 \bar default
10134 ocument\SpecialChar \menuseparator
10135
10136 \bar under
10137 T
10138 \bar default
10139 able\InsetSpace ~
10140 of\InsetSpace ~
10141 Contents
10142 \family default
10143 ).
10144 \end_layout
10145
10146 \begin_layout Itemize
10147 The paragraphs in a 
10148 \emph on
10149 letter
10150 \emph default
10151  document class appear in a skip separation mode, not indented.
10152  This is the standard behavior, no special LaTeX commands are needed for
10153  that.
10154  But in the 
10155 \family sans
10156 \bar under
10157 D
10158 \bar default
10159 ocument\SpecialChar \menuseparator
10160
10161 \bar under
10162 S
10163 \bar default
10164 ettings
10165 \family default
10166  dialog the corresponding radio button indicates 
10167 \family sans
10168 \bar under
10169 I
10170 \bar default
10171 ndent
10172 \family default
10173 .
10174  A 
10175 \family sans
10176 S
10177 \bar under
10178 k
10179 \bar default
10180 ip
10181 \family default
10182  value always has the effect that extra LaTeX commands are inserted in the
10183  document to produce the gap, which is not what is wanted in this case.
10184 \end_layout
10185
10186 \begin_layout Section
10187 Springer Journals (
10188 \family sans
10189 svjour
10190 \family default
10191 )
10192 \end_layout
10193
10194 \begin_layout Standard
10195 by 
10196 \noun on
10197 Martin Vermeer
10198 \end_layout
10199
10200 \begin_layout Subsection
10201 Description
10202 \end_layout
10203
10204 \begin_layout Standard
10205 These are the layout files for some of the journal formats used by Springer
10206  Verlag and listed on 
10207 \begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
10208
10209 \end_inset
10210
10211 , where you should also go to fetch the class files (yes, these are LaTeX2e
10212  now!).
10213  It is a modular system: the things common to all journals are implemented
10214  in 
10215 \family typewriter
10216 svjour.inc
10217 \family default
10218 , which journal-specific layout files (such as, e.g., 
10219 \family typewriter
10220 svjog.layout
10221 \family default
10222  for Journal of Geodesy) can include.
10223 \end_layout
10224
10225 \begin_layout Standard
10226 This means that implementing support for any other Springer journal on this
10227  list is as simple as writing your own 
10228 \family typewriter
10229 sv
10230 \family default
10231 <myjournal>
10232 \family typewriter
10233 .layout
10234 \family default
10235  file following the outline given in 
10236 \family typewriter
10237 svjog.layout
10238 \family default
10239 .
10240  
10241 \end_layout
10242
10243 \begin_layout Standard
10244 It is reasonably well tested only for the Journal of Geodesy.
10245  
10246 \family typewriter
10247 svjour
10248 \family default
10249  and 
10250 \family typewriter
10251 svjog
10252 \family default
10253  come with the standard LyX distribution.
10254  Install the relevant class file (downloaded from Springer) in a proper
10255  directory, reconfigure LaTeX (in the teTeX case by running 
10256 \family typewriter
10257 texhash
10258 \family default
10259 , as root if necessary --- doesn't LyX take care of this?), reconfigure
10260  LyX and it should work.
10261 \end_layout
10262
10263 \begin_layout Subsection
10264 New styles
10265 \end_layout
10266
10267 \begin_layout Standard
10268 A large number of theorem-like styles --- 
10269 \family sans
10270 Claim, Conjecture,
10271 \family default
10272  
10273 \family sans
10274 \SpecialChar \ldots{}
10275 Theorem
10276 \family default
10277 .
10278 \end_layout
10279
10280 \begin_layout Standard
10281
10282 \family sans
10283 Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
10284  Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
10285 \family default
10286 .
10287  See the Springer class file documentation for details.
10288 \end_layout
10289
10290 \begin_layout Subsection
10291 Supported journals
10292 \end_layout
10293
10294 \begin_layout Itemize
10295
10296 \emph on
10297 Journal of Geodesy
10298 \emph default
10299
10300 \family typewriter
10301 svjog.layout 
10302 \family default
10303 --- Martin Vermeer
10304 \end_layout
10305
10306 \begin_layout Itemize
10307
10308 \emph on
10309 Probability Theory and Related Fields
10310 \emph default
10311
10312 \family typewriter
10313 svprobth.layout
10314 \family default
10315  --- Jean-Marc Lasgouttes
10316 \end_layout
10317
10318 \begin_layout Standard
10319 Add your own, it isn't so hard!
10320 \end_layout
10321
10322 \begin_layout Subsection
10323 Credits
10324 \end_layout
10325
10326 \begin_layout Standard
10327 These files are partly based on the older 
10328 \family typewriter
10329 ejour2.layout
10330 \family default
10331 , which was again based on a tinkered-with version of an old LaTeX 2.09 style
10332  file from Springer.
10333  All this, and the 
10334 \family typewriter
10335 ejour2
10336 \family default
10337  layout, are now defunct.
10338  Jean-Marc Lasgouttes helped out big in making me find my way around the
10339  LyX layout file mechanism.
10340 \end_layout
10341
10342 \begin_layout Subsection
10343 Bugs
10344 \end_layout
10345
10346 \begin_layout Standard
10347 Probably.
10348  But probably less than in the old hacked-LaTeX 
10349 \family typewriter
10350 ejour2
10351 \family default
10352 .
10353 \end_layout
10354
10355 \begin_layout Standard
10356 Limitations e.g.: does not display the number for theorem-like layouts, just
10357  #.
10358 \end_layout
10359
10360 \begin_layout Section
10361 AGU journals (
10362 \family sans
10363 aguplus
10364 \family default
10365 )
10366 \end_layout
10367
10368 \begin_layout Standard
10369 by 
10370 \shape smallcaps
10371 Martin Vermeer
10372 \end_layout
10373
10374 \begin_layout Subsection
10375 Description
10376 \end_layout
10377
10378 \begin_layout Standard
10379 These are the layout files for some of the journals of the American Geophysical
10380  Society.
10381  It is assumed that you have both the AGU's own class files and AGUplus
10382  installed (everything to be found at
10383 \begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
10384
10385 \end_inset
10386
10387 ).
10388 \end_layout
10389
10390 \begin_layout Subsection
10391 New styles
10392 \end_layout
10393
10394 \begin_layout Standard
10395 Redefined are 
10396 \family sans
10397 Paragraph
10398 \family default
10399
10400 \family sans
10401 Paragraph*
10402 \family default
10403 .
10404  They are still called this in the LyX GUI, though their LaTeX equivalents
10405  in the AGU classes are 
10406 \family sans
10407 Subsubsubsection
10408 \family default
10409  and 
10410 \family sans
10411 Subsubsubsection*
10412 \family default
10413 .
10414 \end_layout
10415
10416 \begin_layout Standard
10417 Newly defined styles are 
10418 \family sans
10419 Left_Header
10420 \family default
10421
10422 \family sans
10423 Right_Header
10424 \family default
10425
10426 \family sans
10427 Received
10428 \family default
10429
10430 \family sans
10431 Revised
10432 \family default
10433
10434 \family sans
10435 Accepted
10436 \family default
10437
10438 \family sans
10439 CCC
10440 \family default
10441
10442 \family sans
10443 PaperId
10444 \family default
10445
10446 \family sans
10447 AuthorAddr
10448 \family default
10449
10450 \family sans
10451 SlugComment
10452 \family default
10453 .
10454  These are mostly manuscript attributes and defined in the AGU class documentati
10455 on.
10456 \end_layout
10457
10458 \begin_layout Standard
10459 I suspect this is still badly incomplete.
10460 \end_layout
10461
10462 \begin_layout Subsection
10463 New floats
10464 \end_layout
10465
10466 \begin_layout Standard
10467
10468 \family sans
10469 Planotable
10470 \family default
10471  and 
10472 \family sans
10473 Plate
10474 \family default
10475 .
10476  We also have a new 
10477 \family sans
10478 Table_Caption
10479 \family default
10480 .
10481 \end_layout
10482
10483 \begin_layout Subsection
10484 Supported journals
10485 \end_layout
10486
10487 \begin_layout Itemize
10488
10489 \emph on
10490 Journal of Geophysical Research
10491 \emph default
10492
10493 \family typewriter
10494 jgrga.layout 
10495 \family default
10496 --- Martin Vermeer
10497 \end_layout
10498
10499 \begin_layout Standard
10500 Add your own, it isn't so hard! Look at the 
10501 \family typewriter
10502 jgrga.layout
10503 \family default
10504  example and 
10505 \family typewriter
10506 aguplus.inc
10507 \family default
10508 .
10509 \end_layout
10510
10511 \begin_layout Subsection
10512 Bugs and things to remember
10513 \end_layout
10514
10515 \begin_layout Standard
10516 In order to use the new layouts, you must remember to do the following for
10517  a new document:
10518 \end_layout
10519
10520 \begin_layout Enumerate
10521
10522 \emph on
10523 Turn off babel
10524 \emph default
10525 .
10526  This can be done in the 
10527 \family sans
10528 layout\SpecialChar \menuseparator
10529 document
10530 \family default
10531  or 
10532 \family sans
10533 document\SpecialChar \menuseparator
10534 settings
10535 \family default
10536  menu item.
10537  (AGU articles are always in English, right? So 
10538 \emph on
10539 don't
10540 \emph default
10541  choose a language.)
10542 \end_layout
10543
10544 \begin_layout Enumerate
10545 Enter 
10546 \family typewriter
10547 jgrga
10548 \family default
10549  into the document's 
10550 \family sans
10551 Extra Options
10552 \family default
10553  field.
10554  (Yes, this is a bug.)
10555 \end_layout
10556
10557 \begin_layout Enumerate
10558 Make sure you use the 
10559 \family typewriter
10560 agu.bst
10561 \family default
10562  bibliography style, by entering 
10563 \family sans
10564 agu
10565 \family default
10566  into the second field of the BibTeX inset.
10567  None of the standard styles will do.
10568 \end_layout
10569
10570 \begin_layout Section
10571 EGS journals (
10572 \family sans
10573 egs
10574 \family default
10575 )
10576 \end_layout
10577
10578 \begin_layout Standard
10579 by 
10580 \shape smallcaps
10581 Martin Vermeer
10582 \end_layout
10583
10584 \begin_layout Subsection
10585 Description
10586 \end_layout
10587
10588 \begin_layout Standard
10589 This is the layout file for the European Geophysical Society journals.
10590  The needed 
10591 \family typewriter
10592 egs.cls
10593 \family default
10594  can be downloaded from the web site of the EGS under 
10595 \begin_inset LatexCommand \url{www.copernicus.org}
10596
10597 \end_inset
10598
10599 .
10600 \end_layout
10601
10602 \begin_layout Subsection
10603 New styles
10604 \end_layout
10605
10606 \begin_layout Standard
10607
10608 \family sans
10609 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10610  Accepted
10611 \family default
10612
10613 \family sans
10614 Offsets
10615 \family default
10616 .
10617  The current layout file is unfortunately very unmodular and would benefit
10618  from using the various 
10619 \family typewriter
10620 std*.inc
10621 \family default
10622  file inclusions.
10623 \end_layout
10624
10625 \begin_layout Section
10626 Slides [aka 
10627 \noun on
10628 Sli
10629 \noun default
10630 TeX]
10631 \begin_inset LatexCommand \label{sec:slitex}
10632
10633 \end_inset
10634
10635
10636 \end_layout
10637
10638 \begin_layout Standard
10639 by 
10640 \noun on
10641 John Weiss
10642 \noun default
10643  
10644 \end_layout
10645
10646 \begin_layout Subsection
10647 Introduction
10648 \end_layout
10649
10650 \begin_layout Standard
10651 This section describes how to use LyX to make slides for overhead projectors.
10652  There are two document classes that can do this: the default slides class
10653  and the 
10654 \family sans
10655 Foil
10656 \family default
10657 TeX slides class.
10658  This section documents the former.
10659 \end_layout
10660
10661 \begin_layout Standard
10662 I'm going to say this again, nice and clear, so that there's no misunderstanding
10663 :
10664 \end_layout
10665
10666 \begin_layout Standard
10667 \begin_inset VSpace bigskip
10668 \end_inset
10669
10670
10671 \end_layout
10672
10673 \begin_layout Standard
10674 \align center
10675
10676 \size large
10677 This section documents the class 
10678 \begin_inset Quotes eld
10679 \end_inset
10680
10681
10682 \family sans
10683 slides (default)
10684 \family default
10685
10686 \begin_inset Quotes erd
10687 \end_inset
10688
10689  
10690 \emph on
10691 only.
10692 \end_layout
10693
10694 \begin_layout Standard
10695 \begin_inset VSpace bigskip
10696 \end_inset
10697
10698
10699 \end_layout
10700
10701 \begin_layout Standard
10702 If you're looking for the documentation for 
10703 \begin_inset Quotes eld
10704 \end_inset
10705
10706
10707 \family sans
10708 slides (FoilTeX)
10709 \family default
10710
10711 \begin_inset Quotes erd
10712 \end_inset
10713
10714 , check out section\InsetSpace ~
10715
10716 \begin_inset LatexCommand \ref{sec:foiltex}
10717
10718 \end_inset
10719
10720 .
10721  The 
10722 \family sans
10723 foils 
10724 \family default
10725 class [
10726 \begin_inset Quotes eld
10727 \end_inset
10728
10729
10730 \family sans
10731 slides (FoilTeX)
10732 \family default
10733
10734 \begin_inset Quotes erd
10735 \end_inset
10736
10737 ] is actually somewhat better than the default 
10738 \family sans
10739 slides
10740 \family default
10741  class,
10742 \begin_inset Foot
10743 status collapsed
10744
10745 \begin_layout Standard
10746 \SpecialChar \ldots{}
10747 or so I've been told repeatedly by its advocates.
10748  Having never used it, I have no idea if this claim is true or not.
10749 \end_layout
10750
10751 \end_inset
10752
10753  which this section documents.
10754 \end_layout
10755
10756 \begin_layout Standard
10757 This class is the LaTeX2e improvement of the old 
10758 \noun on
10759 Sli
10760 \noun default
10761 TeX package.
10762  Every LaTeX2e distribution includes this class [which I'll just refer to
10763  as 
10764 \begin_inset Quotes eld
10765 \end_inset
10766
10767
10768 \family sans
10769 slides
10770 \family default
10771
10772 \begin_inset Quotes erd
10773 \end_inset
10774
10775  from now on], so you're bound to have it.
10776  As I noted earlier, there are other classes, such as 
10777 \family sans
10778 foils
10779 \family default
10780 , which also produce slides for overhead projectors and do a better job
10781  at it.
10782  However, there are some things which 
10783 \family sans
10784 slides
10785 \family default
10786  can do which the others can't, such as generate overlays.
10787  Read on to learn more!
10788 \end_layout
10789
10790 \begin_layout Subsection
10791 Getting Started
10792 \begin_inset LatexCommand \label{sec:slidesetup}
10793
10794 \end_inset
10795
10796
10797 \end_layout
10798
10799 \begin_layout Standard
10800 Obviously, to use this document class, you need to select 
10801 \begin_inset Quotes eld
10802 \end_inset
10803
10804
10805 \family sans
10806 slides (default)
10807 \family default
10808
10809 \begin_inset Quotes erd
10810 \end_inset
10811
10812  from the class list in the 
10813 \family sans
10814 \bar under
10815 D
10816 \bar default
10817 ocument\SpecialChar \menuseparator
10818
10819 \bar under
10820 S
10821 \bar default
10822 ettings
10823 \family default
10824  dialog.
10825  There are some other special things you should know about this class:
10826 \end_layout
10827
10828 \begin_layout Itemize
10829 Don't bother changing the options 
10830 \family sans
10831 Sides and Columns
10832 \family default
10833 .
10834  They're not supported by the 
10835 \family sans
10836 slides
10837 \family default
10838  class, anyways.
10839 \end_layout
10840
10841 \begin_layout Itemize
10842 The option 
10843 \family sans
10844 \bar under
10845 P
10846 \bar default
10847 age\InsetSpace ~
10848 style
10849 \family default
10850  behaves a bit differently for this class.
10851  The possible choices and what they do are as follows:
10852 \end_layout
10853
10854 \begin_deeper
10855 \begin_layout Description
10856
10857 \family sans
10858 plain
10859 \family default
10860  The final output contains page numbers in the lower right corner.
10861 \end_layout
10862
10863 \begin_layout Description
10864
10865 \family sans
10866 headings
10867 \family default
10868  Like 
10869 \family sans
10870 plain
10871 \family default
10872 , but also prints out any time markers you've put in.
10873  This is the default.
10874 \end_layout
10875
10876 \begin_layout Description
10877
10878 \family sans
10879 empty
10880 \family default
10881  The final output contains no page numbers, time markers, or alignment markers.
10882 \end_layout
10883
10884 \end_deeper
10885 \begin_layout Itemize
10886 The 
10887 \family sans
10888 slides
10889 \family default
10890  class has an extra option: 
10891 \family typewriter
10892 clock
10893 \family default
10894 .
10895  To use it, put 
10896 \begin_inset Quotes eld
10897 \end_inset
10898
10899
10900 \family typewriter
10901 clock
10902 \family default
10903
10904 \begin_inset Quotes erd
10905 \end_inset
10906
10907  in the extra class options.
10908 \end_layout
10909
10910 \begin_deeper
10911 \begin_layout Standard
10912 Using this options allows you to add time markers to 
10913 \family sans
10914 Note
10915 \family default
10916 s.
10917  See section\InsetSpace ~
10918
10919 \begin_inset LatexCommand \ref{sec:slideNote}
10920
10921 \end_inset
10922
10923  for more details.
10924 \end_layout
10925
10926 \end_deeper
10927 \begin_layout Standard
10928 You can also use the template file 
10929 \begin_inset Quotes eld
10930 \end_inset
10931
10932
10933 \family typewriter
10934 slides.lyx
10935 \family default
10936
10937 \begin_inset Quotes erd
10938 \end_inset
10939
10940  to automatically set up a document to use the 
10941 \family sans
10942 slides 
10943 \family default
10944 class [using 
10945 \family sans
10946 \bar under
10947 F
10948 \bar default
10949 ile\SpecialChar \menuseparator
10950 New\InsetSpace ~
10951 from\InsetSpace ~
10952
10953 \bar under
10954 T
10955 \bar default
10956 emplate
10957 \family default
10958  to open your new document].
10959  The template file also contains some examples of the special paragraph
10960  environments used by this class.
10961  I'll describe those next.
10962 \end_layout
10963
10964 \begin_layout Subsection
10965 Paragraph Environments
10966 \end_layout
10967
10968 \begin_layout Subsubsection
10969 Supported Environments
10970 \end_layout
10971
10972 \begin_layout Standard
10973 The first thing you'll notice when you start up a new 
10974 \family sans
10975 slides 
10976 \family default
10977 document is the font size and type: it's the equivalent of the size 
10978 \begin_inset Quotes eld
10979 \end_inset
10980
10981
10982 \family sans
10983 Largest
10984 \family default
10985
10986 \begin_inset Quotes erd
10987 \end_inset
10988
10989  in the 
10990 \family sans
10991 Sans\InsetSpace ~
10992 Serif
10993 \family default
10994  font.
10995  This is also what's used in the output.
10996  Think of this as a 
10997 \begin_inset Quotes eld
10998 \end_inset
10999
11000 visual cue
11001 \begin_inset Quotes erd
11002 \end_inset
11003
11004  to remind you that this is a slide.
11005  Your final slides will use a larger font; ergo, you'll have less space.
11006  Of course, the larger default screen font isn't WYSIWYG, only a reminder.
11007 \end_layout
11008
11009 \begin_layout Standard
11010 The next thing that becomes obvious is the changes to the paragraph environment
11011  pull-down box [at the far-left end of the toolbar].
11012  Most of the paragraph environments you're used to seeing are missing.
11013  There are also five new ones.
11014  That's because the 
11015 \family sans
11016 slides
11017 \family default
11018  class itself only supports certain paragraph environments:
11019 \end_layout
11020
11021 \begin_layout Itemize
11022
11023 \family sans
11024 Standard
11025 \end_layout
11026
11027 \begin_layout Itemize
11028
11029 \family sans
11030 Itemize
11031 \end_layout
11032
11033 \begin_layout Itemize
11034
11035 \family sans
11036 Enumerate
11037 \end_layout
11038
11039 \begin_layout Itemize
11040
11041 \family sans
11042 Description
11043 \end_layout
11044
11045 \begin_layout Itemize
11046
11047 \family sans
11048 List
11049 \end_layout
11050
11051 \begin_layout Itemize
11052
11053 \family sans
11054 Quotation
11055 \end_layout
11056
11057 \begin_layout Itemize
11058
11059 \family sans
11060 Quote
11061 \end_layout
11062
11063 \begin_layout Itemize
11064
11065 \family sans
11066 Verse
11067 \end_layout
11068
11069 \begin_layout Itemize
11070
11071 \family sans
11072 Caption
11073 \end_layout
11074
11075 \begin_layout Itemize
11076
11077 \family sans
11078 LyX-Code
11079 \end_layout
11080
11081 \begin_layout Itemize
11082
11083 \family sans
11084 Comment
11085 \end_layout
11086
11087 \begin_layout Standard
11088 All of the other standard environments, including the section-heading environmen
11089 ts, aren't used in the 
11090 \family sans
11091 slides
11092 \family default
11093  class.
11094 \end_layout
11095
11096 \begin_layout Standard
11097 On the other hand, you'll notice the following new environments:
11098 \end_layout
11099
11100 \begin_layout Itemize
11101
11102 \family sans
11103 Slide
11104 \end_layout
11105
11106 \begin_layout Itemize
11107
11108 \family sans
11109 Overlay
11110 \end_layout
11111
11112 \begin_layout Itemize
11113
11114 \family sans
11115 Note
11116 \end_layout
11117
11118 \begin_layout Itemize
11119
11120 \family sans
11121 InvisibleText
11122 \end_layout
11123
11124 \begin_layout Itemize
11125
11126 \family sans
11127 VisibleText
11128 \end_layout
11129
11130 \begin_layout Standard
11131 These five are kind of quirky, due to a 
11132 \begin_inset Quotes eld
11133 \end_inset
11134
11135 feature
11136 \begin_inset Quotes erd
11137 \end_inset
11138
11139  in LyX.
11140  You see, LyX doesn't permit you to nest any other paragraph environment
11141  into an empty environment.
11142  Now, that's fine and dandy, but it means that you wouldn't be able to start
11143  a slide with anything except plain text.
11144  To deal with this, I've performed a little 
11145 \begin_inset Quotes eld
11146 \end_inset
11147
11148 LaTeX magic.
11149 \begin_inset Quotes erd
11150 \end_inset
11151
11152  
11153 \end_layout
11154
11155 \begin_layout Subsubsection
11156 Quirks of the New Environments
11157 \begin_inset LatexCommand \label{sec:slideQuirk}
11158
11159 \end_inset
11160
11161
11162 \end_layout
11163
11164 \begin_layout Standard
11165 All five of the new paragraph environments are somewhat quirky due to inherent
11166  limitiations in the current version of LyX.
11167  As I just mentioned, LyX forbids environments that begin with another environme
11168 nt.
11169  To get around this, the 
11170 \family sans
11171 Slide
11172 \family default
11173  environment isn't a paragraph environment as described in the 
11174 \emph on
11175 User's Guide
11176 \emph default
11177 .
11178  
11179 \end_layout
11180
11181 \begin_layout Standard
11182 You should consider 
11183 \family sans
11184 Slide
11185 \family default
11186
11187 \family sans
11188 Overlay
11189 \family default
11190 , and 
11191 \family sans
11192 Note
11193 \family default
11194  to be 
11195 \begin_inset Quotes eld
11196 \end_inset
11197
11198 pseudo-environments.
11199 \begin_inset Quotes erd
11200 \end_inset
11201
11202  They look like a section heading or a 
11203 \begin_inset Quotes eld
11204 \end_inset
11205
11206
11207 \family sans
11208 Caption
11209 \family default
11210 ,
11211 \begin_inset Quotes erd
11212 \end_inset
11213
11214  but really begin a [and, if necessary, end the previous] paragraph environment.
11215  Likewise, treat 
11216 \family sans
11217 InvisibleText
11218 \family default
11219  and 
11220 \family sans
11221 VisibleText
11222 \family default
11223  as 
11224 \begin_inset Quotes eld
11225 \end_inset
11226
11227 pseudo-commands.
11228 \begin_inset Quotes erd
11229 \end_inset
11230
11231  These two perform some action.
11232 \end_layout
11233
11234 \begin_layout Standard
11235 A common feature of all five environments, 
11236 \family sans
11237 Slide
11238 \family default
11239
11240 \family sans
11241 Overlay
11242 \family default
11243
11244 \family sans
11245 Note
11246 \family default
11247
11248 \family sans
11249 InvisibleText
11250 \family default
11251  and 
11252 \family sans
11253 VisibleText
11254 \family default
11255 , is a rather long-ish label.
11256  The text following this label --- ordinarily the contents of the paragraph
11257  environment --- is utterly irrelevant for 
11258 \family sans
11259 Slide
11260 \family default
11261
11262 \family sans
11263 Overlay
11264 \family default
11265
11266 \family sans
11267 Note
11268 \family default
11269
11270 \family sans
11271 InvisibleText
11272 \family default
11273  and 
11274 \family sans
11275 VisibleText
11276 \family default
11277 .
11278  LyX completely ignores it.
11279  In fact, you can leave these five environments completely empty.
11280  
11281 \end_layout
11282
11283 \begin_layout Standard
11284 While you don't 
11285 \emph on
11286 have
11287 \emph default
11288  to put any text after the rather long-ish label, you might want to.
11289  This could be a short description of the contents of the 
11290 \family sans
11291 Slide
11292 \family default
11293 , for example.
11294  In that case, enter in your descriptive comment and hit 
11295 \family sans
11296 Return
11297 \family default
11298  as you normally would.
11299 \end_layout
11300
11301 \begin_layout Standard
11302 If, on the other hand, you don't want to enter in any descriptive text,
11303  you'll hit another LyX quirk.
11304  LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
11305  environment until you put something in the old one.
11306  So, do this:
11307 \end_layout
11308
11309 \begin_layout Itemize
11310 Start entering the text that will 
11311 \emph on
11312 follow
11313 \emph default
11314  the new 
11315 \family sans
11316 Slide
11317 \family default
11318
11319 \family sans
11320 Overlay
11321 \family default
11322
11323 \family sans
11324 Note
11325 \family default
11326
11327 \family sans
11328 InvisibleText
11329 \family default
11330  or 
11331 \family sans
11332 VisibleText
11333 \family default
11334 .
11335  
11336 \end_layout
11337
11338 \begin_layout Itemize
11339 Now move to the beginning of that paragraph.
11340  
11341 \end_layout
11342
11343 \begin_layout Itemize
11344 Next, hit 
11345 \family sans
11346 Return
11347 \family default
11348 .
11349  
11350 \end_layout
11351
11352 \begin_layout Itemize
11353 Finally, change this new, empty paragraph to a 
11354 \family sans
11355 Slide
11356 \family default
11357
11358 \family sans
11359 Overlay
11360 \family default
11361
11362 \family sans
11363 Note
11364 \family default
11365
11366 \family sans
11367 InvisibleText
11368 \family default
11369  or 
11370 \family sans
11371 VisibleText
11372 \family default
11373 .
11374  
11375 \end_layout
11376
11377 \begin_layout Standard
11378 Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
11379
11380 \end_layout
11381
11382 \begin_layout Subsection
11383 Making a Presentation with 
11384 \family sans
11385 Slide
11386 \family default
11387 ,
11388 \family sans
11389  Overlay
11390 \family default
11391  and 
11392 \family sans
11393 Note
11394 \end_layout
11395
11396 \begin_layout Subsubsection
11397 Using the 
11398 \family sans
11399 Slide
11400 \family default
11401  Environment
11402 \end_layout
11403
11404 \begin_layout Standard
11405 If you're expecting this section to teach you how to actually make a presentatio
11406 n, you'll be sorely disappointed.
11407  Naturally, I'll describe all of the ways the 
11408 \family sans
11409 slides
11410 \family default
11411  class can assist you in preparing the materials for a presentation.
11412  Filling in the contents, however, is up to you.
11413  [Then again, that 
11414 \emph on
11415 is
11416 \emph default
11417  the LyX philosophy.]
11418 \end_layout
11419
11420 \begin_layout Standard
11421 Choosing the 
11422 \family sans
11423 Slide
11424 \family default
11425  environment [in the manner described in section\InsetSpace ~
11426
11427 \begin_inset LatexCommand \ref{sec:slideQuirk}
11428
11429 \end_inset
11430
11431 ] tells LyX to begin a new slide [duh].
11432  The label for this environment/
11433 \begin_inset Quotes erd
11434 \end_inset
11435
11436 pseudo-command
11437 \begin_inset Quotes erd
11438 \end_inset
11439
11440  is an 
11441 \begin_inset Quotes eld
11442 \end_inset
11443
11444 ASCII line,
11445 \begin_inset Quotes erd
11446 \end_inset
11447
11448  in cool blue, followed by the label, 
11449 \begin_inset Quotes eld
11450 \end_inset
11451
11452 NewSlide:
11453 \begin_inset Quotes erd
11454 \end_inset
11455
11456 .
11457  Any text or paragraph environments that follow this one go on the new slide.
11458  It's that simple.
11459 \end_layout
11460
11461 \begin_layout Standard
11462 Slides are probably the only time you'll need to forcibly end pages in LyX
11463  (this can be specified in the 
11464 \family sans
11465 Paragraph Layout
11466 \family default
11467  dialog).
11468  In fact, you'll want to, once you finish entering the contents of one slide.
11469  If you've entered more text than can physically fit on a slide, the extra
11470  overflows onto a new slide.
11471  I don't recommend doing this, however, since the overflow slide won't have
11472  any page number on it.
11473  Furthermore, it may interfere with any 
11474 \family sans
11475 Overlay
11476 \family default
11477  you've made to accompany the oversized 
11478 \family sans
11479 Slide
11480 \family default
11481 .
11482 \end_layout
11483
11484 \begin_layout Standard
11485 The 
11486 \family sans
11487 Overlay
11488 \family default
11489  and 
11490 \family sans
11491 Note
11492 \family default
11493  environments work the same way as the 
11494 \family sans
11495 Slide 
11496 \family default
11497 environment.
11498  They both create an 
11499 \begin_inset Quotes eld
11500 \end_inset
11501
11502 ASCII line
11503 \begin_inset Quotes erd
11504 \end_inset
11505
11506  followed by a label [
11507 \begin_inset Quotes eld
11508 \end_inset
11509
11510 NewOverlay:
11511 \begin_inset Quotes erd
11512 \end_inset
11513
11514  and 
11515 \begin_inset Quotes eld
11516 \end_inset
11517
11518 NewNote:
11519 \begin_inset Quotes erd
11520 \end_inset
11521
11522 , respectively].
11523  The color is a stunning magenta instead of blue, and the 
11524 \begin_inset Quotes eld
11525 \end_inset
11526
11527 ASCII line
11528 \begin_inset Quotes erd
11529 \end_inset
11530
11531  will look different, in style and in length.
11532  The label fonts of all three also differ from one another.
11533 \end_layout
11534
11535 \begin_layout Standard
11536 As with a 
11537 \family sans
11538 Slide
11539 \family default
11540 , if the contents of a 
11541 \family sans
11542 Note
11543 \family default
11544  or 
11545 \family sans
11546 Overlay
11547 \family default
11548  exceed the physical size of a slide or sheet of paper, the extra will overflow
11549  onto a new sheet.
11550  Again, you should avoid this.
11551  It defeats the whole purpose of 
11552 \family sans
11553 Note
11554 \family default
11555 s and 
11556 \family sans
11557 Overlay
11558 \family default
11559 s.
11560 \end_layout
11561
11562 \begin_layout Subsubsection
11563 Using 
11564 \family sans
11565 Overlay
11566 \family default
11567  with 
11568 \family sans
11569 Slide
11570 \end_layout
11571
11572 \begin_layout Standard
11573 The idea behind an 
11574 \family sans
11575 Overlay
11576 \family default
11577  is a slide that sits atop another slide.
11578  Perhaps you wish to discuss a figure on the main 
11579 \family sans
11580 Slide
11581 \family default
11582  before displaying the text associated with it.
11583  One way to accomplish this is tape a flap of dark paper over the part of
11584  the 
11585 \family sans
11586 Slide
11587 \family default
11588  you want to display later.
11589  This method fails, however, if you wish to overlap one graph with another,
11590  for example.
11591  You would then have to fumble while speaking to align the two separate,
11592  overlapping 
11593 \family sans
11594 Slide
11595 \family default
11596 s to align the two graphs.
11597  The use of an 
11598 \family sans
11599 Overlay
11600 \family default
11601  environment in both cases makes life much easier.
11602 \end_layout
11603
11604 \begin_layout Standard
11605 Each 
11606 \family sans
11607 Overlay
11608 \family default
11609  receives the page number of its 
11610 \begin_inset Quotes eld
11611 \end_inset
11612
11613 parent
11614 \begin_inset Quotes erd
11615 \end_inset
11616
11617  
11618 \family sans
11619 Slide
11620 \family default
11621 , appended by 
11622 \begin_inset Quotes eld
11623 \end_inset
11624
11625
11626 \family typewriter
11627 -a
11628 \family default
11629
11630 \begin_inset Quotes erd
11631 \end_inset
11632
11633 .
11634 \begin_inset Foot
11635 status collapsed
11636
11637 \begin_layout Standard
11638 Presumably, mutliple 
11639 \family sans
11640 Overlay
11641 \family default
11642 s would have 
11643 \begin_inset Quotes eld
11644 \end_inset
11645
11646
11647 \family typewriter
11648 -a
11649 \family default
11650
11651 \begin_inset Quotes erd
11652 \end_inset
11653
11654
11655 \begin_inset Quotes eld
11656 \end_inset
11657
11658
11659 \family typewriter
11660 -b
11661 \family default
11662
11663 \begin_inset Quotes erd
11664 \end_inset
11665
11666
11667 \begin_inset Quotes eld
11668 \end_inset
11669
11670
11671 \family typewriter
11672 -c
11673 \family default
11674
11675 \begin_inset Quotes erd
11676 \end_inset
11677
11678 , etc.\InsetSpace ~
11679 appended to the page number of the parent 
11680 \family sans
11681 Slide
11682 \family default
11683 .
11684  
11685 \end_layout
11686
11687 \end_inset
11688
11689  Clearly, you want the contents of both the 
11690 \family sans
11691 Slide
11692 \family default
11693  and the 
11694 \family sans
11695 Overlay
11696 \family default
11697  to each fit on a single physical slide! You should probably consider an
11698  
11699 \family sans
11700 Overlay
11701 \family default
11702  as 
11703 \begin_inset Quotes eld
11704 \end_inset
11705
11706 part of
11707 \begin_inset Quotes erd
11708 \end_inset
11709
11710  a 
11711 \family sans
11712 Slide
11713 \family default
11714 .
11715  Indeed, the LyX 
11716 \family sans
11717 slides
11718 \family default
11719  class provides a visual cue for this: the label at the start of an 
11720 \family sans
11721 Overlay
11722 \family default
11723  is shorter than that at the start of a 
11724 \family sans
11725 Slide
11726 \family default
11727 .
11728  Lastly, when you generate printable output, you'll find alignment markers
11729  in all four corners of both the 
11730 \family sans
11731 Overlay
11732 \family default
11733  page and its parent 
11734 \family sans
11735 Slide
11736 \family default
11737 .
11738  These will assist you in lining up the two physical slides.
11739 \end_layout
11740
11741 \begin_layout Standard
11742 The major problem in overlaying two slides is aligning the contents of the
11743  two transparencies.
11744  How much space should you leave for that graph on the second slide? Worse
11745  still, what if you want a graph and a sentence on second slide, but there
11746  is text on the main transparency that goes in between them? You could try
11747  and insert vertical space of the right size.
11748  The better way is to use 
11749 \family sans
11750 InvisibleText
11751 \family default
11752  and 
11753 \family sans
11754 VisibleText
11755 \family default
11756 .
11757 \end_layout
11758
11759 \begin_layout Standard
11760 As their names imply, 
11761 \family sans
11762 InvisibleText
11763 \family default
11764  and 
11765 \family sans
11766 VisibleText
11767 \family default
11768  are two command-like paragraph environments that make all subsequent text
11769  invisible and visible, respectively.
11770  Note from section\InsetSpace ~
11771
11772 \begin_inset LatexCommand \ref{sec:slideQuirk}
11773
11774 \end_inset
11775
11776  that you don't place anything 
11777 \emph on
11778 into
11779 \emph default
11780  these two environments, however.
11781  When you create an 
11782 \family sans
11783 InvisibleText
11784 \family default
11785 , it inserts a centered, sky-blue label into the page reading 
11786 \begin_inset Quotes eld
11787 \end_inset
11788
11789 <Invisible Text Follows>
11790 \begin_inset Quotes erd
11791 \end_inset
11792
11793 .
11794  For paragraphs following this label, the parts of the 
11795 \family sans
11796 Slide
11797 \family default
11798  [or 
11799 \family sans
11800 Overlay
11801 \family default
11802 ; it doesn't matter which] where they would be contain instead blank space.
11803  
11804 \end_layout
11805
11806 \begin_layout Standard
11807 For 
11808 \family sans
11809 VisibleText
11810 \family default
11811 , the corresponding centered label is 
11812 \begin_inset Quotes eld
11813 \end_inset
11814
11815 <Visible Text Follows>
11816 \begin_inset Quotes erd
11817 \end_inset
11818
11819  in blazing green.
11820  Paragraphs following this label behave normally.
11821  Note that the beginning of a new 
11822 \family sans
11823 Slide
11824 \family default
11825
11826 \family sans
11827 Overlay
11828 \family default
11829 , or 
11830 \family sans
11831 Note
11832 \family default
11833  automatically shuts off an 
11834 \family sans
11835 InvisibleText
11836 \family default
11837 .
11838  It's therefore not necessary to use 
11839 \family sans
11840 VisibleText
11841 \family default
11842  at the end of a 
11843 \family sans
11844 Slide
11845 \family default
11846 .
11847 \end_layout
11848
11849 \begin_layout Standard
11850 By now, it should be obvious how to create overlay transparencies using
11851  the proper combination of 
11852 \family sans
11853 InvisibleText
11854 \family default
11855  and 
11856 \family sans
11857 VisibleText
11858 \family default
11859  on a 
11860 \family sans
11861 Slide
11862 \family default
11863  and 
11864 \family sans
11865 Overlay
11866 \family default
11867 :
11868 \end_layout
11869
11870 \begin_layout Enumerate
11871 Create a 
11872 \family sans
11873 Slide
11874 \family default
11875 , including everything that will appear on it, whether on the main slide
11876  or on the 
11877 \family sans
11878 Overlay
11879 \family default
11880 .
11881 \end_layout
11882
11883 \begin_layout Enumerate
11884 Before each figure or paragraph that will appear only on the 
11885 \family sans
11886 Overlay
11887 \family default
11888 , insert an 
11889 \family sans
11890 InvisibleText
11891 \family default
11892  environment.
11893  If necessary, insert a 
11894 \family sans
11895 VisibleText
11896 \family default
11897  environment after the 
11898 \family sans
11899 Overlay
11900 \family default
11901 -only text.
11902 \end_layout
11903
11904 \begin_layout Enumerate
11905 Start an 
11906 \family sans
11907 Overlay
11908 \family default
11909  immediately following the 
11910 \family sans
11911 Slide
11912 \family default
11913 .
11914 \end_layout
11915
11916 \begin_layout Enumerate
11917 Copy the contents of this 
11918 \family sans
11919 Slide
11920 \family default
11921  into the 
11922 \family sans
11923 Overlay
11924 \family default
11925 .
11926 \end_layout
11927
11928 \begin_layout Enumerate
11929 Within the 
11930 \family sans
11931 Overlay
11932 \family default
11933 , change all of the 
11934 \family sans
11935 InvisibleText
11936 \family default
11937  lines to 
11938 \family sans
11939 VisibleText
11940 \family default
11941  and vice-versa.
11942 \end_layout
11943
11944 \begin_layout Standard
11945 That's it.
11946  You've just made an 
11947 \family sans
11948 Overlay
11949 \family default
11950 .
11951 \end_layout
11952
11953 \begin_layout Standard
11954 There's one problem with the way I've designed the LyX 
11955 \family sans
11956 slides
11957 \family default
11958  class: you can't make text in the middle of a paragraph invisible, nor
11959  make text in the middle of an invisible paragraph visible again.
11960  To accomplish this feat, you'll need to use some inlined LaTeX codes.
11961 \begin_inset Foot
11962 status collapsed
11963
11964 \begin_layout Standard
11965 The commands of interest are: 
11966 \end_layout
11967
11968 \begin_layout Itemize
11969
11970 \family typewriter
11971 {
11972 \backslash
11973 invisible \SpecialChar \ldots{}
11974  }
11975 \end_layout
11976
11977 \begin_layout Itemize
11978
11979 \family typewriter
11980 {
11981 \backslash
11982 visible \SpecialChar \ldots{}
11983  }
11984 \end_layout
11985
11986 \begin_layout Standard
11987 \SpecialChar \ldots{}
11988 and need to be marked as TeX.
11989  The text whose 
11990 \begin_inset Quotes eld
11991 \end_inset
11992
11993 visibility
11994 \begin_inset Quotes erd
11995 \end_inset
11996
11997  you wish to change goes in between the brackets [and after the 
11998 \family typewriter
11999
12000 \backslash
12001 invisible
12002 \family default
12003  or 
12004 \family typewriter
12005
12006 \backslash
12007 visible
12008 \family default
12009  command].
12010  If you don't know how to mark text as TeX, see the apprpriate section of
12011  the 
12012 \emph on
12013 User's Guide
12014 \emph default
12015 .
12016 \end_layout
12017
12018 \end_inset
12019
12020
12021 \end_layout
12022
12023 \begin_layout Subsubsection
12024 Using 
12025 \family sans
12026 Note
12027 \family default
12028  with 
12029 \family sans
12030 Slide
12031 \family default
12032
12033 \begin_inset LatexCommand \label{sec:slideNote}
12034
12035 \end_inset
12036
12037
12038 \end_layout
12039
12040 \begin_layout Standard
12041 Like an 
12042 \family sans
12043 Overlay
12044 \family default
12045 , a 
12046 \family sans
12047 Note
12048 \family default
12049  is associated with a 
12050 \begin_inset Quotes eld
12051 \end_inset
12052
12053 parent
12054 \begin_inset Quotes erd
12055 \end_inset
12056
12057  
12058 \family sans
12059 Slide
12060 \family default
12061 .
12062  Here, too, the LyX 
12063 \family sans
12064 slides
12065 \family default
12066  class provides visual cues.
12067  The label for a 
12068 \family sans
12069 Note
12070 \family default
12071  is shorter than that of a 
12072 \family sans
12073 Slide
12074 \family default
12075  [yet longer than that of an 
12076 \family sans
12077 Overlay
12078 \family default
12079 ] and, like the label of an 
12080 \family sans
12081 Overlay
12082 \family default
12083  is shockingly magenta.
12084  Additionally, the printed 
12085 \family sans
12086 Note
12087 \family default
12088  has the page number of its 
12089 \begin_inset Quotes eld
12090 \end_inset
12091
12092 parent
12093 \begin_inset Quotes erd
12094 \end_inset
12095
12096  
12097 \family sans
12098 Slide
12099 \family default
12100 , appended by 
12101 \begin_inset Quotes eld
12102 \end_inset
12103
12104
12105 \family typewriter
12106 -
12107 \family default
12108 1
12109 \begin_inset Quotes erd
12110 \end_inset
12111
12112
12113 \begin_inset Quotes eld
12114 \end_inset
12115
12116
12117 \family typewriter
12118 -
12119 \family default
12120 2
12121 \begin_inset Quotes erd
12122 \end_inset
12123
12124
12125 \begin_inset Quotes eld
12126 \end_inset
12127
12128
12129 \family typewriter
12130 -
12131 \family default
12132 3
12133 \begin_inset Quotes erd
12134 \end_inset
12135
12136 , etc.
12137  You can have multiple 
12138 \family sans
12139 Note
12140 \family default
12141 s associated with a single 
12142 \family sans
12143 Slide
12144 \family default
12145 , and, as with 
12146 \family sans
12147 Slide
12148 \family default
12149  and 
12150 \family sans
12151 Overlay
12152 \family default
12153 , you'll probably want to break up long 
12154 \family sans
12155 Note
12156 \family default
12157 s so that they fit on a single sheet of paper.
12158 \end_layout
12159
12160 \begin_layout Standard
12161 The purpose of a 
12162 \family sans
12163 Note
12164 \family default
12165  is obvious: it contains anything additional you might want to say about
12166  a 
12167 \family sans
12168 Slide
12169 \family default
12170 .
12171  It could also be used as a sheet of reminders for a particular 
12172 \family sans
12173 Slide
12174 \family default
12175 .
12176  In the case of the latter, you might want to make use of time markers.
12177  Currently, the LyX 
12178 \family sans
12179 slides
12180 \family default
12181  class has no 
12182 \begin_inset Quotes eld
12183 \end_inset
12184
12185 native
12186 \begin_inset Quotes erd
12187 \end_inset
12188
12189  support for time markers, a 
12190 \noun on
12191 Sli
12192 \noun default
12193 TeX feature.
12194  So, you'll have to resort to using the LaTeX codes.
12195 \end_layout
12196
12197 \begin_layout Standard
12198 To use time markers, you'll need to specify the extra class option 
12199 \begin_inset Quotes eld
12200 \end_inset
12201
12202
12203 \family typewriter
12204 clock
12205 \family default
12206
12207 \begin_inset Quotes erd
12208 \end_inset
12209
12210  [see section\InsetSpace ~
12211
12212 \begin_inset LatexCommand \ref{sec:slidesetup}
12213
12214 \end_inset
12215
12216 ].
12217  This option turns on timing marks, which will appear in the lower-left-hand
12218  corner of every 
12219 \family sans
12220 Note
12221 \family default
12222  you generate.
12223  To set what appears in the time marker, you use the LaTeX commands 
12224 \begin_inset Quotes eld
12225 \end_inset
12226
12227
12228 \family typewriter
12229
12230 \backslash
12231 settime{}
12232 \family default
12233
12234 \begin_inset Quotes erd
12235 \end_inset
12236
12237  and 
12238 \begin_inset Quotes eld
12239 \end_inset
12240
12241
12242 \family typewriter
12243
12244 \backslash
12245 addtime{}
12246 \family default
12247
12248 \begin_inset Quotes erd
12249 \end_inset
12250
12251 .
12252  The arguments of both commands are time measured in seconds.
12253  
12254 \begin_inset Quotes eld
12255 \end_inset
12256
12257
12258 \family typewriter
12259
12260 \backslash
12261 settime{}
12262 \family default
12263
12264 \begin_inset Quotes erd
12265 \end_inset
12266
12267  sets the time marker to a given time.
12268  
12269 \begin_inset Quotes eld
12270 \end_inset
12271
12272
12273 \family typewriter
12274
12275 \backslash
12276 addtime{}
12277 \family default
12278
12279 \begin_inset Quotes erd
12280 \end_inset
12281
12282  increments the time marker by the specified amount.
12283  Using time markers and 
12284 \family sans
12285 Note
12286 \family default
12287 s in this fashion, you can remind yourself how much time to spend on a particula
12288
12289 \family sans
12290 Slide
12291 \family default
12292 .
12293 \end_layout
12294
12295 \begin_layout Standard
12296 There's one last feature to describe.
12297  Clearly, you'd like to print out all of your 
12298 \family sans
12299 Slide
12300 \family default
12301 s and 
12302 \family sans
12303 Overlay
12304 \family default
12305 s on transparencies while printing all of your 
12306 \family sans
12307 Note
12308 \family default
12309 s on plain paper.
12310  However, a 
12311 \family sans
12312 Note
12313 \family default
12314  
12315 \emph on
12316 must
12317 \emph default
12318  follow the 
12319 \family sans
12320 Slide
12321 \family default
12322  with which it is associated.
12323  What's a person to do?
12324 \end_layout
12325
12326 \begin_layout Standard
12327 Luckily, there are two LaTeX commands that allow you to select what to print
12328  out.
12329  Both must be placed into the preamble of your document.
12330  The command 
12331 \begin_inset Quotes eld
12332 \end_inset
12333
12334
12335 \family typewriter
12336
12337 \backslash
12338 onlyslides{
12339 \backslash
12340 slides}
12341 \family default
12342
12343 \begin_inset Quotes erd
12344 \end_inset
12345
12346  will cause the output to contain only the 
12347 \family sans
12348 Slide
12349 \family default
12350 s and 
12351 \family sans
12352 Overlay
12353 \family default
12354 s.
12355  Correspondingly, the command 
12356 \begin_inset Quotes eld
12357 \end_inset
12358
12359
12360 \family typewriter
12361
12362 \backslash
12363 onlynotes{
12364 \backslash
12365 notes}
12366 \family default
12367
12368 \begin_inset Quotes erd
12369 \end_inset
12370
12371  prevents the output of anything but 
12372 \family sans
12373 Note
12374 \family default
12375 s.
12376  I'd advise placing both commands in the preamble and initially comment
12377  both out.
12378  You can then preview your entire presentation as you write.
12379  When you're done writing, you can then uncomment one of the two to select
12380  what you want to print.
12381  I like to uncomment 
12382 \begin_inset Quotes eld
12383 \end_inset
12384
12385
12386 \family typewriter
12387
12388 \backslash
12389 onlyslides{
12390 \backslash
12391 slides}
12392 \family default
12393
12394 \begin_inset Quotes erd
12395 \end_inset
12396
12397  , print to a file with 
12398 \begin_inset Quotes eld
12399 \end_inset
12400
12401
12402 \family typewriter
12403 -slides
12404 \family default
12405
12406 \begin_inset Quotes erd
12407 \end_inset
12408
12409  in its name, comment it back out, then uncomment 
12410 \begin_inset Quotes eld
12411 \end_inset
12412
12413
12414 \family typewriter
12415
12416 \backslash
12417 onlynotes{
12418 \backslash
12419 notes}
12420 \family default
12421
12422 \begin_inset Quotes erd
12423 \end_inset
12424
12425  and print to a 
12426 \begin_inset Quotes eld
12427 \end_inset
12428
12429
12430 \family typewriter
12431 *-notes.ps
12432 \family default
12433
12434 \begin_inset Quotes erd
12435 \end_inset
12436
12437  file.
12438  I can then send either file to a printer, loading transparencies or plain
12439  paper as appropriate.
12440 \end_layout
12441
12442 \begin_layout Standard
12443 You can also provide other arguments to the 
12444 \begin_inset Quotes eld
12445 \end_inset
12446
12447
12448 \family typewriter
12449
12450 \backslash
12451 onlyslides{}
12452 \family default
12453
12454 \begin_inset Quotes erd
12455 \end_inset
12456
12457  and 
12458 \begin_inset Quotes eld
12459 \end_inset
12460
12461
12462 \family typewriter
12463
12464 \backslash
12465 onlynotes{}
12466 \family default
12467
12468 \begin_inset Quotes erd
12469 \end_inset
12470
12471  commands.
12472  See a good LaTeX book for details.
12473 \end_layout
12474
12475 \begin_layout Subsection
12476 The 
12477 \family sans
12478 slides
12479 \family default
12480  Class Template File
12481 \end_layout
12482
12483 \begin_layout Standard
12484 I have also provided a template file, 
12485 \begin_inset Quotes eld
12486 \end_inset
12487
12488
12489 \family typewriter
12490 slides.lyx
12491 \family default
12492
12493 \begin_inset Quotes erd
12494 \end_inset
12495
12496 , with the 
12497 \family sans
12498 slides
12499 \family default
12500  class.
12501  To use it, begin your new presentation with 
12502 \family sans
12503 \bar under
12504 F
12505 \bar default
12506 ile\SpecialChar \menuseparator
12507 New\InsetSpace ~
12508 from\InsetSpace ~
12509
12510 \bar under
12511 T
12512 \bar default
12513 emplate
12514 \family default
12515 .
12516  Your new LyX presentation file will contain an example 
12517 \family sans
12518 Slide
12519 \family default
12520  -- 
12521 \family sans
12522 Overlay
12523 \family default
12524  --
12525 \family sans
12526  Note
12527 \family default
12528  triplet.
12529  The 
12530 \family sans
12531 Slide
12532 \family default
12533  and 
12534 \family sans
12535 Overlay
12536 \family default
12537  additionally contain an example of the use of 
12538 \family sans
12539 InvisibleText
12540 \family default
12541  and 
12542 \family sans
12543 VisibleText
12544 \family default
12545 .
12546  Lastly, the preamble will contain:
12547 \end_layout
12548
12549 \begin_layout LyX-Code
12550 % Uncomment to print out only slides and overlays
12551 \end_layout
12552
12553 \begin_layout LyX-Code
12554 %
12555 \end_layout
12556
12557 \begin_layout LyX-Code
12558 %
12559 \backslash
12560 onlyslides{
12561 \backslash
12562 slides}
12563 \newline
12564  
12565 \end_layout
12566
12567 \begin_layout LyX-Code
12568 % Uncomment to print out only notes
12569 \end_layout
12570
12571 \begin_layout LyX-Code
12572 %
12573 \end_layout
12574
12575 \begin_layout LyX-Code
12576 %
12577 \backslash
12578 onlynotes{
12579 \backslash
12580 notes}
12581 \end_layout
12582
12583 \begin_layout Standard
12584 One final thing: I created this class to support the LaTeX2e 
12585 \begin_inset Quotes eld
12586 \end_inset
12587
12588
12589 \noun on
12590 Sli
12591 \noun default
12592 TeX emulation
12593 \begin_inset Quotes erd
12594 \end_inset
12595
12596  class, one of the built-in LaTeX2e classes.
12597  Neither I nor the rest of the LyX Team endorse or oppose the use of this
12598  built-in slide class.
12599  It's here if you want it or need it.
12600  There exist other LaTeX2e classes for creating presentations, such as the
12601  
12602 \family sans
12603 Foils
12604 \family default
12605  class [see section\InsetSpace ~
12606
12607 \begin_inset LatexCommand \ref{sec:foiltex}
12608
12609 \end_inset
12610
12611 ] or the 
12612 \begin_inset Quotes eld
12613 \end_inset
12614
12615
12616 \family typewriter
12617 seminar
12618 \family default
12619
12620 \begin_inset Quotes erd
12621 \end_inset
12622
12623  package [present on some TeX distributions].
12624  The latter is not yet supported under LyX.
12625 \begin_inset Foot
12626 status collapsed
12627
12628 \begin_layout Standard
12629 Perhaps you can take on the task\SpecialChar \ldots{}
12630
12631 \end_layout
12632
12633 \end_inset
12634
12635  I know nothing about these other classes.
12636  Try them out to see what sort of alternative they provide.
12637 \end_layout
12638
12639 \begin_layout Section
12640 Foils [aka 
12641 \family sans
12642 Foil
12643 \family default
12644 \noun on
12645 TeX
12646 \noun default
12647 ]
12648 \begin_inset LatexCommand \label{sec:foiltex}
12649
12650 \end_inset
12651
12652
12653 \end_layout
12654
12655 \begin_layout Standard
12656 by 
12657 \noun on
12658 Allan Rae
12659 \end_layout
12660
12661 \begin_layout Subsection
12662 Introduction
12663 \end_layout
12664
12665 \begin_layout Standard
12666 This section describes how to use LyX to make slides for overhead projectors.
12667  There are two document classes that can do this: the default slides class
12668  and the 
12669 \family sans
12670 Foil
12671 \family default
12672 TeX slides class.
12673  This section documents the latter.
12674 \end_layout
12675
12676 \begin_layout Standard
12677 I'm going to say this again, nice and clear, so that there's no misunderstanding
12678 :
12679 \end_layout
12680
12681 \begin_layout Standard
12682 \begin_inset VSpace bigskip
12683 \end_inset
12684
12685
12686 \end_layout
12687
12688 \begin_layout Standard
12689 \align center
12690
12691 \size large
12692 This section documents the class 
12693 \begin_inset Quotes eld
12694 \end_inset
12695
12696
12697 \family sans
12698 slides (FoilTeX)
12699 \family default
12700
12701 \begin_inset Quotes erd
12702 \end_inset
12703
12704  
12705 \emph on
12706 only.
12707 \end_layout
12708
12709 \begin_layout Standard
12710 \begin_inset VSpace bigskip
12711 \end_inset
12712
12713
12714 \end_layout
12715
12716 \begin_layout Standard
12717 If you're looking for the documentation for 
12718 \begin_inset Quotes eld
12719 \end_inset
12720
12721
12722 \family sans
12723 slides (default)
12724 \family default
12725
12726 \begin_inset Quotes erd
12727 \end_inset
12728
12729 , check out section\InsetSpace ~
12730
12731 \begin_inset LatexCommand \ref{sec:slitex}
12732
12733 \end_inset
12734
12735 .
12736  If your machine doesn't have the 
12737 \family sans
12738 foils 
12739 \family default
12740 class [
12741 \begin_inset Quotes eld
12742 \end_inset
12743
12744
12745 \family sans
12746 slides (FoilTeX)
12747 \family default
12748
12749 \begin_inset Quotes erd
12750 \end_inset
12751
12752 ] installed, you'll probably have to use the default 
12753 \family sans
12754 slides
12755 \family default
12756  class, which isn't quite as good as 
12757 \family sans
12758 foils.
12759 \end_layout
12760
12761 \begin_layout Standard
12762 The 
12763 \family sans
12764 foils
12765 \family default
12766  class is designed for use with version 2.1 of the 
12767 \family sans
12768 foils.cls
12769 \family default
12770  LaTeX class file which is now an integral part of LaTeX2e.
12771 \end_layout
12772
12773 \begin_layout Subsection
12774 Getting Started
12775 \end_layout
12776
12777 \begin_layout Standard
12778 Obviously, to use this document class, you need to select 
12779 \begin_inset Quotes eld
12780 \end_inset
12781
12782
12783 \family sans
12784 slides (FoilTeX)
12785 \family default
12786
12787 \begin_inset Quotes erd
12788 \end_inset
12789
12790  from the 
12791 \family sans
12792 \bar under
12793 C
12794 \bar default
12795 lass
12796 \family default
12797  entry in the 
12798 \family sans
12799 Document\InsetSpace ~
12800 Layout
12801 \family default
12802  dialog.
12803  There are some settings in the 
12804 \family sans
12805 Document\InsetSpace ~
12806 Layout
12807 \family default
12808  dialog that you should know about that are specific to this class:
12809 \end_layout
12810
12811 \begin_layout Itemize
12812 Don't change the options 
12813 \family sans
12814 Sides
12815 \family default
12816  and 
12817 \family sans
12818 Columns
12819 \family default
12820  on the 
12821 \family sans
12822 Document\InsetSpace ~
12823 Layout
12824 \family default
12825  dialog.
12826  They're ignored by the 
12827 \family sans
12828 foils
12829 \family default
12830  class.
12831 \end_layout
12832
12833 \begin_layout Itemize
12834 The default font size is 20pt with the other options being 17pt, 25pt and
12835  30pt.
12836 \end_layout
12837
12838 \begin_layout Itemize
12839 The default font is 
12840 \family sans
12841 sans
12842 \family default
12843  
12844 \family sans
12845 serif
12846 \family default
12847  but all math equations are still typeset in the usual roman font.
12848 \end_layout
12849
12850 \begin_layout Itemize
12851
12852 \family sans
12853 Foil
12854 \family default
12855 TeX supports A4 and Letter paper sizes as well as a special size for working
12856  with 35mm slides.
12857  It doesn't support A5, B5, legal or executive paper sizes.
12858 \end_layout
12859
12860 \begin_layout Itemize
12861 Don't bother changing the 
12862 \family sans
12863 Float Placement
12864 \family default
12865  settings because they are ignored anyway.
12866  All floats appear where they are defined in the text.
12867 \end_layout
12868
12869 \begin_layout Itemize
12870 The 
12871 \family sans
12872 \bar under
12873 P
12874 \bar default
12875 agestyle
12876 \family default
12877  setting behaves a bit differently for this class.
12878  
12879 \family sans
12880 Foil
12881 \family default
12882 TeX provides extensive footer and header capabilities including a user-defined
12883  logo.
12884  See section\InsetSpace ~
12885
12886 \begin_inset LatexCommand \ref{sec:foilfoot}
12887
12888 \end_inset
12889
12890  for more details.
12891  The title page is treated differently to all other pages in the document
12892  and is 
12893 \emph on
12894 always
12895 \emph default
12896  unnumbered and 
12897 \emph on
12898 always
12899 \emph default
12900  has the logo centered at the bottom of the page (if one is defined).
12901  The possible page style choices and what they do are as follows:
12902 \end_layout
12903
12904 \begin_deeper
12905 \begin_layout List
12906 \labelwidthstring MMMMMMM
12907
12908 \family sans
12909 \series bold
12910 empty
12911 \family default
12912 \series default
12913  The final output contains no page numbers, or other headers or footers
12914  (except footnotes of course).
12915  
12916 \end_layout
12917
12918 \begin_layout List
12919 \labelwidthstring MMMMMMM
12920
12921 \family sans
12922 \series bold
12923 plain
12924 \family default
12925 \series default
12926  The final output contains page numbers centered at the bottom of the page.
12927  No other headings or footers (other than footnotes).
12928 \end_layout
12929
12930 \begin_layout List
12931 \labelwidthstring MMMMMMM
12932
12933 \series bold
12934 foilheadings
12935 \series default
12936  Page numbers in lower right corner.
12937  Additional headers and footers are also shown.
12938  This is also the default.
12939 \end_layout
12940
12941 \begin_layout List
12942 \labelwidthstring MMMMMMM
12943
12944 \series bold
12945 fancy
12946 \series default
12947  Gives you access to the 
12948 \family sans
12949 fancyheadings
12950 \family default
12951  package although its use with 
12952 \family sans
12953 Foil
12954 \family default
12955 TeX is discouraged by the writer of the 
12956 \family sans
12957 Foil
12958 \family default
12959 TeX package because of some potential page layout clashes.
12960 \end_layout
12961
12962 \end_deeper
12963 \begin_layout Subsubsection
12964 Extra Options
12965 \end_layout
12966
12967 \begin_layout Standard
12968 The following options may be used in the extra class options in the 
12969 \family sans
12970 \bar under
12971 D
12972 \bar default
12973 ocument\SpecialChar \menuseparator
12974
12975 \bar under
12976 S
12977 \bar default
12978 ettings
12979 \family default
12980  dialog.
12981 \end_layout
12982
12983 \begin_layout List
12984 \labelwidthstring MMMMMMx
12985
12986 \series bold
12987 35mmSlide
12988 \series default
12989  This sets up the page layout for 7.33in by 11in paper, which is about the
12990  same aspect ratio as a 35mm slide, making it a bit easier to work with
12991  this medium.
12992 \end_layout
12993
12994 \begin_layout List
12995 \labelwidthstring MMMMMMx
12996
12997 \series bold
12998 headrule
12999 \series default
13000  Places a rule across the page below the header on every page except the
13001  title page.
13002 \end_layout
13003
13004 \begin_layout List
13005 \labelwidthstring MMMMMMx
13006
13007 \series bold
13008 footrule
13009 \series default
13010  Places a rule across the page above the footer on every page except the
13011  title page.
13012 \end_layout
13013
13014 \begin_layout List
13015 \labelwidthstring MMMMMMx
13016
13017 \series bold
13018 dvips
13019 \series default
13020  This is automatically set each time you create a new 
13021 \family sans
13022 foils
13023 \family default
13024  document.
13025  This option tells 
13026 \family sans
13027 Foil
13028 \family default
13029 TeX to use the dvips driver to rotate those pages that are set as landscape
13030  foils.
13031 \end_layout
13032
13033 \begin_layout List
13034 \labelwidthstring MMMMMMx
13035
13036 \series bold
13037 landscape
13038 \series default
13039  Simply changes the page dimensions to those of a landscape page but doesn't
13040  do any rotation.
13041  Thus if you use this option you need to use an external program to rotate
13042  each page or feed your paper through your printer as landscape.
13043  Note that this option effectively reverses the roles of the 
13044 \family sans
13045 Foilhead
13046 \family default
13047  and 
13048 \family sans
13049 Rotatefoilhead
13050 \family default
13051  environments (don't worry these are described in the next section).
13052 \end_layout
13053
13054 \begin_layout List
13055 \labelwidthstring MMMMMMx
13056
13057 \series bold
13058 leqno
13059 \series default
13060  Equation numbers on the left.
13061 \end_layout
13062
13063 \begin_layout List
13064 \labelwidthstring MMMMMMx
13065
13066 \series bold
13067 fleqn
13068 \series default
13069  Flush-left equations.
13070 \end_layout
13071
13072 \begin_layout Subsection
13073 Supported Environments
13074 \end_layout
13075
13076 \begin_layout Standard
13077 Most of the environments commonly supported in other classes are also supported
13078  by the 
13079 \family sans
13080 foils
13081 \family default
13082  class.
13083  There are several additional environments provided by 
13084 \family sans
13085 Foil
13086 \family default
13087 TeX as well as a couple added by LyX.
13088  The following environments are shared with other classes:
13089 \end_layout
13090
13091 \begin_layout Standard
13092 \begin_inset ERT
13093 status inlined
13094
13095 \begin_layout Standard
13096
13097
13098 \backslash
13099 begin{multicols}{2}
13100 \end_layout
13101
13102 \end_inset
13103
13104
13105 \end_layout
13106
13107 \begin_layout Itemize
13108
13109 \family sans
13110 Standard
13111 \end_layout
13112
13113 \begin_layout Itemize
13114
13115 \family sans
13116 Itemize
13117 \end_layout
13118
13119 \begin_layout Itemize
13120
13121 \family sans
13122 Enumerate
13123 \end_layout
13124
13125 \begin_layout Itemize
13126
13127 \family sans
13128 Description
13129 \end_layout
13130
13131 \begin_layout Itemize
13132
13133 \family sans
13134 List
13135 \end_layout
13136
13137 \begin_layout Itemize
13138
13139 \family sans
13140 LyX-Code
13141 \end_layout
13142
13143 \begin_layout Itemize
13144
13145 \family sans
13146 Verse
13147 \end_layout
13148
13149 \begin_layout Itemize
13150
13151 \family sans
13152 Quote
13153 \end_layout
13154
13155 \begin_layout Itemize
13156
13157 \family sans
13158 Quotation
13159 \end_layout
13160
13161 \begin_layout Itemize
13162
13163 \family sans
13164 Title
13165 \end_layout
13166
13167 \begin_layout Itemize
13168
13169 \family sans
13170 Author
13171 \end_layout
13172
13173 \begin_layout Itemize
13174
13175 \family sans
13176 Date
13177 \end_layout
13178
13179 \begin_layout Itemize
13180
13181 \family sans
13182 Abstract
13183 \end_layout
13184
13185 \begin_layout Itemize
13186
13187 \family sans
13188 Bibliography
13189 \end_layout
13190
13191 \begin_layout Itemize
13192
13193 \family sans
13194 Address
13195 \end_layout
13196
13197 \begin_layout Itemize
13198
13199 \family sans
13200 RightAddress
13201 \end_layout
13202
13203 \begin_layout Itemize
13204
13205 \family sans
13206 Caption
13207 \end_layout
13208
13209 \begin_layout Itemize
13210
13211 \family sans
13212 Comment
13213 \end_layout
13214
13215 \begin_layout Standard
13216 \begin_inset ERT
13217 status inlined
13218
13219 \begin_layout Standard
13220
13221
13222 \backslash
13223 end{multicols}
13224 \end_layout
13225
13226 \end_inset
13227
13228
13229 \end_layout
13230
13231 \begin_layout Standard
13232 That is, all the major environments apart from the sectioning environments.
13233  Since foils are essentially self-contained sections, with a title and body,
13234  
13235 \family sans
13236 Foil
13237 \family default
13238 TeX provides specific commands for starting new foils and these are:
13239 \end_layout
13240
13241 \begin_layout Itemize
13242
13243 \family sans
13244 Foilhead
13245 \end_layout
13246
13247 \begin_layout Itemize
13248
13249 \family sans
13250 Rotatefoilhead
13251 \end_layout
13252
13253 \begin_layout Standard
13254 LyX also provides slightly modified versions of these two environments called:
13255 \end_layout
13256
13257 \begin_layout Itemize
13258
13259 \family sans
13260 ShortFoilhead
13261 \end_layout
13262
13263 \begin_layout Itemize
13264
13265 \family sans
13266 ShortRotatefoilhead
13267 \end_layout
13268
13269 \begin_layout Standard
13270 and the differences will be explained in the next section.
13271 \end_layout
13272
13273 \begin_layout Standard
13274 Since foils are often used in presenting ideas or new theorems and such
13275  
13276 \family sans
13277 Foil
13278 \family default
13279 TeX also provides a comprehensive box of goodies for presenting them:
13280 \end_layout
13281
13282 \begin_layout Standard
13283 \begin_inset ERT
13284 status inlined
13285
13286 \begin_layout Standard
13287
13288
13289 \backslash
13290 begin{multicols}{2}
13291 \end_layout
13292
13293 \end_inset
13294
13295
13296 \end_layout
13297
13298 \begin_layout Itemize
13299
13300 \family sans
13301 Theorem
13302 \end_layout
13303
13304 \begin_layout Itemize
13305
13306 \family sans
13307 Lemma
13308 \end_layout
13309
13310 \begin_layout Itemize
13311
13312 \family sans
13313 Corollary
13314 \end_layout
13315
13316 \begin_layout Itemize
13317
13318 \family sans
13319 Proposition
13320 \end_layout
13321
13322 \begin_layout Itemize
13323
13324 \family sans
13325 Definition
13326 \end_layout
13327
13328 \begin_layout Itemize
13329
13330 \family sans
13331 Proof
13332 \end_layout
13333
13334 \begin_layout Itemize
13335
13336 \family sans
13337 Theorem*
13338 \end_layout
13339
13340 \begin_layout Itemize
13341
13342 \family sans
13343 Lemma*
13344 \end_layout
13345
13346 \begin_layout Itemize
13347
13348 \family sans
13349 Corollary*
13350 \end_layout
13351
13352 \begin_layout Itemize
13353
13354 \family sans
13355 Proposition*
13356 \end_layout
13357
13358 \begin_layout Itemize
13359
13360 \family sans
13361 Definition*
13362 \end_layout
13363
13364 \begin_layout Standard
13365 \begin_inset ERT
13366 status inlined
13367
13368 \begin_layout Standard
13369
13370
13371 \backslash
13372 end{multicols}
13373 \end_layout
13374
13375 \end_inset
13376
13377
13378 \end_layout
13379
13380 \begin_layout Standard
13381 The starred versions are unnumbered while the unstarred versions are numbered.
13382  There are also two list environments added by LyX and these are:
13383 \end_layout
13384
13385 \begin_layout Itemize
13386
13387 \family sans
13388 TickList
13389 \end_layout
13390
13391 \begin_layout Itemize
13392
13393 \family sans
13394 CrossList
13395 \end_layout
13396
13397 \begin_layout Standard
13398
13399 \family sans
13400 Foil
13401 \family default
13402 TeX provides some powerful header and footer capabilities that are best
13403  set in the preamble although they may be set at any point in a document.
13404  If you want to change these settings in your document the best place to
13405  do so is at the very top of a foil, 
13406 \emph on
13407 i.e.
13408
13409 \emph default
13410  straight after the foilhead.
13411 \end_layout
13412
13413 \begin_layout Standard
13414 For this purpose, the following command styles are provided [
13415 \shape smallcaps
13416 Martin Vermeer
13417 \shape default
13418 ]:
13419 \end_layout
13420
13421 \begin_layout Standard
13422 \begin_inset ERT
13423 status inlined
13424
13425 \begin_layout Standard
13426
13427
13428 \backslash
13429 begin{multicols}{2}
13430 \end_layout
13431
13432 \end_inset
13433
13434
13435 \end_layout
13436
13437 \begin_layout Itemize
13438
13439 \family sans
13440 My\InsetSpace ~
13441 Logo
13442 \end_layout
13443
13444 \begin_layout Itemize
13445
13446 \family sans
13447 Restriction
13448 \end_layout
13449
13450 \begin_layout Itemize
13451
13452 \family sans
13453 Right\InsetSpace ~
13454 Footer
13455 \end_layout
13456
13457 \begin_layout Itemize
13458
13459 \family sans
13460 Right\InsetSpace ~
13461 Header
13462 \end_layout
13463
13464 \begin_layout Itemize
13465
13466 \family sans
13467 Left\InsetSpace ~
13468 Header
13469 \end_layout
13470
13471 \begin_deeper
13472 \begin_layout Standard
13473 \InsetSpace ~
13474
13475 \end_layout
13476
13477 \end_deeper
13478 \begin_layout Standard
13479 \begin_inset ERT
13480 status inlined
13481
13482 \begin_layout Standard
13483
13484
13485 \backslash
13486 end{multicols}
13487 \end_layout
13488
13489 \end_inset
13490
13491
13492 \end_layout
13493
13494 \begin_layout Standard
13495 There are also a few commands provided by 
13496 \family sans
13497 Foil
13498 \family default
13499 TeX that aren't directly supported by LyX but I'll tell you what they do
13500  and how to use them in section\InsetSpace ~
13501
13502 \begin_inset LatexCommand \ref{sec:unsuppfoils}
13503
13504 \end_inset
13505
13506 .
13507 \end_layout
13508
13509 \begin_layout Subsection
13510 Building a Set of Foils
13511 \end_layout
13512
13513 \begin_layout Standard
13514 This section will give a simple introduction to using the different environments
13515  to build a set of foils.
13516  If you want to see an example set of foils take a look at the 
13517 \family typewriter
13518 Foils.lyx
13519 \family default
13520  file accessible from the 
13521 \family sans
13522 \bar under
13523 F
13524 \bar default
13525 ile\SpecialChar \menuseparator
13526
13527 \bar under
13528 O
13529 \bar default
13530 pen\SpecialChar \ldots{}
13531
13532 \family default
13533  dialog under the 
13534 \family sans
13535 Examples
13536 \family default
13537  button.
13538  
13539 \end_layout
13540
13541 \begin_layout Subsubsection
13542 Give It a Title Page
13543 \end_layout
13544
13545 \begin_layout Standard
13546 Unlike other classes that provide 
13547 \family sans
13548 Title
13549 \family default
13550
13551 \family sans
13552 Author
13553 \family default
13554
13555 \family sans
13556 Date
13557 \family default
13558  and 
13559 \family sans
13560 Abstract
13561 \family default
13562  environments, 
13563 \family sans
13564 foils
13565 \family default
13566  creates the title on a page of its own.
13567  If you leave out the 
13568 \family sans
13569 Date
13570 \family default
13571  environment LaTeX will substitute the current date (every time you regenerate
13572  the output).
13573 \end_layout
13574
13575 \begin_layout Subsubsection
13576 Start a New Foil
13577 \end_layout
13578
13579 \begin_layout Standard
13580 As I mentioned earlier, there are four ways of starting a new foil.
13581  For portrait foils you should use 
13582 \family sans
13583 Foilhead
13584 \family default
13585  or 
13586 \family sans
13587 ShortFoilhead.
13588
13589 \family default
13590  The difference between these two environments is the amount of space between
13591  the title of the foil (the foilhead) and the body of the foil.
13592 \end_layout
13593
13594 \begin_layout Standard
13595 Landscape foils are generated using the 
13596 \family sans
13597 Rotatefoilhead
13598 \family default
13599  and 
13600 \family sans
13601 ShortRotatefoilhead
13602 \family default
13603  environments.
13604  Again the only difference is the spacing between foilhead and body.
13605  Both of the short versions have 0.5 inches less separation between the foilhead
13606  and the body.
13607  
13608 \end_layout
13609
13610 \begin_layout Standard
13611 One problem with the support for landscape foils is the requirement that
13612  you have to use the 
13613 \family typewriter
13614 dvips
13615 \family default
13616  driver to generate the PostScript® output otherwise the foils won't be
13617  rotated.
13618  It is possible to get landscape foils even if you haven't got the 
13619 \family typewriter
13620 dvips
13621 \family default
13622  driver provided you can feed your foils sideways through your printer ;-)
13623 \end_layout
13624
13625 \begin_layout Subsubsection
13626 Theorems, Lemmas, Proofs and more
13627 \end_layout
13628
13629 \begin_layout Standard
13630 Due to a small bug in LyX you can't have two of the same type of these environme
13631 nts directly following each other.
13632  They must be separated by something.
13633  If you try, you will just be extending the previous environment as if you
13634  had merged the two environments together.
13635  So, how do you get around this problem? The simplest option is to insert
13636  some text between the two environments or add a 
13637 \family sans
13638 LaTeX
13639 \family default
13640  environment between the two with just a 
13641 \begin_inset Quotes eld
13642 \end_inset
13643
13644
13645 \family typewriter
13646 %
13647 \family default
13648
13649 \begin_inset Quotes erd
13650 \end_inset
13651
13652  in it.
13653  This will force LyX to produce two separate environments and hence the
13654  correct LaTeX output.
13655  An example is provided in the example file included with the LyX distribution.
13656  Remember, this problem only occurs if you are trying to place two of the
13657  same type of theorem-like environments one directly after the other.
13658 \end_layout
13659
13660 \begin_layout Subsubsection
13661 Lists
13662 \end_layout
13663
13664 \begin_layout Standard
13665 You get all the commonly supported list styles found in other classes as
13666  well as two new ones.
13667  I'll only describe the new ones here.
13668  If you want to find out more about the other list environments check out
13669  the 
13670 \emph on
13671 User's Guide.
13672
13673 \emph default
13674  If you intend to use itemized lists you might also want to read about the
13675  
13676 \family sans
13677 Itemize\InsetSpace ~
13678 Bullet\InsetSpace ~
13679 Selection
13680 \family default
13681  dialog described above in section\InsetSpace ~
13682
13683 \begin_inset LatexCommand \ref{sec:bullet}
13684
13685 \end_inset
13686
13687 .
13688 \end_layout
13689
13690 \begin_layout Standard
13691 The two new list styles, 
13692 \family sans
13693 TickList 
13694 \family default
13695 and 
13696 \family sans
13697 CrossList
13698 \family default
13699 , are designed to make it easier for you to create lists of do's and don'ts
13700  or right and wrong by providing dedicated environments that use a tick
13701  or a cross as the label of the list.
13702  These lists are in fact dedicated variants of the 
13703 \family sans
13704 Itemize
13705 \family default
13706  environment.
13707  They do however require that you have the 
13708 \family typewriter
13709 psnfss
13710 \family default
13711  packages installed.
13712 \end_layout
13713
13714 \begin_layout Subsubsection
13715 Figures and Tables
13716 \end_layout
13717
13718 \begin_layout Standard
13719
13720 \family sans
13721 Foil
13722 \family default
13723 TeX redefines the floating tables and figures so that they appear exactly
13724  where they are in the text rather than pushing them to the top of the page
13725  or to some user specified location.
13726  In fact if you change the float placement settings they are simply ignored.
13727 \end_layout
13728
13729 \begin_layout Subsubsection
13730 Page Headers and Footers
13731 \begin_inset LatexCommand \label{sec:foilfoot}
13732
13733 \end_inset
13734
13735
13736 \end_layout
13737
13738 \begin_layout Standard
13739
13740 \family sans
13741 My\InsetSpace ~
13742 Logo
13743 \family default
13744  and 
13745 \family sans
13746 Restriction
13747 \family default
13748  are two commands used to control the left-footer text string.
13749  The first is meant to allow you to include a graphic logo on your foils
13750  and defaults to 
13751 \begin_inset Quotes eld
13752 \end_inset
13753
13754 -Typeset by 
13755 \family sans
13756 Foil
13757 \family default
13758 TeX-
13759 \begin_inset Quotes erd
13760 \end_inset
13761
13762 .
13763  While the second is meant to provide a classification for the audience,
13764  
13765 \emph on
13766 e.g.
13767
13768 \emph default
13769  Confidential.
13770  It is empty by default.
13771 \end_layout
13772
13773 \begin_layout Standard
13774 The remaining page corners can be filled by
13775 \family sans
13776  Right\InsetSpace ~
13777 Footer
13778 \family default
13779  (which defaults to page numbers), 
13780 \family sans
13781 Right\InsetSpace ~
13782 Header
13783 \family default
13784  (top right) and 
13785 \family sans
13786 Left\InsetSpace ~
13787 Header
13788 \family default
13789  (top left).
13790 \end_layout
13791
13792 \begin_layout Subsection
13793 Unsupported 
13794 \family sans
13795 Foil
13796 \family default
13797 TeX Goodies
13798 \begin_inset LatexCommand \label{sec:unsuppfoils}
13799
13800 \end_inset
13801
13802
13803 \end_layout
13804
13805 \begin_layout Standard
13806 All the commands mentioned below need to be set in a 
13807 \family sans
13808 LaTeX
13809 \family default
13810  environment or as 
13811 \family sans
13812 TeX
13813 \family default
13814  within another environment.
13815 \end_layout
13816
13817 \begin_layout Subsubsection
13818 Lengths
13819 \end_layout
13820
13821 \begin_layout Standard
13822 All lengths are adjusted using the 
13823 \family typewriter
13824
13825 \backslash
13826 setlength{
13827 \family default
13828 \emph on
13829 lengthname
13830 \family typewriter
13831 \emph default
13832 }{
13833 \family default
13834 \emph on
13835 newlength
13836 \family typewriter
13837 \emph default
13838 }
13839 \family default
13840  command.
13841  Where 
13842 \emph on
13843 lengthname
13844 \emph default
13845  should be replaced by the name given to the length you want to change and
13846  
13847 \emph on
13848 newlength
13849 \emph default
13850  is the length value.
13851  All lengths should be specified in units of length such as inches (
13852 \family typewriter
13853 in
13854 \family default
13855 ), millimeters (
13856 \family typewriter
13857 mm
13858 \family default
13859 ) or points (
13860 \family typewriter
13861 pt
13862 \family default
13863 ) or relative to some document or font-based length such as 
13864 \family typewriter
13865
13866 \backslash
13867 textwidth
13868 \family default
13869 .
13870  
13871 \end_layout
13872
13873 \begin_layout Standard
13874 It's possible to change the spacing between a foilhead and the body of the
13875  foil by adjusting the length specified by 
13876 \family typewriter
13877
13878 \backslash
13879 foilheadskip
13880 \family default
13881 .
13882  For example, to make 
13883 \emph on
13884 all
13885 \emph default
13886  foilheads 0.5 inches closer to their bodies put the following in the preamble:
13887  
13888 \family typewriter
13889
13890 \backslash
13891 setlength{
13892 \backslash
13893 foilheadskip}{-0.5in}
13894 \end_layout
13895
13896 \begin_layout Standard
13897 The spacings around floats can be adjusted by setting these lengths:
13898 \end_layout
13899
13900 \begin_layout List
13901 \labelwidthstring MMMMMMMMMMM
13902
13903 \family typewriter
13904
13905 \backslash
13906 abovefloatskip 
13907 \family default
13908 Separation between the text and the top of the float
13909 \end_layout
13910
13911 \begin_layout List
13912 \labelwidthstring MMMMMMMMMMM
13913
13914 \family typewriter
13915
13916 \backslash
13917 abovecaptionskip 
13918 \family default
13919 Separation between the float and the caption
13920 \end_layout
13921
13922 \begin_layout List
13923 \labelwidthstring MMMMMMMMMMM
13924
13925 \family typewriter
13926
13927 \backslash
13928 belowcaptionskip 
13929 \family default
13930 Separation between the caption and the following text
13931 \end_layout
13932
13933 \begin_layout List
13934 \labelwidthstring MMMMMMMMMMM
13935
13936 \family typewriter
13937
13938 \backslash
13939 captionwidth
13940 \family default
13941  You can make the captions narrower than the surrounding text by adjusting
13942  this length.
13943  Best done relative to 
13944 \family typewriter
13945
13946 \backslash
13947 textwidth
13948 \family default
13949 .
13950 \end_layout
13951
13952 \begin_layout Standard
13953 There are also several title page related lengths that you may find useful
13954  if you have a long title or several authors:
13955 \end_layout
13956
13957 \begin_layout List
13958 \labelwidthstring MMMMMMMMMMM
13959
13960 \family typewriter
13961
13962 \backslash
13963 abovetitleskip
13964 \family default
13965  Separation from headers to 
13966 \family sans
13967 Title
13968 \end_layout
13969
13970 \begin_layout List
13971 \labelwidthstring MMMMMMMMMMM
13972
13973 \family typewriter
13974
13975 \backslash
13976 titleauthorskip
13977 \family default
13978  between 
13979 \family sans
13980 Title
13981 \family default
13982  and 
13983 \family sans
13984 Author
13985 \family default
13986  environments
13987 \end_layout
13988
13989 \begin_layout List
13990 \labelwidthstring MMMMMMMMMMM
13991
13992 \family typewriter
13993
13994 \backslash
13995 authorauthorskip
13996 \family default
13997  between multiple 
13998 \family sans
13999 Author
14000 \family default
14001  lines
14002 \end_layout
14003
14004 \begin_layout List
14005 \labelwidthstring MMMMMMMMMMM
14006
14007 \family typewriter
14008
14009 \backslash
14010 authordateskip
14011 \family default
14012  between the 
14013 \family sans
14014 Author
14015 \family default
14016  and the 
14017 \family sans
14018 Date
14019 \end_layout
14020
14021 \begin_layout List
14022 \labelwidthstring MMMMMMMMMMM
14023
14024 \family typewriter
14025
14026 \backslash
14027 dateabstractskip
14028 \family default
14029  between the 
14030 \family sans
14031 Date
14032 \family default
14033  and the 
14034 \family sans
14035 Abstract
14036 \end_layout
14037
14038 \begin_layout Standard
14039 The last length related command affects all the list environments.
14040  If you place
14041 \family typewriter
14042  
14043 \backslash
14044 zerolistvertdimens
14045 \family default
14046  
14047 \emph on
14048 inside
14049 \emph default
14050  a list environment then all the vertical spacing between the list items
14051  is removed.
14052  Note that this is a command not a length so it doesn't require 
14053 \family typewriter
14054
14055 \backslash
14056 setlength
14057 \family default
14058  like the stuff mentioned above.
14059 \end_layout
14060
14061 \begin_layout Subsubsection
14062 Headers and Footers
14063 \end_layout
14064
14065 \begin_layout Standard
14066 The 
14067 \family typewriter
14068
14069 \backslash
14070 LogoOn
14071 \family default
14072  and 
14073 \family typewriter
14074
14075 \backslash
14076 LogoOff
14077 \family default
14078  commands control whether the logo in the 
14079 \family sans
14080 MyLogo
14081 \family default
14082  definition appear on a given page.
14083  If you put 
14084 \family typewriter
14085
14086 \backslash
14087 LogoOff
14088 \family default
14089  in the preamble then none of the foils will have the logo on them.
14090  If you don't want the logo on a particular page place the 
14091 \family typewriter
14092
14093 \backslash
14094 LogoOff
14095 \family default
14096  directly after the foilhead of that page and the 
14097 \family typewriter
14098
14099 \backslash
14100 LogoOn
14101 \family default
14102  directly after the next foilhead.
14103 \end_layout
14104
14105 \begin_layout Standard
14106 If you decide to use the 
14107 \family sans
14108 fancy
14109 \family default
14110  page style setting in the 
14111 \family sans
14112 Document\InsetSpace ~
14113 Layout
14114 \family default
14115  dialog you should probably add 
14116 \family typewriter
14117
14118 \backslash
14119 let
14120 \backslash
14121 headwidth
14122 \backslash
14123 textwidth
14124 \family default
14125  to your preamble so headers and footers on landscape pages are correctly
14126  placed when rotated.
14127  This is due to some clashes between the page layouts provided by the 
14128 \family sans
14129 fancyheadings
14130 \family default
14131  package and the 
14132 \family sans
14133 foils
14134 \family default
14135  class.
14136 \end_layout
14137
14138 \begin_layout Section
14139 Latex8 (IEEE Conference Papers)
14140 \end_layout
14141
14142 \begin_layout Standard
14143 by 
14144 \noun on
14145 Allan Rae
14146 \end_layout
14147
14148 \begin_layout Subsection
14149 Introduction
14150 \end_layout
14151
14152 \begin_layout Standard
14153 Since this class is specifically for writing submissions to IEEE sponsored
14154  conferences I strongly recommend that you get a copy of their Authors Kit.
14155  The 
14156 \family sans
14157 latex.sty
14158 \family default
14159  package and associated bibliography style file is included in the kit.
14160  The Authors Kit is usually sent out by email once your initial submission
14161  has been accepted.
14162  There is a lot of useful information in the Authors Kit explaining formatting
14163  restrictions and so on and I will assume you have read this since that
14164  means I don't have to repeat it all here.
14165 \end_layout
14166
14167 \begin_layout Subsection
14168 Getting Started
14169 \end_layout
14170
14171 \begin_layout Standard
14172 [AR\SpecialChar \@.
14173  more to come]
14174 \end_layout
14175
14176 \begin_layout Subsection
14177 Supported Environments
14178 \end_layout
14179
14180 \begin_layout Itemize
14181
14182 \family sans
14183 Standard
14184 \end_layout
14185
14186 \begin_layout Itemize
14187
14188 \family sans
14189 Title
14190 \end_layout
14191
14192 \begin_layout Itemize
14193
14194 \family sans
14195 Author
14196 \end_layout
14197
14198 \begin_layout Itemize
14199
14200 \family sans
14201 E-mail
14202 \end_layout
14203
14204 \begin_layout Itemize
14205
14206 \family sans
14207 Affiliation
14208 \end_layout
14209
14210 \begin_layout Itemize
14211
14212 \family sans
14213 Abstract
14214 \end_layout
14215
14216 \begin_layout Itemize
14217
14218 \family sans
14219 Section
14220 \end_layout
14221
14222 \begin_layout Itemize
14223
14224 \family sans
14225 SubSection
14226 \end_layout
14227
14228 \begin_layout Itemize
14229
14230 \family sans
14231 Caption
14232 \end_layout
14233
14234 \begin_layout Subsection
14235 Differences Between Screen and Paper
14236 \end_layout
14237
14238 \begin_layout Standard
14239 There are slight differences in appearance mainly with the presentation
14240  of section counters.
14241  On screen the trailing period of the section counter is missing but it
14242  will appear in the output so don't let this worry you.
14243 \end_layout
14244
14245 \begin_layout Section
14246 Hollywood (Hollywood spec scripts)
14247 \end_layout
14248
14249 \begin_layout Standard
14250 by 
14251 \shape smallcaps
14252 Garst Reese
14253 \end_layout
14254
14255 \begin_layout Subsection
14256 Introduction
14257 \end_layout
14258
14259 \begin_layout Standard
14260 Getting the format of a Hollywood script right is a 
14261 \begin_inset Quotes eld
14262 \end_inset
14263
14264 rite of passage.
14265 \begin_inset Quotes erd
14266 \end_inset
14267
14268  It is designed to make the readers focus on content and to be easy and
14269  familiar for the actors to read.
14270  Each page of a script should be one minute of film.
14271  Nothing goes in a script that you cannot see or hear on screen.
14272  The courier 12 pt font should be used throughout.
14273  No italics.
14274 \end_layout
14275
14276 \begin_layout Subsection
14277 Special problems
14278 \end_layout
14279
14280 \begin_layout Standard
14281 Speakers' lines should NEVER break in mid-sentence.
14282  If a speaker's lines continue over a page break, repeat the 
14283 \family sans
14284 Speaker
14285 \family default
14286  title followed by (Cont'd).
14287 \end_layout
14288
14289 \begin_layout Subsection
14290 Special features
14291 \end_layout
14292
14293 \begin_layout Standard
14294 Insert the 
14295 \family sans
14296 Speaker
14297 \family default
14298  names as labels then cross-reference the label to insert the name.
14299  The cross-reference dialog will show the current cast of characters.
14300  You can use this to insert the speaker name in narratives also.
14301 \end_layout
14302
14303 \begin_layout Subsection
14304 Paper size and Margins
14305 \end_layout
14306
14307 \begin_layout Standard
14308 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
14309 \end_layout
14310
14311 \begin_layout Subsection
14312 Environments
14313 \end_layout
14314
14315 \begin_layout Standard
14316 The following environments are available.
14317  You can use hollywood.bind to get the bind keys shown at the right.
14318 \end_layout
14319
14320 \begin_layout Itemize
14321
14322 \family sans
14323 Standard
14324 \newline
14325
14326 \family default
14327 Used where nothing else works.
14328  Try to avoid it.
14329 \end_layout
14330
14331 \begin_layout Itemize
14332
14333 \family sans
14334 FADE_IN
14335 \family default
14336 :
14337 \hfill
14338
14339 \family sans
14340 M-z S-I
14341 \family default
14342
14343 \newline
14344 Usually followed by something like 
14345 \begin_inset Quotes eld
14346 \end_inset
14347
14348 on Sally waking up.
14349 \begin_inset Quotes erd
14350 \end_inset
14351
14352
14353 \end_layout
14354
14355 \begin_layout Itemize
14356
14357 \family sans
14358 INT:
14359 \hfill
14360 M-z i
14361 \newline
14362
14363 \family default
14364 Introduces a new INTERIOR camera set-up.
14365  Always followed by DAY or NIGHT, or something similar to define the lighting
14366  required.
14367  Everthing on this line in CAPS.
14368 \end_layout
14369
14370 \begin_layout Itemize
14371
14372 \family sans
14373 EXT:
14374 \hfill
14375 M-z e
14376 \newline
14377
14378 \family default
14379 Introduces a new EXTERIOR camera set-up.
14380  Everthing on this line in CAPS.
14381 \end_layout
14382
14383 \begin_layout Itemize
14384
14385 \family sans
14386 Speaker
14387 \hfill
14388 M-z s
14389 \newline
14390
14391 \family default
14392 The character speaking.
14393 \end_layout
14394
14395 \begin_layout Itemize
14396
14397 \family sans
14398 Parenthetical
14399 \hfill
14400 M-z p
14401 \newline
14402
14403 \family default
14404 Instructions to the speaker.
14405  The () are automatically inserted, but only the ( will show in LyX.
14406  Both will be printed.
14407 \end_layout
14408
14409 \begin_layout Itemize
14410
14411 \family sans
14412 Dialogue
14413 \hfill
14414 M-z d
14415 \newline
14416
14417 \family default
14418 What the 
14419 \family sans
14420 Speaker
14421 \family default
14422  says.
14423 \end_layout
14424
14425 \begin_layout Itemize
14426
14427 \family sans
14428 Transition
14429 \hfill
14430 M-z t
14431 \newline
14432
14433 \family default
14434 Camera movement instruction.
14435  e.g.
14436  CUT TO:
14437 \end_layout
14438
14439 \begin_layout Itemize
14440
14441 \family sans
14442 FADE OUT:
14443 \hfill
14444 M-z S-I
14445 \end_layout
14446
14447 \begin_layout Itemize
14448
14449 \family sans
14450 Author
14451 \hfill
14452 M-z S-A
14453 \end_layout
14454
14455 \begin_layout Itemize
14456
14457 \family sans
14458 Title
14459 \hfill
14460 M-z S-T
14461 \end_layout
14462
14463 \begin_layout Itemize
14464
14465 \family sans
14466 Right_Address
14467 \hfill
14468 M-z r
14469 \end_layout
14470
14471 \begin_layout Subsection
14472 Script jargon
14473 \end_layout
14474
14475 \begin_layout Itemize
14476 (O.S) --- off screen
14477 \end_layout
14478
14479 \begin_layout Itemize
14480 (V.0) --- voice over
14481 \end_layout
14482
14483 \begin_layout Itemize
14484 b.g.
14485  --- background
14486 \end_layout
14487
14488 \begin_layout Itemize
14489 C.U.
14490  --- close-up
14491 \end_layout
14492
14493 \begin_layout Itemize
14494 PAN --- camera movement
14495 \end_layout
14496
14497 \begin_layout Itemize
14498 INSERT --- cut to close-up of
14499 \end_layout
14500
14501 \begin_layout Section
14502 Broadway
14503 \end_layout
14504
14505 \begin_layout Standard
14506 by 
14507 \shape smallcaps
14508 Garst Reese
14509 \end_layout
14510
14511 \begin_layout Subsection
14512 Introduction
14513 \end_layout
14514
14515 \begin_layout Standard
14516 Broadway is for writing plays.
14517  The format is more decorative than Hollywood, and much less standardized.
14518  This format should be suitable for workshops.
14519 \end_layout
14520
14521 \begin_layout Subsection
14522 Special problems
14523 \end_layout
14524
14525 \begin_layout Standard
14526 The same as in Hollywood.
14527 \end_layout
14528
14529 \begin_layout Subsection
14530 Special features
14531 \end_layout
14532
14533 \begin_layout Standard
14534 Insert the 
14535 \family sans
14536 Speaker
14537 \family default
14538  names as labels then cross-reference the label to insert the name.
14539  The cross-reference dialog will show the current cast of characters.
14540 \end_layout
14541
14542 \begin_layout Subsection
14543 Paper size and Margins
14544 \end_layout
14545
14546 \begin_layout Standard
14547 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
14548 \end_layout
14549
14550 \begin_layout Subsection
14551 Environments
14552 \end_layout
14553
14554 \begin_layout Standard
14555 The following environments are available.
14556  You can use broadway.bind to get the bind keys shown at the right.
14557 \end_layout
14558
14559 \begin_layout Itemize
14560
14561 \family sans
14562 Standard
14563 \newline
14564
14565 \family default
14566 You should not have to use this, but it is here for anything that does not
14567  fit otherwise.
14568 \end_layout
14569
14570 \begin_layout Itemize
14571
14572 \family sans
14573 Narrative
14574 \hfill
14575 M-z n
14576 \newline
14577
14578 \family default
14579 Used to describe stage setting and the action.
14580  First use of speaker names in all CAPs.
14581 \end_layout
14582
14583 \begin_layout Itemize
14584
14585 \family sans
14586 ACT
14587 \hfill
14588 M-z a
14589 \newline
14590
14591 \family default
14592 Automatically numbered.
14593  On screen it will be arabic, but will print as Roman.
14594 \end_layout
14595
14596 \begin_layout Itemize
14597
14598 \family sans
14599 ACT*
14600 \hfill
14601 M-z S at
14602 \newline
14603
14604 \family default
14605 Subtitle for 
14606 \family sans
14607 ACT.
14608  
14609 \family default
14610 It is just centered text.
14611 \end_layout
14612
14613 \begin_layout Itemize
14614
14615 \family sans
14616 SCENE
14617 \hfill
14618 M-z S-S
14619 \newline
14620
14621 \family default
14622 Not automatically numbered.
14623  You supply the number.
14624  This is because I couldn't figure out how.
14625 \end_layout
14626
14627 \begin_layout Itemize
14628
14629 \family sans
14630 AT_RISE:
14631 \hfill
14632 M-z S-R
14633 \newline
14634
14635 \family default
14636 A special case of Narrative to describe the setting and action as the curtain
14637  rises.
14638 \end_layout
14639
14640 \begin_layout Itemize
14641
14642 \family sans
14643 Speaker
14644 \hfill
14645 M-z s
14646 \newline
14647
14648 \family default
14649 The speaker's (actor's) title, centered in all CAPS.
14650 \end_layout
14651
14652 \begin_layout Itemize
14653
14654 \family sans
14655 Parenthetical
14656 \hfill
14657 M-z p
14658 \newline
14659
14660 \family default
14661 Instructions to the speaker.
14662  The parentheses are automatically inserted.
14663  The ( will appear on screen, but both will be in the printed play.
14664  This environment is only used within 
14665 \family sans
14666 Dialogue
14667 \family default
14668 .
14669 \end_layout
14670
14671 \begin_layout Itemize
14672
14673 \family sans
14674 Dialogue
14675 \hfill
14676 M-z d
14677 \newline
14678
14679 \family default
14680 What the Speaker says.
14681 \end_layout
14682
14683 \begin_layout Itemize
14684
14685 \family sans
14686 CURTAIN
14687 \hfill
14688 M-z S-C
14689 \newline
14690
14691 \family default
14692 The curtain comes down.
14693 \end_layout
14694
14695 \begin_layout Itemize
14696
14697 \family sans
14698 Title
14699 \hfill
14700 M-z S-T
14701 \end_layout
14702
14703 \begin_layout Itemize
14704
14705 \family sans
14706 Author
14707 \hfill
14708 M-z S-A
14709 \end_layout
14710
14711 \begin_layout Itemize
14712
14713 \family sans
14714 Right_Address
14715 \hfill
14716 M-z r
14717 \end_layout
14718
14719 \begin_layout Standard
14720 Hello there.
14721 \end_layout
14722
14723 \begin_layout Section
14724 RevTeX4
14725 \end_layout
14726
14727 \begin_layout Standard
14728 by 
14729 \noun on
14730 Amir Karger
14731 \end_layout
14732
14733 \begin_layout Standard
14734 \begin_inset VSpace bigskip
14735 \end_inset
14736
14737
14738 \end_layout
14739
14740 \begin_layout Standard
14741 \noindent
14742 The 
14743 \family sans
14744 Revtex\InsetSpace ~
14745 4
14746 \family default
14747  textclass works with the American Physical Sociey's RevTeX 4.0 (the 
14748 \begin_inset Formula $\beta$
14749 \end_inset
14750
14751  release of May, 1999) class.
14752 \end_layout
14753
14754 \begin_layout Standard
14755 LyX has a 
14756 \family sans
14757 Revtex
14758 \family default
14759  textclass, which works with RevTeX 3.1.
14760  However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
14761  That means that it doesn't interact very well with LyX, which requires
14762  LaTeX2e, although it has been kludged to work.
14763  Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
14764  LyX with the 
14765 \family sans
14766 RevTeX\InsetSpace ~
14767 4
14768 \family default
14769  textclass should also be pretty easy to use.
14770 \end_layout
14771
14772 \begin_layout Standard
14773 These documents are supposed to be used in 
14774 \emph on
14775 addition
14776 \emph default
14777  to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
14778  macros, and assume you'll know what to put in the preamble if necessary.
14779 \end_layout
14780
14781 \begin_layout Subsection
14782 Installation
14783 \end_layout
14784
14785 \begin_layout Standard
14786 All you need to do is install RevTeX 4, as described in the package's README
14787  file.
14788  the package can be found at 
14789 \begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
14790
14791 \end_inset
14792
14793 .
14794  Install it somewhere that LaTeX can see it.
14795  Test it by trying to LaTeX a short RevTeX 4 document in some random directory
14796  (i.e., not the directory where you installed the class file.) Then, if you
14797  reconfigure LyX, it will find the class file and let you use the RevTeX4
14798  textclass.
14799 \end_layout
14800
14801 \begin_layout Standard
14802 Probably the easiest way to get started is either to import a RevTeX 4 document
14803  using 
14804 \family typewriter
14805 reLyX
14806 \family default
14807 , or to use the 
14808 \family sans
14809 Revtex\InsetSpace ~
14810 4
14811 \family default
14812  template, found in the templates directory.
14813 \end_layout
14814
14815 \begin_layout Subsection
14816 Preamble Matter
14817 \end_layout
14818
14819 \begin_layout Standard
14820 Optional arguments to 
14821 \family typewriter
14822
14823 \backslash
14824 documentclass
14825 \family default
14826 , like 
14827 \begin_inset Quotes eld
14828 \end_inset
14829
14830 preprint
14831 \begin_inset Quotes erd
14832 \end_inset
14833
14834  and 
14835 \begin_inset Quotes eld
14836 \end_inset
14837
14838 aps
14839 \begin_inset Quotes erd
14840 \end_inset
14841
14842 , go in the 
14843 \family sans
14844 E
14845 \bar under
14846 x
14847 \bar default
14848 tra\InsetSpace ~
14849 Options
14850 \family default
14851  field in the 
14852 \family sans
14853 Document\InsetSpace ~
14854 Layout
14855 \family default
14856  dialog, as usual.
14857  Remember that in RevTeX, at least one optional argument is required! 
14858 \end_layout
14859
14860 \begin_layout Standard
14861 Other preamble matter, like 
14862 \family typewriter
14863
14864 \backslash
14865 draft
14866 \family default
14867  etc.
14868  goes in the 
14869 \family sans
14870 Latex\InsetSpace ~
14871 Preamble
14872 \family default
14873  dialog, also as usual.
14874 \end_layout
14875
14876 \begin_layout Subsection
14877 Layouts
14878 \end_layout
14879
14880 \begin_layout Standard
14881 The layouts basically correspond to the commands in RevTeX4.0.
14882  For example, the Email layout corresponds to 
14883 \family typewriter
14884
14885 \backslash
14886 email{}
14887 \family default
14888 .
14889  Note that (at least as of RevTeX 4.0 Beta), the 
14890 \family sans
14891 Address
14892 \family default
14893  and 
14894 \family sans
14895 Affiliation
14896 \family default
14897  layouts are exactly equivalent, so you shouldn't need to use both.
14898 \begin_inset Foot
14899 status collapsed
14900
14901 \begin_layout Standard
14902 In case you're curious, both were included so that 
14903 \family typewriter
14904 reLyX
14905 \family default
14906  would be able to translate both 
14907 \family typewriter
14908
14909 \backslash
14910 address
14911 \family default
14912  and 
14913 \family typewriter
14914
14915 \backslash
14916 affiliation
14917 \family default
14918 .
14919 \end_layout
14920
14921 \end_inset
14922
14923
14924 \end_layout
14925
14926 \begin_layout Subsection
14927 Important Notes
14928 \end_layout
14929
14930 \begin_layout Standard
14931 There are a couple of important unique aspects of RevTeX 4 which might cause
14932  bugs that will be even more confusing in LyX.
14933 \end_layout
14934
14935 \begin_layout Standard
14936 In RevTeX, the 
14937 \family typewriter
14938
14939 \backslash
14940 thanks
14941 \family default
14942  command goes 
14943 \emph on
14944 outside
14945 \emph default
14946  the 
14947 \family typewriter
14948
14949 \backslash
14950 author
14951 \family default
14952  command.
14953  The LyX equivalent is that there is a separate Thanks layout.
14954  Do 
14955 \emph on
14956 not
14957 \emph default
14958  write footnotes in the 
14959 \family sans
14960 Author
14961 \family default
14962  layout, or weird things may happen.
14963  See the RevTeX 4 documentation for more details.
14964 \end_layout
14965
14966 \begin_layout Standard
14967 Also, the 
14968 \family sans
14969 Author\InsetSpace ~
14970 Email
14971 \family default
14972
14973 \family sans
14974 Author\InsetSpace ~
14975 URL
14976 \family default
14977 , and 
14978 \family sans
14979 Thanks
14980 \family default
14981  layouts must be placed 
14982 \emph on
14983 in between
14984 \emph default
14985  the 
14986 \family sans
14987 Author
14988 \family default
14989  layout and the corresponding 
14990 \family sans
14991 Address
14992 \family default
14993  (or equivalent 
14994 \family sans
14995 Affiliation
14996 \family default
14997 ) layout.
14998  If you put the 
14999 \family sans
15000 Thanks
15001 \family default
15002  after the 
15003 \family sans
15004 Address
15005 \family default
15006 , the LaTeX won't compile.
15007 \end_layout
15008
15009 \begin_layout Subsection
15010 Drawbacks
15011 \end_layout
15012
15013 \begin_layout Standard
15014 The main problem with this layout is that you can't use the optional arguments
15015  to layouts like Email and Title.
15016  (The problem is not unique to this layout; you can't use optional arguments
15017  to the Section layouts either.) This means that after you export that file
15018  to LaTeX (which you'll need to do eventually to send it in to APS), you'll
15019  need to edit the LaTeX file with a text editor to add the optional arguments
15020  to set, e.g., the running title for the page headers.
15021  Lacking these layouts makes the 
15022 \family typewriter
15023
15024 \backslash
15025 altaffiliation
15026 \family default
15027  (and the equivalent 
15028 \family typewriter
15029
15030 \backslash
15031 altaddress
15032 \family default
15033 ) useless, so the corresponding layouts don't exist, and will have to be
15034  added by hand.
15035 \begin_inset Foot
15036 status collapsed
15037
15038 \begin_layout Standard
15039
15040 \emph on
15041 Note from JMarc:
15042 \emph default
15043  actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
15044  has not been updated yet to take advantage of it.
15045 \end_layout
15046
15047 \end_inset
15048
15049  
15050 \end_layout
15051
15052 \begin_layout Section
15053 Article (mwart), book (mwbk) and report (mwrep)
15054 \begin_inset OptArg
15055 status collapsed
15056
15057 \begin_layout Standard
15058 The 
15059 \family typewriter
15060 mw
15061 \family default
15062  Classes
15063 \end_layout
15064
15065 \end_inset
15066
15067
15068 \end_layout
15069
15070 \begin_layout Standard
15071 by 
15072 \noun on
15073 Tomasz Luczak
15074 \end_layout
15075
15076 \begin_layout Standard
15077 The LyX document classes
15078 \emph on
15079  article (mwart)
15080 \emph default
15081
15082 \emph on
15083 report (mwrep)
15084 \emph default
15085  and 
15086 \emph on
15087 book
15088 \emph default
15089  
15090 \emph on
15091 (mwbk)
15092 \emph default
15093  correspond to the LaTeX document classes 
15094 \family typewriter
15095 mwart.cls
15096 \family default
15097
15098 \family typewriter
15099 mwrep.cls
15100 \family default
15101  and 
15102 \family typewriter
15103 mwbk.cls
15104 \family default
15105 , resp.
15106  They are replacements for the standard document classes 
15107 \family typewriter
15108 article.cls
15109 \family default
15110
15111 \family typewriter
15112 report.cls
15113 \family default
15114  and 
15115 \family typewriter
15116 book.cls
15117 \family default
15118 , resp., and fit better to Polish typography conventions in a number of points.
15119  
15120 \end_layout
15121
15122 \begin_layout Standard
15123 Basic differences:
15124 \end_layout
15125
15126 \begin_layout Itemize
15127 Unnumbered titles (with star, eg.
15128  
15129 \family sans
15130 Section*
15131 \family default
15132 ) are added into table of contents,
15133 \end_layout
15134
15135 \begin_layout Itemize
15136 Additional page styles:
15137 \end_layout
15138
15139 \begin_deeper
15140 \begin_layout Description
15141 uheadings header with separated lines,
15142 \end_layout
15143
15144 \begin_layout Description
15145 myheadings custom header, contents headers via commands: 
15146 \family typewriter
15147
15148 \backslash
15149 markright
15150 \family default
15151  and 
15152 \family typewriter
15153
15154 \backslash
15155 markboth
15156 \family default
15157 ,
15158 \end_layout
15159
15160 \begin_layout Description
15161 myuheadings custom header with separated lines,
15162 \end_layout
15163
15164 \begin_layout Description
15165 outer page number is placed on outer side of page
15166 \end_layout
15167
15168 \end_deeper
15169 \begin_layout Itemize
15170 Options 
15171 \end_layout
15172
15173 \begin_deeper
15174 \begin_layout Description
15175 rmheadings serif titles --- default,
15176 \end_layout
15177
15178 \begin_layout Description
15179 sfheadings sansserif titles,
15180 \end_layout
15181
15182 \begin_layout Description
15183 authortitle on title page first placed is author next title --- default,
15184 \end_layout
15185
15186 \begin_layout Description
15187 titleauthor on title page first placed is title next author,
15188 \end_layout
15189
15190 \begin_layout Description
15191 withmarginpar reserve place on page for margins.
15192 \end_layout
15193
15194 \end_deeper
15195 \begin_layout Section
15196 Elsevier Journals
15197 \end_layout
15198
15199 \begin_layout Standard
15200 By 
15201 \noun on
15202 Rod Pinna
15203 \end_layout
15204
15205 \begin_layout Standard
15206 Elsevier Science Publishers B.V.
15207  provides a standard LaTeX document class (
15208 \family typewriter
15209 elsart.cls
15210 \family default
15211 ) for submitting articles to their various journals.
15212  The style file can be downloaded directly from their web site: 
15213 \begin_inset LatexCommand \url{http://authors.elsevier.com/}
15214
15215 \end_inset
15216
15217 .
15218  Instructions are supplied along with the class file, which details the
15219  requirements of the publishers.
15220  LyX includes package that allows for the use of this class, by a layout
15221  and a template file.
15222  Installation of the class file is the same as for any other LaTeX package;
15223  instructions are provided in the Elsevier documentation.
15224 \end_layout
15225
15226 \begin_layout Standard
15227 To make use of 
15228 \family typewriter
15229 elsart.cls
15230 \family default
15231 , a file 
15232 \family typewriter
15233 elsart.layout
15234 \family default
15235  is supplied.
15236  As the Elsevier class file is based mainly on the standard article class,
15237  most of the normal functionality is provided.
15238  The Elsevier class defines a number of mathematical environments, which
15239  are similar to the AMS environments.
15240  These commands are all described in the Elsevier documentation, and are
15241  available in LyX.
15242 \end_layout
15243
15244 \begin_layout Standard
15245 The easiest way to use the Elsevier style is to base documents on the included
15246  template file.
15247  It is best not to use options such as fancy headings or the geometry package,
15248  as elements such as these are defined by Elsevier in their style file.
15249  Ideally, no extra packages except those mentioned in the Elsevier documentation
15250  should be used.
15251  Essentially, Elsevier require as 
15252 \begin_inset Quotes eld
15253 \end_inset
15254
15255 clean
15256 \begin_inset Quotes erd
15257 \end_inset
15258
15259  a 
15260 \begin_inset ERT
15261 status collapsed
15262
15263 \begin_layout Standard
15264
15265
15266 \backslash
15267 LaTeX
15268 \end_layout
15269
15270 \end_inset
15271
15272  file as possible, as their intention is to take the supplied file and replace
15273  the class file with one for the particular journal to which the paper has
15274  been submitted.
15275  This also means that not too much time should be spent on the formating
15276  of the document.
15277  When it comes to be published, this will change anyway.
15278  The rest of the usage for this layout is substantially the same as for
15279  the normal article class.
15280  For details of what Elsevier do and don't allow, refer to their documentation.
15281 \end_layout
15282
15283 \begin_layout Section
15284 Memoir
15285 \end_layout
15286
15287 \begin_layout Standard
15288 By 
15289 \noun on
15290 Jürgen Spitzmüller
15291 \end_layout
15292
15293 \begin_layout Subsection
15294 Overview
15295 \end_layout
15296
15297 \begin_layout Standard
15298 Memoir is a very powerful and constantly evolving class.
15299  It has been designed with regard to fictional and non-fictional literature.
15300  Its aim is to let the user have maximum control over the typesetting of
15301  his document.
15302  Memoir is based on the standard book class, but it can also emulate the
15303  article class (see below).
15304 \end_layout
15305
15306 \begin_layout Standard
15307 Peter Wilson, the developer of Memoir, is known as the author of lots of
15308  useful packages in the LaTeX world.
15309  Most of them have been merged with Memoir.
15310  Therefore, it is much easier to layout the table of contents, appendices,
15311  chapter designs and such.
15312  LyX, though, does not support all of these goodies natively.
15313  Some of them might be added to forthcoming releases
15314 \begin_inset Foot
15315 status collapsed
15316
15317 \begin_layout Standard
15318 You are invited to send suggestions to 
15319 \begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
15320
15321 \end_inset
15322
15323 .
15324 \end_layout
15325
15326 \end_inset
15327
15328 , lots will probably never, due to the limitations of LyX's framework.
15329  Of course you can still use all features with the help of some native LaTeX
15330  commands (ERT
15331 \begin_inset Foot
15332 status collapsed
15333
15334 \begin_layout Standard
15335 Cf.
15336 \begin_inset ERT
15337 status collapsed
15338
15339 \begin_layout Standard
15340
15341
15342 \backslash
15343  
15344 \end_layout
15345
15346 \end_inset
15347
15348 section\InsetSpace ~
15349
15350 \begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
15351
15352 \end_inset
15353
15354  for details.
15355 \end_layout
15356
15357 \end_inset
15358
15359 ).
15360  In this section, we can only list those features which are natively supported
15361  by LyX.
15362  For detailed descriptions (and for the rest of features) we are recommending
15363  to have a look at the detailed manual of the Memoir class
15364 \begin_inset Foot
15365 status collapsed
15366
15367 \begin_layout Standard
15368 Cf.
15369 \begin_inset ERT
15370 status collapsed
15371
15372 \begin_layout Standard
15373
15374
15375 \backslash
15376  
15377 \end_layout
15378
15379 \end_inset
15380
15381
15382 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
15383
15384 \end_inset
15385
15386 .
15387 \end_layout
15388
15389 \end_inset
15390
15391 , which is not only a user guide for the class, but also both a comprehensive
15392  description on good typesetting and a superb example for good typesetting
15393  itself.
15394 \end_layout
15395
15396 \begin_layout Subsection
15397 Basic features and restrictions
15398 \end_layout
15399
15400 \begin_layout Standard
15401 Memoir supports basically all features of the standard book classes.
15402  There are, however, some differences, as follows:
15403 \end_layout
15404
15405 \begin_layout Description
15406 Font\InsetSpace ~
15407 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
15408  17
15409 \end_layout
15410
15411 \begin_layout Description
15412 Page\InsetSpace ~
15413 style: The fancy page style is not supported, due to a command clash
15414  between Memoir and the fancyhdr package (they are both defining a command
15415  with the same name, which confuses LaTeX).
15416  Instead, Memoir comes with a bunch of own page styles (see 
15417 \family sans
15418 Layout\SpecialChar \menuseparator
15419 Document\SpecialChar \menuseparator
15420 Page\InsetSpace ~
15421 Style
15422 \family default
15423 ).
15424  If you want to use these for the chapter pages, you have to use the command
15425  
15426 \family typewriter
15427
15428 \backslash
15429 chapterstyle
15430 \family default
15431  in the main text or in preamble (e.
15432 \begin_inset ERT
15433 status collapsed
15434
15435 \begin_layout Standard
15436
15437
15438 \backslash
15439 ,
15440 \end_layout
15441
15442 \end_inset
15443
15444 g.
15445 \begin_inset ERT
15446 status collapsed
15447
15448 \begin_layout Standard
15449
15450
15451 \backslash
15452  
15453 \end_layout
15454
15455 \end_inset
15456
15457
15458 \family typewriter
15459
15460 \backslash
15461 chapterstyle{companion}
15462 \family default
15463 ).
15464 \end_layout
15465
15466 \begin_layout Description
15467 Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
15468  an optional argument in the standard classes.
15469  With this, you can specify an alternative version of the title for the
15470  table of contents and the headers (for instance, if the title is too long).
15471  In LyX, you can do this via 
15472 \family sans
15473 Insert\SpecialChar \menuseparator
15474 Short\InsetSpace ~
15475 Title
15476 \family default
15477  at the beginning of a chapter/section.
15478  Memoir features a second optional argument and thus separates the table
15479  of contents from the header.
15480  You can define three variants of a title with this: one for the main text,
15481  one for the table of contents, and one for the headers.
15482  Simply insert two optional arguments if you need this feature, the first
15483  one containing the short title for the Table of Contents, the second one
15484  containing an alternative short title for the headers.
15485 \end_layout
15486
15487 \begin_layout Description
15488 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15489  of contents, the list of figures and the list of table start a new page
15490  automatically.
15491  Memoir does not follow this route.
15492  You have to insert a page break yourself, if you want to have one.
15493 \end_layout
15494
15495 \begin_layout Description
15496 Titlepage: For some unknown reason, Memoir uses pagination on the title
15497  page (in the standard classes, title pages are 
15498 \begin_inset Quotes eld
15499 \end_inset
15500
15501 empty
15502 \begin_inset Quotes erd
15503 \end_inset
15504
15505 , i.
15506 \begin_inset ERT
15507 status collapsed
15508
15509 \begin_layout Standard
15510
15511
15512 \backslash
15513 ,
15514 \end_layout
15515
15516 \end_inset
15517
15518 e.
15519 \begin_inset ERT
15520 status collapsed
15521
15522 \begin_layout Standard
15523
15524
15525 \backslash
15526  
15527 \end_layout
15528
15529 \end_inset
15530
15531 without pagina).
15532  If you want an empty title page, type 
15533 \family typewriter
15534
15535 \backslash
15536 aliaspagestyle{title}{empty} 
15537 \family default
15538 in the preamble.
15539 \end_layout
15540
15541 \begin_layout Description
15542 Article: With the class option 
15543 \emph on
15544 article 
15545 \emph default
15546 (to be inserted in 
15547 \family sans
15548 Layout\SpecialChar \menuseparator
15549 Document\SpecialChar \menuseparator
15550 Extra\InsetSpace ~
15551 Options
15552 \family default
15553 ), you can emulate article style.
15554  That is, counters (footnotes, figures, tables etc.) will not be reset on
15555  new chapters, chapters don't start a new page (but are---in contrary to
15556  
15557 \begin_inset Quotes eld
15558 \end_inset
15559
15560 real
15561 \begin_inset Quotes erd
15562 \end_inset
15563
15564  article classes---still allowed), parts, though, use their own page, as
15565  in book.
15566 \end_layout
15567
15568 \begin_layout Description
15569 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15570  font commands, which have been used in the old LaTeX version 2.09 (e.
15571 \begin_inset ERT
15572 status collapsed
15573
15574 \begin_layout Standard
15575
15576
15577 \backslash
15578 ,
15579 \end_layout
15580
15581 \end_inset
15582
15583 g.
15584 \begin_inset ERT
15585 status collapsed
15586
15587 \begin_layout Standard
15588
15589
15590 \backslash
15591  
15592 \end_layout
15593
15594 \end_inset
15595
15596
15597 \family typewriter
15598
15599 \backslash
15600 rm
15601 \family default
15602
15603 \family typewriter
15604
15605 \backslash
15606 it
15607 \family default
15608 ).
15609  It produces an error and stops LaTeX whenever such a command appears.
15610  The class option 
15611 \emph on
15612 oldfontcommands
15613 \emph default
15614  reallows the commands and spits out warnings instead (which does at least
15615  not stop LaTeX).
15616  Since a lot of packages and particularly BibTeX style files are still using
15617  those commands, we have decided to use this option by default.
15618 \end_layout
15619
15620 \begin_layout Subsection
15621 Extra features
15622 \end_layout
15623
15624 \begin_layout Standard
15625 We will only describe the features supported by LyX (which is not much currently
15626 ).
15627  Please consult the Memoir manual
15628 \begin_inset Foot
15629 status collapsed
15630
15631 \begin_layout Standard
15632 Cf.
15633 \begin_inset ERT
15634 status collapsed
15635
15636 \begin_layout Standard
15637
15638
15639 \backslash
15640  
15641 \end_layout
15642
15643 \end_inset
15644
15645
15646 \begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
15647
15648 \end_inset
15649
15650 .
15651 \end_layout
15652
15653 \end_inset
15654
15655  for details.
15656 \end_layout
15657
15658 \begin_layout Description
15659 Abstract: You may wonder why an abstract is an extra feature.
15660  Well, it is in book class.
15661  Usually books don't have abstracts.
15662  Memoir, however, has.
15663  You can use it whereever and how often you like.
15664 \end_layout
15665
15666 \begin_layout Description
15667 Chapterprecis: You may know this from belletristic: The contents of a chapter
15668  is shortly described below the title and also in the table of contents
15669  (e.
15670 \begin_inset ERT
15671 status collapsed
15672
15673 \begin_layout Standard
15674
15675
15676 \backslash
15677 ,
15678 \end_layout
15679
15680 \end_inset
15681
15682 g.
15683 \begin_inset ERT
15684 status collapsed
15685
15686 \begin_layout Standard
15687
15688
15689 \backslash
15690  
15691 \end_layout
15692
15693 \end_inset
15694
15695
15696 \emph on
15697 Our hero arrives in Troia; he loses some friends; he finds others
15698 \emph default
15699 ).
15700  Chapterprecis does exactly this.
15701  It is therefore only sensible below a chapter.
15702 \end_layout
15703
15704 \begin_layout Description
15705 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15706  The epigraph environment provides an elegant way of typesetting such a
15707  motto.
15708  The motto itself (text) and its author (source) are divided by a short
15709  line.
15710  Unfortunately, we have to fool LyX a bit here again, since the environment
15711  needs two arguments (text and source).
15712  In this case, we have to use curly brackets (in TeX mode) between the two
15713  arguments: 
15714 \emph on
15715 <smart slogan>
15716 \emph default
15717  
15718 \family typewriter
15719 }{
15720 \family default
15721  
15722 \emph on
15723 <author of the slogan>.
15724 \end_layout
15725
15726 \begin_layout Description
15727 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15728  complex figurative poems).
15729  Lyx can only support a few of them.
15730  One is poemtitle, which is a centered title for poems, which will also
15731  be added to the table of contents (verse is the standard environment for
15732  poems.
15733  Memoir has some enhanced versions of verse, but you need to use ERT, because
15734  they have to be nested inside regular verse environments, which is not
15735  possible with LyX).
15736 \end_layout
15737
15738 \begin_layout Description
15739 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15740 \end_layout
15741
15742 \begin_layout Chapter
15743 Importing and Exporting Alternate File Formats
15744 \begin_inset OptArg
15745 status collapsed
15746
15747 \begin_layout Standard
15748 Importing and Exporting
15749 \end_layout
15750
15751 \end_inset
15752
15753
15754 \end_layout
15755
15756 \begin_layout Section
15757 Considerations
15758 \end_layout
15759
15760 \begin_layout Standard
15761 Importing and exporting LyX documents from/to other formats has been touched
15762  on briefly in the 
15763 \emph on
15764 User Guide
15765 \emph default
15766 .
15767  Here we describe more of the gory details needed to understand just what
15768  is going on when you click on the 
15769 \family sans
15770 \bar under
15771 F
15772 \bar default
15773 ile\SpecialChar \menuseparator
15774
15775 \bar under
15776 I
15777 \bar default
15778 mport
15779 \family default
15780  and 
15781 \family sans
15782 \bar under
15783 F
15784 \bar default
15785 ile\SpecialChar \menuseparator
15786 E
15787 \bar under
15788 x
15789 \bar default
15790 port
15791 \family default
15792  menu items.
15793  
15794 \end_layout
15795
15796 \begin_layout Section
15797 Importing Other Formats
15798 \end_layout
15799
15800 \begin_layout Subsection
15801 LaTeX
15802 \end_layout
15803
15804 \begin_layout Standard
15805 Translating from LaTeX into LyX is performed by a Perl script called reLyX.
15806  Although it is a standalone program which can be called from the command
15807  line, LyX will call it automatically when a LaTeX document is imported.
15808  See section\InsetSpace ~
15809
15810 \begin_inset LatexCommand \ref{sec:reLyX}
15811
15812 \end_inset
15813
15814  for a complete description.
15815  There are no user tunable parameters for reLyX within LyX.
15816 \end_layout
15817
15818 \begin_layout Subsection
15819 ASCII Text
15820 \end_layout
15821
15822 \begin_layout Standard
15823 When importing plain ASCII text, there are two methods of reading the file.
15824  Importing 
15825 \begin_inset Quotes eld
15826 \end_inset
15827
15828 as lines
15829 \begin_inset Quotes erd
15830 \end_inset
15831
15832  preserves all the linebreaks in the ASCII; to LyX, then, each line looks
15833  like a paragraph.
15834  Importing 
15835 \begin_inset Quotes eld
15836 \end_inset
15837
15838 as paragraphs
15839 \begin_inset Quotes erd
15840 \end_inset
15841
15842  assumes that consecutive lines separated by only a single linebreak form
15843  a single paragraph.
15844  Successive linebreaks with no intervening text are thus assumed to be paragraph
15845  delimiters.
15846 \end_layout
15847
15848 \begin_layout Subsection
15849 Noweb
15850 \end_layout
15851
15852 \begin_layout Standard
15853
15854 \emph on
15855 [Editor's note: Needs to be written, obviously - any volunteers? --- mer]
15856 \end_layout
15857
15858 \begin_layout Section
15859 Exporting Other Formats
15860 \end_layout
15861
15862 \begin_layout Subsection
15863 LaTeX
15864 \end_layout
15865
15866 \begin_layout Standard
15867 LyX generates two types of LaTeX files: stripped down versions for the normal
15868  processing (
15869 \family sans
15870 View DVI
15871 \family default
15872 , etc.) which one normally never sees
15873 \begin_inset Foot
15874 status collapsed
15875
15876 \begin_layout Standard
15877 The resulting file is a perfectly valid LaTeX file, though the preamble
15878  might look a bit strange since it includes some definitions used by LyX
15879  which wouldn't show up in most human-written files.
15880 \end_layout
15881
15882 \end_inset
15883
15884 , and human readable forms which are suitable for exchanging with your colleague
15885 s.
15886  The only settable option for the translation is the line length of the
15887  output file.
15888  The default is 65 characters, but it can be set in 
15889 \family sans
15890 \bar under
15891 T
15892 \bar default
15893 ools
15894 \family default
15895 \SpecialChar \menuseparator
15896
15897 \family sans
15898 \bar under
15899 P
15900 \bar default
15901 references
15902 \family default
15903  using the 
15904 \family sans
15905 \bar under
15906 A
15907 \bar default
15908 scii\InsetSpace ~
15909 line\InsetSpace ~
15910 length
15911 \family default
15912  field.
15913  
15914 \end_layout
15915
15916 \begin_layout Subsection
15917 Device Independent Files
15918 \end_layout
15919
15920 \begin_layout Standard
15921 Device Independent files (DVI files) are produced by running LaTeX on your
15922  document.
15923  There are no user settable options.
15924 \end_layout
15925
15926 \begin_layout Subsection
15927 PostScript
15928 \end_layout
15929
15930 \begin_layout Standard
15931 The next step in the conversion chain is converting a DVI file into Postscript®.
15932  You can either use 
15933 \family sans
15934 \bar under
15935 F
15936 \bar default
15937 ile
15938 \family default
15939 \SpecialChar \menuseparator
15940
15941 \family sans
15942 \bar under
15943 E
15944 \bar default
15945 xport
15946 \family default
15947 \SpecialChar \menuseparator
15948
15949 \family sans
15950 Pos
15951 \bar under
15952 t
15953 \bar default
15954 script
15955 \family default
15956  or, if you need more control on the result, 
15957 \family sans
15958 \bar under
15959 F
15960 \bar default
15961 ile
15962 \family default
15963 \SpecialChar \menuseparator
15964
15965 \family sans
15966 \bar under
15967 P
15968 \bar default
15969 rint
15970 \family default
15971 .
15972  If you use the later, note that it is possible to configure, in 
15973 \family sans
15974 \bar under
15975 T
15976 \bar default
15977 ools
15978 \family default
15979 \SpecialChar \menuseparator
15980
15981 \family sans
15982 \bar under
15983 P
15984 \bar default
15985 references
15986 \family default
15987 , the options passed to the dvips program to achieve different effects.
15988 \end_layout
15989
15990 \begin_layout Subsection
15991 ASCII text
15992 \end_layout
15993
15994 \begin_layout Standard
15995 Exporting as ASCII attempts to preserve the 
15996 \begin_inset Quotes eld
15997 \end_inset
15998
15999 shape
16000 \begin_inset Quotes erd
16001 \end_inset
16002
16003  of the document as well as possible, but things like centering and indentation
16004  are thrown out; paragraphs are separated by blank lines.
16005  Section numbering and cross-references are done correctly, so the resulting
16006  text files is remarkably readable.
16007  The only changeable option is the length of lines, as for LaTeX output.
16008 \end_layout
16009
16010 \begin_layout Subsection
16011 HTML
16012 \end_layout
16013
16014 \begin_layout Standard
16015 LyX documents can be converted to hypertext markup, usually by converting
16016  to LaTeX first, then converting that to HTML\SpecialChar \@.
16017  Four LaTeX
16018 \begin_inset Formula $\rightarrow$
16019 \end_inset
16020
16021 HTML converters are currently known to LyX: 
16022 \family typewriter
16023 tth
16024 \family default
16025
16026 \family typewriter
16027 latex2html
16028 \family default
16029
16030 \family typewriter
16031 hevea
16032 \family default
16033  and 
16034 \family typewriter
16035 htlatex
16036 \family default
16037 .
16038  Though they are autodetected, you can overide the selection in preferences.
16039  You can also include further command line options in this dialog.
16040  
16041 \end_layout
16042
16043 \begin_layout Subsection
16044 PDF
16045 \end_layout
16046
16047 \begin_layout Standard
16048 by 
16049 \noun on
16050 Dekel Tsur
16051 \noun default
16052  (mostly)
16053 \end_layout
16054
16055 \begin_layout Standard
16056 \begin_inset VSpace bigskip
16057 \end_inset
16058
16059
16060 \end_layout
16061
16062 \begin_layout Standard
16063 The fastest way to generate a basic PDF file (no tags, links, etc.) with
16064  any version of LyX is to save the document as a Postscript® file, then
16065  run the 
16066 \family typewriter
16067 ps2pdf
16068 \family default
16069  command on it.
16070  Starting with version 1.1.6, the menu item 
16071 \family sans
16072 File->Export->PDF
16073 \family default
16074  will do all this for you.
16075  There are some issues with fonts that you need to pay attention to: see
16076  Section\InsetSpace ~
16077
16078 \begin_inset LatexCommand \ref{sec:badfonts}
16079
16080 \end_inset
16081
16082 .
16083  Also, as of version 1.1.6, there is a better method that will generate much
16084  more sophisticated files.
16085 \end_layout
16086
16087 \begin_layout Subsubsection
16088 Use pdfLaTeX
16089 \end_layout
16090
16091 \begin_layout Standard
16092 With pdfLaTeX you need to convert your eps figures to PDF (see Section\InsetSpace ~
16093
16094 \begin_inset LatexCommand \ref{sec:pdfeps}
16095
16096 \end_inset
16097
16098 ), and you cannot use pstricks.
16099  On the other hand, with pdfLaTeX it is possible to insert directly images
16100  in JPEG or PNG format, use TrueType fonts, and more.
16101 \end_layout
16102
16103 \begin_layout Subsubsection
16104 Why does the text look so bad when viewed with Acrobat Reader?
16105 \begin_inset LatexCommand \label{sec:badfonts}
16106
16107 \end_inset
16108
16109
16110 \begin_inset OptArg
16111 status collapsed
16112
16113 \begin_layout Standard
16114 Bad Fonts in Acrobat Reader
16115 \end_layout
16116
16117 \end_inset
16118
16119
16120 \end_layout
16121
16122 \begin_layout Standard
16123 The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
16124  When creating a PDF from the LyX file, you need to use outline font instead
16125  of the default bitmap fonts (in fact, you should also use outline fonts
16126  for Postscript files).
16127  Recent LaTeX distributions come with Postscript® Type 1 version of the
16128  standard (Computer Modern) fonts.
16129  pdfLaTeX uses these font by default.
16130  Dvips doesn't use these fonts by default, so to make it use them, add the
16131  following to lines to your 
16132 \family typewriter
16133 ~/.dvipsrc
16134 \family default
16135  file
16136 \end_layout
16137
16138 \begin_layout LyX-Code
16139 p+ psfonts.cmz
16140 \end_layout
16141
16142 \begin_layout LyX-Code
16143 p+ psfonts.amz
16144 \end_layout
16145
16146 \begin_layout Standard
16147 If the default LaTeX font encoding (OT1) is used, nothing else need to be
16148  done.
16149  However, if the T1 font encoding is used, then LaTeX uses the newer EC
16150  fonts, for which there are no Type1 version.
16151  There are two solutions in this case: Either use the 
16152 \begin_inset Quotes eld
16153 \end_inset
16154
16155 ae font
16156 \begin_inset Quotes erd
16157 \end_inset
16158
16159  (which is in fact a 
16160 \begin_inset Quotes eld
16161 \end_inset
16162
16163 virtual
16164 \begin_inset Quotes erd
16165 \end_inset
16166
16167  font that emulates T1 coded fonts using the standard CM fonts).
16168  This is done by selecting 
16169 \begin_inset Quotes eld
16170 \end_inset
16171
16172 AE (Almost European)
16173 \begin_inset Quotes erd
16174 \end_inset
16175
16176  from 
16177 \family sans
16178 Document\SpecialChar \menuseparator
16179 Settings\SpecialChar \menuseparator
16180  Fonts\SpecialChar \menuseparator
16181 Roman
16182 \family default
16183 .
16184  However, some glyphs are missing from the CM fonts (e.g.
16185  eth, thorn), and they are taken from the EC fonts.
16186  Therefore you get these glyphs as bitmaps.
16187  Or use the 
16188 \begin_inset Quotes eld
16189 \end_inset
16190
16191 Latin Modern
16192 \begin_inset Quotes erd
16193 \end_inset
16194
16195  font from 
16196 \family sans
16197 Document\SpecialChar \menuseparator
16198 Settings\SpecialChar \menuseparator
16199  Fonts\SpecialChar \menuseparator
16200 Roman
16201 \family default
16202 .
16203  It is a newer and probably the best Postscript® Type 1 version of cm.
16204  Basically, we recommend this over the 
16205 \begin_inset Quotes eld
16206 \end_inset
16207
16208 ae
16209 \begin_inset Quotes erd
16210 \end_inset
16211
16212  solution.
16213  However, the Latin Modern fonts differ from cm in some visual aspects,
16214  which does not please everybody.
16215 \end_layout
16216
16217 \begin_layout Standard
16218 Note: LyX uses by default the T1 font encoding.
16219  If you wish to use the default font encoding (this is not recommended,
16220  unless you only write English documents), clear the field 
16221 \family sans
16222 \bar under
16223 T
16224 \bar default
16225 eX\InsetSpace ~
16226 encoding
16227 \family default
16228  in preferences (tabs 
16229 \family sans
16230 Outputs
16231 \family default
16232
16233 \family sans
16234 Misc
16235 \family default
16236 ).
16237  
16238 \end_layout
16239
16240 \begin_layout Standard
16241 An alternate option is to use the standard Postscript® fonts instead of
16242  the Computer Modern fonts.
16243  To do that, you just need to select one of the fonts listed in the document
16244  layout dialog (except for 
16245 \begin_inset Quotes eld
16246 \end_inset
16247
16248 default
16249 \begin_inset Quotes erd
16250 \end_inset
16251
16252  and 
16253 \begin_inset Quotes eld
16254 \end_inset
16255
16256 computer modern
16257 \begin_inset Quotes erd
16258 \end_inset
16259
16260 , they're all Postscript® fonts).
16261  When using the Postscript® fonts, the result PDF file is smaller as the
16262  fonts are not saved into the file.
16263  Furthermore, the Postscript® fonts include all T1 glyphs.
16264  On the other hand, the Postscript® fonts have no bold symbol font, so poor
16265  man's bold must be used (see Section\InsetSpace ~
16266
16267 \begin_inset LatexCommand \ref{sec:pdfbold}
16268
16269 \end_inset
16270
16271 ).
16272  The Postscript® fonts also look different from the Computer Modern fonts.
16273 \end_layout
16274
16275 \begin_layout Standard
16276 To sum up, both the Computer Modern and the Postscript® fonts gives good
16277  results (with few exceptions).
16278  The decision of which one to use is a matter of taste.
16279 \end_layout
16280
16281 \begin_layout Subsubsection
16282 Why doesn't the 
16283 \backslash
16284 boldsymbol{} command work when I use pslatex?
16285 \begin_inset LatexCommand \label{sec:pdfbold}
16286
16287 \end_inset
16288
16289
16290 \begin_inset OptArg
16291 status collapsed
16292
16293 \begin_layout Standard
16294
16295 \family typewriter
16296
16297 \backslash
16298 boldsymbol{}
16299 \family default
16300  and 
16301 \family typewriter
16302 pslatex
16303 \end_layout
16304
16305 \end_inset
16306
16307
16308 \end_layout
16309
16310 \begin_layout Standard
16311 The Postscript® fonts do not have a bold symbol font.
16312  The solution is to use the 
16313 \family typewriter
16314
16315 \backslash
16316 pmb{}
16317 \family default
16318  (poor man's bold) command.
16319 \end_layout
16320
16321 \begin_layout Standard
16322 It is possible to redefine the 
16323 \family typewriter
16324
16325 \backslash
16326 boldsymbol
16327 \family default
16328  command to use 
16329 \family typewriter
16330
16331 \backslash
16332 pmb
16333 \family default
16334  by putting
16335 \end_layout
16336
16337 \begin_layout LyX-Code
16338
16339 \backslash
16340 renewcommand{
16341 \backslash
16342 boldsymbol}[1]{
16343 \backslash
16344 pmb{#1}}
16345 \end_layout
16346
16347 \begin_layout Standard
16348 in the preamble.
16349 \end_layout
16350
16351 \begin_layout Subsubsection
16352 Is it possible to do write latex code which is processed only when running
16353  pdfLaTeX?
16354 \begin_inset OptArg
16355 status collapsed
16356
16357 \begin_layout Standard
16358 Conditionals with pdfLaTeX
16359 \end_layout
16360
16361 \end_inset
16362
16363
16364 \end_layout
16365
16366 \begin_layout Standard
16367 Yes.
16368  Here is an example:
16369 \end_layout
16370
16371 \begin_layout LyX-Code
16372
16373 \backslash
16374 newif 
16375 \backslash
16376 ifpdf
16377 \end_layout
16378
16379 \begin_layout LyX-Code
16380    
16381 \backslash
16382 ifx 
16383 \backslash
16384 pdfoutput 
16385 \backslash
16386 undefined
16387 \end_layout
16388
16389 \begin_layout LyX-Code
16390       
16391 \backslash
16392 pdffalse
16393 \end_layout
16394
16395 \begin_layout LyX-Code
16396    
16397 \backslash
16398 else
16399 \end_layout
16400
16401 \begin_layout LyX-Code
16402       
16403 \backslash
16404 pdftrue
16405 \end_layout
16406
16407 \begin_layout LyX-Code
16408
16409 \backslash
16410 fi
16411 \end_layout
16412
16413 \begin_layout LyX-Code
16414
16415 \end_layout
16416
16417 \begin_layout LyX-Code
16418
16419 \backslash
16420 ifpdf
16421 \end_layout
16422
16423 \begin_layout LyX-Code
16424    
16425 \backslash
16426 pdfinfo { /Author (your name and e-mail address)
16427 \end_layout
16428
16429 \begin_layout LyX-Code
16430       /Title (official title -- i.e., title element)
16431 \end_layout
16432
16433 \begin_layout LyX-Code
16434       /Subject (one line description of the document)
16435 \end_layout
16436
16437 \begin_layout LyX-Code
16438    }
16439 \end_layout
16440
16441 \begin_layout LyX-Code
16442    
16443 \backslash
16444 pdfcatalog { /PageMode (/UseNone)
16445 \end_layout
16446
16447 \begin_layout LyX-Code
16448    % /OpenAction (fitbh)
16449 \end_layout
16450
16451 \begin_layout LyX-Code
16452    }
16453 \end_layout
16454
16455 \begin_layout LyX-Code
16456    
16457 \backslash
16458 usepackage[pdftex]{hyperref}
16459 \end_layout
16460
16461 \begin_layout LyX-Code
16462
16463 \backslash
16464 else
16465 \end_layout
16466
16467 \begin_layout LyX-Code
16468    
16469 \backslash
16470 usepackage[ps2pdf]{hyperref}
16471 \end_layout
16472
16473 \begin_layout LyX-Code
16474
16475 \backslash
16476 fi
16477 \end_layout
16478
16479 \begin_layout Subsubsection
16480 How can I make URLs clickable ?
16481 \end_layout
16482
16483 \begin_layout Standard
16484 See the references here :
16485 \end_layout
16486
16487 \begin_layout Standard
16488 \begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
16489
16490 \end_inset
16491
16492
16493 \end_layout
16494
16495 \begin_layout Subsection
16496 Custom
16497 \end_layout
16498
16499 \begin_layout Standard
16500 Custom exports are possible if you have some particularly weird format you
16501  wish to convert to, assuming you have the relevant converter, of course.
16502  The format of the 
16503 \emph on
16504 input
16505 \emph default
16506  file can be chosen in the 
16507 \family sans
16508 \bar under
16509 F
16510 \bar default
16511 ile\SpecialChar \menuseparator
16512
16513 \bar under
16514 E
16515 \bar default
16516 xport\SpecialChar \menuseparator
16517
16518 \bar under
16519 C
16520 \bar default
16521 ustom 
16522 \family default
16523 dialog; LyX will automatically convert the file to this point, then feed
16524  it to your custom converter.
16525  The possible values are all formats that LyX can produce from its own documents.
16526  
16527 \end_layout
16528
16529 \begin_layout Standard
16530 The converter command is also specified in the dialog.It should be a completely
16531  qualified command line which uses the variable 
16532 \family typewriter
16533 $$FName
16534 \family default
16535  to specify the name of the file.
16536  If this variable is not given, then the file will be sent to the standard
16537  input of your command.
16538  You may have to apply a bit of ingenuity to escape this sequence correctly
16539  so that it is compatible with your shell.
16540  
16541 \end_layout
16542
16543 \begin_layout Standard
16544 While it is not possible to save this command using the 
16545 \family sans
16546 Preferences 
16547 \family default
16548 dialog, you can manually edit your 
16549 \family typewriter
16550 .lyx/preferences
16551 \family default
16552  to add a line like
16553 \end_layout
16554
16555 \begin_layout LyX-Code
16556
16557 \backslash
16558 custom_export_command "mycommand $$FName"
16559 \end_layout
16560
16561 \begin_layout Section
16562 The Complete reLyX Description
16563 \begin_inset LatexCommand \label{sec:reLyX}
16564
16565 \end_inset
16566
16567
16568 \end_layout
16569
16570 \begin_layout Subsection
16571 Synopsis
16572 \end_layout
16573
16574 \begin_layout Standard
16575 The simplest way to use reLyX is via the 
16576 \family sans
16577 \bar under
16578 F
16579 \bar default
16580 ile\SpecialChar \menuseparator
16581
16582 \bar under
16583 I
16584 \bar default
16585 mport
16586 \family default
16587  command in LyX.
16588  That runs reLyX on the given file and loads the resulting file into LyX.
16589  You should try that first, and call it from the command line only if you
16590  need to use more complicated options.
16591 \end_layout
16592
16593 \begin_layout Standard
16594
16595 \series bold
16596 reLyX
16597 \series default
16598  [ 
16599 \series bold
16600 -c
16601 \series default
16602  
16603 \shape italic
16604 textclass
16605 \shape default
16606  ] [ 
16607 \series bold
16608 -df
16609 \series default
16610  ] [ 
16611 \series bold
16612 -o
16613 \series default
16614  
16615 \shape italic
16616 outputdir
16617 \shape default
16618  ] [
16619 \series bold
16620  -r
16621 \series default
16622 \shape italic
16623  renv1
16624 \shape default
16625 [,
16626 \shape italic
16627 renv2
16628 \shape default
16629 ...]] [
16630 \series bold
16631  -s
16632 \series default
16633 \shape italic
16634  sfile1
16635 \shape default
16636 [,
16637 \shape italic
16638 sfile2
16639 \shape default
16640 ...]] 
16641 \emph on
16642 inputfile
16643 \end_layout
16644
16645 \begin_layout Standard
16646
16647 \series bold
16648 reLyX
16649 \series default
16650  
16651 \series bold
16652 -p
16653 \series default
16654  
16655 \series bold
16656 -c
16657 \series default
16658  
16659 \shape italic
16660 textclass
16661 \shape default
16662  [ 
16663 \series bold
16664 -df
16665 \series default
16666  ] [ 
16667 \series bold
16668 -o
16669 \series default
16670  
16671 \shape italic
16672 outputdir
16673 \shape default
16674  ] [
16675 \series bold
16676  -r
16677 \series default
16678 \shape italic
16679  renv1
16680 \shape default
16681 [,
16682 \shape italic
16683 renv2
16684 \shape default
16685 ...]] [
16686 \series bold
16687  -s
16688 \series default
16689 \shape italic
16690  sfile1
16691 \shape default
16692 [,
16693 \shape italic
16694 sfile2
16695 \shape default
16696 ...]] 
16697 \emph on
16698 inputfiles
16699 \end_layout
16700
16701 \begin_layout Standard
16702
16703 \series bold
16704 reLyX
16705 \series default
16706  
16707 \series bold
16708 -h
16709 \end_layout
16710
16711 \begin_layout Subsection
16712 Options
16713 \end_layout
16714
16715 \begin_layout Description
16716
16717 \series bold
16718 -c
16719 \series default
16720  Class.
16721  By default, when reLyX sees a 
16722 \family typewriter
16723
16724 \backslash
16725 documentclass{foo}
16726 \family default
16727  command, it creates a file of textclass 
16728 \begin_inset Quotes eld
16729 \end_inset
16730
16731 foo
16732 \begin_inset Quotes erd
16733 \end_inset
16734
16735  and reads the LyX layout file for that class.
16736   Use 
16737 \series bold
16738 -c
16739 \series default
16740  to declare a different textclass (and read a different layout file).
16741 \end_layout
16742
16743 \begin_layout Description
16744
16745 \series bold
16746 -d
16747 \series default
16748  Debug.
16749  By default, reLyX gives sparse output and deletes the temporary files which
16750  were created during translation.
16751  Using the 
16752 \series bold
16753 -d
16754 \series default
16755  flag will create much more output (both to stdout and stderr) and leave
16756  the temporary files around.
16757 \end_layout
16758
16759 \begin_layout Description
16760
16761 \series bold
16762 -f
16763 \series default
16764  Force.
16765  reLyX will not run if the 
16766 \family typewriter
16767 .lyx
16768 \family default
16769  file it would generate already exists Use the 
16770 \series bold
16771 -f
16772 \series default
16773  option (carefully) to clobber any existing files.
16774 \end_layout
16775
16776 \begin_layout Description
16777
16778 \series bold
16779 -h
16780 \series default
16781  Help.
16782  Print out usage information and quit
16783 \end_layout
16784
16785 \begin_layout Description
16786
16787 \series bold
16788 -o
16789 \series default
16790  Output directory.
16791  With this option, all temporary files and LyX output files (for the given
16792  input file, for any included files, or for any file fragments given with
16793  the 
16794 \series bold
16795 -p
16796 \series default
16797  option) will be put into 
16798 \shape italic
16799 outputdir
16800 \shape default
16801 .
16802  Otherwise, for each file 
16803 \emph on
16804 dir/foo.tex
16805 \emph default
16806 , the temporary files and the LyX output file will be created in 
16807 \emph on
16808 dir
16809 \emph default
16810 .
16811  This can be useful if a file includes files from other directories which
16812  you want to consolidate in one directory, or if you don't have write permission
16813  on the directory the LaTeX files are in.
16814 \end_layout
16815
16816 \begin_layout Description
16817
16818 \series bold
16819 -p
16820 \series default
16821  Partial file.
16822  The input files are LaTeX fragments, with no preamble matter or 
16823 \family typewriter
16824
16825 \backslash
16826 begin{document}
16827 \family default
16828  commands.
16829  This option requires the 
16830 \series bold
16831 -c
16832 \series default
16833  option, since there are no 
16834 \family typewriter
16835
16836 \backslash
16837 documentclass
16838 \family default
16839  commands in the files reLyX is translating.
16840  When using this option, you can translate more than one file, as long as
16841  all files are the same class.
16842  The LyX file created by reLyX can be included in an existing LyX file using
16843  
16844 \family sans
16845 \bar under
16846 I
16847 \bar default
16848 nsert\SpecialChar \menuseparator
16849 Fil
16850 \bar under
16851 e
16852 \bar default
16853 \SpecialChar \menuseparator
16854 Ly
16855 \bar under
16856 X
16857 \bar default
16858 \InsetSpace ~
16859 Document
16860 \family default
16861 .
16862 \end_layout
16863
16864 \begin_layout Description
16865
16866 \series bold
16867 -r
16868 \series default
16869  Regular environments (see the Section\InsetSpace ~
16870
16871 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16872
16873 \end_inset
16874
16875 ).
16876   If you give more than one environment, separate them with commas (not
16877  spaces).
16878  You'll probably need to quote the environment list, especially if it has
16879  asterisk environments (foo*) in it.
16880  If you use this command often, considering creating a personal syntax file.
16881 \end_layout
16882
16883 \begin_layout Description
16884
16885 \series bold
16886 -s
16887 \series default
16888  Syntax files.
16889  Input (one or more quoted, comma-separated) syntax files to read in addition
16890  to the default.
16891  (see the section Section\InsetSpace ~
16892
16893 \begin_inset LatexCommand \ref{sub:relyx-syntax}
16894
16895 \end_inset
16896
16897  for details).
16898 \end_layout
16899
16900 \begin_layout Subsection
16901 Description
16902 \end_layout
16903
16904 \begin_layout Subsubsection
16905 Introduction
16906 \end_layout
16907
16908 \begin_layout Standard
16909 reLyX will create a LyX file 
16910 \emph on
16911 dir/foo.lyx
16912 \emph default
16913  from the LaTeX file 
16914 \emph on
16915 dir/foo.tex
16916 \emph default
16917  (unless the 
16918 \series bold
16919 -o
16920 \series default
16921  option is used).
16922 \end_layout
16923
16924 \begin_layout Standard
16925 Suffixes 
16926 \family typewriter
16927 .tex
16928 \family default
16929
16930 \family typewriter
16931 .ltx
16932 \family default
16933  and 
16934 \family typewriter
16935 .latex
16936 \family default
16937  are supported.
16938  If 
16939 \emph on
16940 inputfile
16941 \emph default
16942  does not exist and does not have one of these suffixes, reLyX will try
16943  to translate 
16944 \emph on
16945 inputfile.tex
16946 \emph default
16947 .
16948  (This is similar to the behavior of LaTeX.)
16949 \end_layout
16950
16951 \begin_layout Standard
16952 The purpose of reLyX is to translate 
16953 \shape italic
16954 well-behaved
16955 \shape default
16956  LaTeX2e into LyX.
16957  If your LaTeX file doesn't compile---or if you do weird things, like redefining
16958  standard LaTeX commands---it may choke.
16959  LaTeX209 will often be translated correctly, but it's not guaranteed.
16960 \end_layout
16961
16962 \begin_layout Standard
16963 reLyX has some bugs and lacks a few features.
16964  However, its main goals are:
16965 \end_layout
16966
16967 \begin_layout Itemize
16968 Get through a well-behaved LaTeX2e file without crashing
16969 \end_layout
16970
16971 \begin_layout Itemize
16972 Translate a lot of that file.
16973 \end_layout
16974
16975 \begin_layout Itemize
16976 Localize the parts that can't be translated and copy them in TeX mode
16977 \end_layout
16978
16979 \begin_layout Standard
16980 It achieves these main goals pretty well on most files.
16981 \end_layout
16982
16983 \begin_layout Standard
16984 There are many improvements that can and will be made to reLyX in the future.
16985  However, we wanted to get reLyX out there early on, to make it easier for
16986  new LyX users to read in their existing LaTeX files.
16987 \end_layout
16988
16989 \begin_layout Subsubsection
16990 Usage
16991 \end_layout
16992
16993 \begin_layout Standard
16994 Here's a more lengthy description of what you should do to translate a LaTeX
16995  document into LyX.
16996 \end_layout
16997
16998 \begin_layout Itemize
16999 Run reLyX.
17000 \end_layout
17001
17002 \begin_deeper
17003 \begin_layout Standard
17004 reLyX will inform you of its progress and give any warnings to stderr, so
17005  if you don't want any output at all, try (in csh) 
17006 \begin_inset Quotes eld
17007 \end_inset
17008
17009
17010 \family typewriter
17011 reLyX foo.tex >& /dev/null
17012 \family default
17013
17014 \begin_inset Quotes erd
17015 \end_inset
17016
17017  or (in bash) 
17018 \begin_inset Quotes eld
17019 \end_inset
17020
17021
17022 \family typewriter
17023 reLyX foo.tex
17024 \family default
17025  
17026 \family typewriter
17027 2>&1 >/dev/null
17028 \family default
17029
17030 \begin_inset Quotes erd
17031 \end_inset
17032
17033 .
17034  You should NOT redirect standard output to 
17035 \family typewriter
17036 foo.lyx
17037 \family default
17038 .
17039  
17040 \end_layout
17041
17042 \end_deeper
17043 \begin_layout Itemize
17044 Run LyX on the resulting .lyx file.
17045 \end_layout
17046
17047 \begin_deeper
17048 \begin_layout Standard
17049 In theory, most of the file will have been translated, and anything that's
17050  untranslatable will be highlighted in red (TeX mode).
17051  In theory, LyX will be able to read in the file, and to create printed
17052  documents from it, because all that untranslated red stuff will be passed
17053  directly back to LaTeX, which LyX  uses as a backend.
17054  Unfortunately, reality doesn't always reflect theory.
17055  If reLyX crashes, or LyX cannot read the generated LyX file, see Section\InsetSpace ~
17056
17057 \begin_inset LatexCommand \ref{sub:relyx-bugs}
17058
17059 \end_inset
17060
17061  or the 
17062 \family typewriter
17063 BUGS
17064 \family default
17065  file.
17066 \end_layout
17067
17068 \end_deeper
17069 \begin_layout Itemize
17070 Change things that are in ERT boxes (TeX code) by hand in LyX.
17071 \end_layout
17072
17073 \begin_deeper
17074 \begin_layout Standard
17075 As mentioned above, you should be able to print out the LyX file even without
17076  doing this.
17077  However, changing a command in TeX mode to the corresponding LyX object
17078  will allow you to take advantage of LyX's WYSIWYM editing.
17079 \end_layout
17080
17081 \begin_layout Standard
17082 reLyX is not guaranteed to create a LyX file which generates exactly the
17083  same output as the LaTeX file, but it should come close.
17084  reLyX will generally err on the side of translating less to ensure that
17085  dvi or ps files are accurate, even though this leads to more 
17086 \begin_inset Quotes eld
17087 \end_inset
17088
17089 evil red text
17090 \begin_inset Quotes erd
17091 \end_inset
17092
17093  and less WYSIWYM.
17094 \end_layout
17095
17096 \end_deeper
17097 \begin_layout Itemize
17098 PROOFREAD THE DOCUMENT!!
17099 \end_layout
17100
17101 \begin_deeper
17102 \begin_layout Standard
17103 I'm sure you were planning on doing this anyway, but it's particularly important
17104  after translating a LaTeX document.
17105  reLyX is, at least now, better at 
17106 \begin_inset Quotes eld
17107 \end_inset
17108
17109 macro-translating
17110 \begin_inset Quotes erd
17111 \end_inset
17112
17113  (translating the whole document) than 
17114 \begin_inset Quotes eld
17115 \end_inset
17116
17117 micro-translating
17118 \begin_inset Quotes erd
17119 \end_inset
17120
17121  (translating every little detail).
17122  For example, you may see extra spaces or deleted spaces.
17123  Space handling has improved, but it's not perfect.
17124 \end_layout
17125
17126 \end_deeper
17127 \begin_layout Subsubsection
17128 What reLyX Can Handle
17129 \end_layout
17130
17131 \begin_layout Standard
17132 reLyX understands many LaTeX commands.
17133  It will translate:
17134 \end_layout
17135
17136 \begin_layout Itemize
17137 regular text, including mini-commands like ~, '', 
17138 \family typewriter
17139
17140 \backslash
17141 @
17142 \family default
17143
17144 \family typewriter
17145
17146 \backslash
17147 TeX
17148 \family default
17149 , as well as accented characters like 
17150 \family typewriter
17151
17152 \backslash
17153 '{a}
17154 \family default
17155 , and the special cases ?` and !`
17156 \end_layout
17157
17158 \begin_layout Itemize
17159 title commands like 
17160 \family typewriter
17161
17162 \backslash
17163 author
17164 \family default
17165
17166 \family typewriter
17167
17168 \backslash
17169 date
17170 \family default
17171
17172 \family typewriter
17173
17174 \backslash
17175 title
17176 \family default
17177
17178 \family typewriter
17179
17180 \backslash
17181 thanks
17182 \family default
17183  and the abstract environment
17184 \end_layout
17185
17186 \begin_layout Itemize
17187 heading commands like 
17188 \family typewriter
17189
17190 \backslash
17191 section
17192 \family default
17193  including starred commands (
17194 \family typewriter
17195
17196 \backslash
17197 section*
17198 \family default
17199 )
17200 \end_layout
17201
17202 \begin_layout Itemize
17203 Environments: 
17204 \family typewriter
17205 quote
17206 \family default
17207
17208 \family typewriter
17209 quotation
17210 \family default
17211 , and 
17212 \family typewriter
17213 verse
17214 \family default
17215
17216 \family typewriter
17217 center
17218 \family default
17219
17220 \family typewriter
17221 flushright
17222 \family default
17223 , and 
17224 \family typewriter
17225 flushleft
17226 \end_layout
17227
17228 \begin_layout Itemize
17229
17230 \family typewriter
17231 itemize
17232 \family default
17233
17234 \family typewriter
17235 enumerate
17236 \family default
17237 , and 
17238 \family typewriter
17239 description
17240 \family default
17241  environments, and their 
17242 \family typewriter
17243
17244 \backslash
17245 item
17246 \family default
17247  commands.
17248  Also, well-behaved nested lists
17249 \end_layout
17250
17251 \begin_layout Itemize
17252 cross-referencing commands: 
17253 \family typewriter
17254
17255 \backslash
17256 ref
17257 \family default
17258
17259 \family typewriter
17260
17261 \backslash
17262 pageref
17263 \family default
17264
17265 \family typewriter
17266
17267 \backslash
17268 label
17269 \family default
17270 , and 
17271 \family typewriter
17272
17273 \backslash
17274 cite
17275 \end_layout
17276
17277 \begin_layout Itemize
17278
17279 \family typewriter
17280
17281 \backslash
17282 footnote
17283 \family default
17284  and 
17285 \family typewriter
17286
17287 \backslash
17288 margin
17289 \end_layout
17290
17291 \begin_layout Itemize
17292 font-changing commands including 
17293 \family typewriter
17294
17295 \backslash
17296 em
17297 \family default
17298
17299 \family typewriter
17300
17301 \backslash
17302 emph
17303 \family default
17304
17305 \family typewriter
17306
17307 \backslash
17308 textit
17309 \family default
17310 , and corresponding commands to change family, size, series, and shape
17311 \end_layout
17312
17313 \begin_layout Itemize
17314
17315 \family typewriter
17316
17317 \backslash
17318 input{foo}
17319 \family default
17320  (or 
17321 \family typewriter
17322
17323 \backslash
17324 input{foo.blah}
17325 \family default
17326 ) and 
17327 \family typewriter
17328
17329 \backslash
17330 include{foo}
17331 \family default
17332 .
17333  Plain TeX 
17334 \family typewriter
17335
17336 \backslash
17337 input
17338 \family default
17339  command 
17340 \begin_inset Quotes erd
17341 \end_inset
17342
17343
17344 \family typewriter
17345
17346 \backslash
17347 input foo.tex
17348 \family default
17349
17350 \begin_inset Quotes erd
17351 \end_inset
17352
17353  is also supported.
17354 \end_layout
17355
17356 \begin_layout Itemize
17357
17358 \family typewriter
17359 tabular
17360 \family default
17361  environment, and commands that go inside it like 
17362 \family typewriter
17363
17364 \backslash
17365 hline
17366 \family default
17367
17368 \family typewriter
17369
17370 \backslash
17371 cline
17372 \family default
17373 , and 
17374 \family typewriter
17375
17376 \backslash
17377 multicolumn
17378 \family default
17379  (but see below)
17380 \end_layout
17381
17382 \begin_layout Itemize
17383 float environments 
17384 \family typewriter
17385 table
17386 \family default
17387  and 
17388 \family typewriter
17389 table*
17390 \family default
17391 , as well as 
17392 \family typewriter
17393
17394 \backslash
17395 caption
17396 \family default
17397  commands within them
17398 \end_layout
17399
17400 \begin_layout Itemize
17401
17402 \family typewriter
17403 thebibliography
17404 \family default
17405  environment and 
17406 \family typewriter
17407
17408 \backslash
17409 bibitem
17410 \family default
17411  command, as well as BibTeX's 
17412 \family typewriter
17413
17414 \backslash
17415 bibliography
17416 \family default
17417  and 
17418 \family typewriter
17419
17420 \backslash
17421 bibliographystyle
17422 \family default
17423  commands
17424 \end_layout
17425
17426 \begin_layout Itemize
17427 miscellaneous commands: 
17428 \family typewriter
17429
17430 \backslash
17431 hfill
17432 \family default
17433
17434 \family typewriter
17435
17436 \backslash
17437
17438 \backslash
17439
17440 \family default
17441
17442 \family typewriter
17443
17444 \backslash
17445 noindent
17446 \family default
17447
17448 \family typewriter
17449
17450 \backslash
17451 ldots
17452 \family default
17453 ...
17454 \end_layout
17455
17456 \begin_layout Itemize
17457 documentclass-specific environments (and some commands) which can be  translated
17458  to LyX layouts
17459 \end_layout
17460
17461 \begin_layout Itemize
17462 arguments to certain untranslatable commands (e.g.
17463  
17464 \family typewriter
17465
17466 \backslash
17467 mbox
17468 \family default
17469 )
17470 \end_layout
17471
17472 \begin_layout Standard
17473 Some of this support may not be 100% yet.
17474  See below for details
17475 \end_layout
17476
17477 \begin_layout Standard
17478 reLyX copies math (almost) verbatim from your LaTeX file.
17479  Luckily, LyX reads  in LaTeX math, so (almost) any math which is supported
17480  by LyX should work just fine.
17481  A few math commands which are not supported by LyX will be replaced with
17482  their equivalents, e.g., 
17483 \family typewriter
17484
17485 \backslash
17486 to
17487 \family default
17488  is converted to 
17489 \family typewriter
17490
17491 \backslash
17492 rightarrow
17493 \family default
17494 .
17495  See the section on 
17496 \shape italic
17497 Syntax Files
17498 \shape default
17499  for more details.
17500 \end_layout
17501
17502 \begin_layout Standard
17503 reLyX will also copy any preamble commands (i.e., anything before 
17504 \family typewriter
17505
17506 \backslash
17507 begin{document}
17508 \family default
17509 ) verbatim, so fancy stuff you've got in your preamble should be conserved
17510  in dvi and printed documents, although it will not of course show up in
17511  the LyX window.
17512  Check the preamble to make sure.
17513 \end_layout
17514
17515 \begin_layout Subsubsection
17516 What reLyX Can't Handle --- But it's OK
17517 \end_layout
17518
17519 \begin_layout Itemize
17520 figures and 
17521 \family typewriter
17522 tabular*
17523 \family default
17524  tables
17525 \end_layout
17526
17527 \begin_layout Itemize
17528 minipages
17529 \end_layout
17530
17531 \begin_layout Itemize
17532 spacing commands (
17533 \family typewriter
17534
17535 \backslash
17536 vspace
17537 \family default
17538
17539 \family typewriter
17540
17541 \backslash
17542 pagebreak
17543 \family default
17544
17545 \family typewriter
17546
17547 \backslash
17548 par
17549 \family default
17550 )
17551 \end_layout
17552
17553 \begin_layout Itemize
17554
17555 \family typewriter
17556
17557 \backslash
17558 centering
17559 \family default
17560
17561 \family typewriter
17562
17563 \backslash
17564 raggedleft
17565 \family default
17566
17567 \family typewriter
17568
17569 \backslash
17570 raggedright
17571 \end_layout
17572
17573 \begin_layout Itemize
17574
17575 \family typewriter
17576
17577 \backslash
17578 verb
17579 \family default
17580  and 
17581 \family typewriter
17582 verbatim
17583 \family default
17584  environment.
17585  reLyX is careful to copy 
17586 \shape italic
17587 exactly
17588 \shape default
17589  in this case, including comments and whitespace.
17590 \end_layout
17591
17592 \begin_layout Itemize
17593 some unknown (e.g., user-defined) environments and commands
17594 \end_layout
17595
17596 \begin_layout Standard
17597 reLyX copies unknown commands, along with their arguments, verbatim into
17598  the LyX file.
17599  Also, if it sees a 
17600 \family typewriter
17601
17602 \backslash
17603 begin{foo}
17604 \family default
17605  where it doesn't recognize the 
17606 \begin_inset Quotes eld
17607 \end_inset
17608
17609 foo
17610 \begin_inset Quotes erd
17611 \end_inset
17612
17613  environment, it will copy verbatim until it sees 
17614 \family typewriter
17615
17616 \backslash
17617 end{foo}
17618 \family default
17619  (unless you use the 
17620 \series bold
17621 -r
17622 \series default
17623  option).
17624  Hopefully, then, most of these unknown commands won't cause reLyX to break;
17625  they'll merely require you to do some editing once you've loaded the file
17626  up in LyX.
17627   That should be less painful than editing either the 
17628 \family typewriter
17629 .tex
17630 \family default
17631  or the 
17632 \family typewriter
17633 .lyx
17634 \family default
17635  file using a text editor.
17636 \end_layout
17637
17638 \begin_layout Subsubsection
17639 What reLyX Handles Badly --- a.\InsetSpace ~
17640 k.\InsetSpace ~
17641 a.
17642  BUGS
17643 \begin_inset LatexCommand \label{sub:relyx-bugs}
17644
17645 \end_inset
17646
17647
17648 \end_layout
17649
17650 \begin_layout Standard
17651 Since reLyX is relatively new, it's got a number of problems.
17652   As it matures, these bugs will be squished.
17653  A number of bugs and missing features can be found listed on the LyX bug
17654  tracker, 
17655 \begin_inset LatexCommand \url[LyX Bugzilla]{http://bugzilla.lyx.org/}
17656
17657 \end_inset
17658
17659 .
17660 \end_layout
17661
17662 \begin_layout Standard
17663 If reLyX is choking on something, or LyX can't read it after reLyX translates
17664  it, the best thing to do is to put 
17665 \family typewriter
17666
17667 \backslash
17668 begin{reLyXskip}
17669 \family default
17670  before the offending text, and 
17671 \family typewriter
17672
17673 \backslash
17674 end{reLyXskip}
17675 \family default
17676  after it.
17677  I call this a 
17678 \begin_inset Quotes eld
17679 \end_inset
17680
17681 skip
17682 \begin_inset Quotes erd
17683 \end_inset
17684
17685  block.
17686  reLyX will copy this block exactly, in TeX mode.
17687  Then edit the resulting LyX file, and translate the unknown stuff by hand.
17688  The 
17689 \family typewriter
17690 reLyXskip
17691 \family default
17692  environment is magical; the 
17693 \family typewriter
17694
17695 \backslash
17696 begin
17697 \family default
17698  and 
17699 \family typewriter
17700
17701 \backslash
17702 end
17703 \family default
17704  commands will not be put into the LyX file.
17705 \end_layout
17706
17707 \begin_layout Itemize
17708 \begin_inset Quotes eld
17709 \end_inset
17710
17711 Exact
17712 \begin_inset Quotes erd
17713 \end_inset
17714
17715  copying of unknown environments and commands isn't quite exact.
17716  Specifically, newlines and comments may be lost.
17717  This will yield ugly LyX, but in almost all cases the output will be the
17718  same.
17719  However, certain parts of the file will be copied perfectly, including
17720  whitespace and comments.
17721  This includes: the LaTeX preamble, 
17722 \family typewriter
17723 verbatim
17724 \family default
17725  environments and 
17726 \family typewriter
17727
17728 \backslash
17729 verb
17730 \family default
17731  commands, and skip blocks.
17732 \end_layout
17733
17734 \begin_layout Itemize
17735 reLyX translates only a few options to the 
17736 \family typewriter
17737
17738 \backslash
17739 documentclass
17740 \family default
17741  command.
17742  (Specifically 1[012]pt, [letter|legal|executive|a4|a5|b5]paper, [one|two]side,
17743  landscape, and [one|two]column.) Other options are placed in the extra class
17744  options field in the 
17745 \family sans
17746 \bar under
17747 D
17748 \bar default
17749 ocument\SpecialChar \menuseparator
17750
17751 \bar under
17752 S
17753 \bar default
17754 ettings
17755 \family default
17756  dialog.
17757 \end_layout
17758
17759 \begin_deeper
17760 \begin_layout Standard
17761 More importantly, reLyX doesn't translate 
17762 \family typewriter
17763
17764 \backslash
17765 usepackage
17766 \family default
17767  commands, margin  commands, 
17768 \family typewriter
17769
17770 \backslash
17771 newcommand
17772 \family default
17773 s, or, in fact, anything else from the preamble.
17774  It simply copies them into the LaTeX preamble.
17775  If you have margin commands in your preamble, then the LyX file will generate
17776  the right margins.
17777  However, these margins will override any margins you set in the LyX 
17778 \family sans
17779 \bar under
17780 D
17781 \bar default
17782 ocument
17783 \bar under
17784 \SpecialChar \menuseparator
17785 S
17786 \bar default
17787 ettings
17788 \family default
17789  dialog.
17790  So you should remove the options from the preamble to be safe.
17791  The same goes for setting your language with babel, 
17792 \family typewriter
17793
17794 \backslash
17795 inputencoding
17796 \family default
17797
17798 \family typewriter
17799
17800 \backslash
17801 pagestyle
17802 \family default
17803 , etc.
17804 \end_layout
17805
17806 \end_deeper
17807 \begin_layout Itemize
17808 The foil class has a couple bugs.
17809  reLyX may do weird things with optional arguments to 
17810 \family typewriter
17811
17812 \backslash
17813 foilhead
17814 \family default
17815  commands.
17816  Also, it may handle 
17817 \family typewriter
17818
17819 \backslash
17820 begin{dinglist}
17821 \family default
17822  incorrectly (although the stuff in the environment should translate normally).
17823 \end_layout
17824
17825 \begin_layout Standard
17826 reLyX is hopefully rather robust.
17827  As mentioned above, it may not translate your file perfectly, but it shouldn't
17828  crash.
17829  If it does crash---and the problem is not one of those mentioned above
17830  or in the 
17831 \emph on
17832 BUGS
17833 \emph default
17834  file---see Section\InsetSpace ~
17835
17836 \begin_inset LatexCommand \ref{sub:relyx-bug-reports}
17837
17838 \end_inset
17839
17840 .
17841 \end_layout
17842
17843 \begin_layout Subsubsection
17844 What LyX Can't Handle
17845 \end_layout
17846
17847 \begin_layout Standard
17848 LyX itself is missing a couple features, such that even if reLyX translates
17849  things perfectly, LyX may still have trouble reading it.
17850  If you really need these features, you can export your final document as
17851  LaTeX, and put them back in.
17852  See 
17853 \emph on
17854 BUGS
17855 \emph default
17856  for more details on these bugs.
17857 \end_layout
17858
17859 \begin_layout Itemize
17860 For a number of commands, LyX does not support the optional argument.
17861  Examples include 
17862 \family typewriter
17863
17864 \backslash
17865 sqrt
17866 \family default
17867
17868 \family typewriter
17869
17870 \backslash
17871 chapter
17872 \family default
17873  (and other sectioning commands), and 
17874 \family typewriter
17875
17876 \backslash
17877
17878 \backslash
17879
17880 \family default
17881 .
17882  reLyX will automatically discard the optional arguments with a warning
17883  to stdout.
17884  LyX also ignores the width argument for the 
17885 \family typewriter
17886 thebibliography
17887 \family default
17888  environment.
17889 \end_layout
17890
17891 \begin_layout Itemize
17892 Centering (or right or left justifying) works on full paragraphs.
17893 \end_layout
17894
17895 \begin_layout Itemize
17896 LyX support for tables isn't perfect.
17897  For complicated tables, use a 
17898 \begin_inset Quotes eld
17899 \end_inset
17900
17901 skip
17902 \begin_inset Quotes erd
17903 \end_inset
17904
17905  block, so that they will be copied in TeX mode.
17906 \end_layout
17907
17908 \begin_layout Itemize
17909 The LyX math editor can't handle the AMS-LaTeX math environments align,
17910  split, etc.
17911  So those environments will be copied in TeX mode.
17912  You can change 
17913 \family typewriter
17914 equation*
17915 \family default
17916  environments to the exactly equivalent displaymath, and then they will
17917  be translated correctly.
17918 \end_layout
17919
17920 \begin_layout Subsection
17921 Examples
17922 \end_layout
17923
17924 \begin_layout Standard
17925
17926 \family typewriter
17927 reLyX -df -o 
17928 \begin_inset Quotes eld
17929 \end_inset
17930
17931 my/dir
17932 \begin_inset Quotes erd
17933 \end_inset
17934
17935  -r 
17936 \begin_inset Quotes eld
17937 \end_inset
17938
17939 myenv
17940 \begin_inset Quotes erd
17941 \end_inset
17942
17943  foo.tex > foo.debug
17944 \end_layout
17945
17946 \begin_layout Standard
17947 The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
17948   When it finds a 
17949 \family typewriter
17950
17951 \backslash
17952 begin{myenv} ...
17953  
17954 \backslash
17955 end{myenv}
17956 \family default
17957  block, it will translate the stuff within the block, but copy the 
17958 \family typewriter
17959
17960 \backslash
17961 begin
17962 \family default
17963  and 
17964 \family typewriter
17965
17966 \backslash
17967 end
17968 \family default
17969  commands in TeX mode.
17970   Finally, I'm going to keep the temporary files around (they will also
17971  be in my/dir/) and output lots of debugging information into the file foo.debug.
17972 \end_layout
17973
17974 \begin_layout Subsection
17975 Notes
17976 \end_layout
17977
17978 \begin_layout Subsubsection
17979 Bug Reports
17980 \begin_inset LatexCommand \label{sub:relyx-bug-reports}
17981
17982 \end_inset
17983
17984
17985 \end_layout
17986
17987 \begin_layout Standard
17988 If reLyX is crashing or otherwise acting strangely---in ways other than
17989  those described in Section\InsetSpace ~
17990
17991 \begin_inset LatexCommand \ref{sub:relyx-bugs}
17992
17993 \end_inset
17994
17995  or the bug tracker---then please run reLyX
17996 \series bold
17997  -d
17998 \series default
17999 .
18000   That will allow you to figure out where in the reLyXing process it crashed.
18001  That, in turn, will allow you to write a better bug report, which will
18002  allow the developers to fix it more quickly and easily.
18003 \end_layout
18004
18005 \begin_layout Standard
18006 Bug reports should be sent to the LyX developers' mailing list.
18007  Its address is currently 
18008 \family typewriter
18009 lyx-devel@lists.lyx.org
18010 \family default
18011 .
18012  If you are running reLyX on a huge file, please do not send all of the
18013  output in your bug report.
18014  Just include the last ten or twenty lines of output, along with the piece
18015  of the LaTeX file it crashed on.
18016   Or, even better, attach a small but complete file which causes the same
18017  problem as your original file.
18018 \end_layout
18019
18020 \begin_layout Subsubsection
18021 Implementation Details:
18022 \end_layout
18023
18024 \begin_layout Standard
18025 reLyX makes several 
18026 \begin_inset Quotes eld
18027 \end_inset
18028
18029 passes
18030 \begin_inset Quotes erd
18031 \end_inset
18032
18033  in order to translate a TeX file.
18034  On each pass, it creates one or two files.
18035 \end_layout
18036
18037 \begin_layout Description
18038 Pass\InsetSpace ~
18039 0 \InsetSpace ~
18040
18041 \newline
18042 Before doing anything, read the syntax file (or files).
18043 \end_layout
18044
18045 \begin_layout Description
18046 Pass\InsetSpace ~
18047 1a \InsetSpace ~
18048
18049 \newline
18050 Split preamble (anything before a 
18051 \family typewriter
18052
18053 \backslash
18054 begin{document}
18055 \family default
18056  command) off the rest of the file.
18057  It saves the two pieces in separate files.
18058  This is necessary because there may be very strange stuff in a preamble.
18059  It also ignores anything after the 
18060 \family typewriter
18061
18062 \backslash
18063 end{document}
18064 \family default
18065 , on the assumption that it isn't LaTeX.
18066 \end_layout
18067
18068 \begin_layout Description
18069 Pass\InsetSpace ~
18070 1b \InsetSpace ~
18071
18072 \newline
18073 Translate the preamble.
18074  Currently, that just means translating the 
18075 \family typewriter
18076
18077 \backslash
18078 documentclass
18079 \family default
18080  command and copying the rest exactly into the LyX preamble.
18081 \end_layout
18082
18083 \begin_deeper
18084 \begin_layout Standard
18085 Once you know what class the document is, read the LyX layout file for that
18086  class.
18087 \end_layout
18088
18089 \end_deeper
18090 \begin_layout Description
18091 Pass\InsetSpace ~
18092 2 \InsetSpace ~
18093
18094 \newline
18095
18096 \begin_inset Quotes eld
18097 \end_inset
18098
18099 Clean
18100 \begin_inset Quotes erd
18101 \end_inset
18102
18103  the TeX file, generating slightly stricter LaTeX.
18104  This includes:
18105 \end_layout
18106
18107 \begin_deeper
18108 \begin_layout Itemize
18109 Change, e.g., 
18110 \family typewriter
18111 x^2
18112 \family default
18113  to the equivalent but clearer 
18114 \family typewriter
18115 x^{2}
18116 \end_layout
18117
18118 \begin_layout Itemize
18119 Removing optional arguments that LyX can't handle (e.g., from 
18120 \family typewriter
18121
18122 \backslash
18123 sqrt
18124 \family default
18125 )
18126 \end_layout
18127
18128 \begin_layout Itemize
18129 Changing 
18130 \family typewriter
18131 {
18132 \backslash
18133 em foo}
18134 \family default
18135  to 
18136 \family typewriter
18137
18138 \backslash
18139 emph{foo}
18140 \family default
18141 , etc.
18142  This is necessary because LyX always writes out the non-local forms anyway.
18143  This should very rarely make a difference.
18144 \end_layout
18145
18146 \end_deeper
18147 \begin_layout Description
18148 Pass\InsetSpace ~
18149 3 \InsetSpace ~
18150
18151 \newline
18152 Translate LaTeX text, commands, and environments to LyX.
18153 \end_layout
18154
18155 \begin_layout Description
18156 Pass\InsetSpace ~
18157 4 \InsetSpace ~
18158
18159 \newline
18160 Put the two pieces back together, and do some final tweaking, to generate
18161  the LyX file
18162 \end_layout
18163
18164 \begin_layout Standard
18165 If there are any 
18166 \family typewriter
18167
18168 \backslash
18169 input
18170 \family default
18171  or 
18172 \family typewriter
18173
18174 \backslash
18175 include
18176 \family default
18177  commands, reLyX will loop back to the beginning and translate those.
18178  It assumes that the included files are the same class as the main file,
18179  and that they have no preamble matter.
18180  (If you have an 
18181 \family typewriter
18182
18183 \backslash
18184 input
18185 \family default
18186  command in the preamble of a file, the command will be copied exactly into
18187  the LaTeX preamble portion of the LyX file, so the included file won't
18188  be translated.) So when translating included files, it skips passes 0 and
18189  1.
18190 \end_layout
18191
18192 \begin_layout Standard
18193 If reLyX doesn't find a file you wanted to include, it will give a warning,
18194  but will continue to translate any files it does find.
18195 \end_layout
18196
18197 \begin_layout Subsubsection
18198 Layout Files
18199 \end_layout
18200
18201 \begin_layout Standard
18202 reLyX reads a LyX layout file to know how to handle LaTeX environments and
18203  commands which get translated to LyX layouts.
18204  This file will include all 
18205 \begin_inset Quotes eld
18206 \end_inset
18207
18208 normal
18209 \begin_inset Quotes erd
18210 \end_inset
18211
18212  non-math environments (i.e., including quote and itemize, but not tabular,
18213  minipage, and some other fancy environments), and commands like 
18214 \family typewriter
18215
18216 \backslash
18217 section
18218 \family default
18219  and 
18220 \family typewriter
18221
18222 \backslash
18223 title
18224 \family default
18225 .
18226  If you want to reLyX a class that doesn't have an existing layout file,
18227  then you'll have to create a layout file.
18228  But you have to do this anyway, in order to LyX the file, since LyX depends
18229  on layout files to know how to display and process its files.
18230  Check the LyX documentation for help with this task (which can be hard
18231  or easy, depending on the class you want to create a layout file for.) If
18232  your class is quite similar to a class that has a layout file, then consider
18233  using the 
18234 \series bold
18235 -c
18236 \series default
18237  option.
18238 \end_layout
18239
18240 \begin_layout Subsubsection
18241 Syntax Files
18242 \begin_inset LatexCommand \label{sub:relyx-syntax}
18243
18244 \end_inset
18245
18246
18247 \end_layout
18248
18249 \begin_layout Standard
18250 reLyX always reads at least one syntax file, called the default syntax file.
18251  reLyX will read your personal syntax file if it exists; otherwise it will
18252  read the system-wide file.
18253  reLyX will read additional syntax files if you specify them with the 
18254 \series bold
18255 -s
18256 \series default
18257  option.
18258  (These extra files should have the same format as the default file, but
18259  will tend to be shorter, since they only have to specify extra commands
18260  not found in the default file.) A syntax file tells reLyX a few things.
18261 \end_layout
18262
18263 \begin_layout Standard
18264 First, it describes the syntax of each command, that is, how many required
18265  arguments and how many optional arguments the command takes.
18266  Knowing this makes it easier for reLyX to copy (in TeX mode) commands that
18267  it doesn't know how to translate.
18268  The syntax file simply has a command, followed by braces or brackets describing
18269  its arguments in the correct order.
18270  For example, a syntax file entry 
18271 \family typewriter
18272
18273 \backslash
18274 bibitem[]{}
18275 \family default
18276  means that the 
18277 \family typewriter
18278
18279 \backslash
18280 bibitem
18281 \family default
18282  command takes an optional argument followed by a required one, while the
18283  entry 
18284 \family typewriter
18285
18286 \backslash
18287 bf
18288 \family default
18289  means that the 
18290 \family typewriter
18291
18292 \backslash
18293 bf
18294 \family default
18295  command takes no arguments at all.
18296   When reLyX encounters a token that it doesn't know how to translate into
18297  LyX, it will copy the token---along with the correct number of arguments---exac
18298 tly.
18299   If the token is not in the syntax file, then reLyX just copies as many
18300  arguments as it finds.
18301   This means that it may copy too much.
18302  But since the user can specify additional syntax files, that shouldn't
18303  happen often.
18304 \end_layout
18305
18306 \begin_layout Standard
18307 Some commands that cannot be translated to LyX, like 
18308 \family typewriter
18309
18310 \backslash
18311 mbox
18312 \family default
18313 , have as one of their arguments regular LaTeX text.
18314  If the string 
18315 \begin_inset Quotes eld
18316 \end_inset
18317
18318 translate
18319 \begin_inset Quotes erd
18320 \end_inset
18321
18322  is put into an argument of an (untranslatable) command in the syntax file,
18323  then reLyX will translate that argument instead of copying it verbatim.
18324  So, for example, the default syntax file has 
18325 \family typewriter
18326
18327 \backslash
18328 raisebox{}[][]{translate}
18329 \family default
18330 .
18331  This means that the 
18332 \family typewriter
18333
18334 \backslash
18335 raisebox
18336 \family default
18337  command and the first argument (and optional arguments if they exist) are
18338  copied in TeX mode, but the last argument (which may contain math, complicated
18339  LaTeX, other untranslatable commands, etc.) will be translated into LyX.
18340  You can't use 
18341 \begin_inset Quotes eld
18342 \end_inset
18343
18344 translate
18345 \begin_inset Quotes erd
18346 \end_inset
18347
18348  on optional arguments.
18349 \end_layout
18350
18351 \begin_layout Standard
18352 User-defined syntax files are allowed to define new commands and their syntax,
18353  or override the number of arguments for a command given in the default
18354  syntax file.
18355  (E.g., if you're using a style that gives an extra argument to some command...)
18356  However, this will only be useful for commands copied in TeX mode.
18357  Commands which are actually translated by reLyX (like 
18358 \family typewriter
18359
18360 \backslash
18361 item
18362 \family default
18363 ) have their argument syntax hard-coded.
18364  The hard-coded commands are identified in the default syntax file.
18365 \end_layout
18366
18367 \begin_layout Standard
18368 Second, the syntax file describes any 
18369 \begin_inset Quotes eld
18370 \end_inset
18371
18372 regular environments
18373 \begin_inset Quotes erd
18374 \end_inset
18375
18376 .
18377   Usually, an entire unknown environment will be copied in TeX mode.
18378  If you define a regular environment 
18379 \begin_inset Quotes eld
18380 \end_inset
18381
18382 foo
18383 \begin_inset Quotes erd
18384 \end_inset
18385
18386 , though, then only the 
18387 \family typewriter
18388
18389 \backslash
18390 begin{foo}
18391 \family default
18392  and 
18393 \family typewriter
18394
18395 \backslash
18396 end{foo}
18397 \family default
18398  commands will be copied in TeX mode; the text within the environment will
18399  be treated (i.e., translated) by reLyX as regular LaTeX, rather than being
18400  copied into TeX mode.
18401  Don't try to declare 
18402 \family typewriter
18403 tabbing
18404 \family default
18405  and 
18406 \family typewriter
18407 picture
18408 \family default
18409  as regular environments, as the text within those environments will confuse
18410  reLyX; use this capability for new environments you create that have plain
18411  text or math or simple commands in them.
18412  You also can't declare unknown math environments (like 
18413 \family typewriter
18414 equation*
18415 \family default
18416 ) as regular environments, either, since the LyX math editor won't understand
18417  them.
18418  The names of regular environments appear, whitespace-separated, between
18419  
18420 \family typewriter
18421
18422 \backslash
18423 begin{reLyXre}
18424 \family default
18425  and 
18426 \family typewriter
18427
18428 \backslash
18429 end{reLyXre}
18430 \family default
18431  statements in the syntax file.
18432  (If you have a regular environment which you won't use very often, you
18433  can use the 
18434 \series bold
18435 -r
18436 \series default
18437  option rather than writing a syntax file.)
18438 \end_layout
18439
18440 \begin_layout Standard
18441 Third, the syntax file describes a math translation table.
18442  The LyX math editor doesn't support a few commands.
18443  For example, 
18444 \family typewriter
18445 _
18446 \family default
18447  is supported, but the equivalent 
18448 \family typewriter
18449
18450 \backslash
18451 sb
18452 \family default
18453  is not.
18454  Put any commands you'd like translate between 
18455 \family typewriter
18456
18457 \backslash
18458 begin{reLyXmt}
18459 \family default
18460  and 
18461 \family typewriter
18462
18463 \backslash
18464 end{reLyXmt}
18465 \family default
18466  statements.
18467  The statement 
18468 \begin_inset Quotes eld
18469 \end_inset
18470
18471
18472 \family typewriter
18473
18474 \backslash
18475 | {
18476 \backslash
18477 Vert}
18478 \family default
18479
18480 \begin_inset Quotes erd
18481 \end_inset
18482
18483  means that any 
18484 \family typewriter
18485
18486 \backslash
18487 |
18488 \family default
18489  in math mode will be converted to 
18490 \begin_inset Quotes eld
18491 \end_inset
18492
18493
18494 \family typewriter
18495
18496 \backslash
18497 Vert
18498 \family default
18499  
18500 \begin_inset Quotes erd
18501 \end_inset
18502
18503
18504 \family typewriter
18505  
18506 \family default
18507 (in cases where a token made up of a backslash and a non-letter is translated
18508  to something with letters at the end, a space is added by reLyX.
18509  That way, 
18510 \begin_inset Quotes eld
18511 \end_inset
18512
18513
18514 \family typewriter
18515
18516 \backslash
18517 |a
18518 \family default
18519
18520 \begin_inset Quotes erd
18521 \end_inset
18522
18523  is correctly translated to 
18524 \begin_inset Quotes eld
18525 \end_inset
18526
18527
18528 \family typewriter
18529
18530 \backslash
18531 Vert a
18532 \family default
18533
18534 \begin_inset Quotes erd
18535 \end_inset
18536
18537 ).
18538 \end_layout
18539
18540 \begin_layout Subsubsection
18541 Miscellaneous
18542 \end_layout
18543
18544 \begin_layout Standard
18545 You need Perl version 5.002 or later to run reLyX.
18546  <plug> If you don't have Perl, you should get it anyway (at 
18547 \begin_inset LatexCommand \url[Perl]{http://www.perl.com/}
18548
18549 \end_inset
18550
18551 ), because it's a really useful tool for pretty much anything.
18552  </plug>
18553 \end_layout
18554
18555 \begin_layout Subsection
18556 Diagnostics
18557 \end_layout
18558
18559 \begin_layout Standard
18560 reLyX should always explain why it crashes, if it crashes.
18561  Some diagnostics may be very technical, though, if they come from the guts
18562  of the code.
18563  reLyX gives much more information while running if you use the 
18564 \series bold
18565 -d
18566 \series default
18567  option, but you shouldn't need that unless something goes wrong.
18568 \end_layout
18569
18570 \begin_layout Standard
18571 When it's finished, reLyX will tell you if it finished successfully or died
18572  due to some error.
18573 \end_layout
18574
18575 \begin_layout Subsection
18576 Warnings
18577 \end_layout
18578
18579 \begin_layout Standard
18580 Always keep a copy of your original LaTeX files either under a different
18581  name or in a different directory.
18582  There are a couple ways in which using LyX could lead to overwriting the
18583  original LaTeX file.
18584 \end_layout
18585
18586 \begin_layout Standard
18587 If you import 
18588 \family typewriter
18589 foo.tex
18590 \family default
18591  to create 
18592 \family typewriter
18593 foo.lyx
18594 \family default
18595 , then edit 
18596 \family typewriter
18597 foo.lyx
18598 \family default
18599  and want to re-export it, note that it will overwrite the original 
18600 \family typewriter
18601 foo.tex
18602 \family default
18603 .
18604  (LyX will 
18605 \emph on
18606 not
18607 \emph default
18608  ask you if you want to overwrite it.)
18609 \end_layout
18610
18611 \begin_layout Standard
18612 If you have chosen not to use a temporary directory in the preferences,
18613  then LyX will create its temporary files in your current directory, which
18614  means your LaTeX original may be overwritten (without a warning from LyX)
18615  when you 
18616 \begin_inset Quotes eld
18617 \end_inset
18618
18619 view dvi
18620 \begin_inset Quotes erd
18621 \end_inset
18622
18623  or print the LyX document.
18624 \end_layout
18625
18626 \begin_layout Subsection
18627 Files
18628 \end_layout
18629
18630 \begin_layout Description
18631
18632 \family typewriter
18633 \series medium
18634 MY_LYXDIR/layouts/*.layout
18635 \family default
18636 \series default
18637  \InsetSpace ~
18638
18639 \newline
18640 User's personal layout files for document classes
18641 \end_layout
18642
18643 \begin_layout Description
18644
18645 \family typewriter
18646 \series medium
18647 MY_LYXDIR/reLyX/syntax.default
18648 \family default
18649 \series default
18650  \InsetSpace ~
18651
18652 \newline
18653 User's personal syntax file
18654 \end_layout
18655
18656 \begin_layout Description
18657
18658 \family typewriter
18659 \series medium
18660 LIBDIR/layouts/*.layout
18661 \family default
18662 \series default
18663  \InsetSpace ~
18664
18665 \newline
18666 System-wide layout files for document classes
18667 \end_layout
18668
18669 \begin_layout Description
18670
18671 \family typewriter
18672 \series medium
18673 LIBDIR/reLyX/syntax.default
18674 \family default
18675 \series default
18676  \InsetSpace ~
18677
18678 \newline
18679 System-wide LaTeX syntax file
18680 \end_layout
18681
18682 \begin_layout Standard
18683
18684 \family typewriter
18685 LIBDIR
18686 \family default
18687  is the system-wide LyX directory, usually something like 
18688 \family typewriter
18689 /usr/local/share/lyx/
18690 \family default
18691 .
18692  
18693 \family typewriter
18694 MY_LYXDIR
18695 \family default
18696  is your personal LyX directory, something like 
18697 \family typewriter
18698 .lyx/
18699 \family default
18700  in your home directory.
18701  You can see their actual values in the 
18702 \family sans
18703 \bar under
18704 H
18705 \bar default
18706 elp\SpecialChar \menuseparator
18707 About\InsetSpace ~
18708 Ly
18709 \bar under
18710 X
18711 \family default
18712 \bar default
18713  dialog.
18714 \end_layout
18715
18716 \begin_layout Subsection
18717 See also
18718 \end_layout
18719
18720 \begin_layout Standard
18721
18722 \shape italic
18723 lyx
18724 \shape default
18725 (1), 
18726 \shape italic
18727 latex
18728 \shape default
18729 (1)
18730 \end_layout
18731
18732 \begin_layout Subsection
18733 Authors
18734 \end_layout
18735
18736 \begin_layout Standard
18737 Copyright (c) 1998--9 
18738 \noun on
18739 Amir Karger
18740 \noun default
18741  (
18742 \family typewriter
18743 karger@voth.chem.utah.edu
18744 \family default
18745 )
18746 \end_layout
18747
18748 \begin_layout Standard
18749 Code contributors:
18750 \end_layout
18751
18752 \begin_layout Itemize
18753
18754 \noun on
18755 John Weiss
18756 \noun default
18757  wrote the original CleanTeX pass.
18758 \end_layout
18759
18760 \begin_layout Itemize
18761
18762 \noun on
18763 Etienne Grossmann
18764 \end_layout
18765
18766 \begin_layout Itemize
18767
18768 \noun on
18769 Jos\i \'{e}
18770  Ab\i \'{\i}
18771 lio Oliveira Matos
18772 \end_layout
18773
18774 \begin_layout Itemize
18775
18776 \noun on
18777 David Suarez de Lis
18778 \end_layout
18779
18780 \begin_layout Standard
18781 Other contributors:
18782 \end_layout
18783
18784 \begin_layout Itemize
18785
18786 \noun on
18787 Jean-Marc Lasgouttes
18788 \noun default
18789  worked on the wrapper script and offered lots of bug reports, advice, and
18790  feature suggestions.
18791 \end_layout
18792
18793 \begin_layout Itemize
18794
18795 \noun on
18796 Asger K.
18797  Alstrup Nielsen
18798 \noun default
18799  and 
18800 \noun on
18801 Marc Pavese
18802 \noun default
18803  provided advice.
18804 \end_layout
18805
18806 \begin_layout Itemize
18807 Various members of the LyX developers' and users' lists provided bug reports
18808  and feature suggestions.
18809 \end_layout
18810
18811 \begin_layout Standard
18812 reLyX uses a modified version the Perl TeX parser 
18813 \family typewriter
18814 Text::TeX
18815 \family default
18816  package written by 
18817 \noun on
18818 Ilya Zakharevich
18819 \noun default
18820  (
18821 \family typewriter
18822 ilya@math.ohio-state.edu
18823 \family default
18824 ), available on CPAN.
18825 \end_layout
18826
18827 \begin_layout Chapter
18828 LyX Features needing Extra Software
18829 \end_layout
18830
18831 \begin_layout Section
18832 Using LyX with SGML-Tools (aka LinuxDoc)
18833 \end_layout
18834
18835 \begin_layout Standard
18836 by 
18837 \noun on
18838 Paul Evans
18839 \end_layout
18840
18841 \begin_layout Subsection
18842 Overview
18843 \end_layout
18844
18845 \begin_layout Standard
18846 LinuxDoc is a document class available in LyX if you have the 
18847 \family typewriter
18848 sgml-tools
18849 \family default
18850  package installed.
18851  You can use it to produce documents in the so-called Standardized General
18852  Mark-up Language (SGML) in the particular format used by the Linux Documentatio
18853 n Project.
18854  That is obviously helpful if you are contributing to that project.
18855  You can use the SGML format with the 
18856 \family typewriter
18857 sgml-tools
18858 \family default
18859  package of scripts and programs (to produce other formats, including Latex,
18860  HTML, plain text, man pages and\SpecialChar \ldots{}
18861 ).
18862  You may therefore prefer to use this document class if you want to write
18863  something that can be easily translated into other formats.
18864 \end_layout
18865
18866 \begin_layout Standard
18867 You will find that LinuxDoc has fewer layout options than the other text
18868  classes in LyX.
18869  This is mainly so that the translations into other formats have a chance
18870  of making some sense.
18871  In this section we describe:
18872 \end_layout
18873
18874 \begin_layout Itemize
18875 how to setup and use a document in LinuxDoc
18876 \end_layout
18877
18878 \begin_layout Itemize
18879 how to use the tags in LinuxDoc to layout your document
18880 \end_layout
18881
18882 \begin_layout Itemize
18883 how to use the SGML packages to produce the various formats
18884 \end_layout
18885
18886 \begin_layout Itemize
18887 how to sort out some problems.
18888 \end_layout
18889
18890 \begin_layout Subsection
18891 Preparing and using a LinuxDoc document
18892 \end_layout
18893
18894 \begin_layout Subsubsection
18895 Getting started
18896 \end_layout
18897
18898 \begin_layout Standard
18899 You start by selecting the LinuxDoc class using the 
18900 \family sans
18901 \bar under
18902 D
18903 \bar default
18904 ocument\SpecialChar \menuseparator
18905
18906 \bar under
18907 S
18908 \bar default
18909 ettings
18910 \family default
18911  dialog.
18912
18913 \family sans
18914  
18915 \family default
18916 Then you will find that there are fewer paragraph environments than for
18917  most other classes.
18918  You can see them on the pull down box on the left of the tool bar.
18919  How to use them is described in section\InsetSpace ~
18920
18921 \begin_inset LatexCommand \ref{sec:sgmlparas}
18922
18923 \end_inset
18924
18925 .
18926 \end_layout
18927
18928 \begin_layout Standard
18929 You 
18930 \emph on
18931 must
18932 \emph default
18933  enter a title for the document, followed by an author, marking each with
18934  the appropriate paragraph environment.
18935  If you don't do this, you will get errors when you try to print the file.
18936  You can then enter the date and an abstract.
18937  The document proper must start with a Section paragraph environment rather
18938  than any standard layout.
18939 \end_layout
18940
18941 \begin_layout Standard
18942 After that you can prepare a document as usual using the available range
18943  of paragraph environments.
18944  See section\InsetSpace ~
18945
18946 \begin_inset LatexCommand \ref{sec:sgmlparas}
18947
18948 \end_inset
18949
18950  for the full list and their uses.
18951 \end_layout
18952
18953 \begin_layout Subsubsection
18954 Output from LinuxDoc
18955 \end_layout
18956
18957 \begin_layout Standard
18958 You can print and save these documents in the normal way.
18959  To use the other features of the SGML package you need to save your document
18960  as LinuxDoc; this is a version in which the document is translated into
18961  the basic sgml tags.
18962  Use
18963 \family sans
18964  
18965 \bar under
18966 F
18967 \bar default
18968 ile\SpecialChar \menuseparator
18969
18970 \bar under
18971 E
18972 \bar default
18973 xport\SpecialChar \menuseparator
18974 Linu
18975 \bar under
18976 x
18977 \bar default
18978 Doc.
18979
18980 \family default
18981  You will get a file with the same name and a 
18982 \family typewriter
18983 .sgml
18984 \family default
18985  extension rather than a 
18986 \family typewriter
18987 .lyx
18988 \family default
18989  extension.
18990  See\InsetSpace ~
18991
18992 \begin_inset LatexCommand \ref{sec:sgmloperate}
18993
18994 \end_inset
18995
18996  on how you than make use of this file.
18997 \end_layout
18998
18999 \begin_layout Subsection
19000 Using the paragraph environments in LinuxDoc
19001 \end_layout
19002
19003 \begin_layout Subsubsection
19004 The Structure of a LinuxDoc Document
19005 \end_layout
19006
19007 \begin_layout Standard
19008 There is a formal structure for LinuxDoc which limits how you can place
19009  tags.
19010  There are two parts to all documents: 
19011 \end_layout
19012
19013 \begin_layout Description
19014 Header: this is everything up to the first time you insert a Section layout
19015  marker.
19016  It can include title, author, date, abstract and ToC.
19017  You must include the first two.
19018 \end_layout
19019
19020 \begin_layout Description
19021 Body: from the beginning of the first section onwards.
19022  All other tags are allowed.
19023  
19024 \end_layout
19025
19026 \begin_layout Subsubsection
19027 The LinuxDoc Paragraph Environments
19028 \end_layout
19029
19030 \begin_layout Standard
19031 \begin_inset LatexCommand \label{sec:sgmlparas}
19032
19033 \end_inset
19034
19035 Here is a list of all the tags you will find listed on the layout bar in
19036  the order they come there, with some comments where the purpose or use
19037  is not obvious:
19038 \end_layout
19039
19040 \begin_layout Itemize
19041
19042 \family sans
19043 Standard:
19044 \family roman
19045  works as described in [cross reference]
19046 \end_layout
19047
19048 \begin_layout Itemize
19049
19050 \family sans
19051 Title
19052 \family default
19053 : This will appear at the top left of the document when printed, above a
19054  heavy horizontal rule, although you will not see this on the LyX screen.
19055 \end_layout
19056
19057 \begin_layout Itemize
19058
19059 \family sans
19060 Section, Subsection, Subsubsection, Paragraph and Subparagraph:
19061 \family default
19062  all do what you would expect and in the usual order.
19063  Whether they are numbered or not is controlled by the 
19064 \family sans
19065 Section\InsetSpace ~
19066 number\InsetSpace ~
19067 depth
19068 \family default
19069  setting.
19070  You cannot get the equivalent number free versions in any other way; there
19071  is no 
19072 \family sans
19073 Section*
19074 \family default
19075  or similar
19076 \end_layout
19077
19078 \begin_layout Itemize
19079
19080 \family sans
19081 Enumerate:
19082 \family default
19083  As usual this produces a numbered and indented list as described in the
19084  
19085 \emph on
19086 User's Guide
19087 \emph default
19088 .
19089 \end_layout
19090
19091 \begin_layout Itemize
19092
19093 \family sans
19094 Itemize: 
19095 \family roman
19096 Again much the same as in the other classes: see the 
19097 \emph on
19098 User's Guide
19099 \emph default
19100 .
19101 \end_layout
19102
19103 \begin_layout Itemize
19104
19105 \family sans
19106 Description
19107 \family default
19108 : As explained in the 
19109 \emph on
19110 User's Guide
19111 \emph default
19112 .
19113  Remember that if you want the bold element at the start of a description
19114  to be more than one word then you need to put protected spaces between
19115  the words.
19116  
19117 \end_layout
19118
19119 \begin_layout Itemize
19120
19121 \family sans
19122 Verbatim: 
19123 \family default
19124 As usual.
19125 \end_layout
19126
19127 \begin_layout Itemize
19128
19129 \family sans
19130 Code: similar to the Lyx-Code
19131 \family roman
19132  environment
19133 \end_layout
19134
19135 \begin_layout Itemize
19136
19137 \family sans
19138 Author
19139 \family default
19140 : Anything you mark with this will appear on the left of the heading of
19141  the document, under the heavy rule.
19142 \end_layout
19143
19144 \begin_layout Itemize
19145
19146 \family sans
19147 Date:
19148 \family default
19149  Anything you mark with this will appear on the right of the heading under
19150  the rule.
19151  You do not have to make this a date.
19152  Any text can be entered, e.\InsetSpace ~
19153 g.
19154  a version number.
19155 \end_layout
19156
19157 \begin_layout Itemize
19158
19159 \family sans
19160 Abstract
19161 \family default
19162 : You can use this to produce a free standing paragraph after the author
19163  and date, and before the first section.
19164  You are only allowed one such paragraph.
19165 \begin_inset Foot
19166 status collapsed
19167
19168 \begin_layout Standard
19169
19170 \emph on
19171 Author's note.
19172  
19173 \emph default
19174 This needs checking ---
19175 \emph on
19176 pe.
19177 \end_layout
19178
19179 \end_inset
19180
19181
19182 \end_layout
19183
19184 \begin_layout Itemize
19185
19186 \family sans
19187 Displaymath
19188 \family default
19189 :
19190 \begin_inset Foot
19191 status collapsed
19192
19193 \begin_layout Standard
19194
19195 \emph on
19196 Author's note: 
19197 \emph default
19198 I have not yet checked this ---
19199 \emph on
19200 pe.
19201 \end_layout
19202
19203 \end_inset
19204
19205
19206 \end_layout
19207
19208 \begin_layout Subsubsection
19209 Other document features
19210 \end_layout
19211
19212 \begin_layout Standard
19213 You can also use the 
19214 \family sans
19215 Layout 
19216 \family default
19217 menu to set fonts or to emphasis words.
19218  You can also use the table of contents as usual; see the corresponding
19219  section of the 
19220 \emph on
19221 User's Guide
19222 \emph default
19223 .
19224  Although you will find some some other features on the menus e.\InsetSpace ~
19225 g.
19226  inserting footnotes.
19227  There is some doubt about whether these will work correctly.
19228 \begin_inset Foot
19229 status collapsed
19230
19231 \begin_layout Standard
19232
19233 \emph on
19234 Author's note: 
19235 \emph default
19236 Again still checking to see whether this is my system
19237 \emph on
19238  ---pe.
19239 \end_layout
19240
19241 \end_inset
19242
19243
19244 \end_layout
19245
19246 \begin_layout Subsubsection
19247 Cross references and HTML 
19248 \end_layout
19249
19250 \begin_layout Standard
19251 On the
19252 \family sans
19253  Insert
19254 \family default
19255  menu you will find two new options relating to the inclusion of URL addresses.
19256  If you use either option you will find some highlighted TeX code inserted
19257  into your document in three separate blocks with spaces available between.
19258  The blocks will be:
19259 \end_layout
19260
19261 \begin_layout Quote
19262
19263 \family typewriter
19264
19265 \backslash
19266 htmlurl{
19267 \family default
19268  or 
19269 \family typewriter
19270
19271 \backslash
19272 url{
19273 \family roman
19274
19275 \hfill
19276 space
19277 \family default
19278  
19279 \family typewriter
19280
19281 \hfill
19282 }{
19283 \family roman
19284
19285 \hfill
19286 space
19287 \hfill
19288
19289 \family typewriter
19290 }
19291 \end_layout
19292
19293 \begin_layout Standard
19294 You insert a full HTML tag between the first and second blocks.
19295  This can be 
19296 \begin_inset LatexCommand \url{http://any.address}
19297
19298 \end_inset
19299
19300  or other valid tags such as 
19301 \begin_inset LatexCommand \url{mailto:me@my.address}
19302
19303 \end_inset
19304
19305
19306 \family typewriter
19307 .
19308 \family default
19309 Then y
19310 \family roman
19311 ou 
19312 \family default
19313 insert some description between the second and third blocks.
19314  The differences are:
19315 \end_layout
19316
19317 \begin_layout Itemize
19318
19319 \family sans
19320 URL:
19321 \family roman
19322  both the HTML tag and the description will appear in the document
19323 \end_layout
19324
19325 \begin_layout Itemize
19326
19327 \family sans
19328 HTML\InsetSpace ~
19329 URL: 
19330 \family roman
19331 only the description appears in the printed version
19332 \end_layout
19333
19334 \begin_layout Subsection
19335 Using the LinuxDoc Sgml scripts
19336 \begin_inset Note Note
19337 status collapsed
19338
19339 \begin_layout Standard
19340 This section is completely outdated.
19341 \end_layout
19342
19343 \end_inset
19344
19345
19346 \end_layout
19347
19348 \begin_layout Standard
19349 \begin_inset LatexCommand \label{sec:sgmloperate}
19350
19351 \end_inset
19352
19353 You can use LinuxDoc as a text class without any additional scripts or programs,
19354  but there is not much point in doing this.
19355  All you will get is a document that looks like a 
19356 \emph on
19357 Linux Documentation Project Howto
19358 \family sans
19359 \emph default
19360 .
19361  
19362 \family default
19363 To do the document translation you need to get and install the 
19364 \family typewriter
19365 sgml-tools-1.0.x.tar.gz 
19366 \family default
19367 (with 
19368 \begin_inset Formula $x\geq3$
19369 \end_inset
19370
19371 ) package from 
19372 \family roman
19373 the SGML-Tools WWW Page
19374 \family default
19375  at
19376 \end_layout
19377
19378 \begin_layout LyX-Code
19379
19380 \family roman
19381 \begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
19382
19383 \end_inset
19384
19385
19386 \family default
19387  
19388 \end_layout
19389
19390 \begin_layout Standard
19391 Alternatively, you can go to the 
19392 \family typewriter
19393 sunsite
19394 \family default
19395  archive at
19396 \begin_inset Foot
19397 status collapsed
19398
19399 \begin_layout Standard
19400 Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
19401  has not yet been made available at 
19402 \family typewriter
19403 sunsite
19404 \family default
19405 .
19406 \end_layout
19407
19408 \end_inset
19409
19410
19411 \end_layout
19412
19413 \begin_layout LyX-Code
19414
19415 \family roman
19416 \begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
19417
19418 \end_inset
19419
19420
19421 \end_layout
19422
19423 \begin_layout Standard
19424
19425 \family roman
19426 The
19427 \family default
19428  file 
19429 \family typewriter
19430 sgml-tools-1.0.x.tar.gz
19431 \family default
19432  contains everything that you need to write SGML documents and convert them
19433  to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
19434
19435 \end_layout
19436
19437 \begin_layout Standard
19438 This package was renamed from 
19439 \family typewriter
19440 linuxdoc-sgml-1.5.tar.gz
19441 \family default
19442  in January 1997.
19443 \end_layout
19444
19445 \begin_layout Standard
19446 Follow the instructions in that package on how to install it and how to
19447  use it.
19448  All this has to be done outside of LyX, before you can use the 
19449 \family sans
19450 \bar under
19451 F
19452 \bar default
19453 ile\SpecialChar \menuseparator
19454
19455 \bar under
19456 E
19457 \bar default
19458 xport\SpecialChar \menuseparator
19459 as\InsetSpace ~
19460 LinuxDoc 
19461 \family roman
19462 option.
19463 \end_layout
19464
19465 \begin_layout Subsection
19466 Troubleshooting LinuxDoc
19467 \end_layout
19468
19469 \begin_layout Standard
19470 When you print or preview a LinuxDoc document some checking is done of the
19471  tags before LaTeX is run.
19472  Some errors are trapped here, especially those concerning the structure
19473  of the document.
19474  LyX may produce an error message, but not leave an error box in the document
19475  for you to open.
19476  You may have to look at the files directly to discover what is wrong.
19477  Most problems seem to come from the use of options that are not fully available
19478  in the text class.
19479 \end_layout
19480
19481 \begin_layout Section
19482 Checking TeX
19483 \end_layout
19484
19485 \begin_layout Standard
19486 by 
19487 \noun on
19488 Asger Alstrup
19489 \end_layout
19490
19491 \begin_layout Subsection
19492 Introduction
19493 \end_layout
19494
19495 \begin_layout Standard
19496 Under the 
19497 \family sans
19498 \bar under
19499 T
19500 \bar default
19501 ools
19502 \family default
19503  menu, you'll find a 
19504 \family sans
19505 \bar under
19506 C
19507 \bar default
19508 heck\InsetSpace ~
19509 TeX
19510 \family default
19511  command.
19512  This feature requires you to have the 
19513 \family typewriter
19514 chktex
19515 \family default
19516  program installed, and is grayed out if you don't have it.
19517  You can get it from your nearest CTAN mirror, or over the Web from 
19518 \begin_inset LatexCommand \url{http://www.ifi.uio.no/~jensthi/chktex/}
19519
19520 \end_inset
19521
19522 .
19523 \end_layout
19524
19525 \begin_layout Standard
19526 The 
19527 \family sans
19528 ChkTeX
19529 \family default
19530  package is a program that was written by 
19531 \noun on
19532 Jens T.
19533  Berger Thielemann
19534 \noun default
19535  in frustration because some constructs in LaTeX are sometimes non-intuitive,
19536  and easy to forget.
19537  The program runs over your LaTeX file and checks the integrity of the file,
19538  and flags some common errors.
19539  In other technical words, it is 
19540 \family typewriter
19541 Lint
19542 \family default
19543  for LaTeX.
19544 \end_layout
19545
19546 \begin_layout Standard
19547 Well, what is a syntax checker doing in LyX which is supposed to produce
19548  correct LaTeX anyways? The answer is simple: Just as 
19549 \family typewriter
19550 Lint
19551 \family default
19552  not only checks the 
19553 \emph on
19554 syntax
19555 \emph default
19556  of C programs, but also does 
19557 \emph on
19558 semantic
19559 \emph default
19560  checks for type-errors, 
19561 \family sans
19562 ChkTeX
19563 \family default
19564  catches some common 
19565 \emph on
19566 typographic
19567 \emph default
19568  errors, in addition to the syntactical ones.
19569  Specifically, 
19570 \family sans
19571 ChkTeX
19572 \family default
19573  is capable of detecting several common errors, such as
19574 \end_layout
19575
19576 \begin_layout Itemize
19577 Ellipsis detection:
19578 \newline
19579 Use \SpecialChar \ldots{}
19580  instead of ...
19581 \end_layout
19582
19583 \begin_layout Itemize
19584 No space in front of/after parenthesis:
19585 \newline
19586 ( wrong spacing )
19587 \end_layout
19588
19589 \begin_layout Itemize
19590 Enforcement of normal space after common abbreviations:
19591 \newline
19592 e.
19593  g.
19594  is too wide spacing.
19595 \end_layout
19596
19597 \begin_layout Itemize
19598 Enforcement of end-of-sentence space when the last sentence ends with a
19599  capital letter:
19600 \newline
19601 This is a TEST.
19602  And this is wrong spacing.
19603 \end_layout
19604
19605 \begin_layout Itemize
19606 Space in front of labels and similar commands:
19607 \newline
19608 The label should stick right
19609  up to the text to avoid falling to a wrong page.
19610  
19611 \begin_inset LatexCommand \label{sec:chktex}
19612
19613 \end_inset
19614
19615  
19616 \begin_inset Foot
19617 status collapsed
19618
19619 \begin_layout Standard
19620 This footnote is in danger of falling off to a wrong page
19621 \end_layout
19622
19623 \end_inset
19624
19625  The label is separated too much.
19626 \end_layout
19627
19628 \begin_layout Itemize
19629 Space in front of references, instead of hard spaces:
19630 \newline
19631 In you are in bad luck,
19632  the text will break right between the referenced text and reference number,
19633  and that's a pity.
19634  See section 
19635 \begin_inset LatexCommand \ref{sec:chktex}
19636
19637 \end_inset
19638
19639 .
19640 \end_layout
19641
19642 \begin_layout Itemize
19643 Use of 
19644 \begin_inset Quotes eld
19645 \end_inset
19646
19647 x
19648 \begin_inset Quotes erd
19649 \end_inset
19650
19651  instead of 
19652 \begin_inset Formula $\times$
19653 \end_inset
19654
19655  between numbers:
19656 \newline
19657 2x2 looks cheap compared to 
19658 \begin_inset Formula $2\times2$
19659 \end_inset
19660
19661 .
19662 \end_layout
19663
19664 \begin_layout Standard
19665 and more \SpecialChar \ldots{}
19666  It is an invaluable tool when you are 
19667 \begin_inset Quotes eld
19668 \end_inset
19669
19670 finishing up
19671 \begin_inset Quotes erd
19672 \end_inset
19673
19674  your document before printing, and you should run it right after the obligatory
19675  spelling check, and before you go fine tuning the typesetting.
19676 \end_layout
19677
19678 \begin_layout Subsection
19679 How to use it
19680 \end_layout
19681
19682 \begin_layout Standard
19683 If you have the program installed, usage is as simple as choosing 
19684 \family sans
19685 \bar under
19686 T
19687 \bar default
19688 ools\SpecialChar \menuseparator
19689
19690 \bar under
19691 C
19692 \bar default
19693 heck\InsetSpace ~
19694 TeX
19695 \family default
19696 .
19697  This will make LyX generate a LaTeX file of your document, start 
19698 \family sans
19699 ChkTeX
19700 \family default
19701  to check it, and then make LyX insert 
19702 \begin_inset Quotes eld
19703 \end_inset
19704
19705 error boxes
19706 \begin_inset Quotes erd
19707 \end_inset
19708
19709  with the warnings from 
19710 \family sans
19711 ChkTeX
19712 \family default
19713 , if there were any.
19714  The warnings will be placed close to the point of the mistake, and you
19715  can quickly find them by using the 
19716 \family sans
19717 \bar under
19718 N
19719 \bar default
19720 avigate\SpecialChar \menuseparator
19721
19722 \bar under
19723 E
19724 \bar default
19725 rror
19726 \family default
19727  menu item, or the shortcut key 
19728 \family sans
19729 C-g
19730 \family default
19731  from the default 
19732 \family typewriter
19733 cua
19734 \family default
19735  bind file.
19736  Open the error boxes by clicking on them with the mouse, or use the shortcut
19737  key 
19738 \family sans
19739 C-i
19740 \family default
19741  from 
19742 \family typewriter
19743 cua
19744 \family default
19745  bindings, or the corresponding 
19746 \family sans
19747 C-o
19748 \family default
19749  for the alternate 
19750 \family typewriter
19751 emacs
19752 \family default
19753  bind file.
19754  Read the warning and correct the mistake, if it is a mistake.
19755  If you have trouble understanding what the warning is about, you can safely
19756  ignore it.
19757  Remember that there is a hidden layer between the document on screen and
19758  the technical details in invoking 
19759 \family sans
19760 ChkTeX
19761 \family default
19762 , and this gap can make some warnings seem arcane or just right down plain
19763  silly.
19764 \end_layout
19765
19766 \begin_layout Standard
19767 This document is an excellent testing bed for the feature, and it should
19768  provide quite a few warnings for you to fiddle with.
19769  Since computers are only so smart, expect most of the warnings to be false
19770  alarms, though.
19771 \end_layout
19772
19773 \begin_layout Subsection
19774 How to fine tune it
19775 \end_layout
19776
19777 \begin_layout Standard
19778 Sometimes, you'll find that 
19779 \family sans
19780 ChkTeX
19781 \family default
19782  makes more noise than suits your mood.
19783  Then you can choose not to use it, wait until your mood changes, or try
19784  to customize 
19785 \family sans
19786 ChkTeX
19787 \family default
19788  to get better along with you.
19789  Another choice in the most desperate situations is to use 
19790 \family sans
19791 \bar under
19792 V
19793 \bar default
19794 iew\SpecialChar \menuseparator
19795
19796 \bar under
19797 R
19798 \bar default
19799 emove\InsetSpace ~
19800 All\InsetSpace ~
19801 Error\InsetSpace ~
19802 Boxes
19803 \family default
19804 , which will get rid of all warnings instantly.
19805 \end_layout
19806
19807 \begin_layout Standard
19808 Although 
19809 \family sans
19810 ChkTeX
19811 \family default
19812  
19813 \emph on
19814 is
19815 \emph default
19816  very configurable and extensible, you shouldn't expect to solve all problems
19817  with 
19818 \family sans
19819 ChkTeX
19820 \family default
19821  in LyX this way.
19822  Since LyX has to generate a somewhat special LaTeX file to be able to match
19823  the line numbers from the 
19824 \family sans
19825 ChkTeX
19826 \family default
19827  output
19828 \begin_inset Foot
19829 status collapsed
19830
19831 \begin_layout Standard
19832 You can inspect the specific output from 
19833 \family sans
19834 chktex
19835 \family default
19836  by using 
19837 \family sans
19838 Edit\SpecialChar \menuseparator
19839 View\InsetSpace ~
19840 LaTeX\InsetSpace ~
19841 Log
19842 \family default
19843  right after a 
19844 \family sans
19845 chktex
19846 \family default
19847  run.
19848 \end_layout
19849
19850 \end_inset
19851
19852  to the internal document structure, some of the warnings will not seen
19853  to appear correctly.
19854  There are two things you can do about this:
19855 \end_layout
19856
19857 \begin_layout Itemize
19858 Fine tune the 
19859 \family sans
19860 ChkTeX
19861 \family default
19862  invocation command line in 
19863 \family sans
19864 Preferences
19865 \family default
19866  (tabs 
19867 \family sans
19868 Outputs
19869 \family default
19870
19871 \family sans
19872 Misc
19873 \family default
19874 ), or the global 
19875 \family sans
19876 ChkTeX
19877 \family default
19878  installation configuration file (usually with the file 
19879 \family typewriter
19880 /usr/local/share/chktexrc
19881 \family default
19882 ).
19883  See below to learn what warnings can be enabled and disabled on the command
19884  line.
19885  
19886 \end_layout
19887
19888 \begin_layout Itemize
19889 Export your document as a raw LaTeX file using 
19890 \family sans
19891 \bar under
19892 F
19893 \bar default
19894 ile\SpecialChar \menuseparator
19895
19896 \bar under
19897 E
19898 \bar default
19899 xport\SpecialChar \menuseparator
19900
19901 \bar under
19902 L
19903 \bar default
19904 aTeX
19905 \family default
19906  and run 
19907 \family typewriter
19908 chktex
19909 \family default
19910  manually on that.
19911  Invoked in this way, it can be a hassle to find the corresponding place
19912  in the document inside LyX, but with a little patience, you should be able
19913  to do it.
19914 \end_layout
19915
19916 \begin_layout Standard
19917 Here follows the warning messages that can be enabled and disabled in 
19918 \family sans
19919 Preferences
19920 \family default
19921 .
19922  Use 
19923 \family typewriter
19924 -n#
19925 \family default
19926  to disable a warning, and 
19927 \family typewriter
19928 -w#
19929 \family default
19930  to enable a warning.
19931  The emphasized entries are disabled by default, because the default is
19932  "
19933 \family typewriter
19934 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19935 \family default
19936 ".
19937 \end_layout
19938
19939 \begin_layout Standard
19940 Notice that you should only use the options that enable and disable warnings,
19941  because LyX relies on some of the other command line parameters to be set
19942  in a specific way to have a chance to communicate with 
19943 \family typewriter
19944 chktex
19945 \family default
19946 .
19947 \end_layout
19948
19949 \begin_layout Enumerate
19950
19951 \size small
19952 \emph on
19953 Command terminated with space.
19954 \end_layout
19955
19956 \begin_layout Enumerate
19957
19958 \size small
19959 Non-breaking space (
19960 \begin_inset Quotes eld
19961 \end_inset
19962
19963
19964 \family typewriter
19965 ~
19966 \family default
19967
19968 \begin_inset Quotes erd
19969 \end_inset
19970
19971 ) should have been used.
19972 \end_layout
19973
19974 \begin_layout Enumerate
19975
19976 \size small
19977 \emph on
19978 You should enclose the previous parenthesis with 
19979 \begin_inset Quotes eld
19980 \end_inset
19981
19982
19983 \family typewriter
19984 {}
19985 \family default
19986
19987 \begin_inset Quotes erd
19988 \end_inset
19989
19990 .
19991 \end_layout
19992
19993 \begin_layout Enumerate
19994
19995 \size small
19996 Italic correction (
19997 \begin_inset Quotes eld
19998 \end_inset
19999
20000
20001 \family typewriter
20002
20003 \backslash
20004 /
20005 \family default
20006
20007 \begin_inset Quotes erd
20008 \end_inset
20009
20010 ) found in non-italic buffer.
20011 \end_layout
20012
20013 \begin_layout Enumerate
20014
20015 \size small
20016 Italic correction (
20017 \begin_inset Quotes eld
20018 \end_inset
20019
20020
20021 \family typewriter
20022
20023 \backslash
20024 /
20025 \family default
20026
20027 \begin_inset Quotes erd
20028 \end_inset
20029
20030 ) found more than once.
20031 \end_layout
20032
20033 \begin_layout Enumerate
20034
20035 \size small
20036 \emph on
20037 No italic correction (
20038 \begin_inset Quotes eld
20039 \end_inset
20040
20041
20042 \family typewriter
20043
20044 \backslash
20045 /
20046 \family default
20047
20048 \begin_inset Quotes erd
20049 \end_inset
20050
20051 ) found.
20052 \end_layout
20053
20054 \begin_layout Enumerate
20055
20056 \size small
20057 Accent command 
20058 \begin_inset Quotes eld
20059 \end_inset
20060
20061
20062 \family typewriter
20063 cmd
20064 \family default
20065
20066 \begin_inset Quotes erd
20067 \end_inset
20068
20069  needs use of 
20070 \begin_inset Quotes eld
20071 \end_inset
20072
20073
20074 \family typewriter
20075 cmd
20076 \family default
20077
20078 \begin_inset Quotes erd
20079 \end_inset
20080
20081 .
20082 \end_layout
20083
20084 \begin_layout Enumerate
20085
20086 \size small
20087 Wrong length of dash may have been used.
20088 \end_layout
20089
20090 \begin_layout Enumerate
20091
20092 \size small
20093 \emph on
20094 \begin_inset Quotes eld
20095 \end_inset
20096
20097
20098 \family typewriter
20099 %s
20100 \family default
20101
20102 \begin_inset Quotes erd
20103 \end_inset
20104
20105  expected, found 
20106 \begin_inset Quotes eld
20107 \end_inset
20108
20109
20110 \family typewriter
20111 %s
20112 \family default
20113
20114 \begin_inset Quotes erd
20115 \end_inset
20116
20117 .
20118 \end_layout
20119
20120 \begin_layout Enumerate
20121
20122 \size small
20123 Solo 
20124 \begin_inset Quotes eld
20125 \end_inset
20126
20127
20128 \family typewriter
20129 %s
20130 \family default
20131
20132 \begin_inset Quotes erd
20133 \end_inset
20134
20135  found.
20136 \end_layout
20137
20138 \begin_layout Enumerate
20139
20140 \size small
20141 You should use 
20142 \begin_inset Quotes eld
20143 \end_inset
20144
20145
20146 \family typewriter
20147 %s
20148 \family default
20149
20150 \begin_inset Quotes erd
20151 \end_inset
20152
20153  to achieve an ellipsis.
20154 \end_layout
20155
20156 \begin_layout Enumerate
20157
20158 \size small
20159 Inter-word spacing (
20160 \begin_inset Quotes eld
20161 \end_inset
20162
20163
20164 \family typewriter
20165
20166 \backslash
20167  
20168 \family default
20169
20170 \begin_inset Quotes eld
20171 \end_inset
20172
20173 ) should perhaps be used.
20174 \end_layout
20175
20176 \begin_layout Enumerate
20177
20178 \size small
20179 Inter-sentence spacing (
20180 \begin_inset Quotes eld
20181 \end_inset
20182
20183
20184 \family typewriter
20185
20186 \backslash
20187 @
20188 \family default
20189
20190 \begin_inset Quotes erd
20191 \end_inset
20192
20193 ) should perhaps be used.
20194 \end_layout
20195
20196 \begin_layout Enumerate
20197
20198 \size small
20199 Could not find argument for command.
20200 \end_layout
20201
20202 \begin_layout Enumerate
20203
20204 \size small
20205 No match found for 
20206 \begin_inset Quotes eld
20207 \end_inset
20208
20209
20210 \family typewriter
20211 %s
20212 \family default
20213
20214 \begin_inset Quotes erd
20215 \end_inset
20216
20217 .
20218 \end_layout
20219
20220 \begin_layout Enumerate
20221
20222 \size small
20223 Math mode still on at end of LaTeX file.
20224 \end_layout
20225
20226 \begin_layout Enumerate
20227
20228 \size small
20229 Number of 
20230 \begin_inset Quotes eld
20231 \end_inset
20232
20233
20234 \family typewriter
20235 char
20236 \family default
20237
20238 \begin_inset Quotes erd
20239 \end_inset
20240
20241  doesn't match the number of 
20242 \begin_inset Quotes eld
20243 \end_inset
20244
20245
20246 \family typewriter
20247 char
20248 \family default
20249
20250 \begin_inset Quotes erd
20251 \end_inset
20252
20253 .
20254 \end_layout
20255
20256 \begin_layout Enumerate
20257
20258 \size small
20259 You should use either 
20260 \family typewriter
20261
20262 \begin_inset Quotes eld
20263 \end_inset
20264
20265
20266 \family default
20267  or 
20268 \family typewriter
20269
20270 \begin_inset Quotes erd
20271 \end_inset
20272
20273
20274 \family default
20275  as an alternative to 
20276 \begin_inset Quotes eld
20277 \end_inset
20278
20279
20280 \family typewriter
20281 "
20282 \family default
20283
20284 \begin_inset Quotes erd
20285 \end_inset
20286
20287 .
20288 \end_layout
20289
20290 \begin_layout Enumerate
20291
20292 \size small
20293 You should use "
20294 \family typewriter
20295 '
20296 \family default
20297 " (ASCII 39) instead of "
20298 \family typewriter
20299 ´
20300 \family default
20301 " (ASCII 180).
20302 \end_layout
20303
20304 \begin_layout Enumerate
20305
20306 \size small
20307 User-specified pattern found.
20308 \end_layout
20309
20310 \begin_layout Enumerate
20311
20312 \size small
20313 This command might not be intended.
20314 \end_layout
20315
20316 \begin_layout Enumerate
20317
20318 \size small
20319 \emph on
20320 Comment displayed.
20321 \end_layout
20322
20323 \begin_layout Enumerate
20324
20325 \size small
20326 Either 
20327 \family typewriter
20328 ''
20329 \backslash
20330 ,'
20331 \family default
20332  or 
20333 \family typewriter
20334 '
20335 \backslash
20336 ,''
20337 \family default
20338  will look better.
20339 \end_layout
20340
20341 \begin_layout Enumerate
20342
20343 \size small
20344 Delete this space to maintain correct page references.
20345 \end_layout
20346
20347 \begin_layout Enumerate
20348
20349 \size small
20350 \emph on
20351 You might wish to put this between a pair of 
20352 \begin_inset Quotes eld
20353 \end_inset
20354
20355
20356 \family typewriter
20357 {}
20358 \family default
20359
20360 \begin_inset Quotes erd
20361 \end_inset
20362
20363 .
20364 \end_layout
20365
20366 \begin_layout Enumerate
20367
20368 \size small
20369 You ought to remove spaces in front of punctuation.
20370 \end_layout
20371
20372 \begin_layout Enumerate
20373
20374 \size small
20375 Could not execute LaTeX command.
20376 \end_layout
20377
20378 \begin_layout Enumerate
20379
20380 \size small
20381 Don't use 
20382 \family typewriter
20383
20384 \backslash
20385 /
20386 \family default
20387  in front of small punctuation.
20388 \end_layout
20389
20390 \begin_layout Enumerate
20391
20392 \family typewriter
20393 \size small
20394 $
20395 \backslash
20396 times$
20397 \family default
20398  may look prettier here.
20399 \end_layout
20400
20401 \begin_layout Enumerate
20402
20403 \size small
20404 \emph on
20405 Multiple spaces detected in output.
20406 \end_layout
20407
20408 \begin_layout Enumerate
20409
20410 \size small
20411 This text may be ignored.
20412 \end_layout
20413
20414 \begin_layout Enumerate
20415
20416 \size small
20417 Use 
20418 \family typewriter
20419
20420 \begin_inset Quotes eld
20421 \end_inset
20422
20423
20424 \family default
20425  to begin quotation, not 
20426 \family typewriter
20427 '
20428 \family default
20429 .
20430 \end_layout
20431
20432 \begin_layout Enumerate
20433
20434 \size small
20435 Use 
20436 \family typewriter
20437 '
20438 \family default
20439  to end quotation, not 
20440 \family typewriter
20441
20442 \begin_inset Quotes eld
20443 \end_inset
20444
20445
20446 \family default
20447 .
20448 \end_layout
20449
20450 \begin_layout Enumerate
20451
20452 \size small
20453 Don't mix quotes.
20454 \end_layout
20455
20456 \begin_layout Enumerate
20457
20458 \size small
20459 You should perhaps use 
20460 \begin_inset Quotes eld
20461 \end_inset
20462
20463
20464 \family typewriter
20465 cmd
20466 \family default
20467
20468 \begin_inset Quotes erd
20469 \end_inset
20470
20471  instead.
20472 \end_layout
20473
20474 \begin_layout Enumerate
20475
20476 \size small
20477 You should put a space in front of/after parenthesis.
20478 \end_layout
20479
20480 \begin_layout Enumerate
20481
20482 \size small
20483 You should avoid spaces in front of/after parenthesis.
20484 \end_layout
20485
20486 \begin_layout Enumerate
20487
20488 \size small
20489 \emph on
20490 You should not use punctuation in front of/after quotes.
20491 \end_layout
20492
20493 \begin_layout Enumerate
20494
20495 \size small
20496 Double space found.
20497 \end_layout
20498
20499 \begin_layout Enumerate
20500
20501 \size small
20502 You should put punctuation outside inner/inside display math mode.
20503 \end_layout
20504
20505 \begin_layout Enumerate
20506
20507 \size small
20508 You ought to not use primitive TeX in LaTeX code.
20509 \end_layout
20510
20511 \begin_layout Enumerate
20512
20513 \size small
20514 You should remove spaces in front of 
20515 \begin_inset Quotes eld
20516 \end_inset
20517
20518
20519 \family typewriter
20520 %s
20521 \family default
20522
20523 \begin_inset Quotes erd
20524 \end_inset
20525
20526
20527 \end_layout
20528
20529 \begin_layout Enumerate
20530
20531 \size small
20532 \begin_inset Quotes eld
20533 \end_inset
20534
20535
20536 \family typewriter
20537 %s
20538 \family default
20539
20540 \begin_inset Quotes erd
20541 \end_inset
20542
20543  is normally not followed by 
20544 \begin_inset Quotes eld
20545 \end_inset
20546
20547
20548 \family typewriter
20549 %c
20550 \family default
20551
20552 \begin_inset Quotes erd
20553 \end_inset
20554
20555 .
20556 \end_layout
20557
20558 \begin_layout Standard
20559 In later versions of LyX, we hope to provide a more complete interface to
20560  this tool (and it's smaller cousin 
20561 \family typewriter
20562 lacheck
20563 \family default
20564 ) to exploit the full power of it.
20565  But it's not exactly useless as it is now: go try it on one of your existing
20566  documents of a certain length and be surprised.
20567 \end_layout
20568
20569 \begin_layout Section
20570 Version Control in LyX
20571 \end_layout
20572
20573 \begin_layout Standard
20574 by
20575 \noun on
20576  Lars Gullik Bjønnes
20577 \end_layout
20578
20579 \begin_layout Subsection
20580 Introduction
20581 \end_layout
20582
20583 \begin_layout Standard
20584 A friend of mine wanted to try LyX for a group project.
20585  When he didn't find support for version control or file locking, he dropped
20586  it.
20587  This angered me a bit, so I thought that I should at least make support
20588  for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
20589  This has now been done.
20590  LyX now supports some of the most basic RCS commands.
20591  If you need to something a bit more sophisticated you will have to do that
20592  manually in an xterm.
20593 \end_layout
20594
20595 \begin_layout Standard
20596 Before you begin to use the version control features in LyX, you should
20597  read 
20598 \begin_inset Quotes eld
20599 \end_inset
20600
20601 rcsintro
20602 \begin_inset Quotes erd
20603 \end_inset
20604
20605  (a man file, read it with 
20606 \family typewriter
20607 man rcsintro
20608 \family default
20609 ).
20610  This file describes all the basic features of RCS.
20611  You should especially notice the comment about a RCS directory, and the
20612  notion of a master RCS file (the file ending in 
20613 \family typewriter
20614 ,v
20615 \family default
20616 ).
20617 \end_layout
20618
20619 \begin_layout Standard
20620 The implementation in LyX assumes a recent version of the GNU RCS package---no
20621  guarantees are made for older versions.
20622 \end_layout
20623
20624 \begin_layout Subsection
20625 RCS commands in LyX
20626 \end_layout
20627
20628 \begin_layout Standard
20629 The following sections describe the RCS commands supported by LyX.
20630  You can find them in the 
20631 \family sans
20632 \bar under
20633 F
20634 \bar default
20635 ile\SpecialChar \menuseparator
20636
20637 \bar under
20638 V
20639 \bar default
20640 ersion\InsetSpace ~
20641 Control
20642 \family default
20643  submenu.
20644 \end_layout
20645
20646 \begin_layout Subsubsection
20647
20648 \family sans
20649 Register
20650 \end_layout
20651
20652 \begin_layout Standard
20653 If your document is not under revision control, this is the only item shown
20654  in the menu.
20655  And if it is under revision control, the 
20656 \family sans
20657 \bar under
20658 R
20659 \bar default
20660 egister
20661 \family default
20662  item is grayed out.
20663  
20664 \end_layout
20665
20666 \begin_layout Standard
20667 This command registers your document with RCS\SpecialChar \@.
20668  You are asked interactively
20669  to supply an initial description of the document.
20670  The document is now set in Read-Only mode and you have to 
20671 \family sans
20672 Check\InsetSpace ~
20673 Out\InsetSpace ~
20674 For\InsetSpace ~
20675 Edit
20676 \family default
20677 , before making any changes to it.
20678  A document under revision control has a 
20679 \begin_inset Quotes eld
20680 \end_inset
20681
20682 [RCS:<version> <locker>]
20683 \begin_inset Quotes erd
20684 \end_inset
20685
20686  item tagged to the filename in the minibuffer.
20687 \end_layout
20688
20689 \begin_layout Standard
20690 RCS command that is run: 
20691 \family typewriter
20692 ci -q -u -i -t-"<initial description>" <file-name>
20693 \end_layout
20694
20695 \begin_layout Standard
20696 Read 
20697 \family typewriter
20698 man ci
20699 \family default
20700  to understand the switches.
20701  
20702 \end_layout
20703
20704 \begin_layout Subsubsection
20705
20706 \family sans
20707 Check In Changes
20708 \end_layout
20709
20710 \begin_layout Standard
20711 When you are finished editing a file, you check in your changes.
20712  When you do this, you are asked for a description of the changes.
20713  This is stored in the history log.
20714  The version number is bumped, your changes are applied to the master RCS
20715  file, the document is unlocked and set to Read-Only mode.
20716  
20717 \end_layout
20718
20719 \begin_layout Standard
20720 RCS command: 
20721 \family typewriter
20722 ci -q -u -m"<description>" <file-name>
20723 \end_layout
20724
20725 \begin_layout Subsubsection
20726
20727 \family sans
20728 Check Out For Edit
20729 \end_layout
20730
20731 \begin_layout Standard
20732 By doing this you lock the document so that only you can edit it.
20733  This will also make the document Read-Write only for you.
20734  You will usually continue editing for a while and when you are finished
20735  you check in your changes.
20736  The status line is changed to reflect that you have locked the file.
20737  
20738 \end_layout
20739
20740 \begin_layout Standard
20741 RCS command: 
20742 \family typewriter
20743 co -q -l <file-name>
20744 \end_layout
20745
20746 \begin_layout Subsubsection
20747
20748 \family sans
20749 Revert To Last Version
20750 \end_layout
20751
20752 \begin_layout Standard
20753 This will discard all changes made to the document since the last check
20754  in.
20755  You get a warning before changes are discarded.
20756 \end_layout
20757
20758 \begin_layout Standard
20759 RCS command: 
20760 \family typewriter
20761 co -f -u<version> <file-name>
20762 \end_layout
20763
20764 \begin_layout Subsubsection
20765
20766 \family sans
20767 Undo Last Checkin
20768 \end_layout
20769
20770 \begin_layout Standard
20771 This makes as if the last check in never happened.
20772  No changes are made to the document loaded into LyX, but the last version
20773  is removed from the master RCS file.
20774  
20775 \end_layout
20776
20777 \begin_layout Standard
20778 RCS command: 
20779 \family typewriter
20780 rcs -o<version> <file-name>
20781 \end_layout
20782
20783 \begin_layout Subsubsection
20784
20785 \family sans
20786 Show History
20787 \end_layout
20788
20789 \begin_layout Standard
20790 This show the complete history of the RCS document.
20791  The output of 
20792 \family typewriter
20793 rlog <file-name>
20794 \family default
20795  is shown in a browser.
20796  See 
20797 \family typewriter
20798 man rlog
20799 \family default
20800  for more info.
20801 \end_layout
20802
20803 \begin_layout Section
20804 Literate Programming
20805 \end_layout
20806
20807 \begin_layout Standard
20808 Updated by 
20809 \noun on
20810 Kayvan Sylvan 
20811 \noun default
20812 (kayvan@sylvan.com)
20813 \noun on
20814
20815 \noun default
20816 original documentation written by 
20817 \noun on
20818 Edmar Wienskoski Jr.
20819
20820 \noun default
20821  (edmar-w-jr@technologist.com)
20822 \end_layout
20823
20824 \begin_layout Subsection
20825 Introduction
20826 \end_layout
20827
20828 \begin_layout Standard
20829 The main purpose of this documentation is to show you how to use LyX for
20830  literate programming.
20831  Where it is assumed that you are familiar with this programming technique,
20832  and know what 
20833 \begin_inset Quotes eld
20834 \end_inset
20835
20836 tangling
20837 \begin_inset Quotes erd
20838 \end_inset
20839
20840  and 
20841 \begin_inset Quotes eld
20842 \end_inset
20843
20844 weaving
20845 \begin_inset Quotes erd
20846 \end_inset
20847
20848  means.
20849  If that is not the case, please follow the web links provided in the following
20850  sections.
20851  There is a lot of good documentation out there covering old development
20852  history to the latest tools tips.
20853 \end_layout
20854
20855 \begin_layout Standard
20856 It is also assumed that you are familiar with LyX itself to a point that
20857  you are comfortable changing your LyX preferences, and X resources file.
20858  If that is not the case please refer to other LyX documentation to cover
20859  your specific needs.
20860 \end_layout
20861
20862 \begin_layout Subsection
20863 Literate Programming
20864 \end_layout
20865
20866 \begin_layout Standard
20867 From the Literate Programming FAQ: 
20868 \end_layout
20869
20870 \begin_layout Quotation
20871 Literate programming is the combination of documentation and source together
20872  in a fashion suited for reading by human beings.
20873  In fact, literate programs should be enjoyable reading, even inviting!
20874  (Sorry Bob, I couldn't resist!) In general, literate programs combine source
20875  and documentation in a single file.
20876  Literate programming tools then parse the file to produce either readable
20877  documentation or compilable source.
20878  The WEB style of literate programming was created by D.E.
20879  Knuth during the development of his TeX typesetting software.
20880  
20881 \end_layout
20882
20883 \begin_layout Standard
20884 Another excerpt says:
20885 \end_layout
20886
20887 \begin_layout Quotation
20888
20889 \emph on
20890 How is literate programming different from verbose commenting?
20891 \end_layout
20892
20893 \begin_layout Quotation
20894 There are three distinguishing characteristics.
20895  In order of importance, they are: 
20896 \end_layout
20897
20898 \begin_deeper
20899 \begin_layout Itemize
20900 flexible order of elaboration 
20901 \end_layout
20902
20903 \begin_layout Itemize
20904 automatic support for browsing 
20905 \end_layout
20906
20907 \begin_layout Itemize
20908 typeset documentation, especially diagrams and mathematics 
20909 \end_layout
20910
20911 \end_deeper
20912 \begin_layout Standard
20913 Now that I sparked your curiosity, take a look in the references.
20914 \end_layout
20915
20916 \begin_layout Subsubsection
20917 References
20918 \end_layout
20919
20920 \begin_layout Standard
20921 The complete Literate Programming FAQ can be found at:
20922 \end_layout
20923
20924 \begin_layout Quote
20925 \begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
20926
20927 \end_inset
20928
20929
20930 \end_layout
20931
20932 \begin_layout Standard
20933 The FAQ lists 23 (twenty three!) different literate programming tools.
20934  Where some are specialized or 
20935 \begin_inset Quotes eld
20936 \end_inset
20937
20938 tailored
20939 \begin_inset Quotes erd
20940 \end_inset
20941
20942  for particular programming languages, while other have general scope.
20943  I selected 
20944 \noun on
20945 Noweb
20946 \noun default
20947  for my own use for several reasons:
20948 \end_layout
20949
20950 \begin_layout Itemize
20951 It can generate the documentation either in latex or html.
20952 \end_layout
20953
20954 \begin_layout Itemize
20955 It has a open architecture, i.e., it is easy to plug in new filters and to
20956  perform special processing that you may need.
20957  
20958 \end_layout
20959
20960 \begin_layout Itemize
20961 There is a good selection of filters available already (the html is one
20962  of them).
20963 \end_layout
20964
20965 \begin_layout Itemize
20966 It is free.
20967 \end_layout
20968
20969 \begin_layout Standard
20970 The Noweb web page can be found at: 
20971 \end_layout
20972
20973 \begin_layout Quote
20974 \begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
20975
20976 \end_inset
20977
20978
20979 \end_layout
20980
20981 \begin_layout Standard
20982 Starting from there you can reach many other interesting links and even
20983  some literate program examples.
20984 \end_layout
20985
20986 \begin_layout Subsection
20987 LyX and Literate Programming
20988 \end_layout
20989
20990 \begin_layout Standard
20991 The LyX support for Literate Programming is provided by using the generic
20992  LyX convertors mechanism.
20993  This support is provided in a 
20994 \begin_inset Quotes eld
20995 \end_inset
20996
20997 Noweb independent
20998 \begin_inset Quotes erd
20999 \end_inset
21000
21001  way, i.e., you will be able to use this new LyX feature with some other literate
21002  programming tool of your choice by just changing your LyX preferences.
21003 \end_layout
21004
21005 \begin_layout Subsubsection
21006 Generating documents and code (weaving and tangling)
21007 \end_layout
21008
21009 \begin_layout Paragraph
21010 Selecting the document class
21011 \end_layout
21012
21013 \begin_layout Standard
21014 If you have installed Noweb and LyX successfully, whenever you open a new
21015  document or try to change the document class of an existing one, you will
21016  find that there are three new document classes available:
21017 \end_layout
21018
21019 \begin_layout Itemize
21020 Article (Noweb)
21021 \end_layout
21022
21023 \begin_layout Itemize
21024 Book (Noweb)
21025 \end_layout
21026
21027 \begin_layout Itemize
21028 Report (Noweb)
21029 \end_layout
21030
21031 \begin_layout Standard
21032 You must select one of them to create your literate documents from.
21033  
21034 \end_layout
21035
21036 \begin_layout Standard
21037 Note that literate documents are not limited to these three classes.
21038  New classes can be generated from other styles like letter or in combination
21039  with other class variations like Article (AMS).
21040  If you have special needs that cannot be covered by one of the existing
21041  classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
21042  will arrange to insert a new entry, or teach you how to do it.
21043 \begin_inset Foot
21044 status collapsed
21045
21046 \begin_layout Standard
21047 It is very simple, it involves the creation of a file with four lines, and
21048  re-running of the auto configuration.
21049 \end_layout
21050
21051 \end_inset
21052
21053  Moreover, if you use a literate tool other than Noweb you may need to create
21054  a new set of document classes for it.
21055 \end_layout
21056
21057 \begin_layout Paragraph
21058 Typing code in
21059 \end_layout
21060
21061 \begin_layout Standard
21062 LyX enables you to write code with a layout named 
21063 \noun on
21064 Scrap
21065 \noun default
21066 .
21067 \begin_inset Foot
21068 status collapsed
21069
21070 \begin_layout Standard
21071 The equivalent Noweb term is 
21072 \begin_inset Quotes eld
21073 \end_inset
21074
21075 Chunk
21076 \begin_inset Quotes erd
21077 \end_inset
21078
21079 .
21080  For historical reasons, I got used to the term 
21081 \begin_inset Quotes eld
21082 \end_inset
21083
21084 scrap
21085 \begin_inset Quotes erd
21086 \end_inset
21087
21088  introduced by other literate tool named Nuweb, which I used for many years
21089  before rendering myself to Noweb.
21090 \end_layout
21091
21092 \end_inset
21093
21094  Noweb delimits scraps like this:
21095 \end_layout
21096
21097 \begin_layout LyX-Code
21098 <<My scrap>>=
21099 \end_layout
21100
21101 \begin_layout LyX-Code
21102   code
21103 \end_layout
21104
21105 \begin_layout LyX-Code
21106   more code
21107 \end_layout
21108
21109 \begin_layout LyX-Code
21110   even more code
21111 \end_layout
21112
21113 \begin_layout LyX-Code
21114   @
21115 \end_layout
21116
21117 \begin_layout Standard
21118 The problem is that whatever is written in between the << and the 
21119 \family typewriter
21120 @
21121 \family default
21122  must be taken literally, i.e., LyX should be prevented from making any special
21123  interpretation of what has been written.
21124  This is handled by a special layout named Scrap, that works like a normal
21125  paragraph but has a free spacing capability.
21126 \end_layout
21127
21128 \begin_layout Standard
21129 The down side of the Scrap paragraph layout is that consecutive paragraphs
21130  of code will be spaced with one empty line in the source code and also
21131  in the printed documentation.
21132  The work around is to enter each line of code within a single Scrap, with
21133  a newline (ctrl-return).
21134  The example above will look like this:
21135 \begin_inset Foot
21136 status collapsed
21137
21138 \begin_layout Standard
21139 If you have a printed version of this document you will not see any difference
21140  between the previous example and this one.
21141 \end_layout
21142
21143 \end_inset
21144
21145
21146 \end_layout
21147
21148 \begin_layout LyX-Code
21149 <<My scrap>>=
21150 \newline
21151   code
21152 \newline
21153   more code
21154 \newline
21155   even more code
21156 \newline
21157   @
21158 \end_layout
21159
21160 \begin_layout Standard
21161 This layout works fine.
21162  The only real inconvenience is that you have to type ctrl-return instead
21163  of a plain return.
21164 \begin_inset Foot
21165 status collapsed
21166
21167 \begin_layout Standard
21168 It is in my list of 
21169 \begin_inset Quotes eld
21170 \end_inset
21171
21172 improvements
21173 \begin_inset Quotes erd
21174 \end_inset
21175
21176  to fix that.
21177 \end_layout
21178
21179 \end_inset
21180
21181
21182 \end_layout
21183
21184 \begin_layout Standard
21185 As a special note, you can also use the 
21186 \begin_inset Quotes eld
21187 \end_inset
21188
21189 %def
21190 \begin_inset Quotes erd
21191 \end_inset
21192
21193  construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
21194 rence:
21195 \end_layout
21196
21197 \begin_layout LyX-Code
21198 <<My scrap>>=
21199 \newline
21200   def some_function(args):
21201 \newline
21202     "This is the doc string for this
21203  function."
21204 \newline
21205     print "My args: ", args
21206 \end_layout
21207
21208 \begin_layout LyX-Code
21209 @ %def some_function
21210 \end_layout
21211
21212 \begin_layout Standard
21213 For an example of this usage and the resulting cross-reference output, look
21214  at the Literate python program in 
21215 \emph on
21216 LIBDIR/examples/listerrors.lyx 
21217 \emph default
21218 which should make this all clear.
21219 \end_layout
21220
21221 \begin_layout Paragraph
21222 Generating the documentation
21223 \end_layout
21224
21225 \begin_layout Standard
21226 At this point you already have a new document file with a proper document
21227  class, and with some code and text on it.
21228  How do I print it? The answer is simple, you select 
21229 \family sans
21230 \bar under
21231 V
21232 \bar default
21233 iew\SpecialChar \menuseparator
21234
21235 \bar under
21236 D
21237 \bar default
21238 VI,
21239 \family default
21240  etc.
21241  Just like you would do for a plain document.
21242  No special procedure is required.
21243 \end_layout
21244
21245 \begin_layout Standard
21246 To help orientate you, I will now explain what happens inside LyX:
21247 \end_layout
21248
21249 \begin_layout Enumerate
21250 When the 
21251 \family sans
21252 \bar under
21253 U
21254 \bar default
21255 pdate\SpecialChar \menuseparator
21256
21257 \bar under
21258 D
21259 \bar default
21260 VI 
21261 \family default
21262 menu option is chosen, a latex file is generated.
21263  
21264 \end_layout
21265
21266 \begin_deeper
21267 \begin_layout Standard
21268 If the document is of any literate class the generated file will be named
21269  with an extension name defined by the 
21270 \begin_inset Quotes eld
21271 \end_inset
21272
21273 literate
21274 \begin_inset Quotes erd
21275 \end_inset
21276
21277  format (defined in the Preferences panel), otherwise the file will have
21278  the usual 
21279 \family typewriter
21280 .tex 
21281 \family default
21282 extension.
21283 \end_layout
21284
21285 \end_deeper
21286 \begin_layout Enumerate
21287 Note that the only difference so far is in the name of the file, no special
21288  processing is required by LyX.
21289  Given that you formatted the code using the Scrap layout that, by itself,
21290  takes care of the business.
21291 \end_layout
21292
21293 \begin_layout Enumerate
21294 If the document is of any literate class LyX will then use the internal
21295  LyX to Noweb converter, followed by the Noweb to LaTeX converter
21296 \begin_inset Foot
21297 status open
21298
21299 \begin_layout Standard
21300 The converters are defined in the 
21301 \family sans
21302 \bar under
21303 T
21304 \bar default
21305 ools\SpecialChar \menuseparator
21306
21307 \bar under
21308 P
21309 \bar default
21310 references
21311 \family default
21312  panel, under the 
21313 \begin_inset Quotes eld
21314 \end_inset
21315
21316 Conversion
21317 \begin_inset Quotes erd
21318 \end_inset
21319
21320  tab.
21321 \end_layout
21322
21323 \end_inset
21324
21325  to generate the LaTeX file.
21326 \end_layout
21327
21328 \begin_deeper
21329 \begin_layout Standard
21330 Otherwise it will just skip this step.
21331 \end_layout
21332
21333 \end_deeper
21334 \begin_layout Enumerate
21335 Finally, LaTeX is invoked and the regular post processing continues as in
21336  a plain document.
21337 \end_layout
21338
21339 \begin_layout Standard
21340 Independence from a particular 
21341 \begin_inset Quotes eld
21342 \end_inset
21343
21344 literate tool
21345 \begin_inset Quotes erd
21346 \end_inset
21347
21348  is easily achieved by changing the commands that are run by the various
21349  converters.
21350 \end_layout
21351
21352 \begin_layout Paragraph
21353 Generating the code
21354 \end_layout
21355
21356 \begin_layout Standard
21357 When the build menu option is chosen or the corresponding button in the
21358  toolbar is pressed, a latex file is generated just like step 1 above.
21359  Next, LyX invokes the
21360 \family typewriter
21361  Noweb->Program
21362 \family default
21363  converter.
21364  Typically, this converter (like any other converter), has two parts:
21365 \end_layout
21366
21367 \begin_layout Enumerate
21368 The converter program itself.
21369  This program performs the conversion from the one format to the other (in
21370  this case, from the Noweb format to the Program pseudo-format).
21371 \end_layout
21372
21373 \begin_layout Enumerate
21374 The error log parser.
21375  This is a program whose sole purpose is to rewrite error messages in a
21376  format that LyX understands.
21377  This makes it possible for LyX to place error boxes in the right places
21378  in the file buffer.
21379 \end_layout
21380
21381 \begin_layout Standard
21382 The first part, the 
21383 \begin_inset Quotes eld
21384 \end_inset
21385
21386 Converter
21387 \begin_inset Quotes erd
21388 \end_inset
21389
21390  setting, should be set to 
21391 \begin_inset Quotes eld
21392 \end_inset
21393
21394
21395 \family typewriter
21396 build-script $$i
21397 \family default
21398
21399 \begin_inset Quotes erd
21400 \end_inset
21401
21402 .
21403  This basically means that LyX will call 
21404 \begin_inset Quotes eld
21405 \end_inset
21406
21407 build-script
21408 \begin_inset Quotes erd
21409 \end_inset
21410
21411  (a program or script) with the name of the Noweb file (generally a file
21412  in the LyX temp directory).
21413  
21414 \end_layout
21415
21416 \begin_layout Standard
21417 This is an implementation of 
21418 \begin_inset Quotes eld
21419 \end_inset
21420
21421 build-script
21422 \begin_inset Quotes erd
21423 \end_inset
21424
21425  that you can place in a directory on your path:
21426 \end_layout
21427
21428 \begin_layout LyX-Code
21429 #!/bin/sh
21430 \end_layout
21431
21432 \begin_layout LyX-Code
21433 #
21434 \end_layout
21435
21436 \begin_layout LyX-Code
21437 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
21438 \end_layout
21439
21440 \begin_layout Standard
21441 The next part of the converter setting is the 
21442 \begin_inset Quotes eld
21443 \end_inset
21444
21445 Flags
21446 \begin_inset Quotes erd
21447 \end_inset
21448
21449  which is to be set to 
21450 \begin_inset Quotes eld
21451 \end_inset
21452
21453
21454 \family typewriter
21455 originaldir,parselog=listerrors
21456 \family default
21457
21458 \begin_inset Quotes erd
21459 \end_inset
21460
21461 .
21462  This will run any errors that are generated by the 
21463 \begin_inset Quotes eld
21464 \end_inset
21465
21466 build-script
21467 \begin_inset Quotes erd
21468 \end_inset
21469
21470  process through the 
21471 \begin_inset Quotes eld
21472 \end_inset
21473
21474 listerrors
21475 \begin_inset Quotes erd
21476 \end_inset
21477
21478  program.
21479 \end_layout
21480
21481 \begin_layout Standard
21482 The converter code looks in 
21483 \emph on
21484 MYLYXDIR/scripts 
21485 \emph default
21486 first, then in
21487 \emph on
21488  LIBDIR/scripts 
21489 \emph default
21490 then on the path for the 
21491 \begin_inset Quotes eld
21492 \end_inset
21493
21494 listerrors
21495 \begin_inset Quotes erd
21496 \end_inset
21497
21498  program.
21499 \end_layout
21500
21501 \begin_layout Paragraph
21502 Build instructions in the document
21503 \end_layout
21504
21505 \begin_layout Standard
21506 The last piece of the integration between LyX and noweb is the 
21507 \begin_inset Quotes eld
21508 \end_inset
21509
21510 build-script
21511 \begin_inset Quotes erd
21512 \end_inset
21513
21514  scrap.
21515  Generally, the instructions for building your program should be embedded
21516  in a scrap of its own.
21517  The noweb-specific 
21518 \begin_inset Quotes eld
21519 \end_inset
21520
21521 build-script
21522 \begin_inset Quotes erd
21523 \end_inset
21524
21525  above uses the notangle command to look for this scrap (called 
21526 \begin_inset Quotes eld
21527 \end_inset
21528
21529 build-script
21530 \begin_inset Quotes erd
21531 \end_inset
21532
21533 ) and runs its contents through 
21534 \begin_inset Quotes eld
21535 \end_inset
21536
21537 sh
21538 \begin_inset Quotes erd
21539 \end_inset
21540
21541 .
21542 \end_layout
21543
21544 \begin_layout Standard
21545 Typically, such a scrap would look something like this:
21546 \end_layout
21547
21548 \begin_layout LyX-Code
21549 <<build-script>>=
21550 \newline
21551 #!/bin/sh
21552 \newline
21553
21554 \newline
21555 if [ -z "${NOWEB_SOURCE}" ]
21556 \newline
21557 then
21558 \newline
21559   NOWEB_SOURCE=myfile.nw
21560 \newline
21561
21562 fi
21563 \newline
21564 [...
21565  code to extract files ...]
21566 \newline
21567 [...
21568  code to compile files ...]
21569 \newline
21570 @
21571 \end_layout
21572
21573 \begin_layout Standard
21574 Look in 
21575 \emph on
21576 LIBDIR/examples/listerrors.lyx 
21577 \emph default
21578 or in 
21579 \emph on
21580 LIBDIR/examples/Literate.lyx
21581 \emph default
21582  which implement two versions of the 
21583 \begin_inset Quotes eld
21584 \end_inset
21585
21586 listerrors
21587 \begin_inset Quotes erd
21588 \end_inset
21589
21590  program for some illustrations of how all of these pieces go together or
21591  in 
21592 \emph on
21593 LIBDIR/examples/noweb2lyx.lyx.
21594  
21595 \emph default
21596 Interestingly, these three files show off the language-indepence of the
21597  LyX literate programming support since they are written in Python, C and
21598  Perl respectively.
21599 \end_layout
21600
21601 \begin_layout Subsubsection
21602 Configuring LyX
21603 \end_layout
21604
21605 \begin_layout Standard
21606 All the Literate Programming support is configured by the 
21607 \family sans
21608 \bar under
21609 T
21610 \bar default
21611 ools\SpecialChar \menuseparator
21612
21613 \bar under
21614 P
21615 \bar default
21616 references
21617 \family default
21618  panel in the 
21619 \begin_inset Quotes eld
21620 \end_inset
21621
21622 Conversion
21623 \begin_inset Quotes erd
21624 \end_inset
21625
21626  tab.
21627  The important parts are:
21628 \end_layout
21629
21630 \begin_layout Description
21631 the\InsetSpace ~
21632
21633 \begin_inset Quotes eld
21634 \end_inset
21635
21636 literate
21637 \begin_inset Quotes erd
21638 \end_inset
21639
21640 \InsetSpace ~
21641 format Set up via the Formats tab, this is where the Noweb-specific pieces
21642  are set up.
21643  The 
21644 \family sans
21645 GUI Name
21646 \family default
21647  is set to 
21648 \family typewriter
21649 NoWeb
21650 \family default
21651 , the file extension is set to 
21652 \family typewriter
21653 .nw
21654 \family default
21655 .
21656  This tells LyX to create a file with a 
21657 \family typewriter
21658 .nw
21659 \family default
21660  extension in the first step of the conversion process.
21661 \end_layout
21662
21663 \begin_layout Description
21664 the\InsetSpace ~
21665
21666 \family sans
21667 Program
21668 \family default
21669 \InsetSpace ~
21670 format This is an empty format whose sole purpose is to be the endpoint
21671  of a conversion (which then allows us to set up a converter for it).
21672 \end_layout
21673
21674 \begin_layout Description
21675
21676 \family sans
21677 NoWeb
21678 \family default
21679 ->
21680 \family sans
21681 LaTeX
21682 \family default
21683  This converter performs the 
21684 \begin_inset Quotes eld
21685 \end_inset
21686
21687 weaving
21688 \begin_inset Quotes erd
21689 \end_inset
21690
21691  of the literate document.
21692  For Noweb, it is set to 
21693 \begin_inset Quotes eld
21694 \end_inset
21695
21696
21697 \family typewriter
21698 noweave -delay -index $$i > $$o
21699 \family default
21700
21701 \begin_inset Quotes erd
21702 \end_inset
21703
21704
21705 \end_layout
21706
21707 \begin_layout Description
21708
21709 \family sans
21710 NoWeb
21711 \family default
21712 ->
21713 \family sans
21714 Program
21715 \family default
21716  This performs the 
21717 \begin_inset Quotes eld
21718 \end_inset
21719
21720 tangling step
21721 \begin_inset Quotes erd
21722 \end_inset
21723
21724 .
21725  As stated above, the Converter is set to 
21726 \begin_inset Quotes eld
21727 \end_inset
21728
21729
21730 \family typewriter
21731 build-script $$i
21732 \family default
21733
21734 \begin_inset Quotes erd
21735 \end_inset
21736
21737 , with Flags set to 
21738 \begin_inset Quotes eld
21739 \end_inset
21740
21741
21742 \family typewriter
21743 originaldir,parselog=listerrors
21744 \family default
21745
21746 \begin_inset Quotes erd
21747 \end_inset
21748
21749 .
21750 \end_layout
21751
21752 \begin_layout Subsubsection
21753 Debug extensions
21754 \end_layout
21755
21756 \begin_layout Standard
21757 There is also a new function implemented in the LyX server, the 
21758 \begin_inset Quotes eld
21759 \end_inset
21760
21761 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
21762  
21763 \end_layout
21764
21765 \begin_layout Standard
21766 When debugging code with ddd/gdb, it is possible to invoke a text editor
21767  at the current execution position with a single key stroke.
21768  The default ddd configuration for that is shift-ctrl-V.
21769  It happens that you can define the editor command line invocation in ddd
21770  by accessing the
21771 \family sans
21772  
21773 \bar under
21774 E
21775 \bar default
21776 dit\SpecialChar \menuseparator
21777
21778 \bar under
21779 P
21780 \bar default
21781 references\SpecialChar \menuseparator
21782
21783 \bar under
21784 H
21785 \bar default
21786 elpers 
21787 \family default
21788 dialog and changing the "Edit Sources" entry.
21789 \end_layout
21790
21791 \begin_layout Standard
21792 I take advantage of the new created LyX server function and this ddd feature,
21793  and set 
21794 \begin_inset Quotes eld
21795 \end_inset
21796
21797 Edit Sources
21798 \begin_inset Quotes erd
21799 \end_inset
21800
21801  to:
21802 \end_layout
21803
21804 \begin_layout LyX-Code
21805 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
21806 \end_layout
21807
21808 \begin_layout Standard
21809 With this, whenever you are using ddd and find a point in the program that
21810  you want to edit, you just press shift-ctrl-V (in the ddd window), and
21811  ddd you forward this information to LyX through the LyX server and then
21812  the LyX window will show the same file with the cursor at the same position
21813  ddd was pointing to.
21814  No more guessing or long scrolling to locate a point in the program back
21815  from debugging !
21816 \end_layout
21817
21818 \begin_layout Standard
21819 Note however that you must enable the LyX server to get this feature working
21820  (it is disabled by default).
21821  You can enable it in 
21822 \family sans
21823 Preferences
21824 \family default
21825  (tabs 
21826 \family sans
21827 Inputs
21828 \family default
21829
21830 \family sans
21831 Paths
21832 \family default
21833 ) by entering in the 
21834 \family sans
21835 LyXserver pipe
21836 \family default
21837  a path like 
21838 \begin_inset Quotes eld
21839 \end_inset
21840
21841
21842 \family typewriter
21843 /home/<your-home-directory>/.lyx/lyxpipe
21844 \family default
21845
21846 \begin_inset Quotes erd
21847 \end_inset
21848
21849
21850 \end_layout
21851
21852 \begin_layout Standard
21853 Read the LyX server documentation in the 
21854 \emph on
21855 Customization Manual
21856 \emph default
21857  for further information.
21858 \end_layout
21859
21860 \begin_layout Subsubsection
21861 Toolbar extensions
21862 \end_layout
21863
21864 \begin_layout Standard
21865 There are six new buttons that can be added to your LyX toolbar.
21866  Five of these buttons are short cuts to layout styles: 
21867 \family sans
21868 Standard
21869 \family default
21870
21871 \family sans
21872 Section
21873 \family default
21874
21875 \family sans
21876 LaTeX
21877 \family default
21878
21879 \family sans
21880 LyX-Code
21881 \family default
21882 , and 
21883 \family sans
21884 Scrap
21885 \family default
21886 .
21887  The last one is a short cut to the 
21888 \begin_inset Quotes eld
21889 \end_inset
21890
21891 Build Program
21892 \begin_inset Quotes erd
21893 \end_inset
21894
21895  File menu entry.
21896  
21897 \end_layout
21898
21899 \begin_layout Standard
21900 LyX has a range of buttons that are available for tool bar customization.
21901  In my toolbar I like to combine the six short cuts above with two more:
21902  One for 
21903 \family sans
21904 \bar under
21905 V
21906 \bar default
21907 iew
21908 \family default
21909 \SpecialChar \menuseparator
21910
21911 \family sans
21912 \bar under
21913 U
21914 \bar default
21915 pdate
21916 \family default
21917 \SpecialChar \menuseparator
21918
21919 \family sans
21920 \bar under
21921 D
21922 \bar default
21923 VI
21924 \family default
21925  and the other for 
21926 \family sans
21927 \bar under
21928 V
21929 \bar default
21930 iew\SpecialChar \menuseparator
21931
21932 \bar under
21933 D
21934 \bar default
21935 VI
21936 \family default
21937  File menu entries.
21938  Here is how it looks like:
21939 \end_layout
21940
21941 \begin_layout LyX-Code
21942 Toolbar
21943 \end_layout
21944
21945 \begin_layout LyX-Code
21946   Layouts
21947 \end_layout
21948
21949 \begin_layout LyX-Code
21950   Icon "layout Standard"
21951 \end_layout
21952
21953 \begin_layout LyX-Code
21954   Icon "layout Section"
21955 \end_layout
21956
21957 \begin_layout LyX-Code
21958   Icon "layout LaTeX"
21959 \end_layout
21960
21961 \begin_layout LyX-Code
21962   Icon "layout LyX-Code"
21963 \end_layout
21964
21965 \begin_layout LyX-Code
21966   Icon "layout Scrap"
21967 \end_layout
21968
21969 \begin_layout LyX-Code
21970   Separator
21971 \end_layout
21972
21973 \begin_layout LyX-Code
21974   Icon "buffer-view"
21975 \end_layout
21976
21977 \begin_layout LyX-Code
21978   Icon "buffer-typeset"
21979 \end_layout
21980
21981 \begin_layout LyX-Code
21982   Icon "build-program"
21983 \end_layout
21984
21985 \begin_layout LyX-Code
21986   Separator
21987 \end_layout
21988
21989 \begin_layout LyX-Code
21990 .
21991 \end_layout
21992
21993 \begin_layout LyX-Code
21994 .
21995 \end_layout
21996
21997 \begin_layout LyX-Code
21998 .
21999 \end_layout
22000
22001 \begin_layout LyX-Code
22002 End
22003 \end_layout
22004
22005 \begin_layout Subsubsection
22006 Colors customization
22007 \end_layout
22008
22009 \begin_layout Standard
22010 There are a number of colors in LyX that can be customized in 
22011 \family sans
22012 Preferences
22013 \family default
22014 .
22015  One of the things that bothers people is the LaTeX font color.
22016  The default color is red, since the scraps uses LaTeX font, and there is
22017  a lot of scraps in literate documents, you may get tired of seeing everything
22018  in red.
22019  You can change it by going to the tabs 
22020 \family sans
22021 Look&Feel
22022 \family default
22023
22024 \family sans
22025 Colors.
22026 \end_layout
22027
22028 \begin_layout Standard
22029 The next thing is the visible presence of the newline character in the screen.
22030  You can choose the color of this particular character and make it blend
22031  in the background.
22032  I recommend you choosing a color that is close to the background but not
22033  equal, that way you still can see it is there, but it is not bothering
22034  you anymore.
22035  
22036 \end_layout
22037
22038 \begin_layout Chapter
22039 Secrets of the LaTeX Masters
22040 \begin_inset LatexCommand \label{cha:secrets}
22041
22042 \end_inset
22043
22044
22045 \end_layout
22046
22047 \begin_layout Standard
22048 Though LyX is a powerful tool, it cannot hope to support everything that
22049  can be done with pure TeX/LaTeX.
22050  However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
22051  as long as you are not afraid to use that 
22052 \begin_inset Quotes eld
22053 \end_inset
22054
22055 TeX
22056 \begin_inset Quotes erd
22057 \end_inset
22058
22059  button on the toolbar or add things to the LaTeX preamble.
22060  This section lists some tips, tricks, and otherwise cool ideas to give
22061  your document that extra little flair.
22062  
22063 \emph on
22064 Do try this at home
22065 \emph default
22066 , just start with something a little smaller and less important than your
22067  dissertation!
22068 \end_layout
22069
22070 \begin_layout Standard
22071 Most ideas in this section require less common files in your LaTeX installation.
22072  If you have a system like teTeX, most will already be available.
22073  A few, however, will need to be downloaded from one of the CTAN archives.
22074  Often, there are several ways to do something, or several LaTeX style files
22075  which do the same thing.
22076  We do not endorse one choice over another, we simply claim that we have
22077  done a particular task with a particular file.
22078  Put on your wizard hat, keep an eye out for dragons, and let us begin.
22079 \end_layout
22080
22081 \begin_layout Section
22082 Tricks for Footnotes and Margin Notes
22083 \end_layout
22084
22085 \begin_layout Standard
22086 suggested by 
22087 \noun on
22088 Robin Socha
22089 \end_layout
22090
22091 \begin_layout Subsection
22092 Footnotes 
22093 \end_layout
22094
22095 \begin_layout Standard
22096 LyX cannot yet take care of setting the footnote numbering back to 1 after
22097  each section in the 
22098 \begin_inset Quotes eld
22099 \end_inset
22100
22101
22102 \family sans
22103 article
22104 \family default
22105
22106 \begin_inset Quotes erd
22107 \end_inset
22108
22109
22110 \family roman
22111  document class or changing the counter style.
22112  You'll need to insert LaTeX commands like the following to achieve that:
22113 \end_layout
22114
22115 \begin_layout Standard
22116 \begin_inset ERT
22117 status inlined
22118
22119 \begin_layout Standard
22120
22121
22122 \backslash
22123 setcounter{footnote}{0}
22124 \end_layout
22125
22126 \end_inset
22127
22128  Using 
22129 \family typewriter
22130
22131 \backslash
22132 setcounter{footnote}{0}
22133 \family roman
22134  will set the counter back to 1
22135 \begin_inset Foot
22136 status collapsed
22137
22138 \begin_layout Standard
22139 The counter has been set back to 1.
22140 \end_layout
22141
22142 \end_inset
22143
22144 .
22145 \end_layout
22146
22147 \begin_layout Standard
22148 The following command will change the numbering to small letters.
22149  Take a look at the next footnote in your xdvi or ghostview 
22150 \begin_inset ERT
22151 status inlined
22152
22153 \begin_layout Standard
22154
22155
22156 \backslash
22157 renewcommand{
22158 \backslash
22159 thefootnote}{
22160 \backslash
22161 alph{footnote}}
22162 \end_layout
22163
22164 \end_inset
22165
22166 :
22167 \begin_inset Foot
22168 status collapsed
22169
22170 \begin_layout Standard
22171 This is an example for a footnote with alphabetic numbering.
22172 \newline
22173 Use
22174 \family typewriter
22175  
22176 \backslash
22177 renewcommand{
22178 \backslash
22179 thefootnote {
22180 \backslash
22181 alph{footnote}} 
22182 \family roman
22183 to get this.
22184 \end_layout
22185
22186 \end_inset
22187
22188
22189 \end_layout
22190
22191 \begin_layout Standard
22192 The next command sets the counter style back to default, i.e.
22193  
22194 \family typewriter
22195
22196 \backslash
22197 arabic
22198 \family default
22199
22200 \begin_inset Foot
22201 status collapsed
22202
22203 \begin_layout Standard
22204 Use
22205 \family typewriter
22206  
22207 \backslash
22208 renewcommand{
22209 \backslash
22210 thefootnote}{
22211 \backslash
22212 arabic{footnote}}
22213 \family roman
22214  to set the counter--style back to LyX's default, i.e.
22215  
22216 \backslash
22217 arabic.
22218 \family default
22219
22220 \begin_inset ERT
22221 status collapsed
22222
22223 \begin_layout Standard
22224
22225
22226 \backslash
22227 renewcommand {
22228 \backslash
22229 thefootnote} {
22230 \backslash
22231 arabic{footnote}}
22232 \end_layout
22233
22234 \end_inset
22235
22236
22237 \end_layout
22238
22239 \end_inset
22240
22241 .
22242 \end_layout
22243
22244 \begin_layout Standard
22245 You can use 
22246 \family typewriter
22247
22248 \backslash
22249 arabic
22250 \family default
22251
22252 \family typewriter
22253
22254 \backslash
22255 roman
22256 \family default
22257
22258 \family typewriter
22259
22260 \backslash
22261 Roman
22262 \family default
22263
22264 \family typewriter
22265
22266 \backslash
22267 alph
22268 \family default
22269  or 
22270 \family typewriter
22271
22272 \backslash
22273 Alph
22274 \family default
22275  and others as counter styles.
22276  Just replace the LaTeX command in the above example and rerun TeX to see
22277  what those styles can do.
22278  
22279 \end_layout
22280
22281 \begin_layout Subsection
22282 Margin Notes
22283 \end_layout
22284
22285 \begin_layout Standard
22286 Here are two examples of neat things you can do to margin notes using LaTeX
22287  commands.
22288 \end_layout
22289
22290 \begin_layout Standard
22291 The following command will make a vertical line appear alongside your text---gre
22292 at for 
22293 \begin_inset Quotes eld
22294 \end_inset
22295
22296 thumbing
22297 \begin_inset Quotes erd
22298 \end_inset
22299
22300
22301 \family typewriter
22302
22303 \backslash
22304 marginpar{
22305 \backslash
22306 rule[-10mm]{30mm}{5mm}}
22307 \family roman
22308 .
22309 \family default
22310
22311 \begin_inset ERT
22312 status inlined
22313
22314 \begin_layout Standard
22315
22316
22317 \backslash
22318 marginpar{
22319 \backslash
22320 rule[-10mm]{30mm}{5mm}}
22321 \end_layout
22322
22323 \end_inset
22324
22325
22326 \end_layout
22327
22328 \begin_layout Standard
22329 Check your dvi- or ghostview-output to see what the 
22330 \family typewriter
22331
22332 \backslash
22333 reversemarginpar 
22334 \family default
22335 command does to the following margin note.
22336 \end_layout
22337
22338 \begin_layout Standard
22339 \begin_inset ERT
22340 status inlined
22341
22342 \begin_layout Standard
22343
22344
22345 \backslash
22346 reversemarginpar
22347 \end_layout
22348
22349 \end_inset
22350
22351
22352 \begin_inset Marginal
22353 status collapsed
22354
22355 \begin_layout Standard
22356 This is a 
22357 \newline
22358 margin note.
22359 \end_layout
22360
22361 \end_inset
22362
22363
22364 \end_layout
22365
22366 \begin_layout Section
22367 Multiple Columns
22368 \end_layout
22369
22370 \begin_layout Standard
22371 by 
22372 \noun on
22373 Lars Gullik Bjønnes
22374 \end_layout
22375
22376 \begin_layout Subsection
22377 Purpose
22378 \end_layout
22379
22380 \begin_layout Standard
22381 The aim for this chapter
22382 \begin_inset Foot
22383 status collapsed
22384
22385 \begin_layout Standard
22386 Editor's note: Lars' original chapter was a masterful description of how
22387  to use the 
22388 \family typewriter
22389 multicol
22390 \family default
22391  package.
22392  However, it was too long to flow smoothly in this document.
22393  I have therefore chosen to excerpt the most important sections here (sorry,
22394  Lars); you can read the original chapter (and more of the story!) in the
22395  example file 
22396 \family typewriter
22397 examples/multicol.lyx
22398 \family default
22399 .
22400  --- mer
22401 \end_layout
22402
22403 \end_inset
22404
22405  is to show how the LaTeX package 
22406 \family typewriter
22407 multicol
22408 \family default
22409  can be used in a LyX document.
22410  As LyX doesn't support the 
22411 \family typewriter
22412 multicol
22413 \family default
22414  package natively yet, we have to use some small hacks.
22415  By reading this section it should be obvious how to do this.
22416 \end_layout
22417
22418 \begin_layout Subsection
22419 Limitations 
22420 \end_layout
22421
22422 \begin_layout Standard
22423 The 
22424 \family typewriter
22425 multicol
22426 \family default
22427  package allows switching between one and multicolumn format on the same
22428  page.
22429  Footnotes are handled correctly (for the most part), but will be placed
22430  at the bottom of the page and not under each column.
22431  LaTeX's float mechanism, however, is partly disabled in the current implementat
22432 ion.
22433  At the moment only page-wide floats can be used within the scope of the
22434  environment.
22435 \end_layout
22436
22437 \begin_layout Subsection
22438 Examples
22439 \end_layout
22440
22441 \begin_layout Subsubsection
22442 Two columns
22443 \end_layout
22444
22445 \begin_layout Standard
22446 If you want to have two columns in your text, you have use LaTeX mode to
22447  insert 
22448 \family typewriter
22449
22450 \backslash
22451 begin{multicols}{2}
22452 \family default
22453  at the point where you want the two column layout to start, and then 
22454 \family typewriter
22455
22456 \backslash
22457 end{multicols}
22458 \family default
22459  where you want it to end.
22460  Like this:
22461 \end_layout
22462
22463 \begin_layout Standard
22464 \begin_inset ERT
22465 status inlined
22466
22467 \begin_layout Standard
22468
22469
22470 \backslash
22471 begin{multicols}{2}
22472 \end_layout
22473
22474 \end_inset
22475
22476
22477 \end_layout
22478
22479 \begin_layout Standard
22480 \noindent
22481
22482 \series bold
22483 \size small
22484 The Adventure of the Empty House
22485 \series default
22486
22487 \newline
22488 by 
22489 \noun on
22490 Sir Arthur Conan Doyle
22491 \end_layout
22492
22493 \begin_layout Standard
22494
22495 \size small
22496 It was in the spring of the year 1894 that all London was interested, and
22497  the fashionable world dismayed, by the murder of the Honourable Ronald
22498  Adair under most unusual and inexplicable circumstances.
22499  The public has already learned those particulars of the crime which came
22500  out in the police investigation, but a good deal was suppressed upon that
22501  occasion, since the case for the prosecution was so overwhelmingly strong
22502  that it was not necessary to bring forward all the facts.
22503  Only now, at the end of nearly ten years, am I allowed to supply those
22504  missing links which make up the whole of that remarkable chain.
22505  The crime was of interest in itself, but that interest was as nothing to
22506  me compared to the inconceivable sequel, which afforded me the greatest
22507  shock and surprise of any event in my adventurous life.
22508  Even now, after this long interval, I find myself thrilling as I think
22509  of it, and feeling once more that sudden flood of joy, amazement, and increduli
22510 ty which utterly submerged my mind.
22511  Let me say to that public, which has shown some interest in those glimpses
22512  which I have occasionally given them of the thoughts and actions of a very
22513  remarkable man, that they are not to blame me if I have not shared my knowledge
22514  with them, for I should have considered it my first duty to do so, had
22515  I not been barred by a positive prohibition from his own lips, which was
22516  only withdrawn upon the third of last month.
22517 \end_layout
22518
22519 \begin_layout Standard
22520 \begin_inset ERT
22521 status inlined
22522
22523 \begin_layout Standard
22524
22525
22526 \backslash
22527 end{multicols}
22528 \end_layout
22529
22530 \end_inset
22531
22532
22533 \end_layout
22534
22535 \begin_layout Subsubsection
22536 Multiple columns
22537 \end_layout
22538
22539 \begin_layout Standard
22540 The same pattern is used when you want more than two columns:
22541 \end_layout
22542
22543 \begin_layout Standard
22544 \begin_inset ERT
22545 status inlined
22546
22547 \begin_layout Standard
22548
22549
22550 \backslash
22551 begin{multicols}{3}
22552 \end_layout
22553
22554 \end_inset
22555
22556
22557 \end_layout
22558
22559 \begin_layout Standard
22560
22561 \size footnotesize
22562 It can be imagined that my close intimacy with Sherlock Holmes had interested
22563  me deeply in crime, and that after his disappearance I never failed to
22564  read with care the various problems which came before the public.
22565  And I even attempted, more than once, for my own private satisfaction,
22566  to employ his methods in their solution, though with indifferent success.
22567  There was none, however, which appealed to me like this tragedy of Ronald
22568  Adair.
22569  As I read the evidence at the inquest, which led up to a verdict of willful
22570  murder against some person or persons unknown, I realized more clearly
22571  than I had ever done the loss which the community had sustained by the
22572  death of Sherlock Holmes.
22573  There were points about this strange business which would, I was sure,
22574  have specially appealed to him, and the efforts of the police would have
22575  been supplemented, or more probably anticipated, by the trained observation
22576  and the alert mind of the first criminal agent in Europe.
22577  All day, as I drove upon my round, I turned over the case in my mind and
22578  found no explanation which appeared to me to be adequate.
22579  At the risk of telling a twice-told tale, I will recapitulate the facts
22580  as they were known to the public at the conclusion of the inquest.
22581 \end_layout
22582
22583 \begin_layout Standard
22584 \begin_inset ERT
22585 status inlined
22586
22587 \begin_layout Standard
22588
22589
22590 \backslash
22591 end{multicols}
22592 \end_layout
22593
22594 \end_inset
22595
22596
22597 \end_layout
22598
22599 \begin_layout Standard
22600 You can have have more than 3 columns if you want to, but that might not
22601  be very pleasant for the eye.
22602 \end_layout
22603
22604 \begin_layout Subsubsection
22605 Columns inside columns
22606 \end_layout
22607
22608 \begin_layout Standard
22609 You can even have columns inside columns:
22610 \end_layout
22611
22612 \begin_layout Standard
22613 \begin_inset ERT
22614 status inlined
22615
22616 \begin_layout Standard
22617
22618
22619 \backslash
22620 begin{multicols}{2}
22621 \end_layout
22622
22623 \end_inset
22624
22625
22626 \end_layout
22627
22628 \begin_layout Standard
22629
22630 \size footnotesize
22631 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
22632  at that time governor of one of the Australian colonies.
22633  Adair's mother had returned from Australia to undergo the operation for
22634  cataract, and she, her son Ronald, and her daughter Hilda were living together
22635  at 427 Park Lane.
22636 \end_layout
22637
22638 \begin_layout Standard
22639 \begin_inset ERT
22640 status inlined
22641
22642 \begin_layout Standard
22643
22644
22645 \backslash
22646 begin{multicols}{2}
22647 \end_layout
22648
22649 \end_inset
22650
22651
22652 \end_layout
22653
22654 \begin_layout Standard
22655
22656 \size footnotesize
22657 The youth moved in the best society--had, so far as was known, no enemies
22658  and no particular vices.
22659  He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
22660  had been broken off by mutual consent some months before, and there was
22661  no sign that it had left any very profound feeling behind it.
22662  For the rest {sic} the man's life moved in a narrow and conventional circle,
22663  for his habits were quiet and his nature unemotional.
22664  Yet it was upon this easy-going young aristocrat that death came, in most
22665  strange and unexpected form, between the hours of ten and eleven-twenty
22666  on the night of March 30, 1894.
22667 \end_layout
22668
22669 \begin_layout Standard
22670 \begin_inset ERT
22671 status inlined
22672
22673 \begin_layout Standard
22674
22675
22676 \backslash
22677 end{multicols}
22678 \end_layout
22679
22680 \end_inset
22681
22682
22683 \end_layout
22684
22685 \begin_layout Standard
22686
22687 \size footnotesize
22688 Ronald Adair was fond of cards--playing continually, but never for such
22689  stakes as would hurt him.
22690  He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
22691  It was shown that, after dinner on the day of his death, he had played
22692  a rubber of whist at the latter club.
22693  He had also played there in the afternoon.
22694
22695 \size default
22696  
22697 \size footnotesize
22698 The evidence of those who had played with him-- Mr.
22699  Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
22700  and that there was a fairly equal fall of the cards.
22701  Adair might have lost five pounds, but not more.
22702  His fortune was a considerable one, and such a loss could not in any way
22703  affect him.
22704  He had played nearly every day at one club or other, but he was a cautious
22705  player, and usually rose a winner.
22706  It came out in evidence that, in partnership with Colonel Moran, he had
22707  actually won as much as four hundred and twenty pounds in a sitting, some
22708  weeks before, from Godfrey Milner and Lord Balmoral.
22709  So much for his recent history as it came out at the inquest.
22710 \end_layout
22711
22712 \begin_layout Standard
22713 \begin_inset ERT
22714 status inlined
22715
22716 \begin_layout Standard
22717
22718
22719 \backslash
22720 end{multicols}
22721 \end_layout
22722
22723 \end_inset
22724
22725
22726 \end_layout
22727
22728 \begin_layout Standard
22729 Please do read the file 
22730 \family typewriter
22731 examples/multicol.lyx
22732 \family default
22733  for more advanced examples including column and header spacing, vertical
22734  separator lines, and more.
22735 \end_layout
22736
22737 \begin_layout Section
22738 Numbering in the 
22739 \family sans
22740 Enumerate
22741 \family default
22742  Paragraph Environment
22743 \begin_inset OptArg
22744 status collapsed
22745
22746 \begin_layout Standard
22747 Numbering in Enumerate
22748 \end_layout
22749
22750 \end_inset
22751
22752
22753 \end_layout
22754
22755 \begin_layout Standard
22756 by 
22757 \noun on
22758 John Weiss
22759 \end_layout
22760
22761 \begin_layout Standard
22762 \begin_inset VSpace bigskip
22763 \end_inset
22764
22765
22766 \end_layout
22767
22768 \begin_layout Standard
22769 \noindent
22770 The default numbering for the 
22771 \family sans
22772 Enumerate
22773 \family default
22774  paragraph environment begins with Arabic numbers and ends with uppercase
22775  letters.
22776  Suppose, however, you wanted a different type of numbering scheme.
22777  Here's a quickie example of how to change the numbering scheme:
22778 \end_layout
22779
22780 \begin_layout LyX-Code
22781
22782 \backslash
22783 renewcommand{
22784 \backslash
22785 labelenumi}{
22786 \backslash
22787 Roman{enumi}.}
22788 \end_layout
22789
22790 \begin_layout LyX-Code
22791
22792 \backslash
22793 renewcommand{
22794 \backslash
22795 labelenumii}{
22796 \backslash
22797 Alph{enumii}.}
22798 \end_layout
22799
22800 \begin_layout LyX-Code
22801
22802 \backslash
22803 renewcommand{
22804 \backslash
22805 labelenumiii}{
22806 \backslash
22807 arabic{enumiii}.}
22808 \end_layout
22809
22810 \begin_layout LyX-Code
22811
22812 \backslash
22813 renewcommand{
22814 \backslash
22815 labelenumiv}{
22816 \backslash
22817 alph{enumiv}.)}
22818 \end_layout
22819
22820 \begin_layout Standard
22821 \SpecialChar \ldots{}
22822  which changes the numbering scheme to uppercase Roman numerals, uppercase
22823  letters, Arabic numbers, and lowercase letter.
22824 \end_layout
22825
22826 \begin_layout Standard
22827 Additionally, the previous example also adds a little bit extra to the numbering
22828  scheme.
22829  For example, the first level label actually looks like: 
22830 \begin_inset Quotes eld
22831 \end_inset
22832
22833 I.
22834 \begin_inset Quotes erd
22835 \end_inset
22836
22837 .
22838  For ease of reading, we'll describe what the numbering schemes look like
22839  using a notation something like this: <
22840 \begin_inset Quotes eld
22841 \end_inset
22842
22843 I.
22844 \begin_inset Quotes erd
22845 \end_inset
22846
22847 ,\InsetSpace ~
22848
22849 \begin_inset Quotes erd
22850 \end_inset
22851
22852 A.
22853 \begin_inset Quotes erd
22854 \end_inset
22855
22856 ,\InsetSpace ~
22857
22858 \begin_inset Quotes erd
22859 \end_inset
22860
22861 1.
22862 \begin_inset Quotes erd
22863 \end_inset
22864
22865 ,\InsetSpace ~
22866
22867 \begin_inset Quotes eld
22868 \end_inset
22869
22870 a.)
22871 \begin_inset Quotes erd
22872 \end_inset
22873
22874 >.
22875  
22876 \end_layout
22877
22878 \begin_layout Standard
22879 As you can see in the example, there is a label command for each nesting
22880  level, 
22881 \family typewriter
22882
22883 \backslash
22884 labelenumi
22885 \family default
22886  \SpecialChar \ldots{}
22887  
22888 \family typewriter
22889
22890 \backslash
22891 labelenumiv
22892 \family default
22893 , as well as a counter, 
22894 \family typewriter
22895 enumi
22896 \family default
22897  \SpecialChar \ldots{}
22898  
22899 \family typewriter
22900 enumiv
22901 \family default
22902 .
22903  There are also five 
22904 \begin_inset Quotes eld
22905 \end_inset
22906
22907 number printing
22908 \begin_inset Quotes erd
22909 \end_inset
22910
22911  commands, 
22912 \family typewriter
22913
22914 \backslash
22915 arabic{}
22916 \family default
22917
22918 \family typewriter
22919
22920 \backslash
22921 roman{}
22922 \family default
22923
22924 \family typewriter
22925
22926 \backslash
22927 Roman{}
22928 \family default
22929
22930 \family typewriter
22931
22932 \backslash
22933 alph{}
22934 \family default
22935 , and 
22936 \family typewriter
22937
22938 \backslash
22939 Alph{}
22940 \family default
22941 , each of which take one counter as an argument.
22942  You can add characters before or after these, but there's no need to add
22943  spaces.
22944 \end_layout
22945
22946 \begin_layout Standard
22947 You can get really fancy with these.
22948  For example:
22949 \end_layout
22950
22951 \begin_layout LyX-Code
22952
22953 \backslash
22954 renewcommand{
22955 \backslash
22956 labelenumi}{
22957 \backslash
22958 #
22959 \backslash
22960 Alph{enumi}
22961 \backslash
22962 #}
22963 \end_layout
22964
22965 \begin_layout LyX-Code
22966
22967 \backslash
22968 renewcommand{
22969 \backslash
22970 labelenumii}{
22971 \backslash
22972 Alph{enumi}.
22973 \backslash
22974 arabic{enumii}}
22975 \end_layout
22976
22977 \begin_layout LyX-Code
22978
22979 \backslash
22980 renewcommand{
22981 \backslash
22982 labelenumiii}{
22983 \backslash
22984 alph{enumiii}+}
22985 \end_layout
22986
22987 \begin_layout LyX-Code
22988
22989 \backslash
22990 renewcommand{
22991 \backslash
22992 labelenumiv}{(
22993 \backslash
22994 roman{enumiv})}
22995 \end_layout
22996
22997 \begin_layout Standard
22998 produces the somewhat out of hand numbering scheme: <
22999 \begin_inset Quotes eld
23000 \end_inset
23001
23002 #A#
23003 \begin_inset Quotes erd
23004 \end_inset
23005
23006 ,\InsetSpace ~
23007
23008 \begin_inset Quotes erd
23009 \end_inset
23010
23011 A.1
23012 \begin_inset Quotes erd
23013 \end_inset
23014
23015 ,\InsetSpace ~
23016
23017 \begin_inset Quotes erd
23018 \end_inset
23019
23020 a+
23021 \begin_inset Quotes erd
23022 \end_inset
23023
23024 ,\InsetSpace ~
23025
23026 \begin_inset Quotes eld
23027 \end_inset
23028
23029 (i)
23030 \begin_inset Quotes erd
23031 \end_inset
23032
23033 >.
23034  
23035 \end_layout
23036
23037 \begin_layout Section
23038 Extra Space Between Table Rows
23039 \end_layout
23040
23041 \begin_layout Standard
23042 by 
23043 \noun on
23044 Mike Ressler
23045 \end_layout
23046
23047 \begin_layout Standard
23048 \begin_inset VSpace bigskip
23049 \end_inset
23050
23051
23052 \end_layout
23053
23054 \begin_layout Standard
23055 \noindent
23056 LaTeX allows you to put a bit of extra space between rows in a table by
23057  giving an optional argument to the end-of-row specifier (
23058 \family typewriter
23059
23060 \backslash
23061
23062 \backslash
23063
23064 \family default
23065 ).
23066  LyX has not yet implemented this in a formal way, so here are two dirty
23067  little tricks to do the same job.
23068  
23069 \end_layout
23070
23071 \begin_layout Standard
23072 The first is the more formal, but longwinded way to do it.
23073  In the LaTeX preamble, add the following command definition: 
23074 \end_layout
23075
23076 \begin_layout Standard
23077
23078 \family typewriter
23079
23080 \backslash
23081 newcommand{
23082 \backslash
23083 extratablespace}[1]{
23084 \backslash
23085 noalign{vskip#1}}
23086 \family default
23087  This command takes a single argument---the amount of space you would like
23088  to insert.
23089  Insert the command in the first column of the row 
23090 \emph on
23091 after
23092 \emph default
23093  where you would like the space to appear.
23094  Here is an example (I've removed all the borders using 
23095 \family sans
23096 \bar under
23097 L
23098 \bar default
23099 ayout\SpecialChar \menuseparator
23100 Tabl
23101 \bar under
23102 e
23103 \family default
23104 \bar default
23105 ):
23106 \end_layout
23107
23108 \begin_layout Standard
23109 \align center
23110 \begin_inset Tabular
23111 <lyxtabular version="3" rows="4" columns="3">
23112 <features>
23113 <column alignment="center" valignment="top" width="0pt">
23114 <column alignment="center" valignment="top" width="0pt">
23115 <column alignment="center" valignment="top" width="0pt">
23116 <row>
23117 <cell alignment="center" valignment="top" topline="true" usebox="none">
23118 \begin_inset Text
23119
23120 \begin_layout Standard
23121
23122 \family roman
23123 \series medium
23124 \shape up
23125 \size normal
23126 \emph off
23127 \bar no
23128 \noun off
23129 \color none
23130 Minerals
23131 \end_layout
23132
23133 \end_inset
23134 </cell>
23135 <cell alignment="center" valignment="top" topline="true" usebox="none">
23136 \begin_inset Text
23137
23138 \begin_layout Standard
23139
23140 \family roman
23141 \series medium
23142 \shape up
23143 \size normal
23144 \emph off
23145 \bar no
23146 \noun off
23147 \color none
23148 Calcite
23149 \end_layout
23150
23151 \end_inset
23152 </cell>
23153 <cell alignment="center" valignment="top" topline="true" usebox="none">
23154 \begin_inset Text
23155
23156 \begin_layout Standard
23157
23158 \family roman
23159 \series medium
23160 \shape up
23161 \size normal
23162 \emph off
23163 \bar no
23164 \noun off
23165 \color none
23166 Dolomite
23167 \end_layout
23168
23169 \end_inset
23170 </cell>
23171 </row>
23172 <row>
23173 <cell alignment="center" valignment="top" topline="true" usebox="none">
23174 \begin_inset Text
23175
23176 \begin_layout Standard
23177
23178 \end_layout
23179
23180 \end_inset
23181 </cell>
23182 <cell alignment="center" valignment="top" topline="true" usebox="none">
23183 \begin_inset Text
23184
23185 \begin_layout Standard
23186
23187 \family roman
23188 \series medium
23189 \shape up
23190 \size normal
23191 \emph off
23192 \bar no
23193 \noun off
23194 \color none
23195 Quartz
23196 \end_layout
23197
23198 \end_inset
23199 </cell>
23200 <cell alignment="center" valignment="top" topline="true" usebox="none">
23201 \begin_inset Text
23202
23203 \begin_layout Standard
23204
23205 \family roman
23206 \series medium
23207 \shape up
23208 \size normal
23209 \emph off
23210 \bar no
23211 \noun off
23212 \color none
23213 Graphite
23214 \end_layout
23215
23216 \end_inset
23217 </cell>
23218 </row>
23219 <row>
23220 <cell alignment="center" valignment="top" topline="true" usebox="none">
23221 \begin_inset Text
23222
23223 \begin_layout Standard
23224
23225 \family roman
23226 \series medium
23227 \shape up
23228 \size normal
23229 \emph off
23230 \bar no
23231 \noun off
23232 \color none
23233 \begin_inset ERT
23234 status collapsed
23235
23236 \begin_layout Standard
23237
23238
23239 \backslash
23240 extratablespace{2ex}
23241 \end_layout
23242
23243 \end_inset
23244
23245 Rocks
23246 \end_layout
23247
23248 \end_inset
23249 </cell>
23250 <cell alignment="center" valignment="top" topline="true" usebox="none">
23251 \begin_inset Text
23252
23253 \begin_layout Standard
23254
23255 \family roman
23256 \series medium
23257 \shape up
23258 \size normal
23259 \emph off
23260 \bar no
23261 \noun off
23262 \color none
23263 Limestone
23264 \end_layout
23265
23266 \end_inset
23267 </cell>
23268 <cell alignment="center" valignment="top" topline="true" usebox="none">
23269 \begin_inset Text
23270
23271 \begin_layout Standard
23272
23273 \family roman
23274 \series medium
23275 \shape up
23276 \size normal
23277 \emph off
23278 \bar no
23279 \noun off
23280 \color none
23281 Sandstone
23282 \end_layout
23283
23284 \end_inset
23285 </cell>
23286 </row>
23287 <row>
23288 <cell alignment="center" valignment="top" topline="true" usebox="none">
23289 \begin_inset Text
23290
23291 \begin_layout Standard
23292
23293 \end_layout
23294
23295 \end_inset
23296 </cell>
23297 <cell alignment="center" valignment="top" topline="true" usebox="none">
23298 \begin_inset Text
23299
23300 \begin_layout Standard
23301
23302 \family roman
23303 \series medium
23304 \shape up
23305 \size normal
23306 \emph off
23307 \bar no
23308 \noun off
23309 \color none
23310 Granite
23311 \end_layout
23312
23313 \end_inset
23314 </cell>
23315 <cell alignment="center" valignment="top" topline="true" usebox="none">
23316 \begin_inset Text
23317
23318 \begin_layout Standard
23319
23320 \family roman
23321 \series medium
23322 \shape up
23323 \size normal
23324 \emph off
23325 \bar no
23326 \noun off
23327 \color none
23328 Andesite
23329 \end_layout
23330
23331 \end_inset
23332 </cell>
23333 </row>
23334 </lyxtabular>
23335
23336 \end_inset
23337
23338
23339 \end_layout
23340
23341 \begin_layout Standard
23342 The second method is faster, but will make typographers and TeXperts all
23343  over the world groan.
23344  Simply put an end of row specifier with optional argument at the same spot.
23345  No fancy definitions are needed as in the above example, but there will
23346  be more space inserted than you specified because you essentially added
23347  a blank row plus the extra space.
23348  If the space added is too much, simply use a negative number, like so:
23349 \end_layout
23350
23351 \begin_layout Standard
23352 \align center
23353 \begin_inset Tabular
23354 <lyxtabular version="3" rows="4" columns="3">
23355 <features>
23356 <column alignment="center" valignment="top" width="0pt">
23357 <column alignment="center" valignment="top" width="0pt">
23358 <column alignment="center" valignment="top" width="0pt">
23359 <row>
23360 <cell alignment="center" valignment="top" topline="true" usebox="none">
23361 \begin_inset Text
23362
23363 \begin_layout Standard
23364
23365 \family roman
23366 \series medium
23367 \shape up
23368 \size normal
23369 \emph off
23370 \bar no
23371 \noun off
23372 \color none
23373 Minerals
23374 \end_layout
23375
23376 \end_inset
23377 </cell>
23378 <cell alignment="center" valignment="top" topline="true" usebox="none">
23379 \begin_inset Text
23380
23381 \begin_layout Standard
23382
23383 \family roman
23384 \series medium
23385 \shape up
23386 \size normal
23387 \emph off
23388 \bar no
23389 \noun off
23390 \color none
23391 Calcite
23392 \end_layout
23393
23394 \end_inset
23395 </cell>
23396 <cell alignment="center" valignment="top" topline="true" usebox="none">
23397 \begin_inset Text
23398
23399 \begin_layout Standard
23400
23401 \family roman
23402 \series medium
23403 \shape up
23404 \size normal
23405 \emph off
23406 \bar no
23407 \noun off
23408 \color none
23409 Dolomite
23410 \end_layout
23411
23412 \end_inset
23413 </cell>
23414 </row>
23415 <row>
23416 <cell alignment="center" valignment="top" topline="true" usebox="none">
23417 \begin_inset Text
23418
23419 \begin_layout Standard
23420
23421 \end_layout
23422
23423 \end_inset
23424 </cell>
23425 <cell alignment="center" valignment="top" topline="true" usebox="none">
23426 \begin_inset Text
23427
23428 \begin_layout Standard
23429
23430 \family roman
23431 \series medium
23432 \shape up
23433 \size normal
23434 \emph off
23435 \bar no
23436 \noun off
23437 \color none
23438 Quartz
23439 \end_layout
23440
23441 \end_inset
23442 </cell>
23443 <cell alignment="center" valignment="top" topline="true" usebox="none">
23444 \begin_inset Text
23445
23446 \begin_layout Standard
23447
23448 \family roman
23449 \series medium
23450 \shape up
23451 \size normal
23452 \emph off
23453 \bar no
23454 \noun off
23455 \color none
23456 Graphite
23457 \end_layout
23458
23459 \end_inset
23460 </cell>
23461 </row>
23462 <row>
23463 <cell alignment="center" valignment="top" topline="true" usebox="none">
23464 \begin_inset Text
23465
23466 \begin_layout Standard
23467
23468 \family roman
23469 \series medium
23470 \shape up
23471 \size normal
23472 \emph off
23473 \bar no
23474 \noun off
23475 \color none
23476 \begin_inset ERT
23477 status collapsed
23478
23479 \begin_layout Standard
23480
23481
23482 \backslash
23483
23484 \backslash
23485 [-1ex]
23486 \end_layout
23487
23488 \end_inset
23489
23490  Rocks
23491 \end_layout
23492
23493 \end_inset
23494 </cell>
23495 <cell alignment="center" valignment="top" topline="true" usebox="none">
23496 \begin_inset Text
23497
23498 \begin_layout Standard
23499
23500 \family roman
23501 \series medium
23502 \shape up
23503 \size normal
23504 \emph off
23505 \bar no
23506 \noun off
23507 \color none
23508 Limestone
23509 \end_layout
23510
23511 \end_inset
23512 </cell>
23513 <cell alignment="center" valignment="top" topline="true" usebox="none">
23514 \begin_inset Text
23515
23516 \begin_layout Standard
23517
23518 \family roman
23519 \series medium
23520 \shape up
23521 \size normal
23522 \emph off
23523 \bar no
23524 \noun off
23525 \color none
23526 Sandstone
23527 \end_layout
23528
23529 \end_inset
23530 </cell>
23531 </row>
23532 <row>
23533 <cell alignment="center" valignment="top" topline="true" usebox="none">
23534 \begin_inset Text
23535
23536 \begin_layout Standard
23537
23538 \end_layout
23539
23540 \end_inset
23541 </cell>
23542 <cell alignment="center" valignment="top" topline="true" usebox="none">
23543 \begin_inset Text
23544
23545 \begin_layout Standard
23546
23547 \family roman
23548 \series medium
23549 \shape up
23550 \size normal
23551 \emph off
23552 \bar no
23553 \noun off
23554 \color none
23555 Granite
23556 \end_layout
23557
23558 \end_inset
23559 </cell>
23560 <cell alignment="center" valignment="top" topline="true" usebox="none">
23561 \begin_inset Text
23562
23563 \begin_layout Standard
23564
23565 \family roman
23566 \series medium
23567 \shape up
23568 \size normal
23569 \emph off
23570 \bar no
23571 \noun off
23572 \color none
23573 Andesite
23574 \end_layout
23575
23576 \end_inset
23577 </cell>
23578 </row>
23579 </lyxtabular>
23580
23581 \end_inset
23582
23583
23584 \end_layout
23585
23586 \begin_layout Standard
23587 It's short, sweet, and gets the job done quickly, even if it is really ugly.
23588  You may put away the rotten vegetables now! I promise I won't suggest anything
23589  else like that!
23590 \end_layout
23591
23592 \begin_layout Section
23593 Dropped Capitals
23594 \end_layout
23595
23596 \begin_layout Standard
23597 by 
23598 \noun on
23599 Mike Ressler
23600 \end_layout
23601
23602 \begin_layout Standard
23603 \begin_inset VSpace bigskip
23604 \end_inset
23605
23606
23607 \end_layout
23608
23609 \begin_layout Standard
23610 \noindent
23611 \begin_inset ERT
23612 status collapsed
23613
23614 \begin_layout Standard
23615
23616
23617 \backslash
23618 newfont{
23619 \backslash
23620 tmpfont}{cmr17 scaled 2500}{
23621 \backslash
23622 tmpfont T}
23623 \backslash
23624 vspace*{-8.4ex}
23625 \end_layout
23626
23627 \end_inset
23628
23629
23630 \end_layout
23631
23632 \begin_layout Standard
23633 \noindent
23634 \begin_inset ERT
23635 status inlined
23636
23637 \begin_layout Standard
23638
23639
23640 \backslash
23641 hangindent=3.3em 
23642 \backslash
23643 hangafter=-3
23644 \end_layout
23645
23646 \end_inset
23647
23648  hose of you who like the style of old books probably also like 
23649 \begin_inset Quotes eld
23650 \end_inset
23651
23652 dropped capitals
23653 \begin_inset Quotes erd
23654 \end_inset
23655
23656 ---those large capital letters which begin each new chapter or section.
23657  Implementing them with plain LyX/LaTeX is straightforward (assuming you
23658  know some plain TeX!) but does require a lot of work and many iterations,
23659  as you can see by all the ugly TeX-mode stuff at the beginning of this
23660  paragraph.
23661 \end_layout
23662
23663 \begin_layout Standard
23664 \begin_inset ERT
23665 status inlined
23666
23667 \begin_layout Standard
23668
23669
23670 \backslash
23671 verb+
23672 \backslash
23673 bigdrop{-1em}{3}{ptmri}{T}+
23674 \end_layout
23675
23676 \end_inset
23677
23678 here is a much easier way of doing this, of course.
23679  The 
23680 \family typewriter
23681 dropcaps
23682 \family default
23683  (or the newer 
23684 \family typewriter
23685 dropping
23686 \family default
23687 ) package from CTAN allows a simple way to add such letters to your documents.
23688  Since this package is not a standard part of teTeX, I can't demonstrate
23689  it within this document, but if you copy this paragraph to a new document,
23690  delete the 
23691 \begin_inset Quotes eld
23692 \end_inset
23693
23694
23695 \family typewriter
23696
23697 \backslash
23698 verb
23699 \family default
23700
23701 \begin_inset Quotes erd
23702 \end_inset
23703
23704  and the pluses from the TeX code at the beginning of the paragraph, and
23705  add 
23706 \family typewriter
23707
23708 \backslash
23709 usepackage{dropcaps}
23710 \family default
23711  to your LaTeX preamble, you will get a nice Times Roman Italic 
23712 \begin_inset Quotes eld
23713 \end_inset
23714
23715 T
23716 \begin_inset Quotes erd
23717 \end_inset
23718
23719 , whose height is three lines of text and which protrudes 1 em into the
23720  margin.
23721  (Make certain you have copied 
23722 \begin_inset Quotes eld
23723 \end_inset
23724
23725
23726 \family typewriter
23727 dropcaps.sty
23728 \family default
23729
23730 \begin_inset Quotes erd
23731 \end_inset
23732
23733  into a directory where TeX can see it.) The first argument is the amount
23734  of indentation; in this case the negative sign moves it into the margin.
23735  The second argument is the height of the letter in number of lines of text.
23736  The third argument is the font name: virtually anything which has a tfm
23737  file should work (wade through the 
23738 \family typewriter
23739 .../texmf/fonts/tfm
23740 \family default
23741  directory for possibilities).
23742  My personal favorite is 
23743 \begin_inset Quotes eld
23744 \end_inset
23745
23746
23747 \family typewriter
23748 yinit
23749 \family default
23750
23751 \begin_inset Quotes erd
23752 \end_inset
23753
23754 , a fancy German font specifically designed for dropped capitals.
23755  The fourth argument is the letter (or letters) to be dropped.
23756  The 
23757 \family typewriter
23758 dropping
23759 \family default
23760  package also offers the 
23761 \family typewriter
23762
23763 \backslash
23764 bigdrop
23765 \family default
23766  command, as well as a slightly simplified 
23767 \family typewriter
23768
23769 \backslash
23770 dropping
23771 \family default
23772  command.
23773 \end_layout
23774
23775 \begin_layout Section
23776 Non-standard Paragraph Shapes
23777 \end_layout
23778
23779 \begin_layout Standard
23780 by 
23781 \noun on
23782 Mike Ressler
23783 \end_layout
23784
23785 \begin_layout Standard
23786 \begin_inset VSpace bigskip
23787 \end_inset
23788
23789
23790 \end_layout
23791
23792 \begin_layout Standard
23793 \begin_inset ERT
23794 status inlined
23795
23796 \begin_layout Standard
23797
23798
23799 \backslash
23800 begin{sloppypar}
23801 \end_layout
23802
23803 \end_inset
23804
23805
23806 \end_layout
23807
23808 \begin_layout Standard
23809 \begin_inset ERT
23810 status collapsed
23811
23812 \begin_layout Standard
23813
23814
23815 \backslash
23816 newdimen
23817 \backslash
23818 varunit 
23819 \end_layout
23820
23821 \begin_layout Standard
23822
23823
23824 \backslash
23825 setlength{
23826 \backslash
23827 varunit}{4.5in}
23828 \end_layout
23829
23830 \end_inset
23831
23832
23833 \end_layout
23834
23835 \begin_layout Standard
23836 \noindent
23837 \begin_inset ERT
23838 status collapsed
23839
23840 \begin_layout Standard
23841
23842
23843 \backslash
23844 parshape 19 0.45
23845 \backslash
23846 varunit 0.332
23847 \backslash
23848 varunit
23849 \end_layout
23850
23851 \begin_layout Standard
23852
23853 0.40
23854 \backslash
23855 varunit 0.300
23856 \backslash
23857 varunit
23858 \end_layout
23859
23860 \begin_layout Standard
23861
23862 0.35
23863 \backslash
23864 varunit 0.293
23865 \backslash
23866 varunit
23867 \end_layout
23868
23869 \begin_layout Standard
23870
23871 0.30
23872 \backslash
23873 varunit 0.300
23874 \backslash
23875 varunit
23876 \end_layout
23877
23878 \begin_layout Standard
23879
23880 0.25
23881 \backslash
23882 varunit 0.317
23883 \backslash
23884 varunit
23885 \end_layout
23886
23887 \begin_layout Standard
23888
23889 0.20
23890 \backslash
23891 varunit 0.342
23892 \backslash
23893 varunit
23894 \end_layout
23895
23896 \begin_layout Standard
23897
23898 0.15
23899 \backslash
23900 varunit 0.373
23901 \backslash
23902 varunit
23903 \end_layout
23904
23905 \begin_layout Standard
23906
23907 0.10
23908 \backslash
23909 varunit 0.410
23910 \backslash
23911 varunit
23912 \end_layout
23913
23914 \begin_layout Standard
23915
23916 0.05
23917 \backslash
23918 varunit 0.453
23919 \backslash
23920 varunit
23921 \end_layout
23922
23923 \begin_layout Standard
23924
23925 0.00
23926 \backslash
23927 varunit 0.500
23928 \backslash
23929 varunit
23930 \end_layout
23931
23932 \begin_layout Standard
23933
23934 0.05
23935 \backslash
23936 varunit 0.453
23937 \backslash
23938 varunit
23939 \end_layout
23940
23941 \begin_layout Standard
23942
23943 0.10
23944 \backslash
23945 varunit 0.410
23946 \backslash
23947 varunit
23948 \end_layout
23949
23950 \begin_layout Standard
23951
23952 0.15
23953 \backslash
23954 varunit 0.373
23955 \backslash
23956 varunit
23957 \end_layout
23958
23959 \begin_layout Standard
23960
23961 0.20
23962 \backslash
23963 varunit 0.342
23964 \backslash
23965 varunit
23966 \end_layout
23967
23968 \begin_layout Standard
23969
23970 0.25
23971 \backslash
23972 varunit 0.317
23973 \backslash
23974 varunit
23975 \end_layout
23976
23977 \begin_layout Standard
23978
23979 0.30
23980 \backslash
23981 varunit 0.300
23982 \backslash
23983 varunit
23984 \end_layout
23985
23986 \begin_layout Standard
23987
23988 0.35
23989 \backslash
23990 varunit 0.293
23991 \backslash
23992 varunit
23993 \end_layout
23994
23995 \begin_layout Standard
23996
23997 0.40
23998 \backslash
23999 varunit 0.300
24000 \backslash
24001 varunit
24002 \end_layout
24003
24004 \begin_layout Standard
24005
24006 0.45
24007 \backslash
24008 varunit 0.332
24009 \backslash
24010 varunit
24011 \end_layout
24012
24013 \begin_layout Standard
24014
24015 \end_layout
24016
24017 \end_inset
24018
24019 There are times when the tyranny of rectangular paragraphs must be overthrown.
24020  In such situations, a call to the delightful plain TeX command 
24021 \family typewriter
24022
24023 \backslash
24024 parshape
24025 \family default
24026  is called for.
24027  As you can see, completely arbitrary shapes can be laid out with a suitable
24028  set of linelength definitions.
24029  While this parshape may look a bit silly and useless, one could conceive
24030  of situations such as finely tuned dropped capitals, word wrapping around
24031  non-rectangular graphics, etc.
24032  which will benefit from such handcrafting.
24033 \end_layout
24034
24035 \begin_layout Standard
24036 \begin_inset VSpace bigskip
24037 \end_inset
24038
24039
24040 \end_layout
24041
24042 \begin_layout Standard
24043 The syntax is 
24044 \family typewriter
24045
24046 \backslash
24047 parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
24048  #nindent #nlength
24049 \family default
24050 , where 
24051 \family typewriter
24052 numlines
24053 \family default
24054  is the number of lines of text which define the paragraph.
24055  If there turn out to be fewer lines, the shape is truncated; if there are
24056  more, the excess lines have the same dimensions as the last line of the
24057  definition.
24058  The 
24059 \family typewriter
24060 #nindent
24061 \family default
24062  and 
24063 \family typewriter
24064 #nlength
24065 \family default
24066  entries specify the indentation of the line from the left margin, and the
24067  length of the line as measured from that point.
24068  The shape applies only to the current paragraph; everything is reset to
24069  normal for the next paragraph.
24070 \end_layout
24071
24072 \begin_layout Standard
24073 \begin_inset ERT
24074 status inlined
24075
24076 \begin_layout Standard
24077
24078
24079 \backslash
24080 end{sloppypar}
24081 \end_layout
24082
24083 \end_inset
24084
24085
24086 \end_layout
24087
24088 \begin_layout Section
24089 Summary
24090 \end_layout
24091
24092 \begin_layout Standard
24093 As you can see, the examples in this section range from the useful to the
24094  whimsical.
24095  While I don't expect that anyone will ever need the paragraph shape demonstrate
24096 d in the last section, the important point is that you can do almost anything
24097  you want in LyX if you are willing to figure out how to do it in TeX and
24098  LaTeX.
24099  TeX is a fantastically powerful typesetting system and all that power is
24100  available to you since LyX uses it as its backend.
24101  Happy LyXing!
24102 \end_layout
24103
24104 \end_body
24105 \end_document