-#LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 271
+#LyX 1.6.0svn created this file. For more info see http://www.lyx.org/
+\lyxformat 313
\begin_document
\begin_header
\textclass book
\begin_preamble
\usepackage{multicol}
\newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
+
+% if pdflatex is used
+\usepackage{ifpdf}
+\ifpdf
+
+% set fonts for nicer pdf view
+\IfFileExists{lmodern.sty}
+ {\usepackage{lmodern}}{}
+
+% link all cross references and URLs
+% in pdf output
+ \usepackage[colorlinks=true, bookmarks, bookmarksnumbered, bookmarksopen, bookmarksopenlevel=1,
+ linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
+ pdfpagelayout=OneColumn, pdfnewwindow=true,
+ pdfstartview=XYZ, plainpages=false, pdfpagelabels,
+ pdfauthor={LyX Team}, pdftex,
+ pdftitle={LyX's Extended manual},
+ pdfsubject={LyX's extended documentation},
+ pdfkeywords={LyX, Documentation, Extended}]{hyperref}
+
+\else % if dvi or ps is produced
+
+ % link all cross references and URLs in DVI output
+ \usepackage[ps2pdf, colorlinks=true,
+ linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue]{hyperref}
+
+\fi % end if pdflatex is used
+
+% redefine the \LyX macro for PDF bookmarks
+\def\LyX{\texorpdfstring{%
+ L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
+ {LyX }}
\end_preamble
+\begin_modules
+logicalmkup
+theorems-ams
+theorems-ams-extended
+\end_modules
\language english
\inputencoding latin1
\font_roman default
\graphics default
\paperfontsize default
\spacing single
+\use_hyperref false
\papersize default
\use_geometry false
\use_amsmath 0
\paperpagestyle headings
\tracking_changes false
\output_changes false
-\author "Richard Heck"
-\author "usti"
+\author ""
+\author ""
\end_header
\begin_body
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand tableofcontents
+\begin_inset CommandInset toc
+LatexCommand tableofcontents
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:lyxandlatex"
\end_inset
\begin_layout Section
Translating LaTeX files into LyX
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Translating-LaTeX-files"
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-If you just want to put a piece of LaTeX code into a LyX file, see Section
-\begin_inset LatexCommand ref
+If you just want to put a piece of LaTeX code into a LyX file, see Section\InsetSpace ~
+
+\begin_inset CommandInset ref
+LatexCommand ref
reference "sec:latexcodes"
\end_inset
\begin_layout Section
Inserting LaTeX Code into LyX Documents
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:Inserting-LaTeX-Code"
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:latexcodes"
\end_inset
short sections of LaTeX commands.
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:preamble"
\end_inset
given in Chapter\InsetSpace ~
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "cha:secrets"
\end_inset
\begin_layout Section
Preparing a Bibliography with BibTeX
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:Preparing-a-Bibliography"
\end_inset
\begin_layout Standard
See
-\begin_inset LatexCommand url
-target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
+\end_layout
\end_inset
\begin_layout Subsection
Sectionated Bibliographies
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sub:Sectionated-Bibliographies"
\end_inset
\begin_layout Standard
Available from
-\begin_inset LatexCommand url
-target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
+\end_layout
\end_inset
.
Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "sec:Preparing-a-Bibliography"
\end_inset
LyX (cf.\InsetSpace ~
section\InsetSpace ~
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "sub:Sectionated-Bibliographies"
\end_inset
LaTeX-Code (ERT, cf.\InsetSpace ~
section\InsetSpace ~
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "sec:Inserting-LaTeX-Code"
\end_inset
Also, the btUnits cannot be nested.
\end_layout
+\begin_layout Standard
+
+\end_layout
+
\begin_layout Section
-Making an Index
+Multipart Documents
\end_layout
-\begin_layout Standard
-A good index is one of the hardest things to make in a lengthy document,
- but LyX helps make things a bit simpler by interfacing to the
-\family typewriter
-makeindex
-\family default
- program which is found in most recent LaTeX distributions.
-\begin_inset Foot
-status collapsed
+\begin_layout Subsection
+General Operation
+\end_layout
\begin_layout Standard
+When you are working on a large file with many sections, it is often convenient
+ to break up the document into several files, or perhaps you have something
+ where a table may change from time to time, but the preceding text does
+ not.
+ In these cases, you should seriously consider using multipart documents.
+ For example, scientific papers often have five major sections: the introduction
+, observations, results, discussion, and conclusion.
+ Each of these could be its own separate LyX file, with one
+\begin_inset Quotes eld
+\end_inset
+
+master
+\begin_inset Quotes erd
+\end_inset
+
+ file which contains the title, authors, abstract, references, etc., plus
+ the five included files.
+ It is important to note that each of these files is a full LyX file which
+ can be formatted and printed on its own, as well as included in a master
+ file.
+ Each of these files must have the same document class, however--- don't
+ attempt to mix book classes with article classes.
+ You may also include LaTeX files; however, these files must not have their
+ own preamble
+\emph on
+(i.e.
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-In the
-\family default
-\series default
-\shape default
-\emph default
-\bar default
-
-\family sans
-\size default
-\noun default
-Outputs\SpecialChar \menuseparator
-LaT\SpecialChar \textcompwordmark{}
-eX
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
- section of the preferences dialog, however, you can customize the index
- command, if you prefer an alternative program like
-\family default
-\series default
-\shape default
\emph default
-\bar default
-
+ everything up to and including the
\family typewriter
-\size default
-\noun default
-xindy
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-.
-\end_layout
-\end_inset
+\backslash
+begin{document}
+\family default
+ line as well as the
+\family typewriter
- Inserting an index and marking words to include in it works much the same
- way as preparing a bibliography as mentioned in the last section.
+\backslash
+end{document}
+\family default
+ line must be deleted) or else errors will be generated when you try to
+ make a DVI file.
\end_layout
\begin_layout Standard
-First, go to the end of your file and select
+LyX allows you to include files quite easily with
\family sans
\bar under
I
\bar default
nsert\SpecialChar \menuseparator
-List
-\family default
-\InsetSpace ~
-/\InsetSpace ~
-
-\family sans
-T
-\bar under
-O
-\bar default
-C\SpecialChar \menuseparator
-
+ChiI
\bar under
-I
+d
\bar default
-ndex
-\family default
\InsetSpace ~
-
-\family sans
-List
+Document
\family default
.
- Then, for each word you would like to include in the index, go to the end
- of that word and click on
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-ndex
-\family default
-\InsetSpace ~
+ When you click on this selection a small box is inserted into the file
+ at the current cursor location.
+ Clicking on the box raises a dialog which allows you to select the file
+ to be included, and the method of its inclusion.
+
+\end_layout
-\family sans
-Entry
-\family default
-.
- This will insert a tag showing the word as it will appear in the index.
- That's all there is to it; LyX will automatically call
-\family typewriter
-makeindex
-\family default
- for you and create the index itself.
- The text in the dialog available from right-clicking on the index button
- accepts LaTeX, so you'll need to be careful to avoid using any special
- characters.
- On the positive side, you can use the advanced options - have a look at
- the documentation which comes with your LaTeX distribution to find out
- how to do things like
+\begin_layout Standard
+The file selection box should by now be obvious.
+ The three inclusion methods are
\begin_inset Quotes eld
\end_inset
-nested entries
+include
\begin_inset Quotes erd
\end_inset
-, etc.
-\end_layout
-
-\begin_layout Standard
-Be careful not to put spaces between the word in the text and the index
- marker; apparently the wrong page number can be produced if this happens.
-\end_layout
-
-\begin_layout Section
-Glossaries
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Özgür Ug̃raş Baran
-\end_layout
-
-\begin_layout Standard
-Sometimes you need to compile a list of symbols that are mentioned in your
- document with a brief explanation of them.
- A LaTeX package named
-\family typewriter
-nomencl
-\family default
- provides an easy way of compiling such lists.
-
-\family typewriter
-nomencl
-\family default
- is included in most standard Linux distributions.
- If your distribution doesn't contain it, you should download it from a
- CTAN mirror and install the package in order to use this feature of LyX.
-\end_layout
-
-\begin_layout Standard
-A glossary entry is created if you place the cursor after a symbol entry
- and then use the menu
-\family sans
-Insert\SpecialChar \menuseparator
-Glossary\InsetSpace ~
-Entry
-\family default
-.
- A gray box labeled
+,
\begin_inset Quotes eld
\end_inset
-
-\family sans
-Not
-\family default
-
+input
\begin_inset Quotes erd
\end_inset
- is inserted and a window pops up asking for the glossary entry.
- A glossary entry consists of two main entries.
- The first is the symbol that you want to refer to.
- You should enter a valid LaTeX code for the corresponding field in the
- glossary dialog.
- The second is the description of the symbol.
- You should fill the corresponding field to complete the glossary entry.
-\end_layout
-
-\begin_layout Subsection
-Sort Order of Glossary Entries
-\end_layout
-
-\begin_layout Standard
-Suppose you have two glossary entries for the symbols
-\begin_inset Formula $a$
+, and
+\begin_inset Quotes eld
\end_inset
- and
-\begin_inset Formula $\sigma$
+verbatim
+\begin_inset Quotes erd
\end_inset
.
- The
-\family typewriter
-nomencl
-\family default
- package automatically sorts these two entries considering the symbol entry,
- while printing the Glossary.
- However, this can lead to an undesired sort order.
- For the example given, the first entry appears as
-\family typewriter
-$a$
-\family default
-, while the second is
-\family typewriter
-$
-\backslash
-sigma$
-\family default
-.
- Note that, in this case
-\begin_inset Formula $\sigma$
+ The difference between
+\begin_inset Quotes eld
\end_inset
- is located in front of the
-\begin_inset Formula $a$
+include
+\begin_inset Quotes erd
\end_inset
-, since the character
+ and
\begin_inset Quotes eld
\end_inset
+input
+\begin_inset Quotes erd
+\end_inset
-\backslash
+ is really only meaningful to LaTeXperts, but the practical difference is
+ that files which are
+\begin_inset Quotes eld
+\end_inset
+included
\begin_inset Quotes erd
\end_inset
- is considered in sorting.
- In order to control the sort order, you can edit the
-\family sans
-Sort\InsetSpace ~
-as
-\family default
- field of the glossary dialog.
- For the given example, you can edit this field as
-\family typewriter
-a
-\family default
- and
-\family typewriter
-sigma
-\family default
- correspondingly.
- Then, these entries will be effective in the sort ordering and
-\begin_inset Formula $a$
+ are typeset beginning on a new page, while files which are
+\begin_inset Quotes eld
\end_inset
- will be located before
-\begin_inset Formula $\sigma$
+inputted
+\begin_inset Quotes erd
\end_inset
-.
+ are typeset starting on the current page.
+ Perhaps the labeling in LyX will be changed someday to reflect this.
\end_layout
\begin_layout Standard
-This feature provides exciting ways of ordering the entries.
- For subgrouping and tips for using sort entries see the official nomencl
- documentation.
-\end_layout
+Generally, the master file is converted into a full LaTeX file before typesettin
+g, while the included files are converted to LaTeX files which do not have
+ all the preamble information.
+ Checking the
+\family sans
+Don't
+\family default
+\InsetSpace ~
-\begin_layout Subsection
-Referencing
+\family sans
+typeset
+\family default
+ button prevents this conversion.
\end_layout
\begin_layout Standard
-You can turn on referencing to the equations and pages in the glossary entries.
- For this purpose, you should add referencing options commands at the end
- of description field.
- There are six referencing options in nomencl package:
-\end_layout
-
-\begin_layout Paragraph*
-
-\backslash
-refeq:
+A
+\begin_inset Quotes eld
+\end_inset
+
+verbatim
+\begin_inset Quotes erd
+\end_inset
+
+ included file allows you to include a file typeset exactly as it appears
+ in the file, i.e.\InsetSpace ~
+verbatim mode, with the characters set in a fixed-width
+ typewriter font.
+ Normally, spaces in this file are invisible, though two consecutive spaces
+ are conserved, unlike LyX's normal treatment of spaces.
+ However, setting the
+\family sans
+\bar under
+M
+\bar default
+ark\InsetSpace ~
+spaces\InsetSpace ~
+in\InsetSpace ~
+output
+\family default
+ checkbox typesets a mark to unambiguously define the presence of a space.
+
+\end_layout
+
+\begin_layout Subsection
+Cross-References Between Files
\end_layout
\begin_layout Standard
-Adds reference to the equation by adding the phrase
+It is possible to set up cross-references between the different files.
+ First, open all the files in question: let's call them A and B in a two
+ file example, where B is included in A.
+ Let's say you insert a label in A, then want to reference it in B.
+ Open the cross-reference dialog in whilst in document B, and you can select
+ the
\begin_inset Quotes eld
\end_inset
-, see equation (#)
+buffer
\begin_inset Quotes erd
\end_inset
+ to use.
+\end_layout
+\begin_layout Section
+Fancy Headers and Footers
\end_layout
-\begin_layout Paragraph*
+\begin_layout Standard
+The default page layout is rather plain; for an article document class,
+ all you get is a centered page number at the bottom of the page.
+ This document is the book class, so it appears to be a bit fancier, but
+ to really put on a show, you need to set the document page style to
+\begin_inset Quotes eld
+\end_inset
+
+fancy
+\begin_inset Quotes erd
+\end_inset
-\backslash
-refpage:
+, as mentioned in the
+\family sans
+User\InsetSpace ~
+Guide
+\family default
+.
+ This section describes the LaTeX codes you need to insert in your LaTeX
+ preamble or the text in order to get the desired effects.
\end_layout
\begin_layout Standard
-Adds reference to the page by adding the phrase
+The page header is divided into three fields, not surprisingly labeled
+\begin_inset Quotes eld
+\end_inset
+
+left
+\begin_inset Quotes erd
+\end_inset
+
+,
\begin_inset Quotes eld
\end_inset
-, page (#)
+center
\begin_inset Quotes erd
\end_inset
+, and
+\begin_inset Quotes eld
+\end_inset
-\end_layout
+right
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The footer is also divided into these three fields.
+ The LaTeX commands to set these fields in the simplest manner are
+\family typewriter
-\begin_layout Paragraph*
+\backslash
+lhead
+\family default
+,
+\family typewriter
\backslash
-refeqpage:
-\end_layout
+chead
+\family default
+,
+\family typewriter
-\begin_layout Standard
-Is the short notation of
\backslash
-refeq
+rhead
+\family default
+,
+\family typewriter
+
\backslash
-refpage.
+lfoot
+\family default
+, etc.
+ Suppose you wish to put your name in the upper left hand corner of each
+ page.
+ Simply insert the following command in the preamble:
\end_layout
-\begin_layout Paragraph*
+\begin_layout Standard
+
+\family typewriter
\backslash
-norefeq,
-\backslash
-norefpag,
-\backslash
-norefeqpage:
+lhead{John Q.
+ DocWriter}
\end_layout
\begin_layout Standard
-Turns off corresponding referencing options if they are turned on globally
- (see reference documentation of nomencl).
+You will now see your name in the upper left.
+ If a field has a default entry that you would like to get rid of (often
+ the page number appears in the central footer, simply include a command
+ with a blank argument, e.\InsetSpace \thinspace{}
+g.
\end_layout
-\begin_layout Subsection
-Printing Glossary
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+cfoot{}
\end_layout
\begin_layout Standard
-You can insert the glossary with the menu
-\family sans
-Insert\SpecialChar \menuseparator
-Lists\InsetSpace ~
-&TOC\SpecialChar \menuseparator
-Glossary
-\family default
-.
- A light blue box labeled
+Let's get really fancy: lets put the section number with the word
\begin_inset Quotes eld
\end_inset
-
-\family sans
-Glossary
-\family default
-
+Section
\begin_inset Quotes erd
\end_inset
- will show the place where the index is printed in the output.
- The index list box is not clickable like other LyX-boxes.
- In the printed output the title of the glossary appears as
-\series bold
-Nomenclature
-\series default
-
-\begin_inset Foot
-status collapsed
+ (e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+Page 4) in the upper
+ right, your name in the lower left, and the date in the lower right.
+ The following commands should now appear in the preamble:
+\end_layout
\begin_layout Standard
-This is translated to the document language for a small number of languages,
- amongst others French and German
+
+\family typewriter
+
+\backslash
+lhead{Section
+\backslash
+thesection}
\end_layout
-\end_inset
+\begin_layout Standard
-.
- If you are not happy with the title, you can change it by re-defining the
- command
\family typewriter
\backslash
-nomname
-\family default
- in the preamble.
- For example, in order to change the title
-\emph on
-List of Symbols
-\emph default
- for the
-\emph on
-Glossary
-\emph default
- add the following line to the preamble.
+chead{}
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+
+\family typewriter
\backslash
-renewcommand{
+rhead{Page
\backslash
-nomname}{List of Symbols}
+thepage}
\end_layout
\begin_layout Standard
- If you're unhappy with the amount of space for symbols, you can alter it
- by adding following line to the preamble.
-\end_layout
-\begin_layout LyX-Code
+\family typewriter
\backslash
-renewcommand{
-\backslash
-nomlabelwidth}{3.0cm}
+lfoot{John Q.
+ DocWriter}
\end_layout
-\begin_layout Section
-Multipart Documents
-\end_layout
+\begin_layout Standard
-\begin_layout Subsection
-General Operation
+\family typewriter
+
+\backslash
+cfoot{}
\end_layout
\begin_layout Standard
-When you are working on a large file with many sections, it is often convenient
- to break up the document into several files, or perhaps you have something
- where a table may change from time to time, but the preceding text does
- not.
- In these cases, you should seriously consider using multipart documents.
- For example, scientific papers often have five major sections: the introduction
-, observations, results, discussion, and conclusion.
- Each of these could be its own separate LyX file, with one
-\begin_inset Quotes eld
-\end_inset
-master
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
- file which contains the title, authors, abstract, references, etc., plus
- the five included files.
- It is important to note that each of these files is a full LyX file which
- can be formatted and printed on its own, as well as included in a master
- file.
- Each of these files must have the same document class, however--- don't
- attempt to mix book classes with article classes.
- You may also include LaTeX files; however, these files must not have their
- own preamble
-\emph on
-(i.e.
+\backslash
+rfoot{
+\backslash
+today}
+\end_layout
-\emph default
- everything up to and including the
+\begin_layout Standard
+The codes
\family typewriter
\backslash
-begin{document}
+thesection
\family default
- line as well as the
+ and
\family typewriter
\backslash
-end{document}
+thepage
\family default
- line must be deleted) or else errors will be generated when you try to
- make a DVI file.
+ access LaTeX's section and page counters, and so print out the current
+ section and page numbers.
+
+\family typewriter
+
+\backslash
+today
+\family default
+ simply prints out today's date.
\end_layout
\begin_layout Standard
-LyX allows you to include files quite easily with
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-ChiI
-\bar under
-d
-\bar default
-\InsetSpace ~
-Document
-\family default
-.
- When you click on this selection a small box is inserted into the file
- at the current cursor location.
- Clicking on the box raises a dialog which allows you to select the file
- to be included, and the method of its inclusion.
+The thicknesses of the horizontal rules drawn beneath the header and above
+ the footer can also be modified.
+ If you don't want one of the headers, set its thickness to 0.
+ The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
+ Use the commands, e.\InsetSpace \thinspace{}
+g.
+\family typewriter
+
+\backslash
+renewcommand{
+\backslash
+headrulewidth}{0.4pt}
+\family default
+ and
+\family typewriter
+
+\backslash
+renewcommand{
+\backslash
+footrulewidth}{0.4pt}
+\family default
+ to set the thicknesses.
\end_layout
\begin_layout Standard
-The file selection box should by now be obvious.
- The three inclusion methods are
-\begin_inset Quotes eld
-\end_inset
-
-include
-\begin_inset Quotes erd
-\end_inset
+You can switch the header/footer settings on and off for individual pages
+ using commands like
+\family typewriter
+\backslash
+thispagestyle{empty}
+\family default
,
-\begin_inset Quotes eld
-\end_inset
-
-input
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
+\backslash
+thispagestyle{plain}
+\family default
, and
-\begin_inset Quotes eld
-\end_inset
-
-verbatim
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
+\backslash
+thispagestyle{fancy}
+\family default
.
- The difference between
-\begin_inset Quotes eld
-\end_inset
-
-include
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-input
-\begin_inset Quotes erd
-\end_inset
+ Simply insert them in the text on the page you want changed and mark them
+ as TeX code.
+ In fact, title pages are marked as plain by default, while following pages
+ are marked fancy when using the global fancy setting.
+\end_layout
- is really only meaningful to LaTeXperts, but the practical difference is
- that files which are
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+There are more complex commands which will let you insert things in the
+ upper left on odd numbered pages, etc., but I will refer you to the
+\family typewriter
+fancyhdr
+\family default
+ package documentation for more descriptions.
+ For example, if you have a teTeX installation, look for
+\family typewriter
+/usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
+fancyhdr.dvi
+\family default
+.
+\end_layout
-included
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+As a final example, it is possible to include an Encapsulated PostScript
+ file in the header or footer.
+ Suppose you want to put a company logo in the upper lefthand corner.
+ You might try something like
+\end_layout
- are typeset beginning on a new page, while files which are
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
-inputted
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
- are typeset starting on the current page.
- Perhaps the labeling in LyX will be changed someday to reflect this.
+\backslash
+lhead{
+\backslash
+resizebox{1in}{!}{
+\backslash
+includegraphics{logo.eps}}}
\end_layout
\begin_layout Standard
-Generally, the master file is converted into a full LaTeX file before typesettin
-g, while the included files are converted to LaTeX files which do not have
- all the preamble information.
- Checking the
-\family sans
-Don't
-\family default
-\InsetSpace ~
+\noindent
+(you may need to preface this with
+\family typewriter
-\family sans
-typeset
+\backslash
+usepackage{graphics}
\family default
- button prevents this conversion.
+ if you don't include EPS files elsewhere in your document).
\end_layout
-\begin_layout Standard
-A
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Section
+Itemize Bullet Selection
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:bullet"
-verbatim
-\begin_inset Quotes erd
\end_inset
- included file allows you to include a file typeset exactly as it appears
- in the file, i.e.\InsetSpace ~
-verbatim mode, with the characters set in a fixed-width
- typewriter font.
- Normally, spaces in this file are invisible, though two consecutive spaces
- are conserved, unlike LyX's normal treatment of spaces.
- However, setting the
-\family sans
-\bar under
-M
-\bar default
-ark\InsetSpace ~
-spaces\InsetSpace ~
-in\InsetSpace ~
-output
-\family default
- checkbox typesets a mark to unambiguously define the presence of a space.
-
+
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+ Allan Rae
\end_layout
\begin_layout Subsection
-Cross-References Between Files
+Introduction
\end_layout
\begin_layout Standard
-It is possible to set up cross-references between the different files.
- First, open all the files in question: let's call them A and B in a two
- file example, where B is included in A.
- Let's say you insert a label in A, then want to reference it in B.
- Open the cross-reference dialog in whilst in document B, and you can select
- the
-\begin_inset Quotes eld
-\end_inset
+LyX provides 216 bullet shapes that can be accessed from a simple dialog.
+ Using this dialog you can easily specify what bullet shape to use at each
+ level of an itemized list.
+ These settings are document-wide so you won't be able to specify different
+ sets of bullets for different paragraphs
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+Well, actually you can but you'll have to do it by hand.
+\end_layout
-buffer
-\begin_inset Quotes erd
\end_inset
- to use.
+.
\end_layout
-\begin_layout Section
-Fancy Headers and Footers
+\begin_layout Subsection
+How it looks
\end_layout
\begin_layout Standard
-The default page layout is rather plain; for an article document class,
- all you get is a centered page number at the bottom of the page.
- This document is the book class, so it appears to be a bit fancier, but
- to really put on a show, you need to set the document page style to
-\begin_inset Quotes eld
-\end_inset
-
-fancy
-\begin_inset Quotes erd
-\end_inset
+Open the dialog by selecting the
+\family sans
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
-, as mentioned in the
+\bar under
+S
+\bar default
+ettings
+\family default
+ menu item and then select the
\family sans
-User\InsetSpace ~
-Guide
+\bar under
+B
+\bar default
+ullets
\family default
-.
- This section describes the LaTeX codes you need to insert in your LaTeX
- preamble or the text in order to get the desired effects.
+ tab.
\end_layout
\begin_layout Standard
-The page header is divided into three fields, not surprisingly labeled
-\begin_inset Quotes eld
-\end_inset
+The dialog provides you with a table of bullet shapes.
+ A column of buttons on the left of the table provides access to the six
+ different panels of bullet shapes.
+ The row of buttons across the top is used to select which bullet depth
+ you are changing.
+ A text entry under the table shows the currently selected bullet shape's
+ LaTeX equivalent and this can be edited if desired.
+ If you do modify the text you will also need to specify any needed packages
+ in the LaTeX preamble.
+\end_layout
-left
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+The six panels are divided up by the packages they require.
+ The following table shows the mappings from button name to LaTeX packages.
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="7" columns="2">
+<features>
+<column alignment="center" valignment="top" leftline="true" width="0pt">
+<column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-center
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
-, and
-\begin_inset Quotes eld
-\end_inset
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Button
+\end_layout
-right
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-.
- The footer is also divided into these three fields.
- The LaTeX commands to set these fields in the simplest manner are
-\family typewriter
+\begin_layout Standard
-\backslash
-lhead
-\family default
-,
-\family typewriter
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Packages Required
+\end_layout
-\backslash
-chead
-\family default
-,
-\family typewriter
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-rhead
-\family default
-,
-\family typewriter
+\begin_layout Standard
-\backslash
-lfoot
-\family default
-, etc.
- Suppose you wish to put your name in the upper left hand corner of each
- page.
- Simply insert the following command in the preamble:
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Standard
\end_layout
-\begin_layout Standard
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-\family typewriter
+\begin_layout Standard
-\backslash
-lhead{John Q.
- DocWriter}
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+base LaTeX
\end_layout
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
\begin_layout Standard
-You will now see your name in the upper left.
- If a field has a default entry that you would like to get rid of (often
- the page number appears in the central footer, simply include a command
- with a blank argument, e.\InsetSpace \thinspace{}
-g.
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Maths
\end_layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
\begin_layout Standard
\family typewriter
-
-\backslash
-cfoot{}
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+amssymb.sty
\end_layout
-\begin_layout Standard
-Let's get really fancy: lets put the section number with the word
-\begin_inset Quotes eld
\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-Section
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
- (e.\InsetSpace \thinspace{}
-g.\InsetSpace ~
-Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
-g.\InsetSpace ~
-Page 4) in the upper
- right, your name in the lower left, and the date in the lower right.
- The following commands should now appear in the preamble:
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Ding1
\end_layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
\begin_layout Standard
\family typewriter
-
-\backslash
-lhead{Section
-\backslash
-thesection}
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
\end_layout
-\begin_layout Standard
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\family typewriter
+\begin_layout Standard
-\backslash
-chead{}
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Ding2
\end_layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
\begin_layout Standard
\family typewriter
-
-\backslash
-rhead{Page
-\backslash
-thepage}
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
\end_layout
-\begin_layout Standard
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\family typewriter
+\begin_layout Standard
-\backslash
-lfoot{John Q.
- DocWriter}
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Ding3
\end_layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
\begin_layout Standard
\family typewriter
-
-\backslash
-cfoot{}
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Ding4
\end_layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
\begin_layout Standard
\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+LyX doesn't stop you using bullets from packages you don't have.
+ If you get errors from LaTeX when you try to view or print the file then
+ its likely you are missing a package.
+ LyX doesn't restrict your use since you may be editing locally and exporting
+ elsewhere.
+\end_layout
+
+\begin_layout Subsection
+How to use it
+\end_layout
+
+\begin_layout Standard
+Select which bullet depth you want to change then select the bullet shape
+ and size.
+ Any changes will not be visible in LyX, but are visible when viewing the
+ document using xdvi or ghostview.
+\end_layout
+
+\begin_layout Standard
+You can reset a bullet shape to the default simply by clicking your right
+ mouse button on the appropriate bullet depth button.
+\end_layout
+
+\begin_layout Standard
+If you
+\emph on
+really
+\emph default
+ want to have multiple sets of paragraphs with different sets of bullets
+ in each then you're going to have to get your hands dirty.
+ The itemize bullet selection dialog can help though because it provides
+ you with the LaTeX code for a wide range of bullet shapes.
+ To make your own custom paragraphs you have the following options:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Standard
+
\backslash
-rfoot{
+let
\backslash
-today}
+savelabelitemi=
+\backslash
+labelitemi
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
-The codes
-\family typewriter
+\begin_inset ERT
+status open
+
+\begin_layout Standard
+
\backslash
-thesection
-\family default
- and
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+small
+\backslash
+(
+\backslash
+sharp
+\backslash
+)}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Itemize
+Use the LaTeX command
\family typewriter
\backslash
-thepage
+renewcommand{}{}
\family default
- access LaTeX's section and page counters, and so print out the current
- section and page numbers.
-
+ to specify a new bullet shape for a given depth.
+ You'll also need to save the current bullet shape so you can restore it
+ again afterwards.
+ In this itemized list the following LaTeX code was used to change the bullet
+ used for the first depth.
+\newline
+
\family typewriter
\backslash
-today
+let
+\backslash
+savelabelitemi=
+\backslash
+labelitemi
\family default
- simply prints out today's date.
-\end_layout
-
-\begin_layout Standard
-The thicknesses of the horizontal rules drawn beneath the header and above
- the footer can also be modified.
- If you don't want one of the headers, set its thickness to 0.
- The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
- Use the commands, e.\InsetSpace \thinspace{}
-g.
\family typewriter
+\newline
+
\backslash
-renewcommand{
+renewcommand
\backslash
-headrulewidth}{0.4pt}
+labelitemi[0]{
+\backslash
+small
+\backslash
+(
+\backslash
+sharp
+\backslash
+)}
+\newline
+
\family default
- and
+Note that the itemize depth is specified in Roman numerals as part of the
+
\family typewriter
\backslash
-renewcommand{
-\backslash
-footrulewidth}{0.4pt}
+labelitem
\family default
- to set the thicknesses.
+ command.
\end_layout
+\begin_layout Itemize
+\begin_inset ERT
+status open
+
\begin_layout Standard
-You can switch the header/footer settings on and off for individual pages
- using commands like
-\family typewriter
+[
\backslash
-thispagestyle{empty}
-\family default
-,
-\family typewriter
-
+(
\backslash
-thispagestyle{plain}
-\family default
-, and
-\family typewriter
-
+star
\backslash
-thispagestyle{fancy}
-\family default
-.
- Simply insert them in the text on the page you want changed and mark them
- as TeX code.
- In fact, title pages are marked as plain by default, while following pages
- are marked fancy when using the global fancy setting.
+)]
\end_layout
-\begin_layout Standard
-There are more complex commands which will let you insert things in the
- upper left on odd numbered pages, etc., but I will refer you to the
-\family typewriter
-fancyhdr
-\family default
- package documentation for more descriptions.
- For example, if you have a teTeX installation, look for
+\end_inset
+
+ Specify each individual entry by starting each item with the bullet shape
+ enclosed in square brackets and set as TeX.
+ For example, this item was started with
\family typewriter
-/usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
-fancyhdr.dvi
+[
+\backslash
+(
+\backslash
+star
+\backslash
+)]
\family default
.
\end_layout
\begin_layout Standard
-As a final example, it is possible to include an Encapsulated PostScript
- file in the header or footer.
- Suppose you want to put a company logo in the upper lefthand corner.
- You might try something like
-\end_layout
+\begin_inset ERT
+status open
\begin_layout Standard
-\family typewriter
\backslash
-lhead{
+renewcommand
\backslash
-resizebox{1in}{!}{
+labelitemi[0]{
\backslash
-includegraphics{logo.eps}}}
+savelabelitemi}
\end_layout
-\begin_layout Standard
-\noindent
-(you may need to preface this with
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+You'll also need to revert the labelitem back to its previous setting for
+ the global bullet shape settings to remain in effect.
+ The way used here was:
+\newline
+
\family typewriter
\backslash
-usepackage{graphics}
-\family default
- if you don't include EPS files elsewhere in your document).
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+savelabelitemi}
+\end_layout
+
+\begin_layout Chapter
+Special Document Classes
\end_layout
\begin_layout Section
-Itemize Bullet Selection
-\begin_inset LatexCommand label
-name "sec:bullet"
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:AMS-LaTeX"
\end_inset
-
+AMS LaTeX
\end_layout
\begin_layout Standard
-by
+by
\noun on
- Allan Rae
+David Johnson; updated by Richard Heck
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
-LyX provides 216 bullet shapes that can be accessed from a simple dialog.
- Using this dialog you can easily specify what bullet shape to use at each
- level of an itemized list.
- These settings are document-wide so you won't be able to specify different
- sets of bullets for different paragraphs
-\begin_inset Foot
-status collapsed
+\noindent
+The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
+ papers to be submitted to American Mathematical Society publications.
+ The layouts are not tailored to a specific journal, but easily can be.
+ You should refer to the AMS documentation for specific instructions for
+ each journal (usually it will entail only changing a single line in the
+ TeX output).
+ That documentation is available on the Web at
+\begin_inset Flex URL
+status open
\begin_layout Standard
-Well, actually you can but you'll have to do it by hand.
+
+http://www.ams.org
\end_layout
\end_inset
-.
-\end_layout
+ or by ftp at
+\begin_inset Flex URL
+status open
-\begin_layout Subsection
-How it looks
+\begin_layout Standard
+
+ftp://ftp.ams.org/pub/tex/amslatex/
\end_layout
-\begin_layout Standard
-Open the dialog by selecting the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+\end_inset
-\bar under
-S
-\bar default
-ettings
-\family default
- menu item and then select the
-\family sans
-\bar under
-B
-\bar default
-ullets
-\family default
- tab.
+.
+ These layouts are appropriate, and useful, for any mathematical writing.
+
\end_layout
\begin_layout Standard
-The dialog provides you with a table of bullet shapes.
- A column of buttons on the left of the table provides access to the six
- different panels of bullet shapes.
- The row of buttons across the top is used to select which bullet depth
- you are changing.
- A text entry under the table shows the currently selected bullet shape's
- LaTeX equivalent and this can be edited if desired.
- If you do modify the text you will also need to specify any needed packages
- in the LaTeX preamble.
+There are two basic AMS LaTeX layouts:
\end_layout
-\begin_layout Standard
-The six panels are divided up by the packages they require.
- The following table shows the mappings from button name to LaTeX packages.
+\begin_layout Enumerate
+amsart: The standard AMS article format.
\end_layout
-\begin_layout Standard
-\align center
-\begin_inset Tabular
-<lyxtabular version="3" rows="7" columns="2">
-<features>
-<column alignment="center" valignment="top" leftline="true" width="0pt">
-<column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
-<row topline="true" bottomline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Enumerate
+amsbook: the standard AMS book (really, monograph) format.
+
+\end_layout
\begin_layout Standard
+These layouts themselves contain only the minimum necessary to use the AMS
+ classes.
+ They do not, in particular, contain any of the `theorem' environments used
+ for setting theorems, lemmas, and the like.
+ These are contained, instead, in the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Button
+\begin_layout Standard
+Theorems (AMS)
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+ module, which you will need to load separately when you selected one of
+ the AMS classes.
+ Less commonly used environments are in the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Packages Required
+\begin_layout Standard
+Theorems (AMS-Extended)
\end_layout
\end_inset
-</cell>
-</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+
+ module.
+
+\end_layout
\begin_layout Standard
+By default, theorems and the like are numbered consecutively throughout
+ the document, but this may be modified by loading the module
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Standard
+\begin_layout Standard
+Theorems (Order by Section)
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+ or, if you are using
+\begin_inset Flex CharStyle:Code
+status collapsed
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-base LaTeX
+\begin_layout Standard
+book (AMS)
\end_layout
\end_inset
-</cell>
-</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+, the module
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Maths
+\begin_layout Standard
+Theorems (Order by Chapter)
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+.
+ These will number the results as
+\begin_inset Formula $n.m$
+\end_inset
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-amssymb.sty
+, where the first number refers to the section (or chapter) and the second
+ refers to the total number of results so far in that section (or chapter).
+ Many environments are also available unnumbered.
+ These are indicated by an asterisk at the end.
+ If you happen to want
+\emph on
+only
+\emph default
+ unnumbered results, the the module
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Standard
+Theorems (Starred)
\end_layout
\end_inset
-</cell>
-</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+
+ provides that option.
+\end_layout
\begin_layout Standard
+Note that these modules do not
+\emph on
+have
+\emph default
+ to be used with the AMS classes.
+ It is perfectly possible to use the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding1
+\begin_layout Standard
+Theorems (AMS)
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+ module, and the others mentioned, with other classes, such as
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+\begin_layout Standard
+article
\end_layout
\end_inset
-</cell>
-</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
\begin_layout Standard
+report
+\end_layout
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding2
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Standard
+book (KOMA-script)
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+, and so forth.
+\end_layout
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+\begin_layout Subsection
+What these layouts provide
\end_layout
-\end_inset
-</cell>
-</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
+There is a long list of included environments provided by these layouts.
+ In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
+ variety of `theorem' environments.
+ However, the AMS recommends the environments that are available in LyX.
+
+\end_layout
\begin_layout Standard
+The following environments---as well as the standard environments, such
+ as
+\begin_inset Flex CharStyle:Noun
+status collapsed
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding3
+\begin_layout Standard
+section
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+,
+\begin_inset Flex CharStyle:Noun
+status collapsed
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+\begin_layout Standard
+bibliography
\end_layout
\end_inset
-</cell>
-</row>
-<row topline="true" bottomline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+
+,
+\begin_inset Flex CharStyle:Noun
+status collapsed
\begin_layout Standard
+title
+\end_layout
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding4
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Standard
+author
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+
+, and
+\begin_inset Flex CharStyle:Noun
+status collapsed
\begin_layout Standard
+date
+\end_layout
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+\end_inset
+
+---are provided by
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Standard
+article (AMS)
\end_layout
\end_inset
-</cell>
-</row>
-</lyxtabular>
+
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Standard
+book (AMS)
+\end_layout
\end_inset
+:
+\end_layout
+\begin_layout Description
+Address This should be the author's permanent address.
\end_layout
-\begin_layout Standard
-LyX doesn't stop you using bullets from packages you don't have.
- If you get errors from LaTeX when you try to view or print the file then
- its likely you are missing a package.
- LyX doesn't restrict your use since you may be editing locally and exporting
- elsewhere.
+\begin_layout Description
+Current\InsetSpace ~
+Address This should be the author's temporary address at the time
+ of submission, if different from the Address.
\end_layout
-\begin_layout Subsection
-How to use it
+\begin_layout Description
+Email Author's e-mail address
\end_layout
-\begin_layout Standard
-Select which bullet depth you want to change then select the bullet shape
- and size.
- Any changes will not be visible in LyX, but are visible when viewing the
- document using xdvi or ghostview.
+\begin_layout Description
+URL Author's Web address, if desired.
\end_layout
-\begin_layout Standard
-You can reset a bullet shape to the default simply by clicking your right
- mouse button on the appropriate bullet depth button.
+\begin_layout Description
+Keywords Key words or phrases used to identify specific topics discussed
+ in the paper.
\end_layout
-\begin_layout Standard
-If you
+\begin_layout Description
+Subjectclass These refer to the AMS Subject Classifications, published and
+ described in
\emph on
-really
+Mathematical Reviews
\emph default
- want to have multiple sets of paragraphs with different sets of bullets
- in each then you're going to have to get your hands dirty.
- The itemize bullet selection dialog can help though because it provides
- you with the LaTeX code for a wide range of bullet shapes.
- To make your own custom paragraphs you have the following options:
+.
+ These are also available online at the AMS cites listed above.
+\end_layout
+
+\begin_layout Description
+Thanks
+\end_layout
+
+\begin_layout Description
+Dedicatory
+\end_layout
+
+\begin_layout Description
+Translator
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
+The following environments are provided by both the
+\begin_inset Flex CharStyle:Code
+status collapsed
\begin_layout Standard
+Theorems
+\end_layout
+\end_inset
-\backslash
-let
-\backslash
-savelabelitemi=
-\backslash
-labelitemi
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Standard
+Theorems (AMS)
\end_layout
\end_inset
+ modules, in the latter case in both starred (unnumbered) and unstarred
+ (numbered) versions.
+ These same environments are provided only in the starred versions by the
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Standard
+Theorems (Starred)
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\end_inset
-\begin_layout Standard
+ module:
+\end_layout
+\begin_layout Theorem
+This is typically used for the statements of major results.
+
+\end_layout
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-small
-\backslash
-(
-\backslash
-sharp
-\backslash
-)}
+\begin_layout Corollary*
+This is used for statements which follow fairly directly from previous statement
+s.
+ Again, these can be major results.
+
\end_layout
-\end_inset
+\begin_layout Lemma
+These are smaller results needed to prove other statements.
+\end_layout
+\begin_layout Proposition
+These are less major results which (hopefully) add to the general theory
+ being discussed.
+\end_layout
+\begin_layout Conjecture
+These are statements provided without justification, which the author does
+ not know how to prove, but which seem to be true (to the author, at least).
\end_layout
-\begin_layout Itemize
-Use the LaTeX command
-\family typewriter
+\begin_layout Definition*
+Guess what this is for.
+ The font is different for this environment than for the previous ones.
+
+\end_layout
-\backslash
-renewcommand{}{}
-\family default
- to specify a new bullet shape for a given depth.
- You'll also need to save the current bullet shape so you can restore it
- again afterwards.
- In this itemized list the following LaTeX code was used to change the bullet
- used for the first depth.
-\newline
+\begin_layout Example*
+Used for examples illustrating proven results.
+\end_layout
-\family typewriter
+\begin_layout Problem
+It's not really known what this is for.
+ You should figure it out.
+\end_layout
-\backslash
-let
-\backslash
-savelabelitemi=
-\backslash
-labelitemi
-\family default
-
-\family typewriter
+\begin_layout Exercise*
+Write a description for this one.
+\end_layout
-\newline
+\begin_layout Remark
+This environment is also a type of theorem, usually a lesser sort of observation.
+\end_layout
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-small
-\backslash
-(
-\backslash
-sharp
-\backslash
-)}
-\newline
+\begin_layout Claim*
+Often used in the course of giving a proof of a larger result.
+\end_layout
-\family default
-Note that the itemize depth is specified in Roman numerals as part of the
+\begin_layout Case
+Generally, these are used to break up long arguments, using specific instances
+ of some condition.
-\family typewriter
+\end_layout
-\backslash
-labelitem
-\family default
- command.
+\begin_layout Case
+The numbering scheme for cases is on its own, not together with other numbered
+ statements.
+
\end_layout
-\begin_layout Itemize
-\begin_inset ERT
-status inlined
+\begin_layout Proof
+At the end of this environment , a QED symbol (usually a square, but it
+ can vary with different styles) is placed.
+ If you want to have other environments within this one---for example, Case
+ environments---and have the QED symbol appear only after them, then the
+ other environments need to be nested within the proof environment.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Nesting"
+
+\end_inset
+
+ of the
+\emph on
+User's Guide
+\emph default
+ for information on nesting.
+\end_layout
\begin_layout Standard
+And these are provided by
+\begin_inset Flex CharStyle:Code
+status collapsed
-[
-\backslash
-(
-\backslash
-star
-\backslash
-)]
+\begin_layout Standard
+Theorems (AMS-Extended)
\end_layout
\end_inset
- Specify each individual entry by starting each item with the bullet shape
- enclosed in square brackets and set as TeX.
- For example, this item was started with
-\family typewriter
-[
-\backslash
-(
-\backslash
-star
-\backslash
-)]
-\family default
-.
+:
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\begin_layout Criterion*
+A required condition.
+\end_layout
-\begin_layout Standard
+\begin_layout Algorithm*
+A general procedure to be used.
+\end_layout
+
+\begin_layout Axiom*
+This is a property or statement taken as true within the system being discussed.
+\end_layout
+\begin_layout Condition*
+Sometimes used to state a condition assumed within the present context of
+ discussion.
+\end_layout
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-savelabelitemi}
+\begin_layout Note*
+Similar to a Remark.
\end_layout
-\end_inset
+\begin_layout Notation*
+Used for the explanation of, yes, notation.
+\end_layout
+
+\begin_layout Summary
+Do we really need to tell you?
+\end_layout
+\begin_layout Acknowledgement*
+Acknowledgement.
+\end_layout
+
+\begin_layout Conclusion*
+Sometimes used at the end of a long train of argument.
+\end_layout
+\begin_layout Fact
+Used in a way similar to Proposition, though perhaps lower on the scale.
\end_layout
\begin_layout Standard
-You'll also need to revert the labelitem back to its previous setting for
- the global bullet shape settings to remain in effect.
- The way used here was:
-\newline
+In addition, the AMS classes automatically provide the AMS LaTeX and AMS
+ fonts packages.
+ They need to be available on your system in order to use these environments.
+\end_layout
+
+\begin_layout Section
+Dinbrief
+\end_layout
+\begin_layout Standard
+The document class
+\family sans
+dinbrief
+\family default
+ can be used to type letters according to German conventions.
+ A template file is included in
\family typewriter
+.../lyx/share/templates
+\family default
+ for you to use as a starting point.
+\end_layout
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-savelabelitemi}
+\begin_layout Section
+Paper
\end_layout
-\begin_layout Chapter
-Special Document Classes
+\begin_layout Standard
+The document class
+\family sans
+paper
+\family default
+ provides an alternative to the standard
+\family sans
+article
+\family default
+ class.
+ It provides similar functionality, but you might prefer this layout with
+ sans serif sections, headings, and more.
\end_layout
\begin_layout Section
-AMS LaTeX
+A&A Paper
\end_layout
\begin_layout Standard
by
\noun on
-David Johnson
+Peter Sütterlin
+\end_layout
+
+\begin_layout Subsection
+Introduction
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
+This section describes how LyX can be used to write articles for submission
+ to the scientific journal
+\emph on
+Astronomy and Astrophysics
+\emph default
+ (www.edpsciences.fr/aa/
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+http://www.edpsciences.fr/aa/
+\end_layout
+
+\end_inset
+
+) using Version 5.01 of the document class
+\family typewriter
+aa.cls
+\family default
+.
+ This package can be downloaded from the ftp site
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
\end_inset
\end_layout
\begin_layout Standard
-\noindent
-The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
- papers to be submitted to American Mathematical Society publications.
- The layouts are not tailored to a specific journal, but easily can be.
- You should refer to the AMS documentation for specific instructions for
- each journal (usually it will entail only changing a single line in the
- TeX output).
- That documentation is available on the Web at
-\begin_inset LatexCommand url
-target "http://www.ams.org"
+\align center
+\begin_inset Flex URL
+status collapsed
-\end_inset
+\begin_layout Standard
- or by ftp at
-\begin_inset LatexCommand url
-target "ftp://ftp.ams.org/pub/tex/amslatex/"
+ftp://ftp.edpsciences.org/pub/aa/readme.html
+\end_layout
\end_inset
-.These layouts are appropriate, and useful, for any mathematical writing.
- There are currently 4 distinct AMS LaTeX layouts:
+
\end_layout
-\begin_layout Enumerate
-amsart: The standard AMS-article format.
- All results and similar statements are numbered as
-\begin_inset Formula $(n.m)$
+\begin_layout Standard
+\begin_inset VSpace medskip
\end_inset
-, where the first number refers to the section, and the second refers to
- the total number of results (Theorems, Corollaries, Propositions, Definitions
- and Remarks, etc.) in that section.
- There are also many (but not all) environments available unnumbered, which
- is occasionally needed.
- Unnumbered environments indicated by an asterisk at the end.
-\end_layout
-\begin_layout Enumerate
-amsart-seq: Here, numbering for each type of statement is in its own sequence,
- with no reference to the section number.
- There are also many (but not all) environments available unnumbered, which
- is occasionally needed.
- Unnumbered environments indicated by an asterisk at the end.
\end_layout
-\begin_layout Enumerate
-amsart-plain: This one is even more terse, since all the environments are
- unnumbered.
+\begin_layout Standard
+A manual comes together with that package, and this text is not meant to
+ replace the original manual but merely a short guide how to realize the
+ correct form of your paper.
+
\end_layout
-\begin_layout Enumerate
-amsbook: the standard AMS book (really, monograph) format.
- Numbering is similar to the amsart layout, except that all numbering is
- by
-\begin_inset Formula $(n.m.p)$
-\end_inset
+\begin_layout Standard
+Please note that the publisher of the journal was changed from Springer
+ to EDP Sciences starting January 1, 2001.
+ That change implicated also some slight changes of the style files, namely
+ the removal of the thesaurus command.
+ The LyX class aa supports the newest version of these style files, V 5.01.
+ If you have an older version installed, please upgrade.
+ For compatibility, the old (version 4) layout has been kept as
+\family sans
+article (A&A V4)
+\family default
+.
+ Please refer to the comments in
+\family typewriter
+LyXDir/layouts/aapaper.layout
+\family default
+.
+\end_layout
-, where the first number refers to the chapter, the second to the section,
- and the third is the number of the results (Theorems, Corollaries, Propositions
-, Definitions and Remarks, etc.) in that section.
- There are also many (but not all) environments available unnumbered, which
- is occasionally needed.
- Unnumbered environments indicated by an asterisk at the end.
+\begin_layout Subsection
+Getting started
\end_layout
\begin_layout Standard
-Any AMS LyX file can be converted to either of the numbering schemes by
- simply changing the document class in the
+It is recommended you start from the example template distributed with LyX.
+ If you are not using a template, note the following settings:
+\end_layout
+
+\begin_layout Itemize
+Select
+\family sans
+article (A&A)
+\family default
+ in the
\family sans
\bar under
D
\bar default
ettings
\family default
- dialog.
-
+ dialog (OK, that one was obvious).
+\end_layout
+
+\begin_layout Itemize
+Don't change the option
+\family sans
+Page\InsetSpace ~
+style
+\family default
+: Leave it set to
+\family sans
+default
+\family default
+.
+ The whole layout is done by the macros, you shouldn't change anything.
\end_layout
\begin_layout Subsection
-What these layouts provide
+The header block
\end_layout
\begin_layout Standard
-There is a long list of included environments provided by these layouts.
- Most mathematical papers or books will set as special statements most of
- these environments, in AMS-LaTeX there is an opportunity to define an unlimited
- variety of such declarations.
- However, the AMS recommends the environments that are available in LyX.
- The list of environments (not counting the standard environments such as
-
-\family sans
-sections, bibliography, title, author, date
-\family default
-), is:
+First thing to enter is the header information.
+ It consists of seven entries, of which some are optional.
+ They are
\end_layout
-\begin_layout Description
-Theorem This is typically used for the statements of major results.
- The word
-\begin_inset Quotes eld
-\end_inset
-
+\begin_layout Itemize
\family sans
-Theorem
+Title
\family default
+: [required]
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- appears in bold type, along with an automatically-determined number (an
- unnumbered version,
\family sans
-Theorem*
+Subtitle
\family default
-, is also available).
- The text is italicized.
+: [optional]
\end_layout
-\begin_layout Description
-Corollary This is used for statements which follow fairly directly from
- previous statements.
- Again, these can be major results.
- Unnumbered version
+\begin_layout Itemize
+
\family sans
-Corollary*
+Author
\family default
- is available.
+: [required]
\end_layout
-\begin_layout Description
-Lemma These are smaller results needed to prove other statements.
+\begin_layout Itemize
+
+\family sans
+Address
+\family default
+: [required]
\end_layout
-\begin_layout Description
-Proposition These are less major results which (hopefully) add to the general
- theory being discussed.
+\begin_layout Itemize
+
+\family sans
+Offprints
+\family default
+: [optional] if more than one author: whom to contact for offprint requests.
\end_layout
-\begin_layout Description
-Conjecture These are statements provided without justification, which the
- author does not know how to prove, but which seem to be true (to the author,
- at least).
+\begin_layout Itemize
+
+\family sans
+Mail
+\family default
+: [optional] mail address for contacts.
\end_layout
-\begin_layout Description
-Criterion A required condition.
+\begin_layout Itemize
+
+\family sans
+Date
+\family default
+: [required].
+ Suggested format is
+\family typewriter
+Received: <date>; Accepted <date>
\end_layout
-\begin_layout Description
-Algorithm A general procedure to be used.
+\begin_layout Standard
+There is no need to issue the
+\family typewriter
+
+\backslash
+maketitle
+\family default
+ command, this is done automatically by LyX when the header is finished.
+ Although the order of the single header entries doesn't matter it is advised
+ to keep the above sequence, just to get the best optics and meets the layout
+ of the real document.
\end_layout
-\begin_layout Description
-Axiom This is a property or statement taken as true within the system being
- discussed.
+\begin_layout Standard
+If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
+g.
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+
\end_layout
-\begin_layout Description
-Definition Guess what this is for.
- The font, both on-screen and in the output, is different for this environment
- than for the previous ones.
- The heading (
-\begin_inset Quotes eld
\end_inset
-definition
-\begin_inset Quotes erd
-\end_inset
+to state your present address, just use the standard footnote via
+\family sans
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
-) is still set in boldface, along with the number, if any, but the rest
- is set upright.
-\end_layout
+\bar under
+F
+\bar default
+ootnote.
-\begin_layout Description
-Example Typeset similarly to Definition.
-\end_layout
+\family default
+ LyX will automagically use the term
+\family typewriter
-\begin_layout Description
-Condition
+\backslash
+thanks{}
+\family default
+ in that case.
\end_layout
-\begin_layout Description
-Problem
+\begin_layout Standard
+In addition to these topics, the macros use three additional LaTeX commands
+ that have no counterpart in LyX:
\end_layout
-\begin_layout Description
-Exercise
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Remark This environment is also a new type of theorem.
- This is set with the word Remark in italics, and the rest upright.
-\end_layout
+\family typewriter
-\begin_layout Description
-Note Set similarly to the Remark environment.
+\backslash
+and
+\family default
+ to separate different names for more than one author and institute, respectivel
+y.
\end_layout
-\begin_layout Description
-Notation
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Claim
-\end_layout
+\family typewriter
-\begin_layout Description
-Summary
+\backslash
+inst{<nr>}
+\family default
+to mark corresponding author/institute pairs.
+ The institutes are numbered sequentially as they appear in the
+\family sans
+Address
+\family default
+ field, so you have to put a marker to each author.
\end_layout
-\begin_layout Description
-Acknowledgement
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+email{address}
+\family default
+ to supply an email address for fast contact.
\end_layout
-\begin_layout Description
-Case Generally, these are used to break up long arguments, using specific
- instances of some condition.
- The numbering scheme for cases is on its own, not together with other numbered
- statements.
+\begin_layout Standard
+In all cases, the appropriate command has to be entered in LyX and marked
+ as LaTeX code.
+ See the examples.
\end_layout
-\begin_layout Description
-Conclusion
+\begin_layout Subsection
+The abstract
\end_layout
-\begin_layout Description
-Fact
+\begin_layout Standard
+The abstract should immediately follow the header block.
+ With version 5 the abstract environment was changed to a command, and there
+ is now a resctriction to only one paragraph.
+ In addition, it should contain an entry with the keywords.
+ This is not yet implemented for LyX, therefore you have to enter the LaTeX
+ command
+\family typewriter
+
+\backslash
+keywords{}
+\family default
+ by hand and mark it as LaTeX code.
+ Refer to the example paper.
\end_layout
-\begin_layout Description
-Proof The word
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsection
+Supported environments
+\end_layout
+
+\begin_layout Standard
+The A&A paper layout supports the following environments for structuring
+ your text:
+\end_layout
+\begin_layout Itemize
-\shape italic
-Proof
-\shape default
+\family sans
+Standard
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- is set in italics, but the rest is set upright.
- At the end of this environment (other environments can be nested within
- this one, of course) a QED symbol (usually a square, but it can vary with
- different styles) is placed.
+\family sans
+Section
\end_layout
-\begin_layout Description
-Address This should be the author's permanent address.
+\begin_layout Itemize
+
+\family sans
+Subsection
\end_layout
-\begin_layout Description
-Current\InsetSpace ~
-Address This should be the author's temporary address at the time
- of submission, if different from the Address.
+\begin_layout Itemize
+
+\family sans
+Subsubsection
\end_layout
-\begin_layout Description
-Email Author's e-mail address
+\begin_layout Itemize
+
+\family sans
+Itemize
\end_layout
-\begin_layout Description
-URL Author's Web address, if desired.
+\begin_layout Itemize
+
+\family sans
+Enumerate
\end_layout
-\begin_layout Description
-Keywords Key words or phrases used to identify specific topics discussed
- in the paper.
+\begin_layout Itemize
+
+\family sans
+Description
\end_layout
-\begin_layout Description
-Subjectclass These refer to the AMS Subject Classifications, published and
- described in
-\emph on
-Mathematical Reviews
-\emph default
-.
- These are also available online at the AMS cites listed above.
+\begin_layout Itemize
+
+\family sans
+Caption
\end_layout
-\begin_layout Description
-Thanks
+\begin_layout Itemize
+
+\family sans
+Abstract
\end_layout
-\begin_layout Description
-Dedicatory
+\begin_layout Itemize
+
+\family sans
+Acknowledgment
\end_layout
-\begin_layout Description
-Translator
+\begin_layout Itemize
+
+\family sans
+Bibliography
\end_layout
-\begin_layout Standard
-In addition, these environments automatically provide the AMS LaTeX and
- AMS fonts packages.
- They need to be available on your system in order to use these environments.
+\begin_layout Itemize
+
+\family sans
+LaTeX
\end_layout
-\begin_layout Section
-Dinbrief
+\begin_layout Subsection
+Commands not supported by LyX
\end_layout
\begin_layout Standard
-The document class
+Some commands are not yet supported by the
\family sans
-dinbrief
+paper (A&A)
\family default
- can be used to type letters according to German conventions.
- A template file is included in
-\family typewriter
-.../lyx/share/templates
-\family default
- for you to use as a starting point.
+ layout for LyX.
+ Some have already been mentioned.
+ For the sake of completeness, they are listed all together here:
\end_layout
-\begin_layout Section
-Paper
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-The document class
-\family sans
-paper
-\family default
- provides an alternative to the standard
-\family sans
-article
-\family default
- class.
- It provides similar functionality, but you might prefer this layout with
- sans serif sections, headings, and more.
-\end_layout
+\family typewriter
-\begin_layout Section
-A&A Paper
+\backslash
+and
\end_layout
-\begin_layout Standard
-by
-\noun on
-Peter Sütterlin
-\end_layout
+\begin_layout Itemize
-\begin_layout Subsection
-Introduction
+\family typewriter
+
+\backslash
+email
\end_layout
-\begin_layout Standard
-This section describes how LyX can be used to write articles for submission
- to the scientific journal
-\emph on
-Astronomy and Astrophysics
-\emph default
- (
-\begin_inset LatexCommand url
-name "www.edpsciences.fr/aa/"
-target "http://www.edpsciences.fr/aa/"
+\begin_layout Itemize
-\end_inset
+\family typewriter
+
+\backslash
+appendix
+\end_layout
+
+\begin_layout Itemize
-) using Version 5.01 of the document class
\family typewriter
-aa.cls
-\family default
-.
- This package can be downloaded from the ftp site
+
+\backslash
+authorrunning
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
+\begin_layout Itemize
+\family typewriter
+\backslash
+inst{}
\end_layout
-\begin_layout Standard
-\align center
-\begin_inset LatexCommand url
-target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
+\begin_layout Itemize
-\end_inset
+\family typewriter
+
+\backslash
+keywords{}
+\end_layout
+\begin_layout Itemize
+
+\family typewriter
+\backslash
+object{}
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
+\begin_layout Itemize
+\family typewriter
+\backslash
+titlerunning{}
\end_layout
\begin_layout Standard
-A manual comes together with that package, and this text is not meant to
- replace the original manual but merely a short guide how to realize the
- correct form of your paper.
+If you want to use any of these commands, you have to enter them yourself.
+\series bold
+Do not forget to mark them as LaTeX code!
+\end_layout
+
+\begin_layout Subsection
+Figure and Table Floats
\end_layout
\begin_layout Standard
-Please note that the publisher of the journal was changed from Springer
- to EDP Sciences starting January 1, 2001.
- That change implicated also some slight changes of the style files, namely
- the removal of the thesaurus command.
- The LyX class aa supports the newest version of these style files, V 5.01.
- If you have an older version installed, please upgrade.
- For compatibility, the old (version 4) layout has been kept as
+LyX provides support for the necessary float environments
\family sans
-article (A&A V4)
+figure, figure*, table
\family default
-.
- Please refer to the comments in
-\family typewriter
-LyXDir/layouts/aapaper.layout
+ and
+\family sans
+table*
\family default
+, therefore we won't tell much about it here.
+ Refer to the
+\emph on
+User's\InsetSpace ~
+Guide
+\emph default
.
-\end_layout
+ Just remember that tables should be left-aligned.
+ For that, select the table and change the alignment in
+\family sans
+\bar under
+E
+\bar default
+dit\SpecialChar \menuseparator
-\begin_layout Subsection
-Getting started
+\bar under
+P
+\bar default
+aragraph\InsetSpace ~
+Settings.
\end_layout
\begin_layout Standard
-It is recommended you start from the example template distributed with LyX.
- If you are not using a template, note the following settings:
+There is only one special thing: the figures with caption besides the figure.
+ To create such a figure, you have to do the following:
\end_layout
-\begin_layout Itemize
-Select
-\family sans
-article (A&A)
-\family default
- in the
+\begin_layout Enumerate
+Create a wide figure float:
\family sans
\bar under
-D
+I
\bar default
-ocument\SpecialChar \menuseparator
-
+nsert\SpecialChar \menuseparator
+Flo
\bar under
-S
+a
\bar default
-ettings
-\family default
- dialog (OK, that one was obvious).
-\end_layout
-
-\begin_layout Itemize
-Don't change the option
-\family sans
-Page\InsetSpace ~
-style
+t\SpecialChar \menuseparator
+Figure
\family default
-: Leave it set to
+, then right click in the figure and select
\family sans
-default
+\bar under
+S
+\bar default
+pan\InsetSpace ~
+columns
\family default
.
- The whole layout is done by the macros, you shouldn't change anything.
-\end_layout
-
-\begin_layout Subsection
-The header block
\end_layout
-\begin_layout Standard
-First thing to enter is the header information.
- It consists of seven entries, of which some are optional.
- They are
+\begin_layout Enumerate
+Enter your caption text.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Enumerate
+Press
\family sans
-Title
+Return
\family default
-: [required]
+ to move the cursor above the caption.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
+Insert your figure
+\end_layout
+\begin_layout Enumerate
+Position the cursor behind the figure and insert a horizontal fill:
\family sans
-Subtitle
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
+
+\bar under
+S
+\bar default
+pecial\InsetSpace ~
+Character
+\bar under
+\SpecialChar \menuseparator
+H
+\bar default
+orizontal\InsetSpace ~
+Fill
\family default
-: [optional]
+.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Enumerate
+Switch to LaTeX mode:
\family sans
-Author
+M-c\InsetSpace ~
+t
\family default
-: [required]
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
+Enter
+\family typewriter
-\family sans
-Address
+\backslash
+parbox[b]{55mm}{
\family default
-: [required]
+.
+
+\series bold
+Do not close the brace!
\end_layout
-\begin_layout Itemize
-
+\begin_layout Enumerate
+Position the cursor behind the caption text, switch to LaTeX mode and insert
+ the closing brace:
\family sans
-Offprints
+M-c\InsetSpace ~
+t
\family default
-: [optional] if more than one author: whom to contact for offprint requests.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Mail
+
+\family typewriter
+}
\family default
-: [optional] mail address for contacts.
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Also, refer to the figures in the example paper.
+\end_layout
-\family sans
-Date
-\family default
-: [required].
- Suggested format is
-\family typewriter
-Received: <date>; Accepted <date>
+\begin_layout Subsection
+Referee layout
\end_layout
\begin_layout Standard
-There is no need to issue the
+For submission, the paper has to be formated in a special double-spacing
+ layout.
+ For this purpose, you have to give the option
\family typewriter
-
-\backslash
-maketitle
+referee
\family default
- command, this is done automatically by LyX when the header is finished.
- Although the order of the single header entries doesn't matter it is advised
- to keep the above sequence, just to get the best optics and meets the layout
- of the real document.
-\end_layout
-
-\begin_layout Standard
-If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
-g.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-
-\end_layout
-
-\end_inset
-
-to state your present address, just use the standard footnote via
+ to the documentclass.
+ This must be done using the extra class options field in the
\family sans
\bar under
-I
+D
\bar default
-nsert\SpecialChar \menuseparator
+ocument\SpecialChar \menuseparator
\bar under
-F
+S
\bar default
-ootnote.
-
+ettings
\family default
- LyX will automagically use the term
+ dialog.
+ Just enter the string
\family typewriter
-
-\backslash
-thanks{}
+referee
\family default
- in that case.
-\end_layout
-
-\begin_layout Standard
-In addition to these topics, the macros use three additional LaTeX commands
- that have no counterpart in LyX:
+ there.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
-
-\backslash
-and
-\family default
- to separate different names for more than one author and institute, respectivel
-y.
+\begin_layout Subsection
+The example paper
\end_layout
-\begin_layout Itemize
-
-\family typewriter
-
-\backslash
-inst{<nr>}
-\family default
-to mark corresponding author/institute pairs.
- The institutes are numbered sequentially as they appear in the
+\begin_layout Standard
+The
\family sans
-Address
+Examples
\family default
- field, so you have to put a marker to each author.
+ directory contains an example paper written with LyX.
+ It is the example paper from the original macro package, translated to
+ LyX.
+ Use it for inspiration, and compare the original LaTeX code with LyX way
+ of writing.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
-
-\backslash
-email{address}
-\family default
- to supply an email address for fast contact.
+\begin_layout Section
+AASTeX
\end_layout
\begin_layout Standard
-In all cases, the appropriate command has to be entered in LyX and marked
- as LaTeX code.
- See the examples.
-
+by
+\noun on
+Mike Ressler
\end_layout
\begin_layout Subsection
-The abstract
+Introduction
\end_layout
\begin_layout Standard
-The abstract should immediately follow the header block.
- With version 5 the abstract environment was changed to a command, and there
- is now a resctriction to only one paragraph.
- In addition, it should contain an entry with the keywords.
- This is not yet implemented for LyX, therefore you have to enter the LaTeX
- command
-\family typewriter
-
-\backslash
-keywords{}
-\family default
- by hand and mark it as LaTeX code.
- Refer to the example paper.
-\end_layout
-
-\begin_layout Subsection
-Supported environments
+AASTeX is a set of macros produced by the American Astronomical Society
+ to facilitate electronic manuscript submission to the three journals they
+ publish: the Astrophysical Journal (including the Letters and Supplement),
+ the Astronomical Journal, and the Publications of the Astronomical Society
+ of the Pacific.
+ LyX has proven to be an excellent tool for generating these documents,
+ especially given its equation, citation, and figure handling capabilities.
+ LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
+ is the version described here, or higher.
+ Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
+ incompatible with LyX.
+ The AASTeX package may be downloaded from the AASTeX Web site
\end_layout
\begin_layout Standard
-The A&A paper layout supports the following environments for structuring
- your text:
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Standard
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Section
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Subsection
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Subsubsection
-\end_layout
+\begin_inset VSpace medskip
+\end_inset
-\begin_layout Itemize
-\family sans
-Itemize
\end_layout
-\begin_layout Itemize
-
-\family sans
-Enumerate
-\end_layout
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
-\begin_layout Itemize
+\begin_layout Standard
-\family sans
-Description
+http://www.journals.uchicago.edu/AAS/AASTeX
\end_layout
-\begin_layout Itemize
-
-\family sans
-Caption
-\end_layout
+\end_inset
-\begin_layout Itemize
-\family sans
-Abstract
\end_layout
-\begin_layout Itemize
-
-\family sans
-Acknowledgment
-\end_layout
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-\begin_layout Itemize
-\family sans
-Bibliography
\end_layout
-\begin_layout Itemize
-
-\family sans
-LaTeX
+\begin_layout Standard
+A complete user guide is contained in that package and you should familiarize
+ yourself with it thoroughly before embarking on writing a paper in LyX.
+ LyX will not reduce the need to figure out all the AASTeX commands, it
+ will only reduce the drudgery of typing everything in.
+ It is your responsibility to ensure that the final exported LaTeX document
+ conforms completely to the requirements of the journal to which you are
+ submitting your paper.
\end_layout
\begin_layout Subsection
-Commands not supported by LyX
+Starting a New Paper
\end_layout
\begin_layout Standard
-Some commands are not yet supported by the
+I strongly suggest that you start with the AASTeX template file.
+ Click on
\family sans
-paper (A&A)
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
+New from
\family default
- layout for LyX.
- Some have already been mentioned.
- For the sake of completeness, they are listed all together here:
-\end_layout
-
-\begin_layout Itemize
-
-\family typewriter
-
-\backslash
-and
-\end_layout
-
-\begin_layout Itemize
-
-\family typewriter
-
-\backslash
-email
-\end_layout
-
-\begin_layout Itemize
-
-\family typewriter
-
-\backslash
-appendix
-\end_layout
-
-\begin_layout Itemize
-
-\family typewriter
-
-\backslash
-authorrunning
-\end_layout
-
-\begin_layout Itemize
-
+
+\family sans
+\bar under
+T
+\bar default
+emplate
+\family default
+, enter the new file name, then choose the
\family typewriter
-
-\backslash
-inst{}
-\end_layout
-
-\begin_layout Itemize
-
+aastex.lyx
+\family default
+ template.
+ This will show the most common fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
\family typewriter
-
-\backslash
-keywords{}
-\end_layout
-
-\begin_layout Itemize
-
+<>
+\family default
+) with the correct information.
+ Many of the AASTeX commands and environments can be implemented directly
+ in LyX, but some cannot: most noticeably
\family typewriter
\backslash
-object{}
-\end_layout
-
-\begin_layout Itemize
-
+altaffilmark
+\family default
+ and
\family typewriter
\backslash
-titlerunning{}
-\end_layout
-
-\begin_layout Standard
-If you want to use any of these commands, you have to enter them yourself.
-
-\series bold
-Do not forget to mark them as LaTeX code!
+altaffiltext
+\family default
+, which should stick out like a sore thumb if you actually just opened the
+ template file.
+ For commands such as these, the LaTeX code must be entered directly and
+ marked as such.
+ Such commands are referred to as ERT, or Evil Red Text.
+ I tried to minimize the amount of ERT needed in an AASTeX document, but
+ there is still a bit more required than any of us would like.
\end_layout
\begin_layout Subsection
-Figure and Table Floats
+Finishing Your Paper
\end_layout
\begin_layout Standard
-LyX provides support for the necessary float environments
-\family sans
-figure, figure*, table
-\family default
- and
-\family sans
-table*
-\family default
-, therefore we won't tell much about it here.
- Refer to the
-\emph on
-User's\InsetSpace ~
-Guide
-\emph default
-.
- Just remember that tables should be left-aligned.
- For that, select the table and change the alignment in
-\family sans
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
+When the paper is finished to your satisfaction and previews/prints correctly,
+ there are a few
+\begin_inset Quotes eld
+\end_inset
-\bar under
-P
-\bar default
-aragraph\InsetSpace ~
-Settings.
-\end_layout
+postprocessing
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-There is only one special thing: the figures with caption besides the figure.
- To create such a figure, you have to do the following:
+ actions which need to be done before you submit it to the journals.
+
\end_layout
\begin_layout Enumerate
-Create a wide figure float:
+Export your paper as a LaTeX file (
\family sans
\bar under
-I
+F
\bar default
-nsert\SpecialChar \menuseparator
-Flo
+ile\SpecialChar \menuseparator
+
\bar under
-a
+E
\bar default
-t\SpecialChar \menuseparator
-Figure
-\family default
-, then right click in the figure and select
-\family sans
+xport\SpecialChar \menuseparator
+
\bar under
-S
+L
\bar default
-pan\InsetSpace ~
-columns
+aTeX
\family default
-.
+).
+
\end_layout
\begin_layout Enumerate
-Enter your caption text.
+Edit the resulting
+\family typewriter
+.tex
+\family default
+ file with your favorite text editor
\end_layout
+\begin_deeper
\begin_layout Enumerate
-Press
-\family sans
-Return
+remove the comment lines before the
+\family typewriter
+
+\backslash
+documentclass
\family default
- to move the cursor above the caption.
+ command
\end_layout
\begin_layout Enumerate
-Insert your figure
-\end_layout
+remove the
+\family typewriter
-\begin_layout Enumerate
-Position the cursor behind the figure and insert a horizontal fill:
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+\backslash
+usepackage...{fontenc}
+\family default
+ line if it appears (usually just after
+\family typewriter
-\bar under
-S
-\bar default
-pecial\InsetSpace ~
-Character
-\bar under
-\SpecialChar \menuseparator
-H
-\bar default
-orizontal\InsetSpace ~
-Fill
+\backslash
+documentclass
\family default
-.
-\end_layout
+}; also remove the
+\family typewriter
-\begin_layout Enumerate
-Switch to LaTeX mode:
-\family sans
-M-c\InsetSpace ~
-t
+\backslash
+secnumdepth
\family default
-.
+ line if it appears.
\end_layout
\begin_layout Enumerate
-Enter
+remove everything between (and including) the
\family typewriter
\backslash
-parbox[b]{55mm}{
+makeatletter
\family default
-.
-
-\series bold
-Do not close the brace!
-\end_layout
+ and
+\family typewriter
-\begin_layout Enumerate
-Position the cursor behind the caption text, switch to LaTeX mode and insert
- the closing brace:
-\family sans
-M-c\InsetSpace ~
-t
+\backslash
+makeatother
\family default
-
+ commands, except for any commands you specifically put into the LaTeX preamble
+ (which should appear immediately after the
+\begin_inset Quotes eld
+\end_inset
+
+User specified LaTeX commands
+\begin_inset Quotes erd
+\end_inset
+
+ comment in the
\family typewriter
-}
+.tex
\family default
-.
+ file).
\end_layout
-\begin_layout Standard
-Also, refer to the figures in the example paper.
+\end_deeper
+\begin_layout Enumerate
+Run the resulting file through LaTeX to make sure it still processes correctly.
\end_layout
-\begin_layout Subsection
-Referee layout
+\begin_layout Enumerate
+Reread the journal requirements to make sure your filenames and formats
+ are correct.
\end_layout
-\begin_layout Standard
-For submission, the paper has to be formated in a special double-spacing
- layout.
- For this purpose, you have to give the option
-\family typewriter
-referee
-\family default
- to the documentclass.
- This must be done using the extra class options field in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
- Just enter the string
-\family typewriter
-referee
-\family default
- there.
+\begin_layout Enumerate
+Submit it.
\end_layout
\begin_layout Subsection
-The example paper
+Comments On Specific Commands
\end_layout
\begin_layout Standard
-The
-\family sans
-Examples
+I will not describe the detailed usage of the individual AASTeX commands:
+ the AASTeX User Guide (
+\family typewriter
+aasguide.tex
\family default
- directory contains an example paper written with LyX.
- It is the example paper from the original macro package, translated to
- LyX.
- Use it for inspiration, and compare the original LaTeX code with LyX way
- of writing.
-\end_layout
-
-\begin_layout Section
-AASTeX
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Mike Ressler
-\end_layout
+) gives a good description of each.
+ Thus it's probably easiest for me to go down the list as found in the guide
+ and offer comments where necessary.
+ So let's begin \SpecialChar \ldots{}
-\begin_layout Subsection
-Introduction
\end_layout
-\begin_layout Standard
-AASTeX is a set of macros produced by the American Astronomical Society
- to facilitate electronic manuscript submission to the three journals they
- publish: the Astrophysical Journal (including the Letters and Supplement),
- the Astronomical Journal, and the Publications of the Astronomical Society
- of the Pacific.
- LyX has proven to be an excellent tool for generating these documents,
- especially given its equation, citation, and figure handling capabilities.
- LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
- is the version described here, or higher.
- Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
- incompatible with LyX.
- The AASTeX package may be downloaded from the AASTeX Web site
+\begin_layout Subsubsection
+Things that work as expected
\end_layout
\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
-
-
-\end_layout
+\begin_inset ERT
+status open
\begin_layout Standard
-\align center
-\begin_inset LatexCommand url
-target "http://www.journals.uchicago.edu/AAS/AASTeX"
-
-\end_inset
+\backslash
+begin{sloppypar}
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
\end_layout
\begin_layout Standard
-A complete user guide is contained in that package and you should familiarize
- yourself with it thoroughly before embarking on writing a paper in LyX.
- LyX will not reduce the need to figure out all the AASTeX commands, it
- will only reduce the drudgery of typing everything in.
- It is your responsibility to ensure that the final exported LaTeX document
- conforms completely to the requirements of the journal to which you are
- submitting your paper.
-\end_layout
-
-\begin_layout Subsection
-Starting a New Paper
-\end_layout
+Because they work as you might expect, I simply list them and the section
+ they are found in:
+\family typewriter
-\begin_layout Standard
-I strongly suggest that you start with the AASTeX template file.
- Click on
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-New from
-\family default
-
-\family sans
-\bar under
-T
-\bar default
-emplate
+\backslash
+documentclass
\family default
-, enter the new file name, then choose the
+ (2.1.1),
\family typewriter
-aastex.lyx
+
+\backslash
+begin{document}
\family default
- template.
- This will show the most common fields found in a manuscript.
- Simply overwrite the existing text (including the brackets,
+ (2.2),
\family typewriter
-<>
+
+\backslash
+title
\family default
-) with the correct information.
- Many of the AASTeX commands and environments can be implemented directly
- in LyX, but some cannot: most noticeably
+ (2.3),
\family typewriter
\backslash
-altaffilmark
+author
\family default
- and
+ (2.3),
\family typewriter
\backslash
-altaffiltext
+affil
\family default
-, which should stick out like a sore thumb if you actually just opened the
- template file.
- For commands such as these, the LaTeX code must be entered directly and
- marked as such.
- Such commands are referred to as ERT, or Evil Red Text.
- I tried to minimize the amount of ERT needed in an AASTeX document, but
- there is still a bit more required than any of us would like.
-\end_layout
-
-\begin_layout Subsection
-Finishing Your Paper
-\end_layout
-
-\begin_layout Standard
-When the paper is finished to your satisfaction and previews/prints correctly,
- there are a few
-\begin_inset Quotes eld
-\end_inset
-
-postprocessing
-\begin_inset Quotes erd
-\end_inset
-
- actions which need to be done before you submit it to the journals.
-
-\end_layout
-
-\begin_layout Enumerate
-Export your paper as a LaTeX file (
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
+ (2.3),
+\family typewriter
-\bar under
-L
-\bar default
-aTeX
+\backslash
+abstract
\family default
-).
-
-\end_layout
-
-\begin_layout Enumerate
-Edit the resulting
+ (2.4),
\family typewriter
-.tex
+
+\backslash
+keywords
\family default
- file with your favorite text editor
-\end_layout
+ (2.5),
+\family typewriter
-\begin_deeper
-\begin_layout Enumerate
-remove the comment lines before the
+\backslash
+section
+\family default
+ (2.7),
\family typewriter
\backslash
-documentclass
+subsection
\family default
- command
-\end_layout
+ (2.7),
+\family typewriter
-\begin_layout Enumerate
-remove the
+\backslash
+subsubsection
+\family default
+ (2.7),
\family typewriter
\backslash
-usepackage...{fontenc}
+paragraph
\family default
- line if it appears (usually just after
+ (2.7),
\family typewriter
\backslash
-documentclass
+facility
\family default
-}; also remove the
+ (2.10),
\family typewriter
\backslash
-secnumdepth
+begin{displaymath}
\family default
- line if it appears.
-\end_layout
+ (2.12),
+\family typewriter
-\begin_layout Enumerate
-remove everything between (and including) the
+\backslash
+begin{equation}
+\family default
+ (2.12),
\family typewriter
\backslash
-makeatletter
+begin{eqnarray}
\family default
- and
+ (2.12),
\family typewriter
\backslash
-makeatother
+begin{mathletters}
\family default
- commands, except for any commands you specifically put into the LaTeX preamble
- (which should appear immediately after the
-\begin_inset Quotes eld
-\end_inset
-
-User specified LaTeX commands
-\begin_inset Quotes erd
-\end_inset
-
- comment in the
-\family typewriter
-.tex
-\family default
- file).
-\end_layout
-
-\end_deeper
-\begin_layout Enumerate
-Run the resulting file through LaTeX to make sure it still processes correctly.
-\end_layout
-
-\begin_layout Enumerate
-Reread the journal requirements to make sure your filenames and formats
- are correct.
-\end_layout
-
-\begin_layout Enumerate
-Submit it.
-\end_layout
-
-\begin_layout Subsection
-Comments On Specific Commands
-\end_layout
-
-\begin_layout Standard
-I will not describe the detailed usage of the individual AASTeX commands:
- the AASTeX User Guide (
-\family typewriter
-aasguide.tex
-\family default
-) gives a good description of each.
- Thus it's probably easiest for me to go down the list as found in the guide
- and offer comments where necessary.
- So let's begin \SpecialChar \ldots{}
-
-\end_layout
-
-\begin_layout Subsubsection
-Things that work as expected
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-
-\backslash
-begin{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-Because they work as you might expect, I simply list them and the section
- they are found in:
-\family typewriter
-
-\backslash
-documentclass
-\family default
- (2.1.1),
-\family typewriter
-
-\backslash
-begin{document}
-\family default
- (2.2),
-\family typewriter
-
-\backslash
-title
-\family default
- (2.3),
-\family typewriter
-
-\backslash
-author
-\family default
- (2.3),
-\family typewriter
-
-\backslash
-affil
-\family default
- (2.3),
-\family typewriter
-
-\backslash
-abstract
-\family default
- (2.4),
-\family typewriter
-
-\backslash
-keywords
-\family default
- (2.5),
-\family typewriter
-
-\backslash
-section
-\family default
- (2.7),
-\family typewriter
-
-\backslash
-subsection
-\family default
- (2.7),
-\family typewriter
-
-\backslash
-subsubsection
-\family default
- (2.7),
-\family typewriter
-
-\backslash
-paragraph
-\family default
- (2.7),
-\family typewriter
-
-\backslash
-facility
-\family default
- (2.10),
-\family typewriter
-
-\backslash
-begin{displaymath}
-\family default
- (2.12),
-\family typewriter
-
-\backslash
-begin{equation}
-\family default
- (2.12),
-\family typewriter
-
-\backslash
-begin{eqnarray}
-\family default
- (2.12),
-\family typewriter
-
-\backslash
-begin{mathletters}
-\family default
- (2.12),
-\family typewriter
+ (2.12),
+\family typewriter
\backslash
begin{thebibliography}
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\family typewriter
aastex.layout
\family default
- appears in
+ appears in LyX's
\family typewriter
-/usr/.../share/lyx/layouts
+layouts
\family default
- or
-\family typewriter
-~/.lyx/layouts
-\family default
-.
+ folder
\end_layout
\begin_layout Enumerate
\begin_layout Subsubsection
References
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "cite"
\end_inset
\end_layout
\begin_layout Section
-qijmpc and ijmpd
+ijmpc and ijmpd
\end_layout
\begin_layout Standard
, respectively.
These files, together with instructions for the authors, can be downloaded
from the sites
-\begin_inset LatexCommand url
-target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
+\end_layout
\end_inset
and
-\begin_inset LatexCommand url
-target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
+\end_layout
\end_inset
\end_layout
\begin_layout Section
-Kluwer
+iopart
\end_layout
\begin_layout Standard
by
\noun on
-Panayotis Papasotiriou
+Uwe Stöhr
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-The Kluwer package is a set of macros produced by Kluwer Academic Publishers
- that facilitates electronic manuscript submission to the journals they
- publish.
- Most known of them (at least in my domain of interest) are
-\emph on
-Astrophysics and Space Science
-\emph default
- and
-\emph on
-Solar Physics
-\emph default
-, but there are many others (see a complete list at
-\begin_inset LatexCommand url
-target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
-
-\end_inset
-
-).
- The Kluwer package may be downloaded from the site
-\begin_inset LatexCommand url
-target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
-
-\end_inset
-
-.
- A complete user guide is contained in that package (but it can also be
- downloaded separately).
-\end_layout
+The iopart package provides a document class to create electronic manuscript
+ submission to the journals published by the Institute of Physics.
+ Instructions for the authors how to create a paper using the iopart class
+ can be downloaded together with the iopart package from the site
+\begin_inset Flex URL
+status collapsed
\begin_layout Standard
-LyX supports many features of the package but not everything.
- However, the ERT needed is reduced to some
-\begin_inset Quotes eld
-\end_inset
-
-peculiar
-\begin_inset Quotes erd
-\end_inset
-
- commands of the package (see\InsetSpace ~
-\begin_inset LatexCommand ref
-reference "subsec:kluwer_peculiarities"
+ftp://ftp.iop.org/pub/journals/latex2e
+\end_layout
\end_inset
-).
- I have recently used LyX to write an article submitted to the
-\emph on
-Astrophysics and Space Science
-\emph default
- without any problem.
+.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-The easiest way to write a paper is to start with the Kluwer template file.
- Click on
+The easiest way to write a paper is to start with the file
+\emph on
+IOP-article.lyx
+\emph default
+ that is available in LyX's examples files folder.
+ Open this file, save it under a new name, and start writing.
+ The example file explains how to use the special text environments.
+ Here are the most important advices:
+\end_layout
+
+\begin_layout Itemize
+To be able to compile your document to a PDF, PS, or DVI, assure that the
+ two options
\family sans
-File\SpecialChar \menuseparator
-New from
+Use AMS math package
\family default
-
+ in the document settings under
\family sans
-\bar under
-T
-\bar default
-emplate
-\family default
-, then choose the
-\family typewriter
-kluwer.lyx
-\family default
- template.
- This will give an (almost) empty document that includes the most common
- fields found in a manuscript and a short description of their use.
- As in most templates, simply overwrite the existing text (including the
- brackets,
-\family typewriter
-<>
+Math Options
\family default
-) with the correct information.
+ are not used!
\end_layout
-\begin_layout Subsection
-Preparing a paper for submission
+\begin_layout Itemize
+
+\size normal
+The title environment defines the kind of your paper.
+ So use one of the following environments for the title:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+
+\family sans
+\size normal
+Title
+\family default
+ for a Paper
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Review
+\family default
+ for a Review
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Topical
+\family default
+ for a Topical review
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Comment
+\family default
+ for a Comment
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Note
+\family default
+ for a Note
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Paper
+\family default
+ for a Paper (same as Title)
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Prelim
+\family default
+ for a Preliminary communication
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Rapid
+\family default
+ for a Rapid communication
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Letter
+\family default
+ for a Letter to the editor
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+
+\size normal
+All title environments except of
+\family sans
+Letter
+\family default
+ can have an optional short title.
+\end_layout
+
+\begin_layout Itemize
+There is a general title environment
+\family sans
+Article
+\family default
+ which is not directly supported by the LyX.
+ This can be used as ERT when your document doesn't fit into one of the
+ other title types.
+\end_layout
+
+\begin_layout Standard
+For more informations like hints for special table and formula formatting,
+ look at the IOP author guidelines.
+\end_layout
+
+\begin_layout Section
+Kluwer
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Panayotis Papasotiriou
+\end_layout
+
+\begin_layout Subsection
+Overview
+\end_layout
+
+\begin_layout Standard
+The Kluwer package is a set of macros produced by Kluwer Academic Publishers
+ that facilitates electronic manuscript submission to the journals they
+ publish.
+ Most known of them (at least in my domain of interest) are
+\emph on
+Astrophysics and Space Science
+\emph default
+ and
+\emph on
+Solar Physics
+\emph default
+, but there are many others (see a complete list at
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+http://www.wkap.nl/jrnllist.htm/JRNLHOME
+\end_layout
+
+\end_inset
+
+).
+ The Kluwer package may be downloaded from the site
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+http://www.wkap.nl/kaphtml.htm/STYLEFILES
+\end_layout
+
+\end_inset
+
+.
+ A complete user guide is contained in that package (but it can also be
+ downloaded separately).
+\end_layout
+
+\begin_layout Standard
+LyX supports many features of the package but not everything.
+ However, the ERT needed is reduced to some
+\begin_inset Quotes eld
+\end_inset
+
+peculiar
+\begin_inset Quotes erd
+\end_inset
+
+ commands of the package (see\InsetSpace ~
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:kluwer_peculiarities"
+
+\end_inset
+
+).
+ I have recently used LyX to write an article submitted to the
+\emph on
+Astrophysics and Space Science
+\emph default
+ without any problem.
+\end_layout
+
+\begin_layout Subsection
+Writing a paper
+\end_layout
+
+\begin_layout Standard
+The easiest way to write a paper is to start with the Kluwer template file.
+ Click on
+\family sans
+File\SpecialChar \menuseparator
+New from
+\family default
+
+\family sans
+\bar under
+T
+\bar default
+emplate
+\family default
+, then choose the
+\family typewriter
+kluwer.lyx
+\family default
+ template.
+ This will give an (almost) empty document that includes the most common
+ fields found in a manuscript and a short description of their use.
+ As in most templates, simply overwrite the existing text (including the
+ brackets,
+\family typewriter
+<>
+\family default
+) with the correct information.
+\end_layout
+
+\begin_layout Subsection
+Preparing a paper for submission
\end_layout
\begin_layout Standard
\end_inset
of the Kluwer package
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "subsec:kluwer_peculiarities"
\end_inset
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
These are the layout files for some of the journal formats used by Springer
Verlag and listed on
-\begin_inset LatexCommand url
-target "http://www.springer.de/author/tex/help-journals.html"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+http://www.springer.de/author/tex/help-journals.html
+\end_layout
\end_inset
Society.
It is assumed that you have both the AGU's own class files and AGUplus
installed (everything to be found at
-\begin_inset LatexCommand url
-target "ftp://ftp.agu.org/journals/latex/journals"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+ftp://ftp.agu.org/journals/latex/journals
+\end_layout
\end_inset
egs.cls
\family default
can be downloaded from the web site of the EGS under
-\begin_inset LatexCommand url
-target "www.copernicus.org"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+www.copernicus.org
+\end_layout
\end_inset
Sli
\noun default
TeX]
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:slitex"
\end_inset
, check out section\InsetSpace ~
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "sec:foiltex"
\end_inset
\begin_layout Subsection
Getting Started
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:slidesetup"
\end_inset
s.
See section\InsetSpace ~
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "sec:slideNote"
\end_inset
\begin_layout Subsubsection
Quirks of the New Environments
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:slideQuirk"
\end_inset
\family default
environment [in the manner described in section\InsetSpace ~
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "sec:slideQuirk"
\end_inset
invisible and visible, respectively.
Note from section\InsetSpace ~
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "sec:slideQuirk"
\end_inset
Slide
\family default
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:slideNote"
\end_inset
[see section\InsetSpace ~
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "sec:slidesetup"
\end_inset
\end_inset
-\family typewriter
-
-\backslash
-onlyslides{
-\backslash
-slides}
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- , print to a file with
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
--slides
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- in its name, comment it back out, then uncomment
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
-onlynotes{
-\backslash
-notes}
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- and print to a
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-*-notes.ps
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- file.
- I can then send either file to a printer, loading transparencies or plain
- paper as appropriate.
-\end_layout
-
-\begin_layout Standard
-You can also provide other arguments to the
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
-onlyslides{}
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
-onlynotes{}
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- commands.
- See a good LaTeX book for details.
-\end_layout
-
-\begin_layout Subsection
-The
-\family sans
-slides
-\family default
- Class Template File
-\end_layout
-
-\begin_layout Standard
-I have also provided a template file,
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-slides.lyx
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-, with the
-\family sans
-slides
-\family default
- class.
- To use it, begin your new presentation with
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-New\InsetSpace ~
-from\InsetSpace ~
-
-\bar under
-T
-\bar default
-emplate
-\family default
-.
- Your new LyX presentation file will contain an example
-\family sans
-Slide
-\family default
- --
-\family sans
-Overlay
-\family default
- --
-\family sans
-Note
-\family default
- triplet.
- The
-\family sans
-Slide
-\family default
- and
-\family sans
-Overlay
-\family default
- additionally contain an example of the use of
-\family sans
-InvisibleText
-\family default
- and
-\family sans
-VisibleText
-\family default
-.
- Lastly, the preamble will contain:
-\end_layout
-
-\begin_layout LyX-Code
-% Uncomment to print out only slides and overlays
-\end_layout
-
-\begin_layout LyX-Code
-%
-\end_layout
-
-\begin_layout LyX-Code
-%
-\backslash
-onlyslides{
-\backslash
-slides}
-\newline
-
-\end_layout
-
-\begin_layout LyX-Code
-% Uncomment to print out only notes
-\end_layout
-
-\begin_layout LyX-Code
-%
-\end_layout
-
-\begin_layout LyX-Code
-%
-\backslash
-onlynotes{
-\backslash
-notes}
-\end_layout
-
-\begin_layout Standard
-One final thing: I created this class to support the LaTeX2e
-\begin_inset Quotes eld
-\end_inset
-
-
-\noun on
-Sli
-\noun default
-TeX emulation
-\begin_inset Quotes erd
-\end_inset
-
- class, one of the built-in LaTeX2e classes.
- Neither I nor the rest of the LyX Team endorse or oppose the use of this
- built-in slide class.
- It's here if you want it or need it.
- There exist other LaTeX2e classes for creating presentations, such as the
-
-\family sans
-Foils
-\family default
- class [see section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:foiltex"
-
-\end_inset
-
-] or the
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-seminar
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- package [present on some TeX distributions].
- The latter is not yet supported under LyX.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-Perhaps you can take on the task\SpecialChar \ldots{}
-
-\end_layout
-
-\end_inset
-
- I know nothing about these other classes.
- Try them out to see what sort of alternative they provide.
-\end_layout
-
-\begin_layout Section
-Foils [aka
-\family sans
-Foil
-\family default
-\noun on
-TeX
-\noun default
-]
-\begin_inset LatexCommand label
-name "sec:foiltex"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Allan Rae
-\end_layout
-
-\begin_layout Subsection
-Introduction
-\end_layout
-
-\begin_layout Standard
-This section describes how to use LyX to make slides for overhead projectors.
- There are two document classes that can do this: the default slides class
- and the
-\family sans
-Foil
-\family default
-TeX slides class.
- This section documents the latter.
-\end_layout
-
-\begin_layout Standard
-I'm going to say this again, nice and clear, so that there's no misunderstanding
-:
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\align center
-
-\size large
-This section documents the class
-\begin_inset Quotes eld
-\end_inset
-
-
-\family sans
-slides (FoilTeX)
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\emph on
-only.
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-If you're looking for the documentation for
-\begin_inset Quotes eld
-\end_inset
-
-
-\family sans
-slides (default)
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-, check out section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:slitex"
-
-\end_inset
-
-.
- If your machine doesn't have the
-\family sans
-foils
-\family default
- class [
-\begin_inset Quotes eld
-\end_inset
-
-
-\family sans
-slides (FoilTeX)
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-] installed, you'll probably have to use the default
-\family sans
-slides
-\family default
- class, which isn't quite as good as
-\family sans
-foils.
-\end_layout
-
-\begin_layout Standard
-The
-\family sans
-foils
-\family default
- class is designed for use with version 2.1 of the
-\family sans
-foils.cls
-\family default
- LaTeX class file which is now an integral part of LaTeX2e.
-\end_layout
-
-\begin_layout Subsection
-Getting Started
-\end_layout
-
-\begin_layout Standard
-Obviously, to use this document class, you need to select
-\begin_inset Quotes eld
-\end_inset
-
-
-\family sans
-slides (FoilTeX)
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- from the
-\family sans
-\bar under
-C
-\bar default
-lass
-\family default
- entry in the
-\family sans
-Document\InsetSpace ~
-Layout
-\family default
- dialog.
- There are some settings in the
-\family sans
-Document\InsetSpace ~
-Layout
-\family default
- dialog that you should know about that are specific to this class:
-\end_layout
-
-\begin_layout Itemize
-Don't change the options
-\family sans
-Sides
-\family default
- and
-\family sans
-Columns
-\family default
- on the
-\family sans
-Document\InsetSpace ~
-Layout
-\family default
- dialog.
- They're ignored by the
-\family sans
-foils
-\family default
- class.
-\end_layout
-
-\begin_layout Itemize
-The default font size is 20pt with the other options being 17pt, 25pt and
- 30pt.
-\end_layout
-
-\begin_layout Itemize
-The default font is
-\family sans
-sans
-\family default
-
-\family sans
-serif
-\family default
- but all math equations are still typeset in the usual roman font.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Foil
-\family default
-TeX supports A4 and Letter paper sizes as well as a special size for working
- with 35mm slides.
- It doesn't support A5, B5, legal or executive paper sizes.
-\end_layout
-
-\begin_layout Itemize
-Don't bother changing the
-\family sans
-Float Placement
-\family default
- settings because they are ignored anyway.
- All floats appear where they are defined in the text.
-\end_layout
-
-\begin_layout Itemize
-The
-\family sans
-\bar under
-P
-\bar default
-agestyle
-\family default
- setting behaves a bit differently for this class.
-
-\family sans
-Foil
-\family default
-TeX provides extensive footer and header capabilities including a user-defined
- logo.
- See section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:foilfoot"
-
-\end_inset
-
- for more details.
- The title page is treated differently to all other pages in the document
- and is
-\emph on
-always
-\emph default
- unnumbered and
-\emph on
-always
-\emph default
- has the logo centered at the bottom of the page (if one is defined).
- The possible page style choices and what they do are as follows:
-\end_layout
-
-\begin_deeper
-\begin_layout List
-\labelwidthstring MMMMMMM
-
-\family sans
-\series bold
-empty
-\family default
-\series default
- The final output contains no page numbers, or other headers or footers
- (except footnotes of course).
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMM
-
-\family sans
-\series bold
-plain
-\family default
-\series default
- The final output contains page numbers centered at the bottom of the page.
- No other headings or footers (other than footnotes).
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMM
-
-\series bold
-foilheadings
-\series default
- Page numbers in lower right corner.
- Additional headers and footers are also shown.
- This is also the default.
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMM
-
-\series bold
-fancy
-\series default
- Gives you access to the
-\family sans
-fancyheadings
-\family default
- package although its use with
-\family sans
-Foil
-\family default
-TeX is discouraged by the writer of the
-\family sans
-Foil
-\family default
-TeX package because of some potential page layout clashes.
-\end_layout
-
-\end_deeper
-\begin_layout Subsubsection
-Extra Options
-\end_layout
-
-\begin_layout Standard
-The following options may be used in the extra class options in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMx
-
-\series bold
-35mmSlide
-\series default
- This sets up the page layout for 7.33in by 11in paper, which is about the
- same aspect ratio as a 35mm slide, making it a bit easier to work with
- this medium.
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMx
-
-\series bold
-headrule
-\series default
- Places a rule across the page below the header on every page except the
- title page.
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMx
-
-\series bold
-footrule
-\series default
- Places a rule across the page above the footer on every page except the
- title page.
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMx
-
-\series bold
-dvips
-\series default
- This is automatically set each time you create a new
-\family sans
-foils
-\family default
- document.
- This option tells
-\family sans
-Foil
-\family default
-TeX to use the dvips driver to rotate those pages that are set as landscape
- foils.
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMx
-
-\series bold
-landscape
-\series default
- Simply changes the page dimensions to those of a landscape page but doesn't
- do any rotation.
- Thus if you use this option you need to use an external program to rotate
- each page or feed your paper through your printer as landscape.
- Note that this option effectively reverses the roles of the
-\family sans
-Foilhead
-\family default
- and
-\family sans
-Rotatefoilhead
-\family default
- environments (don't worry these are described in the next section).
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMx
+\family typewriter
-\series bold
-leqno
-\series default
- Equation numbers on the left.
-\end_layout
+\backslash
+onlyslides{
+\backslash
+slides}
+\family default
-\begin_layout List
-\labelwidthstring MMMMMMx
+\begin_inset Quotes erd
+\end_inset
-\series bold
-fleqn
-\series default
- Flush-left equations.
-\end_layout
+ , print to a file with
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-Supported Environments
-\end_layout
-\begin_layout Standard
-Most of the environments commonly supported in other classes are also supported
- by the
-\family sans
-foils
-\family default
- class.
- There are several additional environments provided by
-\family sans
-Foil
+\family typewriter
+-slides
\family default
-TeX as well as a couple added by LyX.
- The following environments are shared with other classes:
-\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\begin_inset Quotes erd
+\end_inset
+
+ in its name, comment it back out, then uncomment
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+\family typewriter
\backslash
-begin{multicols}{2}
-\end_layout
+onlynotes{
+\backslash
+notes}
+\family default
+\begin_inset Quotes erd
\end_inset
+ and print to a
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout Itemize
+\family typewriter
+*-notes.ps
+\family default
-\family sans
-Standard
+\begin_inset Quotes erd
+\end_inset
+
+ file.
+ I can then send either file to a printer, loading transparencies or plain
+ paper as appropriate.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+You can also provide other arguments to the
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Itemize
-\end_layout
-\begin_layout Itemize
+\family typewriter
-\family sans
-Enumerate
-\end_layout
+\backslash
+onlyslides{}
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Description
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-\family sans
-List
-\end_layout
+\family typewriter
-\begin_layout Itemize
+\backslash
+onlynotes{}
+\family default
-\family sans
-LyX-Code
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ commands.
+ See a good LaTeX book for details.
+\end_layout
+\begin_layout Subsection
+The
\family sans
-Verse
+slides
+\family default
+ Class Template File
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+I have also provided a template file,
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Quote
-\end_layout
-\begin_layout Itemize
+\family typewriter
+slides.lyx
+\family default
-\family sans
-Quotation
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+, with the
+\family sans
+slides
+\family default
+ class.
+ To use it, begin your new presentation with
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
+New\InsetSpace ~
+from\InsetSpace ~
+\bar under
+T
+\bar default
+emplate
+\family default
+.
+ Your new LyX presentation file will contain an example
\family sans
-Title
+Slide
+\family default
+ --
+\family sans
+Overlay
+\family default
+ --
+\family sans
+Note
+\family default
+ triplet.
+ The
+\family sans
+Slide
+\family default
+ and
+\family sans
+Overlay
+\family default
+ additionally contain an example of the use of
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+.
+ Lastly, the preamble will contain:
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
+% Uncomment to print out only slides and overlays
+\end_layout
-\family sans
-Author
+\begin_layout LyX-Code
+%
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
+%
+\backslash
+onlyslides{
+\backslash
+slides}
+\newline
+
+\end_layout
-\family sans
-Date
+\begin_layout LyX-Code
+% Uncomment to print out only notes
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
+%
+\end_layout
-\family sans
-Abstract
+\begin_layout LyX-Code
+%
+\backslash
+onlynotes{
+\backslash
+notes}
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+One final thing: I created this class to support the LaTeX2e
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Bibliography
-\end_layout
-\begin_layout Itemize
+\noun on
+Sli
+\noun default
+TeX emulation
+\begin_inset Quotes erd
+\end_inset
+ class, one of the built-in LaTeX2e classes.
+ Neither I nor the rest of the LyX Team endorse or oppose the use of this
+ built-in slide class.
+ It's here if you want it or need it.
+ There exist other LaTeX2e classes for creating presentations, such as the
+
\family sans
-Address
-\end_layout
+Foils
+\family default
+ class [see section\InsetSpace ~
-\begin_layout Itemize
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foiltex"
-\family sans
-RightAddress
-\end_layout
+\end_inset
-\begin_layout Itemize
+] or the
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Caption
-\end_layout
-\begin_layout Itemize
+\family typewriter
+seminar
+\family default
-\family sans
-Comment
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+ package [present on some TeX distributions].
+ The latter is not yet supported under LyX.
+\begin_inset Foot
+status collapsed
\begin_layout Standard
+Perhaps you can take on the task\SpecialChar \ldots{}
-
-\backslash
-end{multicols}
\end_layout
\end_inset
-
+ I know nothing about these other classes.
+ Try them out to see what sort of alternative they provide.
\end_layout
-\begin_layout Standard
-That is, all the major environments apart from the sectioning environments.
- Since foils are essentially self-contained sections, with a title and body,
-
+\begin_layout Section
+Foils [aka
\family sans
Foil
\family default
-TeX provides specific commands for starting new foils and these are:
-\end_layout
-
-\begin_layout Itemize
+\noun on
+TeX
+\noun default
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foiltex"
-\family sans
-Foilhead
-\end_layout
+\end_inset
-\begin_layout Itemize
-\family sans
-Rotatefoilhead
\end_layout
\begin_layout Standard
-LyX also provides slightly modified versions of these two environments called:
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-ShortFoilhead
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-ShortRotatefoilhead
+by
+\noun on
+Allan Rae
\end_layout
-\begin_layout Standard
-and the differences will be explained in the next section.
+\begin_layout Subsection
+Introduction
\end_layout
\begin_layout Standard
-Since foils are often used in presenting ideas or new theorems and such
-
+This section describes how to use LyX to make slides for overhead projectors.
+ There are two document classes that can do this: the default slides class
+ and the
\family sans
Foil
\family default
-TeX also provides a comprehensive box of goodies for presenting them:
+TeX slides class.
+ This section documents the latter.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-
-\backslash
-begin{multicols}{2}
+I'm going to say this again, nice and clear, so that there's no misunderstanding
+:
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\align center
-\family sans
-Theorem
-\end_layout
+\size large
+This section documents the class
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family sans
-Lemma
-\end_layout
+slides (FoilTeX)
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Corollary
+
+\emph on
+only.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Proposition
-\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
-\begin_layout Itemize
-\family sans
-Definition
\end_layout
-\begin_layout Itemize
-
-\family sans
-Proof
-\end_layout
+\begin_layout Standard
+If you're looking for the documentation for
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family sans
-Theorem*
-\end_layout
-
-\begin_layout Itemize
+slides (default)
+\family default
-\family sans
-Lemma*
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+, check out section\InsetSpace ~
-\family sans
-Corollary*
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slitex"
-\begin_layout Itemize
+\end_inset
+.
+ If your machine doesn't have the
\family sans
-Proposition*
-\end_layout
+foils
+\family default
+ class [
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family sans
-Definition*
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-
-\backslash
-end{multicols}
-\end_layout
+slides (FoilTeX)
+\family default
+\begin_inset Quotes erd
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-The starred versions are unnumbered while the unstarred versions are numbered.
- There are also two list environments added by LyX and these are:
-\end_layout
-
-\begin_layout Itemize
-
+] installed, you'll probably have to use the default
\family sans
-TickList
-\end_layout
-
-\begin_layout Itemize
-
+slides
+\family default
+ class, which isn't quite as good as
\family sans
-CrossList
+foils.
\end_layout
\begin_layout Standard
-
+The
\family sans
-Foil
+foils
\family default
-TeX provides some powerful header and footer capabilities that are best
- set in the preamble although they may be set at any point in a document.
- If you want to change these settings in your document the best place to
- do so is at the very top of a foil,
-\emph on
-i.e.
-
-\emph default
- straight after the foilhead.
+ class is designed for use with version 2.1 of the
+\family sans
+foils.cls
+\family default
+ LaTeX class file which is now an integral part of LaTeX2e.
\end_layout
-\begin_layout Standard
-For this purpose, the following command styles are provided [
-\shape smallcaps
-Martin Vermeer
-\shape default
-]:
+\begin_layout Subsection
+Getting Started
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
+Obviously, to use this document class, you need to select
+\begin_inset Quotes eld
+\end_inset
-\backslash
-begin{multicols}{2}
-\end_layout
+\family sans
+slides (FoilTeX)
+\family default
+\begin_inset Quotes erd
\end_inset
-
+ from the
+\family sans
+\bar under
+C
+\bar default
+lass
+\family default
+ entry in the
+\family sans
+Document\InsetSpace ~
+Layout
+\family default
+ dialog.
+ There are some settings in the
+\family sans
+Document\InsetSpace ~
+Layout
+\family default
+ dialog that you should know about that are specific to this class:
\end_layout
\begin_layout Itemize
-
+Don't change the options
\family sans
-My\InsetSpace ~
-Logo
+Sides
+\family default
+ and
+\family sans
+Columns
+\family default
+ on the
+\family sans
+Document\InsetSpace ~
+Layout
+\family default
+ dialog.
+ They're ignored by the
+\family sans
+foils
+\family default
+ class.
\end_layout
\begin_layout Itemize
+The default font size is 20pt with the other options being 17pt, 25pt and
+ 30pt.
+\end_layout
+\begin_layout Itemize
+The default font is
\family sans
-Restriction
+sans
+\family default
+
+\family sans
+serif
+\family default
+ but all math equations are still typeset in the usual roman font.
\end_layout
\begin_layout Itemize
\family sans
-Right\InsetSpace ~
-Footer
+Foil
+\family default
+TeX supports A4 and Letter paper sizes as well as a special size for working
+ with 35mm slides.
+ It doesn't support A5, B5, legal or executive paper sizes.
\end_layout
\begin_layout Itemize
-
+Don't bother changing the
\family sans
-Right\InsetSpace ~
-Header
+Float Placement
+\family default
+ settings because they are ignored anyway.
+ All floats appear where they are defined in the text.
\end_layout
\begin_layout Itemize
-
+The
\family sans
-Left\InsetSpace ~
-Header
-\end_layout
+\bar under
+P
+\bar default
+agestyle
+\family default
+ setting behaves a bit differently for this class.
+
+\family sans
+Foil
+\family default
+TeX provides extensive footer and header capabilities including a user-defined
+ logo.
+ See section\InsetSpace ~
-\begin_deeper
-\begin_layout Standard
-\InsetSpace ~
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foilfoot"
+
+\end_inset
+ for more details.
+ The title page is treated differently to all other pages in the document
+ and is
+\emph on
+always
+\emph default
+ unnumbered and
+\emph on
+always
+\emph default
+ has the logo centered at the bottom of the page (if one is defined).
+ The possible page style choices and what they do are as follows:
\end_layout
-\end_deeper
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\begin_deeper
+\begin_layout List
+\labelwidthstring MMMMMMM
-\begin_layout Standard
+\family sans
+\series bold
+empty
+\family default
+\series default
+ The final output contains no page numbers, or other headers or footers
+ (except footnotes of course).
+
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMM
-\backslash
-end{multicols}
+\family sans
+\series bold
+plain
+\family default
+\series default
+ The final output contains page numbers centered at the bottom of the page.
+ No other headings or footers (other than footnotes).
\end_layout
-\end_inset
-
+\begin_layout List
+\labelwidthstring MMMMMMM
+\series bold
+foilheadings
+\series default
+ Page numbers in lower right corner.
+ Additional headers and footers are also shown.
+ This is also the default.
\end_layout
-\begin_layout Standard
-There are also a few commands provided by
+\begin_layout List
+\labelwidthstring MMMMMMM
+
+\series bold
+fancy
+\series default
+ Gives you access to the
+\family sans
+fancyheadings
+\family default
+ package although its use with
\family sans
Foil
\family default
-TeX that aren't directly supported by LyX but I'll tell you what they do
- and how to use them in section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:unsuppfoils"
-
-\end_inset
-
-.
+TeX is discouraged by the writer of the
+\family sans
+Foil
+\family default
+TeX package because of some potential page layout clashes.
\end_layout
-\begin_layout Subsection
-Building a Set of Foils
+\end_deeper
+\begin_layout Subsubsection
+Extra Options
\end_layout
\begin_layout Standard
-This section will give a simple introduction to using the different environments
- to build a set of foils.
- If you want to see an example set of foils take a look at the
-\family typewriter
-Foils.lyx
-\family default
- file accessible from the
+The following options may be used in the extra class options in the
\family sans
\bar under
-F
+D
\bar default
-ile\SpecialChar \menuseparator
+ocument\SpecialChar \menuseparator
\bar under
-O
+S
\bar default
-pen\SpecialChar \ldots{}
-
-\family default
- dialog under the
-\family sans
-Examples
+ettings
\family default
- button.
-
+ dialog.
\end_layout
-\begin_layout Subsubsection
-Give It a Title Page
+\begin_layout List
+\labelwidthstring MMMMMMx
+
+\series bold
+35mmSlide
+\series default
+ This sets up the page layout for 7.33in by 11in paper, which is about the
+ same aspect ratio as a 35mm slide, making it a bit easier to work with
+ this medium.
\end_layout
-\begin_layout Standard
-Unlike other classes that provide
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
+\begin_layout List
+\labelwidthstring MMMMMMx
+
+\series bold
+headrule
+\series default
+ Places a rule across the page below the header on every page except the
+ title page.
+\end_layout
+
+\begin_layout List
+\labelwidthstring MMMMMMx
+
+\series bold
+footrule
+\series default
+ Places a rule across the page above the footer on every page except the
+ title page.
+\end_layout
+
+\begin_layout List
+\labelwidthstring MMMMMMx
+
+\series bold
+dvips
+\series default
+ This is automatically set each time you create a new
\family sans
-Date
+foils
\family default
- and
+ document.
+ This option tells
\family sans
-Abstract
+Foil
\family default
- environments,
+TeX to use the dvips driver to rotate those pages that are set as landscape
+ foils.
+\end_layout
+
+\begin_layout List
+\labelwidthstring MMMMMMx
+
+\series bold
+landscape
+\series default
+ Simply changes the page dimensions to those of a landscape page but doesn't
+ do any rotation.
+ Thus if you use this option you need to use an external program to rotate
+ each page or feed your paper through your printer as landscape.
+ Note that this option effectively reverses the roles of the
\family sans
-foils
-\family default
- creates the title on a page of its own.
- If you leave out the
+Foilhead
+\family default
+ and
\family sans
-Date
+Rotatefoilhead
\family default
- environment LaTeX will substitute the current date (every time you regenerate
- the output).
+ environments (don't worry these are described in the next section).
\end_layout
-\begin_layout Subsubsection
-Start a New Foil
+\begin_layout List
+\labelwidthstring MMMMMMx
+
+\series bold
+leqno
+\series default
+ Equation numbers on the left.
\end_layout
-\begin_layout Standard
-As I mentioned earlier, there are four ways of starting a new foil.
- For portrait foils you should use
-\family sans
-Foilhead
-\family default
- or
-\family sans
-ShortFoilhead.
+\begin_layout List
+\labelwidthstring MMMMMMx
-\family default
- The difference between these two environments is the amount of space between
- the title of the foil (the foilhead) and the body of the foil.
+\series bold
+fleqn
+\series default
+ Flush-left equations.
+\end_layout
+
+\begin_layout Subsection
+Supported Environments
\end_layout
\begin_layout Standard
-Landscape foils are generated using the
+Most of the environments commonly supported in other classes are also supported
+ by the
\family sans
-Rotatefoilhead
+foils
\family default
- and
+ class.
+ There are several additional environments provided by
\family sans
-ShortRotatefoilhead
+Foil
\family default
- environments.
- Again the only difference is the spacing between foilhead and body.
- Both of the short versions have 0.5 inches less separation between the foilhead
- and the body.
-
+TeX as well as a couple added by LyX.
+ The following environments are shared with other classes:
\end_layout
\begin_layout Standard
-One problem with the support for landscape foils is the requirement that
- you have to use the
-\family typewriter
-dvips
-\family default
- driver to generate the PostScript output otherwise the foils won't be rotated.
- It is possible to get landscape foils even if you haven't got the
-\family typewriter
-dvips
-\family default
- driver provided you can feed your foils sideways through your printer ;-)
-\end_layout
-
-\begin_layout Subsubsection
-Theorems, Lemmas, Proofs and more
-\end_layout
+\begin_inset ERT
+status open
\begin_layout Standard
-Due to a small bug in LyX you can't have two of the same type of these environme
-nts directly following each other.
- They must be separated by something.
- If you try, you will just be extending the previous environment as if you
- had merged the two environments together.
- So, how do you get around this problem? The simplest option is to insert
- some text between the two environments or add a
-\family sans
-LaTeX
-\family default
- environment between the two with just a
-\begin_inset Quotes eld
-\end_inset
-\family typewriter
-%
-\family default
+\backslash
+begin{multicols}{2}
+\end_layout
-\begin_inset Quotes erd
\end_inset
- in it.
- This will force LyX to produce two separate environments and hence the
- correct LaTeX output.
- An example is provided in the example file included with the LyX distribution.
- Remember, this problem only occurs if you are trying to place two of the
- same type of theorem-like environments one directly after the other.
-\end_layout
-\begin_layout Subsubsection
-Lists
\end_layout
-\begin_layout Standard
-You get all the commonly supported list styles found in other classes as
- well as two new ones.
- I'll only describe the new ones here.
- If you want to find out more about the other list environments check out
- the
-\emph on
-User's Guide.
+\begin_layout Itemize
-\emph default
- If you intend to use itemized lists you might also want to read about the
-
\family sans
-Itemize\InsetSpace ~
-Bullet\InsetSpace ~
-Selection
-\family default
- dialog described above in section\InsetSpace ~
+Standard
+\end_layout
-\begin_inset LatexCommand ref
-reference "sec:bullet"
+\begin_layout Itemize
-\end_inset
+\family sans
+Itemize
+\end_layout
-.
+\begin_layout Itemize
+
+\family sans
+Enumerate
\end_layout
-\begin_layout Standard
-The two new list styles,
+\begin_layout Itemize
+
\family sans
-TickList
-\family default
- and
+Description
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-CrossList
-\family default
-, are designed to make it easier for you to create lists of do's and don'ts
- or right and wrong by providing dedicated environments that use a tick
- or a cross as the label of the list.
- These lists are in fact dedicated variants of the
+List
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Itemize
-\family default
- environment.
- They do however require that you have the
-\family typewriter
-psnfss
-\family default
- packages installed.
+LyX-Code
\end_layout
-\begin_layout Subsubsection
-Figures and Tables
+\begin_layout Itemize
+
+\family sans
+Verse
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\family sans
-Foil
-\family default
-TeX redefines the floating tables and figures so that they appear exactly
- where they are in the text rather than pushing them to the top of the page
- or to some user specified location.
- In fact if you change the float placement settings they are simply ignored.
+Quote
\end_layout
-\begin_layout Subsubsection
-Page Headers and Footers
-\begin_inset LatexCommand label
-name "sec:foilfoot"
+\begin_layout Itemize
-\end_inset
+\family sans
+Quotation
+\end_layout
+\begin_layout Itemize
+\family sans
+Title
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\family sans
-My\InsetSpace ~
-Logo
-\family default
- and
+Author
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Restriction
-\family default
- are two commands used to control the left-footer text string.
- The first is meant to allow you to include a graphic logo on your foils
- and defaults to
-\begin_inset Quotes eld
-\end_inset
+Date
+\end_layout
+
+\begin_layout Itemize
--Typeset by
\family sans
-Foil
-\family default
-TeX-
-\begin_inset Quotes erd
-\end_inset
+Abstract
+\end_layout
-.
- While the second is meant to provide a classification for the audience,
-
-\emph on
-e.\InsetSpace \thinspace{}
-g.
-\emph default
-\InsetSpace ~
-Confidential.
- It is empty by default.
+\begin_layout Itemize
+
+\family sans
+Bibliography
\end_layout
-\begin_layout Standard
-The remaining page corners can be filled by
+\begin_layout Itemize
+
\family sans
-Right\InsetSpace ~
-Footer
-\family default
- (which defaults to page numbers),
+Address
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Right\InsetSpace ~
-Header
-\family default
- (top right) and
+RightAddress
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Left\InsetSpace ~
-Header
-\family default
- (top left).
+Caption
\end_layout
-\begin_layout Subsection
-Unsupported
+\begin_layout Itemize
+
\family sans
-Foil
-\family default
-TeX Goodies
-\begin_inset LatexCommand label
-name "sec:unsuppfoils"
+Comment
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Standard
+
+
+\backslash
+end{multicols}
+\end_layout
\end_inset
\end_layout
\begin_layout Standard
-All the commands mentioned below need to be set in a
+That is, all the major environments apart from the sectioning environments.
+ Since foils are essentially self-contained sections, with a title and body,
+
\family sans
-LaTeX
+Foil
\family default
- environment or as
+TeX provides specific commands for starting new foils and these are:
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-TeX
-\family default
- within another environment.
+Foilhead
\end_layout
-\begin_layout Subsubsection
-Lengths
+\begin_layout Itemize
+
+\family sans
+Rotatefoilhead
\end_layout
\begin_layout Standard
-All lengths are adjusted using the
-\family typewriter
+LyX also provides slightly modified versions of these two environments called:
+\end_layout
-\backslash
-setlength{
-\family default
-\emph on
-lengthname
-\family typewriter
-\emph default
-}{
-\family default
-\emph on
-newlength
-\family typewriter
-\emph default
-}
-\family default
- command.
- Where
-\emph on
-lengthname
-\emph default
- should be replaced by the name given to the length you want to change and
-
-\emph on
-newlength
-\emph default
- is the length value.
- All lengths should be specified in units of length such as inches (
-\family typewriter
-in
-\family default
-), millimeters (
-\family typewriter
-mm
-\family default
-) or points (
-\family typewriter
-pt
-\family default
-) or relative to some document or font-based length such as
-\family typewriter
+\begin_layout Itemize
-\backslash
-textwidth
-\family default
-.
-
+\family sans
+ShortFoilhead
\end_layout
-\begin_layout Standard
-It's possible to change the spacing between a foilhead and the body of the
- foil by adjusting the length specified by
-\family typewriter
-
-\backslash
-foilheadskip
-\family default
-.
- For example, to make
-\emph on
-all
-\emph default
- foilheads 0.5 inches closer to their bodies put the following in the preamble:
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-setlength{
-\backslash
-foilheadskip}{-0.5in}
+\family sans
+ShortRotatefoilhead
\end_layout
\begin_layout Standard
-The spacings around floats can be adjusted by setting these lengths:
+and the differences will be explained in the next section.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-\family typewriter
-
-\backslash
-abovefloatskip
+\begin_layout Standard
+Since foils are often used in presenting ideas or new theorems and such
+
+\family sans
+Foil
\family default
- Separation between the text and the top of the float
+TeX also provides a comprehensive box of goodies for presenting them:
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Standard
-\family typewriter
\backslash
-abovecaptionskip
-\family default
- Separation between the float and the caption
+begin{multicols}{2}
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+\end_inset
-\family typewriter
-\backslash
-belowcaptionskip
-\family default
- Separation between the caption and the following text
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+\begin_layout Itemize
-\family typewriter
+\family sans
+Theorem
+\end_layout
-\backslash
-captionwidth
-\family default
- You can make the captions narrower than the surrounding text by adjusting
- this length.
- Best done relative to
-\family typewriter
+\begin_layout Itemize
-\backslash
-textwidth
-\family default
-.
+\family sans
+Lemma
\end_layout
-\begin_layout Standard
-There are also several title page related lengths that you may find useful
- if you have a long title or several authors:
-\end_layout
+\begin_layout Itemize
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+\family sans
+Corollary
+\end_layout
-\family typewriter
+\begin_layout Itemize
-\backslash
-abovetitleskip
-\family default
- Separation from headers to
\family sans
-Title
+Proposition
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-titleauthorskip
-\family default
- between
-\family sans
-Title
-\family default
- and
\family sans
-Author
-\family default
- environments
+Definition
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-authorauthorskip
-\family default
- between multiple
\family sans
-Author
-\family default
- lines
+Proof
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-authordateskip
-\family default
- between the
\family sans
-Author
-\family default
- and the
+Theorem*
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Date
+Lemma*
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+\begin_layout Itemize
-\family typewriter
+\family sans
+Corollary*
+\end_layout
+
+\begin_layout Itemize
-\backslash
-dateabstractskip
-\family default
- between the
\family sans
-Date
-\family default
- and the
+Proposition*
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Abstract
+Definition*
\end_layout
\begin_layout Standard
-The last length related command affects all the list environments.
- If you place
-\family typewriter
+\begin_inset ERT
+status open
+
+\begin_layout Standard
-\backslash
-zerolistvertdimens
-\family default
-
-\emph on
-inside
-\emph default
- a list environment then all the vertical spacing between the list items
- is removed.
- Note that this is a command not a length so it doesn't require
-\family typewriter
\backslash
-setlength
-\family default
- like the stuff mentioned above.
+end{multicols}
\end_layout
-\begin_layout Subsubsection
-Headers and Footers
+\end_inset
+
+
\end_layout
\begin_layout Standard
-The
-\family typewriter
+The starred versions are unnumbered while the unstarred versions are numbered.
+ There are also two list environments added by LyX and these are:
+\end_layout
-\backslash
-LogoOn
-\family default
- and
-\family typewriter
+\begin_layout Itemize
-\backslash
-LogoOff
-\family default
- commands control whether the logo in the
\family sans
-MyLogo
-\family default
- definition appear on a given page.
- If you put
-\family typewriter
-
-\backslash
-LogoOff
-\family default
- in the preamble then none of the foils will have the logo on them.
- If you don't want the logo on a particular page place the
-\family typewriter
+TickList
+\end_layout
-\backslash
-LogoOff
-\family default
- directly after the foilhead of that page and the
-\family typewriter
+\begin_layout Itemize
-\backslash
-LogoOn
-\family default
- directly after the next foilhead.
+\family sans
+CrossList
\end_layout
\begin_layout Standard
-If you decide to use the
-\family sans
-fancy
-\family default
- page style setting in the
-\family sans
-Document\InsetSpace ~
-Layout
-\family default
- dialog you should probably add
-\family typewriter
-\backslash
-let
-\backslash
-headwidth
-\backslash
-textwidth
-\family default
- to your preamble so headers and footers on landscape pages are correctly
- placed when rotated.
- This is due to some clashes between the page layouts provided by the
-\family sans
-fancyheadings
-\family default
- package and the
\family sans
-foils
+Foil
\family default
- class.
-\end_layout
+TeX provides some powerful header and footer capabilities that are best
+ set in the preamble although they may be set at any point in a document.
+ If you want to change these settings in your document the best place to
+ do so is at the very top of a foil,
+\emph on
+i.e.
-\begin_layout Section
-Latex8 (IEEE Conference Papers)
+\emph default
+ straight after the foilhead.
\end_layout
\begin_layout Standard
-by
-\noun on
-Allan Rae
+For this purpose, the following command styles are provided [
+\shape smallcaps
+Martin Vermeer
+\shape default
+]:
\end_layout
-\begin_layout Subsection
-Introduction
-\end_layout
+\begin_layout Standard
+\begin_inset ERT
+status open
\begin_layout Standard
-Since this class is specifically for writing submissions to IEEE sponsored
- conferences I strongly recommend that you get a copy of their Authors Kit.
- The
-\family sans
-latex.sty
-\family default
- package and associated bibliography style file is included in the kit.
- The Authors Kit is usually sent out by email once your initial submission
- has been accepted.
- There is a lot of useful information in the Authors Kit explaining formatting
- restrictions and so on and I will assume you have read this since that
- means I don't have to repeat it all here.
-\end_layout
-\begin_layout Subsection
-Getting Started
-\end_layout
-\begin_layout Standard
-[AR\SpecialChar \@.
- more to come]
+\backslash
+begin{multicols}{2}
\end_layout
-\begin_layout Subsection
-Supported Environments
+\end_inset
+
+
\end_layout
\begin_layout Itemize
\family sans
-Standard
+My\InsetSpace ~
+Logo
\end_layout
\begin_layout Itemize
\family sans
-Title
+Restriction
\end_layout
\begin_layout Itemize
\family sans
-Author
+Right\InsetSpace ~
+Footer
\end_layout
\begin_layout Itemize
\family sans
-E-mail
+Right\InsetSpace ~
+Header
\end_layout
\begin_layout Itemize
\family sans
-Affiliation
+Left\InsetSpace ~
+Header
\end_layout
-\begin_layout Itemize
+\begin_deeper
+\begin_layout Standard
+\InsetSpace ~
+
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Standard
+
+
+\backslash
+end{multicols}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+There are also a few commands provided by
+\family sans
+Foil
+\family default
+TeX that aren't directly supported by LyX but I'll tell you what they do
+ and how to use them in section\InsetSpace ~
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:unsuppfoils"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Building a Set of Foils
+\end_layout
+
+\begin_layout Standard
+This section will give a simple introduction to using the different environments
+ to build a set of foils.
+ If you want to see an example set of foils take a look at the
+\family typewriter
+Foils.lyx
+\family default
+ file accessible from the
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
+
+\bar under
+O
+\bar default
+pen\SpecialChar \ldots{}
+
+\family default
+ dialog under the
+\family sans
+Examples
+\family default
+ button.
+
+\end_layout
+
+\begin_layout Subsubsection
+Give It a Title Page
+\end_layout
+\begin_layout Standard
+Unlike other classes that provide
+\family sans
+Title
+\family default
+,
+\family sans
+Author
+\family default
+,
+\family sans
+Date
+\family default
+ and
\family sans
Abstract
-\end_layout
-
-\begin_layout Itemize
-
+\family default
+ environments,
\family sans
-Section
-\end_layout
-
-\begin_layout Itemize
-
+foils
+\family default
+ creates the title on a page of its own.
+ If you leave out the
\family sans
-SubSection
+Date
+\family default
+ environment LaTeX will substitute the current date (every time you regenerate
+ the output).
\end_layout
-\begin_layout Itemize
+\begin_layout Subsubsection
+Start a New Foil
+\end_layout
+\begin_layout Standard
+As I mentioned earlier, there are four ways of starting a new foil.
+ For portrait foils you should use
\family sans
-Caption
-\end_layout
+Foilhead
+\family default
+ or
+\family sans
+ShortFoilhead.
-\begin_layout Subsection
-Differences Between Screen and Paper
+\family default
+ The difference between these two environments is the amount of space between
+ the title of the foil (the foilhead) and the body of the foil.
\end_layout
\begin_layout Standard
-There are slight differences in appearance mainly with the presentation
- of section counters.
- On screen the trailing period of the section counter is missing but it
- will appear in the output so don't let this worry you.
-\end_layout
-
-\begin_layout Section
-Hollywood (Hollywood spec scripts)
+Landscape foils are generated using the
+\family sans
+Rotatefoilhead
+\family default
+ and
+\family sans
+ShortRotatefoilhead
+\family default
+ environments.
+ Again the only difference is the spacing between foilhead and body.
+ Both of the short versions have 0.5 inches less separation between the foilhead
+ and the body.
+
\end_layout
\begin_layout Standard
-by
-\shape smallcaps
-Garst Reese
+One problem with the support for landscape foils is the requirement that
+ you have to use the
+\family typewriter
+dvips
+\family default
+ driver to generate the PostScript output otherwise the foils won't be rotated.
+ It is possible to get landscape foils even if you haven't got the
+\family typewriter
+dvips
+\family default
+ driver provided you can feed your foils sideways through your printer ;-)
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Subsubsection
+Theorems, Lemmas, Proofs and more
\end_layout
\begin_layout Standard
-Getting the format of a Hollywood script right is a
+Due to a small bug in LyX you can't have two of the same type of these environme
+nts directly following each other.
+ They must be separated by something.
+ If you try, you will just be extending the previous environment as if you
+ had merged the two environments together.
+ So, how do you get around this problem? The simplest option is to insert
+ some text between the two environments or add a
+\family sans
+LaTeX
+\family default
+ environment between the two with just a
\begin_inset Quotes eld
\end_inset
-rite of passage.
+
+\family typewriter
+%
+\family default
+
\begin_inset Quotes erd
\end_inset
- It is designed to make the readers focus on content and to be easy and
- familiar for the actors to read.
- Each page of a script should be one minute of film.
- Nothing goes in a script that you cannot see or hear on screen.
- The courier 12 pt font should be used throughout.
- No italics.
+ in it.
+ This will force LyX to produce two separate environments and hence the
+ correct LaTeX output.
+ An example is provided in the example file included with the LyX distribution.
+ Remember, this problem only occurs if you are trying to place two of the
+ same type of theorem-like environments one directly after the other.
\end_layout
-\begin_layout Subsection
-Special problems
+\begin_layout Subsubsection
+Lists
\end_layout
\begin_layout Standard
-Speakers' lines should NEVER break in mid-sentence.
- If a speaker's lines continue over a page break, repeat the
+You get all the commonly supported list styles found in other classes as
+ well as two new ones.
+ I'll only describe the new ones here.
+ If you want to find out more about the other list environments check out
+ the
+\emph on
+User's Guide.
+
+\emph default
+ If you intend to use itemized lists you might also want to read about the
+
\family sans
-Speaker
+Itemize\InsetSpace ~
+Bullet\InsetSpace ~
+Selection
\family default
- title followed by (Cont'd).
-\end_layout
+ dialog described above in section\InsetSpace ~
-\begin_layout Subsection
-Special features
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:bullet"
+
+\end_inset
+
+.
\end_layout
\begin_layout Standard
-Insert the
+The two new list styles,
\family sans
-Speaker
+TickList
\family default
- names as labels then cross-reference the label to insert the name.
- The cross-reference dialog will show the current cast of characters.
- You can use this to insert the speaker name in narratives also.
+ and
+\family sans
+CrossList
+\family default
+, are designed to make it easier for you to create lists of do's and don'ts
+ or right and wrong by providing dedicated environments that use a tick
+ or a cross as the label of the list.
+ These lists are in fact dedicated variants of the
+\family sans
+Itemize
+\family default
+ environment.
+ They do however require that you have the
+\family typewriter
+psnfss
+\family default
+ packages installed.
\end_layout
-\begin_layout Subsection
-Paper size and Margins
+\begin_layout Subsubsection
+Figures and Tables
\end_layout
\begin_layout Standard
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
-\end_layout
-\begin_layout Subsection
-Environments
+\family sans
+Foil
+\family default
+TeX redefines the floating tables and figures so that they appear exactly
+ where they are in the text rather than pushing them to the top of the page
+ or to some user specified location.
+ In fact if you change the float placement settings they are simply ignored.
\end_layout
-\begin_layout Standard
-The following environments are available.
- You can use hollywood.bind to get the bind keys shown at the right.
+\begin_layout Subsubsection
+Page Headers and Footers
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foilfoot"
+
+\end_inset
+
+
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
\family sans
-Standard
-\newline
+My\InsetSpace ~
+Logo
+\family default
+ and
+\family sans
+Restriction
+\family default
+ are two commands used to control the left-footer text string.
+ The first is meant to allow you to include a graphic logo on your foils
+ and defaults to
+\begin_inset Quotes eld
+\end_inset
+-Typeset by
+\family sans
+Foil
\family default
-Used where nothing else works.
- Try to avoid it.
-\end_layout
+TeX-
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+.
+ While the second is meant to provide a classification for the audience,
+
+\emph on
+e.\InsetSpace \thinspace{}
+g.
+\emph default
+\InsetSpace ~
+Confidential.
+ It is empty by default.
+\end_layout
+\begin_layout Standard
+The remaining page corners can be filled by
\family sans
-FADE_IN
+Right\InsetSpace ~
+Footer
\family default
-:
-\hfill
-
+ (which defaults to page numbers),
\family sans
-M-z S-I
+Right\InsetSpace ~
+Header
+\family default
+ (top right) and
+\family sans
+Left\InsetSpace ~
+Header
\family default
+ (top left).
+\end_layout
-\newline
-Usually followed by something like
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsection
+Unsupported
+\family sans
+Foil
+\family default
+TeX Goodies
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:unsuppfoils"
-on Sally waking up.
-\begin_inset Quotes erd
\end_inset
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+All the commands mentioned below need to be set in a
\family sans
-INT:
-\hfill
-M-z i
-\newline
-
+LaTeX
\family default
-Introduces a new INTERIOR camera set-up.
- Always followed by DAY or NIGHT, or something similar to define the lighting
- required.
- Everthing on this line in CAPS.
-\end_layout
-
-\begin_layout Itemize
-
+ environment or as
\family sans
-EXT:
-\hfill
-M-z e
-\newline
-
+TeX
\family default
-Introduces a new EXTERIOR camera set-up.
- Everthing on this line in CAPS.
+ within another environment.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Speaker
-\hfill
-M-z s
-\newline
-
-\family default
-The character speaking.
+\begin_layout Subsubsection
+Lengths
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+All lengths are adjusted using the
+\family typewriter
-\family sans
-Parenthetical
-\hfill
-M-z p
-\newline
+\backslash
+setlength{
+\family default
+\emph on
+lengthname
+\family typewriter
+\emph default
+}{
+\family default
+\emph on
+newlength
+\family typewriter
+\emph default
+}
+\family default
+ command.
+ Where
+\emph on
+lengthname
+\emph default
+ should be replaced by the name given to the length you want to change and
+
+\emph on
+newlength
+\emph default
+ is the length value.
+ All lengths should be specified in units of length such as inches (
+\family typewriter
+in
+\family default
+), millimeters (
+\family typewriter
+mm
+\family default
+) or points (
+\family typewriter
+pt
+\family default
+) or relative to some document or font-based length such as
+\family typewriter
+\backslash
+textwidth
\family default
-Instructions to the speaker.
- The () are automatically inserted, but only the ( will show in LyX.
- Both will be printed.
+.
+
\end_layout
-\begin_layout Itemize
-
-\family sans
-Dialogue
-\hfill
-M-z d
-\newline
+\begin_layout Standard
+It's possible to change the spacing between a foilhead and the body of the
+ foil by adjusting the length specified by
+\family typewriter
+\backslash
+foilheadskip
\family default
-What the
-\family sans
-Speaker
-\family default
- says.
+.
+ For example, to make
+\emph on
+all
+\emph default
+ foilheads 0.5 inches closer to their bodies put the following in the preamble:
+
+\family typewriter
+
+\backslash
+setlength{
+\backslash
+foilheadskip}{-0.5in}
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+The spacings around floats can be adjusted by setting these lengths:
+\end_layout
-\family sans
-Transition
-\hfill
-M-z t
-\newline
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+\backslash
+abovefloatskip
\family default
-Camera movement instruction.
- e.\InsetSpace \thinspace{}
-g.\InsetSpace ~
-CUT TO:
+ Separation between the text and the top of the float
\end_layout
-\begin_layout Itemize
-
-\family sans
-FADE OUT:
-\hfill
-M-z S-I
-\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\begin_layout Itemize
+\family typewriter
-\family sans
-Author
-\hfill
-M-z S-A
+\backslash
+abovecaptionskip
+\family default
+ Separation between the float and the caption
\end_layout
-\begin_layout Itemize
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\family sans
-Title
-\hfill
-M-z S-T
+\family typewriter
+
+\backslash
+belowcaptionskip
+\family default
+ Separation between the caption and the following text
\end_layout
-\begin_layout Itemize
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\family sans
-Right_Address
-\hfill
-M-z r
-\end_layout
+\family typewriter
-\begin_layout Subsection
-Script jargon
-\end_layout
+\backslash
+captionwidth
+\family default
+ You can make the captions narrower than the surrounding text by adjusting
+ this length.
+ Best done relative to
+\family typewriter
-\begin_layout Itemize
-(O.S) --- off screen
+\backslash
+textwidth
+\family default
+.
\end_layout
-\begin_layout Itemize
-(V.0) --- voice over
+\begin_layout Standard
+There are also several title page related lengths that you may find useful
+ if you have a long title or several authors:
\end_layout
-\begin_layout Itemize
-b.g.
- --- background
-\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\begin_layout Itemize
-C.U.
- --- close-up
-\end_layout
+\family typewriter
-\begin_layout Itemize
-PAN --- camera movement
+\backslash
+abovetitleskip
+\family default
+ Separation from headers to
+\family sans
+Title
\end_layout
-\begin_layout Itemize
-INSERT --- cut to close-up of
-\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\begin_layout Section
-Broadway
-\end_layout
+\family typewriter
-\begin_layout Standard
-by
-\shape smallcaps
-Garst Reese
+\backslash
+titleauthorskip
+\family default
+ between
+\family sans
+Title
+\family default
+ and
+\family sans
+Author
+\family default
+ environments
\end_layout
-\begin_layout Subsection
-Introduction
-\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\begin_layout Standard
-Broadway is for writing plays.
- The format is more decorative than Hollywood, and much less standardized.
- This format should be suitable for workshops.
-\end_layout
+\family typewriter
-\begin_layout Subsection
-Special problems
+\backslash
+authorauthorskip
+\family default
+ between multiple
+\family sans
+Author
+\family default
+ lines
\end_layout
-\begin_layout Standard
-The same as in Hollywood.
-\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\begin_layout Subsection
-Special features
-\end_layout
+\family typewriter
-\begin_layout Standard
-Insert the
+\backslash
+authordateskip
+\family default
+ between the
\family sans
-Speaker
+Author
\family default
- names as labels then cross-reference the label to insert the name.
- The cross-reference dialog will show the current cast of characters.
+ and the
+\family sans
+Date
\end_layout
-\begin_layout Subsection
-Paper size and Margins
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+dateabstractskip
+\family default
+ between the
+\family sans
+Date
+\family default
+ and the
+\family sans
+Abstract
\end_layout
\begin_layout Standard
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+The last length related command affects all the list environments.
+ If you place
+\family typewriter
+
+\backslash
+zerolistvertdimens
+\family default
+
+\emph on
+inside
+\emph default
+ a list environment then all the vertical spacing between the list items
+ is removed.
+ Note that this is a command not a length so it doesn't require
+\family typewriter
+
+\backslash
+setlength
+\family default
+ like the stuff mentioned above.
\end_layout
-\begin_layout Subsection
-Environments
+\begin_layout Subsubsection
+Headers and Footers
\end_layout
\begin_layout Standard
-The following environments are available.
- You can use broadway.bind to get the bind keys shown at the right.
-\end_layout
+The
+\family typewriter
-\begin_layout Itemize
+\backslash
+LogoOn
+\family default
+ and
+\family typewriter
+\backslash
+LogoOff
+\family default
+ commands control whether the logo in the
\family sans
-Standard
-\newline
-
+MyLogo
\family default
-You should not have to use this, but it is here for anything that does not
- fit otherwise.
-\end_layout
+ definition appear on a given page.
+ If you put
+\family typewriter
-\begin_layout Itemize
+\backslash
+LogoOff
+\family default
+ in the preamble then none of the foils will have the logo on them.
+ If you don't want the logo on a particular page place the
+\family typewriter
-\family sans
-Narrative
-\hfill
-M-z n
-\newline
+\backslash
+LogoOff
+\family default
+ directly after the foilhead of that page and the
+\family typewriter
+\backslash
+LogoOn
\family default
-Used to describe stage setting and the action.
- First use of speaker names in all CAPs.
+ directly after the next foilhead.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+If you decide to use the
\family sans
-ACT
-\hfill
-M-z a
-\newline
-
+fancy
\family default
-Automatically numbered.
- On screen it will be arabic, but will print as Roman.
-\end_layout
-
-\begin_layout Itemize
-
+ page style setting in the
\family sans
-ACT*
-\hfill
-M-z S at
-\newline
+Document\InsetSpace ~
+Layout
+\family default
+ dialog you should probably add
+\family typewriter
+\backslash
+let
+\backslash
+headwidth
+\backslash
+textwidth
\family default
-Subtitle for
+ to your preamble so headers and footers on landscape pages are correctly
+ placed when rotated.
+ This is due to some clashes between the page layouts provided by the
\family sans
-ACT.
-
+fancyheadings
\family default
- It is just centered text.
+ package and the
+\family sans
+foils
+\family default
+ class.
\end_layout
-\begin_layout Itemize
-
-\family sans
-SCENE
-\hfill
-M-z S-S
-\newline
+\begin_layout Section
+Latex8 (IEEE Conference Papers)
+\end_layout
-\family default
-Not automatically numbered.
- You supply the number.
- This is because I couldn't figure out how.
+\begin_layout Standard
+by
+\noun on
+Allan Rae
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Introduction
+\end_layout
+\begin_layout Standard
+Since this class is specifically for writing submissions to IEEE sponsored
+ conferences I strongly recommend that you get a copy of their Authors Kit.
+ The
\family sans
-AT_RISE:
-\hfill
-M-z S-R
-\newline
-
+latex.sty
\family default
-A special case of Narrative to describe the setting and action as the curtain
- rises.
+ package and associated bibliography style file is included in the kit.
+ The Authors Kit is usually sent out by email once your initial submission
+ has been accepted.
+ There is a lot of useful information in the Authors Kit explaining formatting
+ restrictions and so on and I will assume you have read this since that
+ means I don't have to repeat it all here.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Getting Started
+\end_layout
-\family sans
-Speaker
-\hfill
-M-z s
-\newline
+\begin_layout Standard
+[AR\SpecialChar \@.
+ more to come]
+\end_layout
-\family default
-The speaker's (actor's) title, centered in all CAPS.
+\begin_layout Subsection
+Supported Environments
\end_layout
\begin_layout Itemize
\family sans
-Parenthetical
-\hfill
-M-z p
-\newline
+Standard
+\end_layout
+
+\begin_layout Itemize
-\family default
-Instructions to the speaker.
- The parentheses are automatically inserted.
- The ( will appear on screen, but both will be in the printed play.
- This environment is only used within
\family sans
-Dialogue
-\family default
-.
+Title
\end_layout
\begin_layout Itemize
\family sans
-Dialogue
-\hfill
-M-z d
-\newline
+Author
+\end_layout
-\family default
-What the Speaker says.
+\begin_layout Itemize
+
+\family sans
+E-mail
\end_layout
\begin_layout Itemize
\family sans
-CURTAIN
-\hfill
-M-z S-C
-\newline
+Affiliation
+\end_layout
-\family default
-The curtain comes down.
+\begin_layout Itemize
+
+\family sans
+Abstract
\end_layout
\begin_layout Itemize
\family sans
-Title
-\hfill
-M-z S-T
+Section
\end_layout
\begin_layout Itemize
\family sans
-Author
-\hfill
-M-z S-A
+SubSection
\end_layout
\begin_layout Itemize
\family sans
-Right_Address
-\hfill
-M-z r
+Caption
+\end_layout
+
+\begin_layout Subsection
+Differences Between Screen and Paper
\end_layout
\begin_layout Standard
-Hello there.
+There are slight differences in appearance mainly with the presentation
+ of section counters.
+ On screen the trailing period of the section counter is missing but it
+ will appear in the output so don't let this worry you.
\end_layout
\begin_layout Section
-RevTeX4
+Hollywood (Hollywood spec scripts)
\end_layout
\begin_layout Standard
by
-\noun on
-Amir Karger
+\shape smallcaps
+Garst Reese
+\end_layout
+
+\begin_layout Subsection
+Introduction
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
+Getting the format of a Hollywood script right is a
+\begin_inset Quotes eld
+\end_inset
+
+rite of passage.
+\begin_inset Quotes erd
\end_inset
+ It is designed to make the readers focus on content and to be easy and
+ familiar for the actors to read.
+ Each page of a script should be one minute of film.
+ Nothing goes in a script that you cannot see or hear on screen.
+ The courier 12 pt font should be used throughout.
+ No italics.
+\end_layout
+\begin_layout Subsection
+Special problems
\end_layout
\begin_layout Standard
-\noindent
-The
+Speakers' lines should NEVER break in mid-sentence.
+ If a speaker's lines continue over a page break, repeat the
\family sans
-Revtex\InsetSpace ~
-4
+Speaker
\family default
- textclass works with the American Physical Sociey's RevTeX 4.0 (the
-\begin_inset Formula $\beta$
-\end_inset
+ title followed by (Cont'd).
+\end_layout
- release of May, 1999) class.
+\begin_layout Subsection
+Special features
\end_layout
\begin_layout Standard
-LyX has a
-\family sans
-Revtex
-\family default
- textclass, which works with RevTeX 3.1.
- However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
- That means that it doesn't interact very well with LyX, which requires
- LaTeX2e, although it has been kludged to work.
- Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
- LyX with the
+Insert the
\family sans
-RevTeX\InsetSpace ~
-4
+Speaker
\family default
- textclass should also be pretty easy to use.
+ names as labels then cross-reference the label to insert the name.
+ The cross-reference dialog will show the current cast of characters.
+ You can use this to insert the speaker name in narratives also.
+\end_layout
+
+\begin_layout Subsection
+Paper size and Margins
\end_layout
\begin_layout Standard
-These documents are supposed to be used in
-\emph on
-addition
-\emph default
- to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
- macros, and assume you'll know what to put in the preamble if necessary.
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
\end_layout
\begin_layout Subsection
-Installation
+Environments
\end_layout
\begin_layout Standard
-All you need to do is install RevTeX 4, as described in the package's README
- file.
- The package can be found at
-\begin_inset LatexCommand url
-name "The RevTeX 4 Web Site"
-target "http://publish.aps.org/revtex4/"
-
-\end_inset
-
-.
- Install it somewhere that LaTeX can see it.
- Test it by trying to LaTeX a short RevTeX 4 document in some random directory
- (i.e., not the directory where you installed the class file.) Then, if you
- reconfigure LyX, it will find the class file and let you use the RevTeX4
- textclass.
+The following environments are available.
+ You can use hollywood.bind to get the bind keys shown at the right.
\end_layout
-\begin_layout Standard
-Probably the easiest way to get started is either to import a RevTeX 4 document
- using
-\family typewriter
-reLyX
-\family default
-, or to use the
+\begin_layout Itemize
+
\family sans
-Revtex\InsetSpace ~
-4
-\family default
- template, found in the templates directory.
-\end_layout
+Standard
+\newline
-\begin_layout Subsection
-Preamble Matter
+\family default
+Used where nothing else works.
+ Try to avoid it.
\end_layout
-\begin_layout Standard
-Optional arguments to
-\family typewriter
+\begin_layout Itemize
-\backslash
-documentclass
+\family sans
+FADE_IN
\family default
-, like
-\begin_inset Quotes eld
-\end_inset
+:
+\hfill
-preprint
-\begin_inset Quotes erd
-\end_inset
+\family sans
+M-z S-I
+\family default
- and
+\newline
+Usually followed by something like
\begin_inset Quotes eld
\end_inset
-aps
+on Sally waking up.
\begin_inset Quotes erd
\end_inset
-, go in the
-\family sans
-E
-\bar under
-x
-\bar default
-tra\InsetSpace ~
-Options
-\family default
- field in the
-\family sans
-Document\InsetSpace ~
-Layout
-\family default
- dialog, as usual.
- Remember that in RevTeX, at least one optional argument is required!
+
\end_layout
-\begin_layout Standard
-Other preamble matter, like
-\family typewriter
+\begin_layout Itemize
-\backslash
-draft
-\family default
- etc.\InsetSpace ~
-goes in the
\family sans
-La
-\family default
-T
-\family sans
-eX\InsetSpace ~
-Preamble
-\family default
- dialog, also as usual.
-\end_layout
+INT:
+\hfill
+M-z i
+\newline
-\begin_layout Subsection
-Layouts
+\family default
+Introduces a new INTERIOR camera set-up.
+ Always followed by DAY or NIGHT, or something similar to define the lighting
+ required.
+ Everthing on this line in CAPS.
\end_layout
-\begin_layout Standard
-The layouts basically correspond to the commands in RevTeX4.0.
- For example, the Email layout corresponds to
-\family typewriter
+\begin_layout Itemize
-\backslash
-email{}
-\family default
-.
- Note that (at least as of RevTeX 4.0 Beta), the
-\family sans
-Address
-\family default
- and
\family sans
-Affiliation
-\family default
- layouts are exactly equivalent, so you shouldn't need to use both.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-In case you're curious, both were included so that
-\family typewriter
-reLyX
-\family default
- would be able to translate both
-\family typewriter
-
-\backslash
-address
-\family default
- and
-\family typewriter
+EXT:
+\hfill
+M-z e
+\newline
-\backslash
-affiliation
\family default
-.
+Introduces a new EXTERIOR camera set-up.
+ Everthing on this line in CAPS.
\end_layout
-\end_inset
+\begin_layout Itemize
+\family sans
+Speaker
+\hfill
+M-z s
+\newline
+\family default
+The character speaking.
\end_layout
-\begin_layout Subsection
-Important Notes
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-There are a couple of important unique aspects of RevTeX 4 which might cause
- bugs that will be even more confusing in LyX.
+\family sans
+Parenthetical
+\hfill
+M-z p
+\newline
+
+\family default
+Instructions to the speaker.
+ The () are automatically inserted, but only the ( will show in LyX.
+ Both will be printed.
\end_layout
-\begin_layout Standard
-In RevTeX, the
-\family typewriter
+\begin_layout Itemize
-\backslash
-thanks
-\family default
- command goes
-\emph on
-outside
-\emph default
- the
-\family typewriter
+\family sans
+Dialogue
+\hfill
+M-z d
+\newline
-\backslash
-author
\family default
- command.
- The LyX equivalent is that there is a separate Thanks layout.
- Do
-\emph on
-not
-\emph default
- write footnotes in the
+What the
\family sans
-Author
+Speaker
\family default
- layout, or weird things may happen.
- See the RevTeX 4 documentation for more details.
+ says.
\end_layout
-\begin_layout Standard
-Also, the
-\family sans
-Author\InsetSpace ~
-Email
-\family default
-,
+\begin_layout Itemize
+
\family sans
-Author\InsetSpace ~
-URL
+Transition
+\hfill
+M-z t
+\newline
+
\family default
-, and
+Camera movement instruction.
+ e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+CUT TO:
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Thanks
-\family default
- layouts must be placed
-\emph on
-in between
-\emph default
- the
+FADE OUT:
+\hfill
+M-z S-I
+\end_layout
+
+\begin_layout Itemize
+
\family sans
Author
-\family default
- layout and the corresponding
-\family sans
-Address
-\family default
- (or equivalent
-\family sans
-Affiliation
-\family default
-) layout.
- If you put the
+\hfill
+M-z S-A
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Thanks
-\family default
- after the
+Title
+\hfill
+M-z S-T
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Address
-\family default
-, the LaTeX won't compile.
+Right_Address
+\hfill
+M-z r
\end_layout
\begin_layout Subsection
-Drawbacks
+Script jargon
\end_layout
-\begin_layout Standard
-The main problem with this layout is that you can't use the optional arguments
- to layouts like Email and Title.
- (The problem is not unique to this layout; you can't use optional arguments
- to the Section layouts either.) This means that after you export that file
- to LaTeX (which you'll need to do eventually to send it in to APS), you'll
- need to edit the LaTeX file with a text editor to add the optional arguments
- to set, e.\InsetSpace \thinspace{}
-g., the running title for the page headers.
- Lacking these layouts makes the
-\family typewriter
-
-\backslash
-altaffiliation
-\family default
- (and the equivalent
-\family typewriter
+\begin_layout Itemize
+(O.S) --- off screen
+\end_layout
-\backslash
-altaddress
-\family default
-) useless, so the corresponding layouts don't exist, and will have to be
- added by hand.
-\begin_inset Foot
-status collapsed
+\begin_layout Itemize
+(V.0) --- voice over
+\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+b.g.
+ --- background
+\end_layout
-\emph on
-Note from JMarc:
-\emph default
- actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
- has not been updated yet to take advantage of it.
+\begin_layout Itemize
+C.U.
+ --- close-up
\end_layout
-\end_inset
+\begin_layout Itemize
+PAN --- camera movement
+\end_layout
-
+\begin_layout Itemize
+INSERT --- cut to close-up of
\end_layout
\begin_layout Section
-Article (mwart), book (mwbk) and report (mwrep)
-\begin_inset OptArg
-status collapsed
+Broadway
+\end_layout
\begin_layout Standard
-The
-\family typewriter
-mw
-\family default
- Classes
+by
+\shape smallcaps
+Garst Reese
\end_layout
-\end_inset
-
-
+\begin_layout Subsection
+Introduction
\end_layout
\begin_layout Standard
-by
-\noun on
-Tomasz Luczak
+Broadway is for writing plays.
+ The format is more decorative than Hollywood, and much less standardized.
+ This format should be suitable for workshops.
\end_layout
-\begin_layout Standard
-The LyX document classes
-\emph on
-article (mwart)
-\emph default
-,
-\emph on
-report (mwrep)
-\emph default
- and
-\emph on
-book
-\emph default
-
-\emph on
-(mwbk)
-\emph default
- correspond to the LaTeX document classes
-\family typewriter
-mwart.cls
-\family default
-,
-\family typewriter
-mwrep.cls
-\family default
- and
-\family typewriter
-mwbk.cls
-\family default
-, resp.
- They are replacements for the standard document classes
-\family typewriter
-article.cls
-\family default
-,
-\family typewriter
-report.cls
-\family default
- and
-\family typewriter
-book.cls
-\family default
-, resp., and fit better to Polish typography conventions in a number of points.
-
+\begin_layout Subsection
+Special problems
\end_layout
\begin_layout Standard
-Basic differences:
+The same as in Hollywood.
\end_layout
-\begin_layout Itemize
-Unnumbered titles (with star, eg.
-
+\begin_layout Subsection
+Special features
+\end_layout
+
+\begin_layout Standard
+Insert the
\family sans
-Section*
+Speaker
\family default
-) are added into table of contents,
+ names as labels then cross-reference the label to insert the name.
+ The cross-reference dialog will show the current cast of characters.
\end_layout
-\begin_layout Itemize
-Additional page styles:
+\begin_layout Subsection
+Paper size and Margins
\end_layout
-\begin_deeper
-\begin_layout Description
-uheadings header with separated lines,
+\begin_layout Standard
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
\end_layout
-\begin_layout Description
-myheadings custom header, contents headers via commands:
-\family typewriter
+\begin_layout Subsection
+Environments
+\end_layout
-\backslash
-markright
-\family default
- and
-\family typewriter
+\begin_layout Standard
+The following environments are available.
+ You can use broadway.bind to get the bind keys shown at the right.
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Standard
+\newline
-\backslash
-markboth
\family default
-,
+You should not have to use this, but it is here for anything that does not
+ fit otherwise.
\end_layout
-\begin_layout Description
-myuheadings custom header with separated lines,
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-outer page number is placed on outer side of page
+\family sans
+Narrative
+\hfill
+M-z n
+\newline
+
+\family default
+Used to describe stage setting and the action.
+ First use of speaker names in all CAPs.
\end_layout
-\end_deeper
\begin_layout Itemize
-Options
-\end_layout
-\begin_deeper
-\begin_layout Description
-rmheadings serif titles --- default,
-\end_layout
+\family sans
+ACT
+\hfill
+M-z a
+\newline
-\begin_layout Description
-sfheadings sansserif titles,
+\family default
+Automatically numbered.
+ On screen it will be arabic, but will print as Roman.
\end_layout
-\begin_layout Description
-authortitle on title page first placed is author next title --- default,
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-titleauthor on title page first placed is title next author,
-\end_layout
+\family sans
+ACT*
+\hfill
+M-z S at
+\newline
-\begin_layout Description
-withmarginpar reserve place on page for margins.
-\end_layout
+\family default
+Subtitle for
+\family sans
+ACT.
-\end_deeper
-\begin_layout Section
-Elsevier Journals
+\family default
+ It is just centered text.
\end_layout
-\begin_layout Standard
-By
-\noun on
-Rod Pinna
+\begin_layout Itemize
+
+\family sans
+SCENE
+\hfill
+M-z S-S
+\newline
+
+\family default
+Not automatically numbered.
+ You supply the number.
+ This is because I couldn't figure out how.
\end_layout
-\begin_layout Standard
-Elsevier Science Publishers B.V.
- provides a standard LaTeX document class (
-\family typewriter
-elsart.cls
+\begin_layout Itemize
+
+\family sans
+AT_RISE:
+\hfill
+M-z S-R
+\newline
+
\family default
-) for submitting articles to their various journals.
- The style file can be downloaded directly from their web site:
-\begin_inset LatexCommand url
-target "http://authors.elsevier.com/"
+A special case of Narrative to describe the setting and action as the curtain
+ rises.
+\end_layout
-\end_inset
+\begin_layout Itemize
-.
- Instructions are supplied along with the class file, which details the
- requirements of the publishers.
- LyX includes package that allows for the use of this class, by a layout
- and a template file.
- Installation of the class file is the same as for any other LaTeX package;
- instructions are provided in the Elsevier documentation.
+\family sans
+Speaker
+\hfill
+M-z s
+\newline
+
+\family default
+The speaker's (actor's) title, centered in all CAPS.
\end_layout
-\begin_layout Standard
-To make use of
-\family typewriter
-elsart.cls
+\begin_layout Itemize
+
+\family sans
+Parenthetical
+\hfill
+M-z p
+\newline
+
\family default
-, a file
-\family typewriter
-elsart.layout
+Instructions to the speaker.
+ The parentheses are automatically inserted.
+ The ( will appear on screen, but both will be in the printed play.
+ This environment is only used within
+\family sans
+Dialogue
\family default
- is supplied.
- As the Elsevier class file is based mainly on the standard article class,
- most of the normal functionality is provided.
- The Elsevier class defines a number of mathematical environments, which
- are similar to the AMS environments.
- These commands are all described in the Elsevier documentation, and are
- available in LyX.
+.
\end_layout
-\begin_layout Standard
-The easiest way to use the Elsevier style is to base documents on the included
- template file.
- It is best not to use options such as fancy headings or the geometry package,
- as elements such as these are defined by Elsevier in their style file.
- Ideally, no extra packages except those mentioned in the Elsevier documentation
- should be used.
- Essentially, Elsevier require as
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-clean
-\begin_inset Quotes erd
-\end_inset
+\family sans
+Dialogue
+\hfill
+M-z d
+\newline
- a
-\begin_inset ERT
-status collapsed
+\family default
+What the Speaker says.
+\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+\family sans
+CURTAIN
+\hfill
+M-z S-C
+\newline
-\backslash
-LaTeX
+\family default
+The curtain comes down.
\end_layout
-\end_inset
+\begin_layout Itemize
- file as possible, as their intention is to take the supplied file and replace
- the class file with one for the particular journal to which the paper has
- been submitted.
- This also means that not too much time should be spent on the formating
- of the document.
- When it comes to be published, this will change anyway.
- The rest of the usage for this layout is substantially the same as for
- the normal article class.
- For details of what Elsevier do and don't allow, refer to their documentation.
+\family sans
+Title
+\hfill
+M-z S-T
\end_layout
-\begin_layout Section
-Memoir
+\begin_layout Itemize
+
+\family sans
+Author
+\hfill
+M-z S-A
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Right_Address
+\hfill
+M-z r
\end_layout
\begin_layout Standard
-By
-\noun on
-Jürgen Spitzmüller
+Hello there.
\end_layout
-\begin_layout Subsection
-Overview
+\begin_layout Section
+RevTeX4
\end_layout
\begin_layout Standard
-Memoir is a very powerful and constantly evolving class.
- It has been designed with regard to fictional and non-fictional literature.
- Its aim is to let the user have maximum control over the typesetting of
- his document.
- Memoir is based on the standard book class, but it can also emulate the
- article class (see below).
+by
+\noun on
+Amir Karger
\end_layout
\begin_layout Standard
-Peter Wilson, the developer of Memoir, is known as the author of lots of
- useful packages in the LaTeX world.
- Most of them have been merged with Memoir.
- Therefore, it is much easier to layout the table of contents, appendices,
- chapter designs and such.
- LyX, though, does not support all of these goodies natively.
- Some of them might be added to forthcoming releases
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-You are invited to send suggestions to
-\begin_inset LatexCommand url
-target "lyx-devel@lists.lyx.org"
-
+\begin_inset VSpace bigskip
\end_inset
-.
+
\end_layout
+\begin_layout Standard
+\noindent
+The
+\family sans
+Revtex\InsetSpace ~
+4
+\family default
+ textclass works with the American Physical Sociey's RevTeX 4.0 (the
+\begin_inset Formula $\beta$
\end_inset
-, lots will probably never, due to the limitations of LyX's framework.
- Of course you can still use all features with the help of some native LaTeX
- commands (ERT
-\begin_inset Foot
-status collapsed
+ release of May, 1999) class.
+\end_layout
\begin_layout Standard
-Cf.
-\begin_inset ERT
-status collapsed
+LyX has a
+\family sans
+Revtex
+\family default
+ textclass, which works with RevTeX 3.1.
+ However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
+ That means that it doesn't interact very well with LyX, which requires
+ LaTeX2e, although it has been kludged to work.
+ Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
+ LyX with the
+\family sans
+RevTeX\InsetSpace ~
+4
+\family default
+ textclass should also be pretty easy to use.
+\end_layout
\begin_layout Standard
-
-
-\backslash
-
+These documents are supposed to be used in
+\emph on
+addition
+\emph default
+ to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
+ macros, and assume you'll know what to put in the preamble if necessary.
\end_layout
-\end_inset
-
-section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:Inserting-LaTeX-Code"
-
-\end_inset
-
- for details.
+\begin_layout Subsection
+Installation
\end_layout
-\end_inset
-
-).
- In this section, we can only list those features which are natively supported
- by LyX.
- For detailed descriptions (and for the rest of features) we are recommending
- to have a look at the detailed manual of the Memoir class
-\begin_inset Foot
-status collapsed
-
\begin_layout Standard
-Cf.
-\begin_inset ERT
+All you need to do is install RevTeX 4, as described in the package's README
+ file.
+ The package can be found at The RevTeX 4 Web Site
+\begin_inset Flex URL
status collapsed
\begin_layout Standard
-
-\backslash
-
+http://publish.aps.org/revtex4/
\end_layout
\end_inset
-
-\begin_inset LatexCommand url
-target "CTAN:/macros/latex/memoir/memman.pdf"
-
-\end_inset
-
.
+ Install it somewhere that LaTeX can see it.
+ Test it by trying to LaTeX a short RevTeX 4 document in some random directory
+ (i.e., not the directory where you installed the class file.) Then, if you
+ reconfigure LyX, it will find the class file and let you use the RevTeX4
+ textclass.
\end_layout
-\end_inset
-
-, which is not only a user guide for the class, but also both a comprehensive
- description on good typesetting and a superb example for good typesetting
- itself.
+\begin_layout Standard
+Probably the easiest way to get started is either to import a RevTeX 4 document
+ using
+\family typewriter
+tex2lyx
+\family default
+, or to use the
+\family sans
+Revtex\InsetSpace ~
+4
+\family default
+ template, found in the templates directory.
\end_layout
\begin_layout Subsection
-Basic features and restrictions
+Preamble Matter
\end_layout
\begin_layout Standard
-Memoir supports basically all features of the standard book classes.
- There are, however, some differences, as follows:
-\end_layout
-
-\begin_layout Description
-Font\InsetSpace ~
-sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
- 17
-\end_layout
-
-\begin_layout Description
-Page\InsetSpace ~
-style: The fancy page style is not supported, due to a command clash
- between Memoir and the fancyhdr package (they are both defining a command
- with the same name, which confuses LaTeX).
- Instead, Memoir comes with a bunch of own page styles (see
-\family sans
-Layout\SpecialChar \menuseparator
-Document\SpecialChar \menuseparator
-Page\InsetSpace ~
-Style
-\family default
-).
- If you want to use these for the chapter pages, you have to use the command
-
+Optional arguments to
\family typewriter
\backslash
-chapterstyle
+documentclass
\family default
- in the main text or in preamble (e.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-,
-\end_layout
-
+, like
+\begin_inset Quotes eld
\end_inset
-g.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
+preprint
+\begin_inset Quotes erd
+\end_inset
-\backslash
-
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
+aps
+\begin_inset Quotes erd
\end_inset
+, go in the
+\family sans
+E
+\bar under
+x
+\bar default
+tra\InsetSpace ~
+Options
+\family default
+ field in the
+\family sans
+Document\InsetSpace ~
+Layout
+\family default
+ dialog, as usual.
+ Remember that in RevTeX, at least one optional argument is required!
+\end_layout
+\begin_layout Standard
+Other preamble matter, like
\family typewriter
\backslash
-chapterstyle{companion}
+draft
\family default
-).
-\end_layout
-
-\begin_layout Description
-Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
- an optional argument in the standard classes.
- With this, you can specify an alternative version of the title for the
- table of contents and the headers (for instance, if the title is too long).
- In LyX, you can do this via
+ etc.\InsetSpace ~
+goes in the
\family sans
-Insert\SpecialChar \menuseparator
-Short\InsetSpace ~
-Title
+La
\family default
- at the beginning of a chapter/section.
- Memoir features a second optional argument and thus separates the table
- of contents from the header.
- You can define three variants of a title with this: one for the main text,
- one for the table of contents, and one for the headers.
- Simply insert two optional arguments if you need this feature, the first
- one containing the short title for the Table of Contents, the second one
- containing an alternative short title for the headers.
-\end_layout
-
-\begin_layout Description
-TOC/LOT/LOF: In the standard classes (and in many other classes), the table
- of contents, the list of figures and the list of table start a new page
- automatically.
- Memoir does not follow this route.
- You have to insert a page break yourself, if you want to have one.
+T
+\family sans
+eX\InsetSpace ~
+Preamble
+\family default
+ dialog, also as usual.
\end_layout
-\begin_layout Description
-Titlepage: For some unknown reason, Memoir uses pagination on the title
- page (in the standard classes, title pages are
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsection
+Layouts
+\end_layout
-empty
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+The layouts basically correspond to the commands in RevTeX4.0.
+ For example, the Email layout corresponds to
+\family typewriter
-, i.
-\begin_inset ERT
+\backslash
+email{}
+\family default
+.
+ Note that (at least as of RevTeX 4.0 Beta), the
+\family sans
+Address
+\family default
+ and
+\family sans
+Affiliation
+\family default
+ layouts are exactly equivalent, so you shouldn't need to use both.
+\begin_inset Foot
status collapsed
\begin_layout Standard
+In case you're curious, both were included so that
+\family typewriter
+tex2lyx
+\family default
+ would be able to translate both
+\family typewriter
+\backslash
+address
+\family default
+ and
+\family typewriter
\backslash
-,
+affiliation
+\family default
+.
\end_layout
\end_inset
-e.
-\begin_inset ERT
-status collapsed
-\begin_layout Standard
+\end_layout
+\begin_layout Subsection
+Important Notes
+\end_layout
-\backslash
-
+\begin_layout Standard
+There are a couple of important unique aspects of RevTeX 4 which might cause
+ bugs that will be even more confusing in LyX.
\end_layout
-\end_inset
+\begin_layout Standard
+In RevTeX, the
+\family typewriter
-without pagina).
- If you want an empty title page, type
+\backslash
+thanks
+\family default
+ command goes
+\emph on
+outside
+\emph default
+ the
\family typewriter
\backslash
-aliaspagestyle{title}{empty}
+author
\family default
- in the preamble.
+ command.
+ The LyX equivalent is that there is a separate Thanks layout.
+ Do
+\emph on
+not
+\emph default
+ write footnotes in the
+\family sans
+Author
+\family default
+ layout, or weird things may happen.
+ See the RevTeX 4 documentation for more details.
\end_layout
-\begin_layout Description
-Article: With the class option
+\begin_layout Standard
+Also, the
+\family sans
+Author\InsetSpace ~
+Email
+\family default
+,
+\family sans
+Author\InsetSpace ~
+URL
+\family default
+, and
+\family sans
+Thanks
+\family default
+ layouts must be placed
\emph on
-article
+in between
\emph default
- (to be inserted in
+ the
\family sans
-Layout\SpecialChar \menuseparator
-Document\SpecialChar \menuseparator
-Extra\InsetSpace ~
-Options
+Author
\family default
-), you can emulate article style.
- That is, counters (footnotes, figures, tables etc.) will not be reset on
- new chapters, chapters don't start a new page (but are---in contrary to
-
-\begin_inset Quotes eld
-\end_inset
-
-real
-\begin_inset Quotes erd
-\end_inset
-
- article classes---still allowed), parts, though, use their own page, as
- in book.
+ layout and the corresponding
+\family sans
+Address
+\family default
+ (or equivalent
+\family sans
+Affiliation
+\family default
+) layout.
+ If you put the
+\family sans
+Thanks
+\family default
+ after the
+\family sans
+Address
+\family default
+, the LaTeX won't compile.
\end_layout
-\begin_layout Description
-Oldfontcommands: By default, Memoir does not allow the use of the deprecated
- font commands, which have been used in the old LaTeX version 2.09 (e.
-\begin_inset ERT
-status collapsed
+\begin_layout Subsection
+Drawbacks
+\end_layout
\begin_layout Standard
+The main problem with this layout is that you can't use the optional arguments
+ to layouts like Email and Title.
+ (The problem is not unique to this layout; you can't use optional arguments
+ to the Section layouts either.) This means that after you export that file
+ to LaTeX (which you'll need to do eventually to send it in to APS), you'll
+ need to edit the LaTeX file with a text editor to add the optional arguments
+ to set, e.\InsetSpace \thinspace{}
+g., the running title for the page headers.
+ Lacking these layouts makes the
+\family typewriter
+\backslash
+altaffiliation
+\family default
+ (and the equivalent
+\family typewriter
\backslash
-,
+altaddress
+\family default
+) useless, so the corresponding layouts don't exist, and will have to be
+ added by hand.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+
+\emph on
+Note from JMarc:
+\emph default
+ actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
+ has not been updated yet to take advantage of it.
\end_layout
\end_inset
-g.
-\begin_inset ERT
+
+\end_layout
+
+\begin_layout Section
+Article (mwart), book (mwbk) and report (mwrep)
+\begin_inset OptArg
status collapsed
\begin_layout Standard
-
-
-\backslash
-
+The
+\family typewriter
+mw
+\family default
+ Classes
\end_layout
\end_inset
-\family typewriter
+\end_layout
-\backslash
-rm
+\begin_layout Standard
+by
+\noun on
+Tomasz Luczak
+\end_layout
+
+\begin_layout Standard
+The LyX document classes
+\emph on
+article (mwart)
+\emph default
+,
+\emph on
+report (mwrep)
+\emph default
+ and
+\emph on
+book
+\emph default
+
+\emph on
+(mwbk)
+\emph default
+ correspond to the LaTeX document classes
+\family typewriter
+mwart.cls
\family default
,
\family typewriter
-
-\backslash
-it
+mwrep.cls
\family default
-).
- It produces an error and stops LaTeX whenever such a command appears.
- The class option
-\emph on
-oldfontcommands
-\emph default
- reallows the commands and spits out warnings instead (which does at least
- not stop LaTeX).
- Since a lot of packages and particularly BibTeX style files are still using
- those commands, we have decided to use this option by default.
-\end_layout
-
-\begin_layout Subsection
-Extra features
+ and
+\family typewriter
+mwbk.cls
+\family default
+, resp.
+ They are replacements for the standard document classes
+\family typewriter
+article.cls
+\family default
+,
+\family typewriter
+report.cls
+\family default
+ and
+\family typewriter
+book.cls
+\family default
+, resp., and fit better to Polish typography conventions in a number of points.
+
\end_layout
\begin_layout Standard
-We will only describe the features supported by LyX (which is not much currently
-).
- Please consult the Memoir manual
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-Cf.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-
+Basic differences:
\end_layout
-\end_inset
-
-
-\begin_inset LatexCommand url
-target "CTAN:/macros/latex/memoir/memman.pdf"
-
-\end_inset
-
-.
+\begin_layout Itemize
+Unnumbered titles (with star, eg.
+
+\family sans
+Section*
+\family default
+) are added into table of contents,
\end_layout
-\end_inset
-
- for details.
+\begin_layout Itemize
+Additional page styles:
\end_layout
+\begin_deeper
\begin_layout Description
-Abstract: You may wonder why an abstract is an extra feature.
- Well, it is in book class.
- Usually books don't have abstracts.
- Memoir, however, has.
- You can use it wherever and how often you like.
+uheadings header with separated lines,
\end_layout
\begin_layout Description
-Chapterprecis: You may know this from belletristic: The contents of a chapter
- is shortly described below the title and also in the table of contents
- (e.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
+myheadings custom header, contents headers via commands:
+\family typewriter
+\backslash
+markright
+\family default
+ and
+\family typewriter
\backslash
+markboth
+\family default
,
\end_layout
-\end_inset
-
-g.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-
+\begin_layout Description
+myuheadings custom header with separated lines,
\end_layout
-\end_inset
-
+\begin_layout Description
+outer page number is placed on outer side of page
+\end_layout
-\emph on
-Our hero arrives in Troia; he loses some friends; he finds others
-\emph default
-).
- Chapterprecis does exactly this.
- It is therefore only sensible below a chapter.
+\end_deeper
+\begin_layout Itemize
+Options
\end_layout
+\begin_deeper
\begin_layout Description
-Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
- The epigraph environment provides an elegant way of typesetting such a
- motto.
- The motto itself (text) and its author (source) are divided by a short
- line.
- Unfortunately, we have to fool LyX a bit here again, since the environment
- needs two arguments (text and source).
- In this case, we have to use curly brackets (in TeX mode) between the two
- arguments:
-\emph on
-<smart slogan>
-\emph default
-
-\family typewriter
-}{
-\family default
-
-\emph on
-<author of the slogan>.
+rmheadings serif titles --- default,
\end_layout
\begin_layout Description
-Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
- complex figurative poems).
- LyX can only support a few of them.
- One is poemtitle, which is a centered title for poems, which will also
- be added to the table of contents (verse is the standard environment for
- poems.
- Memoir has some enhanced versions of verse, but you need to use ERT, because
- they have to be nested inside regular verse environments, which is not
- possible with LyX).
+sfheadings sansserif titles,
\end_layout
\begin_layout Description
-Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
+authortitle on title page first placed is author next title --- default,
\end_layout
-\begin_layout Chapter
-Importing and Exporting Alternate File Formats
-\begin_inset OptArg
-status collapsed
-
-\begin_layout Standard
-Importing and Exporting
+\begin_layout Description
+titleauthor on title page first placed is title next author,
\end_layout
-\end_inset
-
-
+\begin_layout Description
+withmarginpar reserve place on page for margins.
\end_layout
+\end_deeper
\begin_layout Section
-Considerations
+Elsevier Journals
\end_layout
\begin_layout Standard
-Importing and exporting LyX documents from/to other formats has been touched
- on briefly in the
-\emph on
-User Guide
-\emph default
-.
- Here we describe more of the gory details needed to understand just what
- is going on when you click on the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-mport
-\family default
- and
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-E
-\bar under
-x
-\bar default
-port
-\family default
- menu items.
-
-\end_layout
-
-\begin_layout Section
-Importing Other Formats
+By
+\noun on
+Rod Pinna
\end_layout
-\begin_layout Subsection
-LaTeX
-\end_layout
+\begin_layout Standard
+Elsevier Science Publishers B.V.
+ provides a standard LaTeX document class (
+\family typewriter
+elsart.cls
+\family default
+) for submitting articles to their various journals.
+ The style file can be downloaded directly from their web site:
+\begin_inset Flex URL
+status collapsed
\begin_layout Standard
-Translating from LaTeX into LyX is performed by a Perl script called reLyX.
- Although it is a standalone program which can be called from the command
- line, LyX will call it automatically when a LaTeX document is imported.
- See section\InsetSpace ~
-\begin_inset LatexCommand ref
-reference "sec:reLyX"
+http://authors.elsevier.com/
+\end_layout
\end_inset
- for a complete description.
- There are no user tunable parameters for reLyX within LyX.
+.
+ Instructions are supplied along with the class file, which details the
+ requirements of the publishers.
+ LyX includes package that allows for the use of this class, by a layout
+ and a template file.
+ Installation of the class file is the same as for any other LaTeX package;
+ instructions are provided in the Elsevier documentation.
\end_layout
-\begin_layout Subsection
-ASCII Text
+\begin_layout Standard
+To make use of
+\family typewriter
+elsart.cls
+\family default
+, a file
+\family typewriter
+elsart.layout
+\family default
+ is supplied.
+ As the Elsevier class file is based mainly on the standard article class,
+ most of the normal functionality is provided.
+ The Elsevier class defines a number of mathematical environments, which
+ are similar to the AMS environments.
+ These commands are all described in the Elsevier documentation, and are
+ available in LyX.
\end_layout
\begin_layout Standard
-When importing plain ASCII text, there are two methods of reading the file.
- Importing
+The easiest way to use the Elsevier style is to base documents on the included
+ template file.
+ It is best not to use options such as fancy headings or the geometry package,
+ as elements such as these are defined by Elsevier in their style file.
+ Ideally, no extra packages except those mentioned in the Elsevier documentation
+ should be used.
+ Essentially, Elsevier require as
\begin_inset Quotes eld
\end_inset
-as lines
+clean
\begin_inset Quotes erd
\end_inset
- preserves all the linebreaks in the ASCII; to LyX, then, each line looks
- like a paragraph.
- Importing
-\begin_inset Quotes eld
-\end_inset
+ a
+\begin_inset ERT
+status collapsed
-as paragraphs
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
- assumes that consecutive lines separated by only a single linebreak form
- a single paragraph.
- Successive linebreaks with no intervening text are thus assumed to be paragraph
- delimiters.
-\end_layout
-\begin_layout Subsection
-Noweb
+\backslash
+LaTeX
\end_layout
-\begin_layout Standard
+\end_inset
-\emph on
-[Editor's note: Needs to be written, obviously - any volunteers? --- mer]
+ file as possible, as their intention is to take the supplied file and replace
+ the class file with one for the particular journal to which the paper has
+ been submitted.
+ This also means that not too much time should be spent on the formating
+ of the document.
+ When it comes to be published, this will change anyway.
+ The rest of the usage for this layout is substantially the same as for
+ the normal article class.
+ For details of what Elsevier do and don't allow, refer to their documentation.
\end_layout
\begin_layout Section
-Exporting Other Formats
+Memoir
\end_layout
\begin_layout Standard
-The output formats listed here in the following are also explained concerning
- possible graphics formats in the
-\emph on
-Embedded Objects
-\emph default
- manual.
+By
+\noun on
+Jürgen Spitzmüller
\end_layout
\begin_layout Subsection
-LaTeX
+Overview
\end_layout
\begin_layout Standard
-LyX generates two types of LaTeX files: stripped down versions for the normal
- processing (
-\family sans
-View DVI
-\family default
-, etc.) which one normally never sees
+Memoir is a very powerful and constantly evolving class.
+ It has been designed with regard to fictional and non-fictional literature.
+ Its aim is to let the user have maximum control over the typesetting of
+ his document.
+ Memoir is based on the standard book class, but it can also emulate the
+ article class (see below).
+\end_layout
+
+\begin_layout Standard
+Peter Wilson, the developer of Memoir, is known as the author of lots of
+ useful packages in the LaTeX world.
+ Most of them have been merged with Memoir.
+ Therefore, it is much easier to layout the table of contents, appendices,
+ chapter designs and such.
+ LyX, though, does not support all of these goodies natively.
+ Some of them might be added to forthcoming releases
\begin_inset Foot
status collapsed
\begin_layout Standard
-The resulting file is a perfectly valid LaTeX file, though the preamble
- might look a bit strange since it includes some definitions used by LyX
- which wouldn't show up in most human-written files.
-\end_layout
-
-\end_inset
-
-, and human readable forms which are suitable for exchanging with your colleague
-s.
- The only settable option for the translation is the line length of the
- output file.
- The default is 65 characters, but it can be set in
-\family sans
-\bar under
-T
-\bar default
-ools
-\family default
-\SpecialChar \menuseparator
+You are invited to send suggestions to
+\begin_inset Flex URL
+status collapsed
-\family sans
-\bar under
-P
-\bar default
-references
-\family default
- using the
-\family sans
-\bar under
-A
-\bar default
-scii\InsetSpace ~
-line\InsetSpace ~
-length
-\family default
- field.
-
-\end_layout
+\begin_layout Standard
-\begin_layout Subsection
-Device Independent Files
+lyx-devel@lists.lyx.org
\end_layout
-\begin_layout Standard
-Device Independent files (DVI files) are produced by running LaTeX on your
- document.
- There are no user settable options.
-\end_layout
+\end_inset
-\begin_layout Subsection
-PostScript
+.
\end_layout
-\begin_layout Standard
-The next step in the conversion chain is converting a DVI file into Postscript.
- You can either use
-\family sans
-\bar under
-F
-\bar default
-ile
-\family default
-\SpecialChar \menuseparator
+\end_inset
-\family sans
-\bar under
-E
-\bar default
-xport
-\family default
-\SpecialChar \menuseparator
+, lots will probably never, due to the limitations of LyX's framework.
+ Of course you can still use all features with the help of some native LaTeX
+ commands (ERT
+\begin_inset Foot
+status collapsed
-\family sans
-Pos
-\bar under
-t
-\bar default
-script
-\family default
- or, if you need more control on the result,
-\family sans
-\bar under
-F
-\bar default
-ile
-\family default
-\SpecialChar \menuseparator
+\begin_layout Standard
+Cf.
+\begin_inset ERT
+status collapsed
-\family sans
-\bar under
-P
-\bar default
-rint
-\family default
-.
- If you use the later, note that it is possible to configure, in
-\family sans
-\bar under
-T
-\bar default
-ools
-\family default
-\SpecialChar \menuseparator
+\begin_layout Standard
-\family sans
-\bar under
-P
-\bar default
-references
-\family default
-, the options passed to the dvips program to achieve different effects.
-\end_layout
-\begin_layout Subsection
-ASCII text
+\backslash
+
\end_layout
-\begin_layout Standard
-Exporting as ASCII attempts to preserve the
-\begin_inset Quotes eld
\end_inset
-shape
-\begin_inset Quotes erd
-\end_inset
+section\InsetSpace ~
- of the document as well as possible, but things like centering and indentation
- are thrown out; paragraphs are separated by blank lines.
- Section numbering and cross-references are done correctly, so the resulting
- text files is remarkably readable.
- The only changeable option is the length of lines, as for LaTeX output.
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Inserting-LaTeX-Code"
-\begin_layout Subsection
-HTML
+\end_inset
+
+ for details.
\end_layout
-\begin_layout Standard
-LyX documents can be converted to hypertext markup, usually by converting
- to LaTeX first, then converting that to HTML\SpecialChar \@.
- Four LaTeX
-\begin_inset Formula $\rightarrow$
\end_inset
-HTML converters are currently known to LyX:
-\family typewriter
-tth
-\family default
-,
-\family typewriter
-latex2html
-\family default
-,
-\family typewriter
-hevea
-\family default
- and
-\family typewriter
-htlatex
-\family default
-.
- Though they are autodetected, you can overide the selection in preferences.
- You can also include further command line options in this dialog.
-
-\end_layout
+).
+ In this section, we can only list those features which are natively supported
+ by LyX.
+ For detailed descriptions (and for the rest of features) we are recommending
+ to have a look at the detailed manual of the Memoir class
+\begin_inset Foot
+status collapsed
-\begin_layout Subsection
-PDF
-\end_layout
+\begin_layout Standard
+Cf.
+\begin_inset ERT
+status collapsed
\begin_layout Standard
-by
-\noun on
-Dekel Tsur
-\noun default
- (mostly)
+
+
+\backslash
+
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
-\end_layout
+\begin_inset Flex URL
+status collapsed
-\begin_layout Standard
-The fastest way to generate a basic PDF file (no tags, links, etc.) with
- any version of LyX is to save the document as a Postscript file, then run
- the
-\family typewriter
-ps2pdf
-\family default
- command on it.
- Starting with version 1.1.6, the menu item
-\family sans
-File->Export->PDF
-\family default
- will do all this for you.
- There are some issues with fonts that you need to pay attention to: see
- Section\InsetSpace ~
+\begin_layout Standard
-\begin_inset LatexCommand ref
-reference "sec:badfonts"
+CTAN:/macros/latex/memoir/memman.pdf
+\end_layout
\end_inset
.
- Also, as of version 1.1.6, there is a better method that will generate much
- more sophisticated files.
\end_layout
-\begin_layout Subsubsection
-Use pdfLaTeX
+\end_inset
+
+, which is not only a user guide for the class, but also both a comprehensive
+ description on good typesetting and a superb example for good typesetting
+ itself.
\end_layout
-\begin_layout Standard
-With pdfLaTeX you cannot use pstricks.
- On the other hand, with pdfLaTeX it is possible to insert directly images
- in JPEG, PDF or PNG format, use TrueType fonts, and more.
+\begin_layout Subsection
+Basic features and restrictions
\end_layout
-\begin_layout Subsubsection
-Why does the text look so bad when viewed with Acrobat Reader?
-\begin_inset LatexCommand label
-name "sec:badfonts"
+\begin_layout Standard
+Memoir supports basically all features of the standard book classes.
+ There are, however, some differences, as follows:
+\end_layout
-\end_inset
+\begin_layout Description
+Font\InsetSpace ~
+sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
+ 17
+\end_layout
+\begin_layout Description
+Page\InsetSpace ~
+style: The fancy page style is not supported, due to a command clash
+ between Memoir and the fancyhdr package (they are both defining a command
+ with the same name, which confuses LaTeX).
+ Instead, Memoir comes with a bunch of own page styles (see
+\family sans
+Layout\SpecialChar \menuseparator
+Document\SpecialChar \menuseparator
+Page\InsetSpace ~
+Style
+\family default
+).
+ If you want to use these for the chapter pages, you have to use the command
+
+\family typewriter
-\begin_inset OptArg
+\backslash
+chapterstyle
+\family default
+ in the main text or in preamble (e.
+\begin_inset ERT
status collapsed
\begin_layout Standard
-Bad Fonts in Acrobat Reader
+
+
+\backslash
+,
\end_layout
\end_inset
-
-\end_layout
+g.
+\begin_inset ERT
+status collapsed
\begin_layout Standard
-The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
- When creating a PDF from the LyX file, you need to use outline font instead
- of the default bitmap fonts (in fact, you should also use outline fonts
- for Postscript files).
- Recent LaTeX distributions come with Postscript Type 1 version of the standard
- (Computer Modern) fonts.
- pdfLaTeX uses these font by default.
- Dvips doesn't use these fonts by default, so to make it use them, add the
- following to lines to your
-\family typewriter
-~/.dvipsrc
-\family default
- file
-\end_layout
-\begin_layout LyX-Code
-p+ psfonts.cmz
-\end_layout
-\begin_layout LyX-Code
-p+ psfonts.amz
+\backslash
+
\end_layout
-\begin_layout Standard
-If the default LaTeX font encoding (OT1) is used, nothing else need to be
- done.
- However, if the T1 font encoding is used, then LaTeX uses the newer EC
- fonts, for which there are no Type1 version.
- The solution is to use the ae package which emulates T1 coded fonts using
- the standard CM fonts.
- This is done by adding
+\end_inset
+
+
\family typewriter
\backslash
-usepackage{ae,aecompl}
+chapterstyle{companion}
\family default
- to the preamble of the LyX file.
- However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
-g.\InsetSpace ~
-eth, thorn), and
- they are taken from the EC fonts.
- Therefore you get these glyphs as bitmaps.
+).
\end_layout
-\begin_layout Standard
-Note: LyX uses by default the T1 font encoding.
- If you wish to use the default font encoding (this is not recommended,
- unless you only write English documents), clear the field
-\family sans
-\bar under
-T
-\bar default
-eX\InsetSpace ~
-encoding
-\family default
- in preferences (tabs
-\family sans
-Outputs
-\family default
-,
+\begin_layout Description
+Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
+ an optional argument in the standard classes.
+ With this, you can specify an alternative version of the title for the
+ table of contents and the headers (for instance, if the title is too long).
+ In LyX, you can do this via
\family sans
-Misc
+Insert\SpecialChar \menuseparator
+Short\InsetSpace ~
+Title
\family default
-).
-
+ at the beginning of a chapter/section.
+ Memoir features a second optional argument and thus separates the table
+ of contents from the header.
+ You can define three variants of a title with this: one for the main text,
+ one for the table of contents, and one for the headers.
+ Simply insert two optional arguments if you need this feature, the first
+ one containing the short title for the Table of Contents, the second one
+ containing an alternative short title for the headers.
\end_layout
-\begin_layout Standard
-An alternate option is to use the standard Postscript fonts instead of the
- Computer Modern fonts.
- To do that, you need to select
-\family sans
-pslatex
-\family default
- as the global font in the document layout dialog.
- When using the Postscript fonts, the result PDF file is smaller as the
- fonts are not saved into the file.
- Furthermore, the Postscript fonts include all T1 glyphs.
- On the other hand, the Postscript fonts have no bold symbol font, so poor
- man's bold must be used (see Section\InsetSpace ~
+\begin_layout Description
+TOC/LOT/LOF: In the standard classes (and in many other classes), the table
+ of contents, the list of figures and the list of table start a new page
+ automatically.
+ Memoir does not follow this route.
+ You have to insert a page break yourself, if you want to have one.
+\end_layout
-\begin_inset LatexCommand ref
-reference "sec:pdfbold"
+\begin_layout Description
+Titlepage: For some unknown reason, Memoir uses pagination on the title
+ page (in the standard classes, title pages are
+\begin_inset Quotes eld
+\end_inset
+empty
+\begin_inset Quotes erd
\end_inset
-).
- The Postscript fonts also look different from the Computer Modern fonts.
-\end_layout
+, i.
+\begin_inset ERT
+status collapsed
\begin_layout Standard
-To sum up, both the Computer Modern and the Postscript fonts gives good
- results (with few exceptions).
- The decision of which one to use is a matter of taste.
-\end_layout
-\begin_layout Subsubsection
-Why doesn't the
+
\backslash
-boldsymbol{} command work when I use pslatex?
-\begin_inset LatexCommand label
-name "sec:pdfbold"
+,
+\end_layout
\end_inset
-
-\begin_inset OptArg
+e.
+\begin_inset ERT
status collapsed
\begin_layout Standard
+
+\backslash
+
+\end_layout
+
+\end_inset
+
+without pagina).
+ If you want an empty title page, type
\family typewriter
\backslash
-boldsymbol{}
+aliaspagestyle{title}{empty}
\family default
- and
-\family typewriter
-pslatex
+ in the preamble.
\end_layout
+\begin_layout Description
+Article: With the class option
+\emph on
+article
+\emph default
+ (to be inserted in
+\family sans
+Layout\SpecialChar \menuseparator
+Document\SpecialChar \menuseparator
+Extra\InsetSpace ~
+Options
+\family default
+), you can emulate article style.
+ That is, counters (footnotes, figures, tables etc.) will not be reset on
+ new chapters, chapters don't start a new page (but are---in contrary to
+
+\begin_inset Quotes eld
\end_inset
+real
+\begin_inset Quotes erd
+\end_inset
+ article classes---still allowed), parts, though, use their own page, as
+ in book.
\end_layout
+\begin_layout Description
+Oldfontcommands: By default, Memoir does not allow the use of the deprecated
+ font commands, which have been used in the old LaTeX version 2.09 (e.
+\begin_inset ERT
+status collapsed
+
\begin_layout Standard
-The Postscript fonts do not have a bold symbol font.
- The solution is to use the
-\family typewriter
+
\backslash
-pmb{}
-\family default
- (poor man's bold) command.
+,
\end_layout
+\end_inset
+
+g.
+\begin_inset ERT
+status collapsed
+
\begin_layout Standard
-It is possible to redefine the
+
+
+\backslash
+
+\end_layout
+
+\end_inset
+
+
\family typewriter
\backslash
-boldsymbol
+rm
\family default
- command to use
+,
\family typewriter
\backslash
-pmb
+it
\family default
- by putting
+).
+ It produces an error and stops LaTeX whenever such a command appears.
+ The class option
+\emph on
+oldfontcommands
+\emph default
+ reallows the commands and spits out warnings instead (which does at least
+ not stop LaTeX).
+ Since a lot of packages and particularly BibTeX style files are still using
+ those commands, we have decided to use this option by default.
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-renewcommand{
-\backslash
-boldsymbol}[1]{
-\backslash
-pmb{#1}}
+\begin_layout Subsection
+Extra features
\end_layout
\begin_layout Standard
-in the preamble.
-\end_layout
+We will only describe the features supported by LyX (which is not much currently
+).
+ Please consult the Memoir manual
+\begin_inset Foot
+status collapsed
-\begin_layout Subsubsection
-Is it possible to do write LaTeX-code which is processed only when running
- pdfLaTeX?
-\begin_inset OptArg
+\begin_layout Standard
+Cf.
+\begin_inset ERT
status collapsed
\begin_layout Standard
-Conditionals with pdfLaTeX
+
+
+\backslash
+
\end_layout
\end_inset
-\end_layout
+\begin_inset Flex URL
+status collapsed
\begin_layout Standard
-Yes you can do this with the
-\family typewriter
-ifpdf.sty
-\family default
- package.
- Here is an example:
-\end_layout
-
-\begin_layout LyX-Code
+CTAN:/macros/latex/memoir/memman.pdf
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-usepackage{ifpdf}
+.
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-ifpdf
+ for details.
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-pdfinfo { /Author (your name and e-mail address)
+\begin_layout Description
+Abstract: You may wonder why an abstract is an extra feature.
+ Well, it is in book class.
+ Usually books don't have abstracts.
+ Memoir, however, has.
+ You can use it wherever and how often you like.
\end_layout
-\begin_layout LyX-Code
- /Title (official title -- i.e., title element)
-\end_layout
+\begin_layout Description
+Chapterprecis: You may know this from belletristic: The contents of a chapter
+ is shortly described below the title and also in the table of contents
+ (e.
+\begin_inset ERT
+status collapsed
-\begin_layout LyX-Code
- /Subject (one line description of the document)
-\end_layout
+\begin_layout Standard
-\begin_layout LyX-Code
- }
-\end_layout
-\begin_layout LyX-Code
-
\backslash
-pdfcatalog { /PageMode (/UseNone)
+,
\end_layout
-\begin_layout LyX-Code
- % /OpenAction (fitbh)
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- }
-\end_layout
+g.
+\begin_inset ERT
+status collapsed
-\begin_layout LyX-Code
-
-\backslash
-usepackage[pdftex]{hyperref}
-\end_layout
+\begin_layout Standard
-\begin_layout LyX-Code
\backslash
-else
+
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-usepackage[ps2pdf]{hyperref}
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-\backslash
-fi
+\emph on
+Our hero arrives in Troia; he loses some friends; he finds others
+\emph default
+).
+ Chapterprecis does exactly this.
+ It is therefore only sensible below a chapter.
\end_layout
-\begin_layout Subsubsection
-How can I make URLs clickable?
+\begin_layout Description
+Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
+ The epigraph environment provides an elegant way of typesetting such a
+ motto.
+ The motto itself (text) and its author (source) are divided by a short
+ line.
+ Unfortunately, we have to fool LyX a bit here again, since the environment
+ needs two arguments (text and source).
+ In this case, we have to use curly brackets (in TeX mode) between the two
+ arguments:
+\emph on
+<smart slogan>
+\emph default
+
+\family typewriter
+}{
+\family default
+
+\emph on
+<author of the slogan>.
\end_layout
-\begin_layout Standard
-See the references here:
+\begin_layout Description
+Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
+ complex figurative poems).
+ LyX can only support a few of them.
+ One is poemtitle, which is a centered title for poems, which will also
+ be added to the table of contents (verse is the standard environment for
+ poems.
+ Memoir has some enhanced versions of verse, but you need to use ERT, because
+ they have to be nested inside regular verse environments, which is not
+ possible with LyX).
+\end_layout
+
+\begin_layout Description
+Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
\end_layout
+\begin_layout Chapter
+Importing and Exporting Alternate File Formats
+\begin_inset OptArg
+status collapsed
+
\begin_layout Standard
-\begin_inset LatexCommand url
-target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
+Importing and Exporting
+\end_layout
\end_inset
\end_layout
-\begin_layout Subsection
-Custom
+\begin_layout Section
+Considerations
\end_layout
\begin_layout Standard
-Custom exports are possible if you have some particularly weird format you
- wish to convert to, assuming you have the relevant converter, of course.
- The format of the
+Importing and exporting LyX documents from/to other formats has been touched
+ on briefly in the
\emph on
-input
+User Guide
\emph default
- file can be chosen in the
+.
+ Here we describe more of the gory details needed to understand just what
+ is going on when you click on the
\family sans
\bar under
F
ile\SpecialChar \menuseparator
\bar under
-E
+I
\bar default
-xport\SpecialChar \menuseparator
-
+mport
+\family default
+ and
+\family sans
\bar under
-C
+F
\bar default
-ustom
+ile\SpecialChar \menuseparator
+E
+\bar under
+x
+\bar default
+port
\family default
- dialog; LyX will automatically convert the file to this point, then feed
- it to your custom converter.
- The possible values are all formats that LyX can produce from its own documents.
+ menu items.
\end_layout
+\begin_layout Section
+Importing Other Formats
+\end_layout
+
+\begin_layout Subsection
+LaTeX
+\end_layout
+
\begin_layout Standard
-The converter command is also specified in the dialog.
- It should be a completely qualified command line which uses the variable
+Translating from LaTeX into LyX is performed by a converter program called
\family typewriter
-$$FName
+tex2lyx
\family default
- to specify the name of the file.
- If this variable is not given, then the file will be sent to the standard
- input of your command.
- You may have to apply a bit of ingenuity to escape this sequence correctly
- so that it is compatible with your shell.
-
+.
+ Although it is a standalone program which can be called from the command
+ line, LyX will call it automatically when a LaTeX document is imported.
+ See section\InsetSpace ~
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Translating-LaTeX-files"
+
+\end_inset
+
+ for a complete description.
+\end_layout
+
+\begin_layout Subsection
+ASCII Text
\end_layout
-\begin_layout Standard
-While it is not possible to save this command using the
-\family sans
-Preferences
-\family default
- dialog, you can manually edit your
-\family typewriter
-.lyx/preferences
-\family default
- to add a line like
-\end_layout
+\begin_layout Standard
+When importing plain ASCII text, there are two methods of reading the file.
+ Importing
+\begin_inset Quotes eld
+\end_inset
+
+as lines
+\begin_inset Quotes erd
+\end_inset
+
+ preserves all the linebreaks in the ASCII; to LyX, then, each line looks
+ like a paragraph.
+ Importing
+\begin_inset Quotes eld
+\end_inset
+
+as paragraphs
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
+ assumes that consecutive lines separated by only a single linebreak form
+ a single paragraph.
+ Successive linebreaks with no intervening text are thus assumed to be paragraph
+ delimiters.
+\end_layout
-\backslash
-custom_export_command "mycommand $$FName"
+\begin_layout Subsection
+Noweb
\end_layout
-\begin_layout Chapter
-LyX Features needing Extra Software
+\begin_layout Standard
+
+\emph on
+[Editor's note: Needs to be written, obviously - any volunteers? --- mer]
\end_layout
\begin_layout Section
-Using LyX with SGML-Tools (aka LinuxDoc)
+Exporting Other Formats
\end_layout
\begin_layout Standard
-by
-\noun on
-Paul Evans
+The output formats listed here in the following are also explained concerning
+ possible graphics formats in the
+\emph on
+Embedded Objects
+\emph default
+ manual.
\end_layout
\begin_layout Subsection
-Overview
+LaTeX
\end_layout
\begin_layout Standard
-LinuxDoc is a document class available in LyX if you have the
-\family typewriter
-sgml-tools
-\family default
- package installed.
- You can use it to produce documents in the so-called Standardized General
- Mark-up Language (SGML) in the particular format used by the Linux Documentatio
-n Project.
- That is obviously helpful if you are contributing to that project.
- You can use the SGML format with the
-\family typewriter
-sgml-tools
+LyX generates two types of LaTeX files: stripped down versions for the normal
+ processing (
+\family sans
+View DVI
\family default
- package of scripts and programs (to produce other formats, including LaTeX,
- HTML, plain text, man pages and\SpecialChar \ldots{}
-).
- You may therefore prefer to use this document class if you want to write
- something that can be easily translated into other formats.
-\end_layout
+, etc.) which one normally never sees
+\begin_inset Foot
+status collapsed
\begin_layout Standard
-You will find that LinuxDoc has fewer layout options than the other text
- classes in LyX.
- This is mainly so that the translations into other formats have a chance
- of making some sense.
- In this section we describe:
+The resulting file is a perfectly valid LaTeX file, though the preamble
+ might look a bit strange since it includes some definitions used by LyX
+ which wouldn't show up in most human-written files.
\end_layout
-\begin_layout Itemize
-how to setup and use a document in LinuxDoc
-\end_layout
+\end_inset
-\begin_layout Itemize
-how to use the tags in LinuxDoc to layout your document
-\end_layout
+, and human readable forms which are suitable for exchanging with your colleague
+s.
+ The only settable option for the translation is the line length of the
+ output file.
+ The default is 65 characters, but it can be set in
+\family sans
+\bar under
+T
+\bar default
+ools
+\family default
+\SpecialChar \menuseparator
-\begin_layout Itemize
-how to use the SGML packages to produce the various formats
+\family sans
+\bar under
+P
+\bar default
+references
+\family default
+ using the
+\family sans
+\bar under
+A
+\bar default
+scii\InsetSpace ~
+line\InsetSpace ~
+length
+\family default
+ field.
+
\end_layout
-\begin_layout Itemize
-how to sort out some problems.
+\begin_layout Subsection
+Device Independent Files
\end_layout
-\begin_layout Subsection
-Preparing and using a LinuxDoc document
+\begin_layout Standard
+Device Independent files (DVI files) are produced by running LaTeX on your
+ document.
+ There are no user settable options.
\end_layout
-\begin_layout Subsubsection
-Getting started
+\begin_layout Subsection
+PostScript
\end_layout
\begin_layout Standard
-You start by selecting the LinuxDoc class using the
+The next step in the conversion chain is converting a DVI file into Postscript.
+ You can either use
\family sans
\bar under
-D
+F
\bar default
-ocument\SpecialChar \menuseparator
+ile
+\family default
+\SpecialChar \menuseparator
+\family sans
\bar under
-S
+E
\bar default
-ettings
+xport
\family default
- dialog.
- Then you will find that there are fewer paragraph environments than for
- most other classes.
- You can see them on the pull down box on the left of the tool bar.
- How to use them is described in section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:sgmlparas"
+\SpecialChar \menuseparator
-\end_inset
+\family sans
+Pos
+\bar under
+t
+\bar default
+script
+\family default
+ or, if you need more control on the result,
+\family sans
+\bar under
+F
+\bar default
+ile
+\family default
+\SpecialChar \menuseparator
+\family sans
+\bar under
+P
+\bar default
+rint
+\family default
.
+ If you use the later, note that it is possible to configure, in
+\family sans
+\bar under
+T
+\bar default
+ools
+\family default
+\SpecialChar \menuseparator
+
+\family sans
+\bar under
+P
+\bar default
+references
+\family default
+, the options passed to the dvips program to achieve different effects.
\end_layout
-\begin_layout Standard
-You
-\emph on
-must
-\emph default
- enter a title for the document, followed by an author, marking each with
- the appropriate paragraph environment.
- If you don't do this, you will get errors when you try to print the file.
- You can then enter the date and an abstract.
- The document proper must start with a Section paragraph environment rather
- than any standard layout.
+\begin_layout Subsection
+ASCII text
\end_layout
\begin_layout Standard
-After that you can prepare a document as usual using the available range
- of paragraph environments.
- See section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:sgmlparas"
+Exporting as ASCII attempts to preserve the
+\begin_inset Quotes eld
+\end_inset
+shape
+\begin_inset Quotes erd
\end_inset
- for the full list and their uses.
+ of the document as well as possible, but things like centering and indentation
+ are thrown out; paragraphs are separated by blank lines.
+ Section numbering and cross-references are done correctly, so the resulting
+ text files is remarkably readable.
+ The only changeable option is the length of lines, as for LaTeX output.
\end_layout
-\begin_layout Subsubsection
-Output from LinuxDoc
+\begin_layout Subsection
+HTML
\end_layout
\begin_layout Standard
-You can print and save these documents in the normal way.
- To use the other features of the SGML package you need to save your document
- as LinuxDoc; this is a version in which the document is translated into
- the basic sgml tags.
- Use
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-Linu
-\bar under
-x
-\bar default
-Doc.
+LyX documents can be converted to hypertext markup, usually by converting
+ to LaTeX first, then converting that to HTML\SpecialChar \@.
+ Four LaTeX
+\begin_inset Formula $\rightarrow$
+\end_inset
+HTML converters are currently known to LyX:
+\family typewriter
+tth
\family default
- You will get a file with the same name and a
+,
\family typewriter
-.sgml
+latex2html
\family default
- extension rather than a
+,
\family typewriter
-.lyx
+hevea
\family default
- extension.
- See\InsetSpace ~
+ and
+\family typewriter
+htlatex
+\family default
+.
+ Though they are autodetected, you can overide the selection in preferences.
+ You can also include further command line options in this dialog.
+
+\end_layout
+
+\begin_layout Subsection
+PDF
+\end_layout
-\begin_inset LatexCommand ref
-reference "sec:sgmloperate"
+\begin_layout Standard
+by
+\noun on
+Dekel Tsur
+\noun default
+ (mostly)
+\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
- on how you than make use of this file.
+
\end_layout
-\begin_layout Subsection
-Using the paragraph environments in LinuxDoc
+\begin_layout Standard
+The fastest way to generate a basic PDF file (no tags, links, etc.) with
+ any version of LyX is to save the document as a Postscript file, then run
+ the
+\family typewriter
+ps2pdf
+\family default
+ command on it.
+ Starting with version 1.1.6, the menu item
+\family sans
+File->Export->PDF
+\family default
+ will do all this for you.
+ There are some issues with fonts that you need to pay attention to: see
+ Section\InsetSpace ~
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:badfonts"
+
+\end_inset
+
+.
+ Also, as of version 1.1.6, there is a better method that will generate much
+ more sophisticated files.
\end_layout
\begin_layout Subsubsection
-The Structure of a LinuxDoc Document
+Use pdfLaTeX
\end_layout
\begin_layout Standard
-There is a formal structure for LinuxDoc which limits how you can place
- tags.
- There are two parts to all documents:
-\end_layout
-
-\begin_layout Description
-Header: this is everything up to the first time you insert a Section layout
- marker.
- It can include title, author, date, abstract and ToC.
- You must include the first two.
-\end_layout
-
-\begin_layout Description
-Body: from the beginning of the first section onwards.
- All other tags are allowed.
-
+With pdfLaTeX you cannot use pstricks.
+ On the other hand, with pdfLaTeX it is possible to insert directly images
+ in JPEG, PDF or PNG format, use TrueType fonts, and more.
\end_layout
\begin_layout Subsubsection
-The LinuxDoc Paragraph Environments
-\end_layout
-
-\begin_layout Standard
-\begin_inset LatexCommand label
-name "sec:sgmlparas"
+Why does the text look so bad when viewed with Acrobat Reader?
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:badfonts"
\end_inset
-Here is a list of all the tags you will find listed on the layout bar in
- the order they come there, with some comments where the purpose or use
- is not obvious:
-\end_layout
-\begin_layout Itemize
+\begin_inset OptArg
+status collapsed
-\family sans
-Standard:
-\family default
-
-\family roman
-works as described in [cross reference]
+\begin_layout Standard
+Bad Fonts in Acrobat Reader
\end_layout
-\begin_layout Itemize
-
-\family sans
-Title
-\family default
-: This will appear at the top left of the document when printed, above a
- heavy horizontal rule, although you will not see this on the LyX screen.
-\end_layout
+\end_inset
-\begin_layout Itemize
-\family sans
-Section, Subsection, Subsubsection, Paragraph and Subparagraph:
-\family default
- all do what you would expect and in the usual order.
- Whether they are numbered or not is controlled by the
-\family sans
-Section\InsetSpace ~
-number\InsetSpace ~
-depth
-\family default
- setting.
- You cannot get the equivalent number free versions in any other way; there
- is no
-\family sans
-Section*
-\family default
- or similar
\end_layout
-\begin_layout Itemize
-
-\family sans
-Enumerate:
+\begin_layout Standard
+The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
+ When creating a PDF from the LyX file, you need to use outline font instead
+ of the default bitmap fonts (in fact, you should also use outline fonts
+ for Postscript files).
+ Recent LaTeX distributions come with Postscript Type 1 version of the standard
+ (Computer Modern) fonts.
+ pdfLaTeX uses these font by default.
+ Dvips doesn't use these fonts by default, so to make it use them, add the
+ following to lines to your
+\family typewriter
+~/.dvipsrc
\family default
- As usual this produces a numbered and indented list as described in the
-
-\emph on
-User's Guide
-\emph default
-.
+ file
\end_layout
-\begin_layout Itemize
-
-\family sans
-Itemize:
-\family default
-
-\family roman
-Again much the same as in the other classes: see the
-\family default
-
-\family roman
-\emph on
-User's Guide
-\emph default
-.
+\begin_layout LyX-Code
+p+ psfonts.cmz
\end_layout
-\begin_layout Itemize
-
-\family sans
-Description
-\family default
-: As explained in the
-\emph on
-User's Guide
-\emph default
-.
- Remember that if you want the bold element at the start of a description
- to be more than one word then you need to put protected spaces between
- the words.
-
+\begin_layout LyX-Code
+p+ psfonts.amz
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+If the default LaTeX font encoding (OT1) is used, nothing else need to be
+ done.
+ However, if the T1 font encoding is used, then LaTeX uses the newer EC
+ fonts, for which there are no Type1 version.
+ The solution is to use the ae package which emulates T1 coded fonts using
+ the standard CM fonts.
+ This is done by adding
+\family typewriter
-\family sans
-Verbatim:
+\backslash
+usepackage{ae,aecompl}
\family default
- As usual.
+ to the preamble of the LyX file.
+ However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+eth, thorn), and
+ they are taken from the EC fonts.
+ Therefore you get these glyphs as bitmaps.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+Note: LyX uses by default the T1 font encoding.
+ If you wish to use the default font encoding (this is not recommended,
+ unless you only write English documents), clear the field
\family sans
-Code: similar to the LyX-Code
+\bar under
+T
+\bar default
+eX\InsetSpace ~
+encoding
\family default
-
-\family roman
-environment
-\end_layout
-
-\begin_layout Itemize
-
+ in preferences (tabs
\family sans
-Author
+Outputs
\family default
-: Anything you mark with this will appear on the left of the heading of
- the document, under the heavy rule.
-\end_layout
-
-\begin_layout Itemize
-
+,
\family sans
-Date:
+Misc
\family default
- Anything you mark with this will appear on the right of the heading under
- the rule.
- You do not have to make this a date.
- Any text can be entered, e.\InsetSpace ~
-g.
- a version number.
+).
+
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+An alternate option is to use the standard Postscript fonts instead of the
+ Computer Modern fonts.
+ To do that, you need to select
\family sans
-Abstract
+pslatex
\family default
-: You can use this to produce a free standing paragraph after the author
- and date, and before the first section.
- You are only allowed one such paragraph.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-
-\emph on
-Author's note.
+ as the global font in the document layout dialog.
+ When using the Postscript fonts, the result PDF file is smaller as the
+ fonts are not saved into the file.
+ Furthermore, the Postscript fonts include all T1 glyphs.
+ On the other hand, the Postscript fonts have no bold symbol font, so poor
+ man's bold must be used (see Section\InsetSpace ~
-\emph default
- This needs checking ---
-\emph on
-pe.
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:pdfbold"
\end_inset
-
+).
+ The Postscript fonts also look different from the Computer Modern fonts.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Displaymath
-\family default
-:
-\begin_inset Foot
-status collapsed
-
\begin_layout Standard
-
-\emph on
-Author's note:
-\emph default
- I have not yet checked this ---
-\emph on
-pe.
+To sum up, both the Computer Modern and the Postscript fonts gives good
+ results (with few exceptions).
+ The decision of which one to use is a matter of taste.
\end_layout
-\end_inset
-
+\begin_layout Subsubsection
+Why doesn't the
+\backslash
+boldsymbol{} command work when I use pslatex?
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:pdfbold"
-\end_layout
+\end_inset
-\begin_layout Subsubsection
-Other document features
-\end_layout
-\begin_layout Standard
-You can also use the
-\family sans
-Layout
-\family default
- menu to set fonts or to emphasis words.
- You can also use the table of contents as usual; see the corresponding
- section of the
-\emph on
-User's Guide
-\emph default
-.
- Although you will find some some other features on the menus e.\InsetSpace ~
-g.
- inserting footnotes.
- There is some doubt about whether these will work correctly.
-\begin_inset Foot
+\begin_inset OptArg
status collapsed
\begin_layout Standard
-\emph on
-Author's note:
-\emph default
- Again still checking to see whether this is my system
-\emph on
----pe.
+\family typewriter
+
+\backslash
+boldsymbol{}
+\family default
+ and
+\family typewriter
+pslatex
\end_layout
\end_inset
\end_layout
-\begin_layout Subsubsection
-Cross references and HTML
-\end_layout
-
\begin_layout Standard
-On the
-\family sans
-Insert
+The Postscript fonts do not have a bold symbol font.
+ The solution is to use the
+\family typewriter
+
+\backslash
+pmb{}
\family default
- menu you will find two new options relating to the inclusion of URL addresses.
- If you use either option you will find some highlighted TeX code inserted
- into your document in three separate blocks with spaces available between.
- The blocks will be:
+ (poor man's bold) command.
\end_layout
-\begin_layout Quote
-
+\begin_layout Standard
+It is possible to redefine the
\family typewriter
\backslash
-htmlurl{
+boldsymbol
\family default
- or
+ command to use
\family typewriter
\backslash
-url{
-\family roman
-
-\hfill
-space
+pmb
\family default
-
-\family typewriter
+ by putting
+\end_layout
-\hfill
-}{
-\family roman
+\begin_layout LyX-Code
-\hfill
-space
-\hfill
+\backslash
+renewcommand{
+\backslash
+boldsymbol}[1]{
+\backslash
+pmb{#1}}
+\end_layout
-\family typewriter
-}
+\begin_layout Standard
+in the preamble.
\end_layout
+\begin_layout Subsubsection
+Is it possible to do write LaTeX-code which is processed only when running
+ pdfLaTeX?
+\begin_inset OptArg
+status collapsed
+
\begin_layout Standard
-You insert a full HTML tag between the first and second blocks.
- This can be
-\begin_inset LatexCommand url
-target "http://any.address"
+Conditionals with pdfLaTeX
+\end_layout
\end_inset
- or other valid tags such as
-\begin_inset LatexCommand url
-target "mailto:me@my.address"
-
-\end_inset
+\end_layout
+\begin_layout Standard
+Yes you can do this with the
\family typewriter
-.
-\family default
-Then y
-\family roman
-ou
+ifpdf.sty
\family default
- insert some description between the second and third blocks.
- The differences are:
+ package.
+ Here is an example:
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
-\family sans
-URL:
-\family default
-
-\family roman
-both the HTML tag and the description will appear in the document
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
-\family sans
-HTML\InsetSpace ~
-URL:
-\family default
-
-\family roman
-only the description appears in the printed version
+\backslash
+usepackage{ifpdf}
\end_layout
-\begin_layout Subsection
-Using the LinuxDoc Sgml scripts
-\begin_inset Note Note
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Standard
-This section is completely outdated.
+\backslash
+ifpdf
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+pdfinfo { /Author (your name and e-mail address)
+\end_layout
+\begin_layout LyX-Code
+ /Title (official title -- i.e., title element)
+\end_layout
+\begin_layout LyX-Code
+ /Subject (one line description of the document)
\end_layout
-\begin_layout Standard
-\begin_inset LatexCommand label
-name "sec:sgmloperate"
+\begin_layout LyX-Code
+ }
+\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+pdfcatalog { /PageMode (/UseNone)
+\end_layout
-You can use LinuxDoc as a text class without any additional scripts or programs,
- but there is not much point in doing this.
- All you will get is a document that looks like a
-\emph on
-Linux Documentation Project Howto
-\family sans
-\emph default
-.
+\begin_layout LyX-Code
+ % /OpenAction (fitbh)
+\end_layout
-\family default
- To do the document translation you need to get and install the
-\family typewriter
-sgml-tools-1.0.x.tar.gz
-\family default
- (with
-\begin_inset Formula $x\geq3$
-\end_inset
+\begin_layout LyX-Code
+ }
+\end_layout
-) package from
-\family roman
-the SGML-Tools WWW Page
-\family default
- at
+\begin_layout LyX-Code
+
+\backslash
+usepackage[pdftex]{hyperref}
\end_layout
\begin_layout LyX-Code
-\family roman
-\begin_inset LatexCommand url
-target "http://pobox.com/~cg/sgmltools"
+\backslash
+else
+\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+usepackage[ps2pdf]{hyperref}
+\end_layout
+\begin_layout LyX-Code
-\family default
-
+\backslash
+fi
\end_layout
-\begin_layout Standard
-Alternatively, you can go to the
-\family typewriter
-sunsite
-\family default
- archive at
-\begin_inset Foot
-status collapsed
+\begin_layout Subsubsection
+How can I make URLs clickable?
+\end_layout
\begin_layout Standard
-Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
- has not yet been made available at
-\family typewriter
-sunsite
-\family default
-.
+See the references here:
\end_layout
-\end_inset
+\begin_layout Standard
+\begin_inset Flex URL
+status collapsed
+\begin_layout Standard
+http://wiki.lyx.org/pmwiki.php/FAQ/PDF
\end_layout
-\begin_layout LyX-Code
-
-\family roman
-\begin_inset LatexCommand url
-target "ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz"
-
\end_inset
\end_layout
-\begin_layout Standard
-
-\family roman
-The
-\family default
- file
-\family typewriter
-sgml-tools-1.0.x.tar.gz
-\family default
- contains everything that you need to write SGML documents and convert them
- to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
-
-\end_layout
-
-\begin_layout Standard
-This package was renamed from
-\family typewriter
-linuxdoc-sgml-1.5.tar.gz
-\family default
- in January 1997.
+\begin_layout Subsection
+Custom
\end_layout
\begin_layout Standard
-Follow the instructions in that package on how to install it and how to
- use it.
- All this has to be done outside of LyX, before you can use the
+Custom exports are possible if you have some particularly weird format you
+ wish to convert to, assuming you have the relevant converter, of course.
+ The format of the
+\emph on
+input
+\emph default
+ file can be chosen in the
\family sans
\bar under
F
E
\bar default
xport\SpecialChar \menuseparator
-as\InsetSpace ~
-LinuxDoc
+
+\bar under
+C
+\bar default
+ustom
\family default
+ dialog; LyX will automatically convert the file to this point, then feed
+ it to your custom converter.
+ The possible values are all formats that LyX can produce from its own documents.
-\family roman
-option.
\end_layout
-\begin_layout Subsection
-Troubleshooting LinuxDoc
+\begin_layout Standard
+The converter command is also specified in the dialog.
+ It should be a completely qualified command line which uses the variable
+
+\family typewriter
+$$FName
+\family default
+ to specify the name of the file.
+ If this variable is not given, then the file will be sent to the standard
+ input of your command.
+ You may have to apply a bit of ingenuity to escape this sequence correctly
+ so that it is compatible with your shell.
+
\end_layout
\begin_layout Standard
-When you print or preview a LinuxDoc document some checking is done of the
- tags before LaTeX is run.
- Some errors are trapped here, especially those concerning the structure
- of the document.
- LyX may produce an error message, but not leave an error box in the document
- for you to open.
- You may have to look at the files directly to discover what is wrong.
- Most problems seem to come from the use of options that are not fully available
- in the text class.
+While it is not possible to save this command using the
+\family sans
+Preferences
+\family default
+ dialog, you can manually edit your
+\family typewriter
+.lyx/preferences
+\family default
+ to add a line like
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+custom_export_command "mycommand $$FName"
+\end_layout
+
+\begin_layout Chapter
+LyX Features needing Extra Software
\end_layout
\begin_layout Section
\family default
program installed, and is grayed out if you don't have it.
You can get it from your nearest CTAN mirror, or over the Web from
-\begin_inset LatexCommand url
-target "http://www.ifi.uio.no/~jensthi/chktex/"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+http://www.ifi.uio.no/~jensthi/chktex/
+\end_layout
\end_inset
The label should stick right
up to the text to avoid falling to a wrong page.
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:chktex"
\end_inset
the text will break right between the referenced text and reference number,
and that's a pity.
See section
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "sec:chktex"
\end_inset
\family default
installation configuration file (usually with the file
\family typewriter
-/usr/local/share/chktexrc
+chktexrc
\family default
).
See below to learn what warnings can be enabled and disabled on the command
\end_layout
\begin_layout Quote
-\begin_inset LatexCommand url
-name "Literate Programming FAQ"
-target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
+Literate Programming FAQ
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
+\end_layout
\end_inset
\end_layout
\begin_layout Quote
-\begin_inset LatexCommand url
-name "Noweb home page"
-target "http://www.cs.virginia.edu/~nr/noweb/"
+Noweb home page
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Standard
+
+http://www.cs.virginia.edu/~nr/noweb/
+\end_layout
\end_inset
\end_layout
\begin_layout Subsection
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sub:LyX-and-Literate"
\end_inset
If the document is of any literate class LyX will then use the internal
LyX to Noweb converter, followed by the Noweb to LaTeX converter
\begin_inset Foot
-status open
+status collapsed
\begin_layout Standard
The converters are defined in the
\end_inset
tab.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:converters"
+
+\end_inset
+
+ of the
+\emph on
+Customization
+\emph default
+ manual for general information about converters.
\end_layout
\end_inset
Noweb->Program
\family default
converter.
- Typically, this converter (like any other converter), has two parts:
+ This converter needs to be defined by the user and is not installed by
+ default, though the Program format is.
+ This converter (like any other converter) will have two parts:
\end_layout
\begin_layout Enumerate
\begin_inset Quotes erd
\end_inset
- (a program or script) with the name of the Noweb file (generally a file
+ (a program or script) with the name of the Noweb file (normally a file
in the LyX temp directory).
\end_layout
\family typewriter
-originaldir,parselog=listerrors
+parselog=listerrors
\family default
\begin_inset Quotes erd
program.
\end_layout
+\begin_layout Standard
+The build will normally take place in LyX's temporary directory, so the
+ files produced by the conversion will be in that directory.
+ LyX will copy out what it regards as the `main' file, but the
+\family typewriter
+Noweb->Program
+\family default
+ conversion may produce several files, and so most of these would then be
+ deleted when LyX was closed.
+ The present solution is to use a `copier',
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:converters-etc"
+
+\end_inset
+
+ of the
+\emph on
+Customization
+\emph default
+ manual for information on these.
+\end_layout
+
+\end_inset
+
+ in this case, the
+\family typewriter
+ext_copy.py
+\family default
+ script in its default mode, so that the entire contents of the temporary
+ directory is copied.
+ More will get copied than is needed, to be sure, but nothing will be lost.
+ If, however, you know what extensions the generated files will have, this
+ can be improved by using the
+\family typewriter
+-e
+\family default
+ option to
+\family typewriter
+ext_copy
+\family default
+.
+ This option takes a comma-separated list of extensions to copy.
+ So, for example, if the conversion will generate only files with the extensions
+
+\family typewriter
+.c
+\family default
+ and
+\family typewriter
+.h
+\family default
+, then the correct definition would be:
+\end_layout
+
+\begin_layout LyX-Code
+python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
+\end_layout
+
+\begin_layout Standard
+The result will be that only files with these two extensions will be copied
+ out.
+\end_layout
+
\begin_layout Paragraph
Build instructions in the document
\end_layout
\begin_layout Chapter
Secrets of the LaTeX Masters
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "cha:secrets"
\end_inset
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\noindent
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
\begin_layout Standard