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