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