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